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

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

CbprPlusCustomerCreditSchemeData

Information necessary for FI to FI customer credit transfers, specifically for CBPR+

chargeBearerstring(ChargeBearer)required
  • DEBT (BorneByDebtor): All transaction charges are to be borne by the debtor
  • CRED (BorneByCreditor): All transaction charges are to be borne by the creditor
  • SHAR (Shared): In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor.
  • SLEV (FollowingServiceLevel): Charges are to be applied following the rules agreed in the service level and/or scheme
Enum"DEBT""CRED""SHAR""SLEV"
chargesArray of objects(Charge)
exchangeRatenumber(double)

Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.

regulatoryReportingArray of objects(RegulatoryReporting)<= 10 items
{ "chargeBearer": "DEBT", "charges": [ {} ], "exchangeRate": 0.1, "regulatoryReporting": [ {} ] }

CbprPlusCreditTransferPaymentScheme

schemastringrequired
schemeDataobject(CbprPlusCustomerCreditSchemeData)required

Information necessary for FI to FI customer credit transfers, specifically for CBPR+

schemeData.​chargeBearerstring(ChargeBearer)required
  • DEBT (BorneByDebtor): All transaction charges are to be borne by the debtor
  • CRED (BorneByCreditor): All transaction charges are to be borne by the creditor
  • SHAR (Shared): In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor.
  • SLEV (FollowingServiceLevel): Charges are to be applied following the rules agreed in the service level and/or scheme
Enum"DEBT""CRED""SHAR""SLEV"
schemeData.​chargesArray of objects(Charge)
schemeData.​exchangeRatenumber(double)

Factor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.

schemeData.​regulatoryReportingArray of objects(RegulatoryReporting)<= 10 items
{ "schema": "string", "schemeData": { "chargeBearer": "DEBT", "charges": [], "exchangeRate": 0.1, "regulatoryReporting": [] } }

transactional

Operations

request-to-pay

Operations

financial

Operations

bulk

Operations

refund

Operations