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.

Languages
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

AccountIdentification

Holds details pertaining to an identifier of an account or store of value.

accountKnownAsstring<= 40 characters

A name or label of the account.

identifierobject(AccountIdentifier)required
identifier.​namespacestring[ 1 .. 40 ] characters

An identifier's namespace provides a context for the identifier to distinguish different identifiers which may have the same value but be intended to identify different accounts. For example, a bank may use the same MSISDN (identifier) with different namespaces to distinguish between a customer's cheque or savings accounts.

This may be used by the following schemes:

  • ZA_RPP
identifier.​schemastringrequired

Indicates the schema of the identifier, e.g. MOBILE, CUSTOM.

Discriminator
identifier.​valuestring[ 1 .. 2048 ] charactersrequired
registeredSchemesArray of strings(PaymentSchemeName)

The list of schemes with which the identifier is registered.

Items Enum"ZA_RTC""ZA_RPP""ZA_EFT""CBPR_PLUS"
{ "accountKnownAs": "string", "identifier": { "schema": "string", "value": "string" }, "registeredSchemes": [ "ZA_RTC" ] }

AddressTypeCode

  • ADDR: A postal address.
  • PBOX: A postal office (PO) box address.
  • HOME: A (residential) home address.
  • BIZZ: A business address.
  • MLTO: Address to which mail is sent.
  • DLVY: Address to which delivery is to take place
string(AddressTypeCode)
  • ADDR: A postal address.
  • PBOX: A postal office (PO) box address.
  • HOME: A (residential) home address.
  • BIZZ: A business address.
  • MLTO: Address to which mail is sent.
  • DLVY: Address to which delivery is to take place
Enum"ADDR""PBOX""HOME""BIZZ""MLTO""DLVY"
"ADDR"

CountryCode

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

string(CountryCode)[A-Z]{2,2}

A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).

"string"

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations