EPC API for receiving Electrum calls (17.1.0)

The Electrum EPC API for receiving Electrum calls is an asynchronous API that allows Corporate Clients to participate in various nationally regulated payment schemes. This document describes the operations a Corporate Client must implement for Electrum to consume in order to complete the integration with the Electrum Enterprise Payments Channel API.

Download OpenAPI description

epc-elpapi-partner-redoc.json

epc-elpapi-partner-redoc.yaml

Overview

URL

https://electrum.co.za

Electrum Support

support@electrum.co.za

Servers

Mock server

https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-partner-redoc/

Partner API sandbox

https://example.com/path/payments/partner-api/v1/

credit-transfer

Operations related to credit transfer transactions.

Operations

identifier-determination

Operations used to retrieve additional information related to an identifier

Operations

Schema

PersonIdentifier

identificationstring<= 35 charactersrequired

Unique and unambiguous identification of a person, for example a passport.

issuerstring<= 35 characters

The entity that assigns the identification

schemeobject(PersonIdentifierScheme)

{
  "identification": "string",
  "issuer": "string",
  "scheme": {
    "schema": "string",
    "value": "ARNU"
  }
}

PersonIdentification

identifiersArray of objects(PersonIdentifier)required

identifiers[].identificationstring<= 35 charactersrequired

Unique and unambiguous identification of a person, for example a passport.

identifiers[].issuerstring<= 35 characters

The entity that assigns the identification

identifiers[].schemeobject(PersonIdentifierScheme)

schemastringrequired

Identifies the party as a person, always PERSON

{
  "identifiers": [
    { … }
  ],
  "schema": "string"
}

PartyIdentification

The identification of a party, either a person or an organisation.

identifiersArray of objects(OrganisationIdentifier)required

identifiers[].BICstring[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9]...required

identifiers[].schemastringrequired

Indicates the identifier as a BIC organisation identifier, always BIC

Discriminator

schemastringrequired

Identifies the party as an organisation, always ORGANISATION

Discriminator

{
  "identifiers": [
    { … }
  ],
  "schema": "ORGANISATION"
}

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations