EPC API for calling Electrum (17.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
Mock server

https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-redoc/

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

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

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations