EPC API for calling Electrum (29.1.0)

The Electrum EPC API for calling Electrum is an asynchronous API that allows Corporate Clients to participate in various nationally regulated payment schemes This document describes the operations exposed by Electrum for partners to consume in order to initiate outbound or respond to inbound payments.

Download OpenAPI description
Overview
Languages
Servers
Payments API sandbox

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

credit-transfer

Operations related to credit transfer transactions.

Operations

scheme-inquiry

Operations that are related to retrieving information from industry for a particular scheme.

Operations

request-to-pay

Operations which pertain to a request for payment from a creditor to a debtor

Operations

Schema

OriginalErrorResponse

A model carrying information detailing a previously returned error response. If the original response included an ErrorDetail payload it is returned in the detail field.

detailobject(ErrorDetail)

A model carrying information detailing the reason for an error that occurred.

httpStatusstringrequired

The HTTP status of the HTTP response which originally communicated the error.

schemastring
Value"OriginalErrorResponse"
{ "detail": { "detail": "string", "message": "string", "schema": "ErrorDetail" }, "httpStatus": "string", "schema": "OriginalErrorResponse" }

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" }

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations