Every message sent across the connection has been documented below using a JSON schema which defines the structure of the message. Each JSON Schema is also provided in its raw form so it can be used to validate any messages whilst developing your integration.

Pay-At-Counter

Loading Content ...

EPOS To Connect Requests

  • Connected Terminals

    Request Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example 1

    ***Error: Content has failed to load.***

    Example 2

    ***Error: Content has failed to load.***

    Response Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example 1

    ***Error: Content has failed to load.***

    Example 2

    ***Error: Content has failed to load.***

  • Terminal Details

    Request Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

    Response Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

  • Perform Transaction

    Request Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example 1

    ***Error: Content has failed to load.***

    Example 2

    ***Error: Content has failed to load.***

    Response Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example 1

    ***Error: Content has failed to load.***

    Example 2

    ***Error: Content has failed to load.***

  • Cancel Transaction

    Request Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

    Response Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

  • Duplicate

    Request Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

    Response Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Example

    ***Error: Content has failed to load.***

  • Report

    Request Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example 1

    ***Error: Content has failed to load.***

    Example 2

    ***Error: Content has failed to load.***

    Response Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example 1

    ***Error: Content has failed to load.***

    Example 2

    ***Error: Content has failed to load.***

Connect To EPOS Requests

  • Verify Signature

    Request Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

    Response Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

Connect To EPOS Notifications

  • Terminal Notification

    Notification Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

Connect To EPOS Error

  • Error

    Error Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example 1

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

    Example 2

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

    Example 3

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

    Example 4

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

    Example 5

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

    Example 6

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

    Example 7

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

    Example 8

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

    Example 9

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

    Example 10

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

Pay-At-Table

Loading Content ...

Connect To EPOS Requests

  • Table List Request

    Request Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

    Response Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

  • Table Lock Request

    Request Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

    Response Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

  • POS Receipt Request

    Request Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

    Response Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

  • Final POS Receipt Request

    Request Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

    Response Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

Connect To EPOS Notifications

  • Transaction Response

    Notification Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

  • Table Unlock

    Notification Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

  • Report Response

    Notification Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example

    ***Error: Content has failed to load.***

Connect To EPOS Error

  • Error

    Error Message

    JSON Schema

    ***Error: Content has failed to load.***

    Raw JSON schema: link

    Additional Information

    ***Error: Content has failed to load.***

    Example 1

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

    Example 2

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

    Example 3

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

    Example 4

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

    Example 5

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

    Example 6

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

    Example 7

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

    Example 8

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

    Example 9

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

    Example 10

    Message To Connect

    ***Error: Content has failed to load.***

    Error Message To EPoS

    ***Error: Content has failed to load.***

All JSON schemas use http://json-schema.org/draft-04/schema#.

Documentation of JSON Schemas built using Matic.js.

Messages over the WebSocket connection use JSON following the JSON-RPC2 Protocol.

Next Steps

Once you've completed the integration, use the Checklist to ensure that everything has been implemented as expected.