EPC API for receiving Electrum calls (29.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
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

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": [ {} ] }

TaxInformation

totalAmountobject(Amount)required
totalAmount.​currencystring^[A-Z]{3}$required

A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.

totalAmount.​valuenumber(double)>= 0required

The payment amount in the denomination of the indicated currency, in the format '. with the number of minor units (fractional digits) compliant with the number of decimal places published in ISO 4217.

Currency CodeExampleValidNotes
USD10.0Represents 10 USD and no cents.
USD10.00
USD10.001US dollar does not support three decimal places.
JPY10.0Represents 10 Japanese Yen.
JPY10.1Japanese Yen does not support decimal places.
{ "totalAmount": { "currency": "string", "value": 0.1 } }

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations