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

BankingIdentifier

issuerstring<= 35 characters

The entity that assigns the identification

schemastringrequired

Identifies this account identifier as generic, always GENERIC

Discriminator
schemeobject(GenericAccountIdentificationScheme)

Identifies the scheme that defines the identification of a generic account.

valuestring[ 1 .. 40 ] charactersrequired
{ "issuer": "string", "schema": "GENERIC", "scheme": { "schema": "string", "value": "AIIN" }, "value": "string" }

ZaRppAccountInformation

creationDatestring(date-time)required

The date when the account referenced by this proxy identifier was created.

proxyobject(NonBankingIdentifier)
traditionalAccountTypeobject(AccountType)
traditionalIdentifierobject(BankingIdentifier)required
traditionalIdentifier.​issuerstring<= 35 characters

The entity that assigns the identification

traditionalIdentifier.​schemastringrequired

Identifies this account identifier as generic, always GENERIC

Discriminator
traditionalIdentifier.​schemeobject(GenericAccountIdentificationScheme)

Identifies the scheme that defines the identification of a generic account.

traditionalIdentifier.​valuestring[ 1 .. 40 ] charactersrequired
{ "creationDate": "2019-08-24T14:15:22Z", "proxy": { "namespace": "string", "schema": "string" }, "traditionalAccountType": { "schema": "string", "value": "CACC" }, "traditionalIdentifier": { "schema": "string", "value": "string" } }

Amount

currencystring^[A-Z]{3}$required

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

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.
{ "currency": "string", "value": 0.1 }

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations