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

dca

This Data Configuration API (DCA) contains EPS DatAdmin functions.

/countrySettings

Country settings are configuration parameters of the forecourt controller device

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

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

        Request Body schema: application/json
        object (countrySettingsObject)

        Responses

        Request samples

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

        Response samples

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