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

RegulatoryAuthority

countrystring(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).

namestring<= 140 characters

The name of the entity requiring the regulatory reporting information

{ "country": "string", "name": "string" }

RegulatoryReportingDetail

additionalInformationArray of strings

Additional details that cater for specific domestic regulatory requirements

amountobject(Amount)
codestring<= 10 characters

Specifies the nature, purpose, and reason for the transaction to be reported for regulatory and statutory requirements in a coded form.

countrystring(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).

datestring(date)
typestring<= 35 characters

Specifies the type of the information supplied in the regulatory reporting detail

{ "additionalInformation": [ "string" ], "amount": { "currency": "string", "value": 0.1 }, "code": "string", "country": "string", "date": "2019-08-24", "type": "string" }

RegulatoryReporting

applicabilitystring

Identifies whether the regulatory reporting information applies to the debit side, to the credit side or to both debit and credit sides of the transaction.

Enum"CREDIT""DEBIT""BOTH"
authorityobject(RegulatoryAuthority)
detailsArray of objects(RegulatoryReportingDetail)
{ "applicability": "CREDIT", "authority": { "country": "string", "name": "string" }, "details": [ {} ] }

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations