Documentation Powered by Redocly

EPS API Collection (1.0.0)

Download OpenAPI specification:Download

E-mail: support@openretailing.org License: Conexxus and IFSF License, Copyright © IFSF and CONEXXUS, INC. 2022, All Rights Reserved.

Group: EPS APIs

Definition: Interface for using a EPS system from a point of sale system (POS), device, or site system.

Description: Add Electronic Payment Server definition.

You can find out more about apis at the Open Retailing website.

Associated API Definitions in this Group:

  • (none)

Use Case Summary: The basic use case flows are:

  • Authorization
  • Completion/FinancialAdvice
  • Sale/Payment
  • Reversal
  • Refund/Return

Architecture: This API uses RESTFul Web Services, associating required functionality with resources and operations on those resources. For handling unsolicited events from the service provider to the client, it uses HTML5 constructs such as "Server Sent Events" and "Web Sockets".

Referenced Standards:

Scope: OpenRetailing

Part of: EPS API Group

Authentication

apikey

apikey security scheme as defined by Open Retailing API Implementation Guide - Security.

Security Scheme Type API Key
Header parameter name: X-Api-Key

basic

This API supports Basic Authentication.

Security Scheme Type HTTP
HTTP Authorization Scheme basic

oauth2

OAuth2 security scheme as defined by Open Retailing API Implementation Guide - Security.

Security Scheme Type OAuth2
authorizationCode OAuth Flow
Authorization URL: https://gitlab.openretailing.org
Token URL: https://gitlab.openretailing.org/oauth/token
Scopes:
  • read -

    Grants read access

  • write -

    Grants write access

  • admin -

    Grants access to admin operations

connection

Contains EPS connection functions

/connection

Used to establish a connection to the EPS or
to verify the EPS is connected.
See POI Registration, Heartbeat Process and Reconnect Logic sections in the Implementation Guide.

Authorizations:
apikey
    basic
      oauth2
        Request Body schema: application/json
        transmissionID
        required
        integer (integerUnsigned8BaseType) [ 0 .. 99999999 ]

        8 digit numeric value

        timestamp
        required
        string <date-time> (dateTimeType) [ 10 .. 30 ] characters
        applicationName
        string (description100BaseType) <= 100 characters

        100 character description.

        applicationSoftwareVersion
        string (description8BaseType) <= 8 characters

        8 character description.

        required
        Array of objects (alternateIDArray) <= 100 items [ items ]

        Responses

        Request samples

        Content type
        application/json
        {
        • "transmissionID": 123456,
        • "vendor": {
          },
        • "timestamp": "2021-04-08T05:20:00",
        • "applicationName": "OpenRetailing Site System",
        • "applicationSoftwareVersion": "01.00.00",
        • "siteSystemIDs": [
          ]
        }

        Response samples

        Content type
        application/json
        {
        • "statusReturn": {
          },
        • "transmissionID": 123456,
        • "connectionID": "40641ee8-8c1b-47cb-9609-70ff4318f7f5"
        }

        /connection

        Indicate to the EPS that the site is disconnecting this session. Any session data (e.g., keys) will be removed from the host system and resources freed up.

        Authorizations:
        apikey
          basic
            oauth2
              header Parameters
              openretailing-connection-id
              required
              string (connectionIDType) [ 1 .. 1024 ] characters

              The Site Reference ID returned in the "connect" call.

              Responses

              Response samples

              Content type
              application/json
              {
              • "statusReturn": {
                }
              }