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

ZaRppServices

string(ZaRppServices)
Enum"PBPX""PBAC""RTP-PBPX""RTP-PBAC"
"PBPX"

ZaInstitutionDomainDetails

domainstring[ 1 .. 35 ] charactersrequired

A BankservAfrica-specific field requirement that associates this institution with a specific "domain"

  • which is essentially a type of namespace. This is the equivalent of the Electrum 'namespace' found on Non-Banking Identifiers, such as a MobileIdentifier
namestring[ 1 .. 100 ] charactersrequired

Name by which an institution is known and which is usually used to identify that institution

servicesArray of strings(ZaRppServices)>= 0 itemsrequired
Items Enum"PBPX""PBAC""RTP-PBPX""RTP-PBAC"
{ "domain": "string", "name": "string", "services": [ "PBPX" ] }

ParticipantIdentificationDetails

bicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)

branchobject(BranchIdentification)
domainDetailsArray of objects(ZaInstitutionDomainDetails)
memberIdstring[ 1 .. 35 ] characters

Identification of a member of a clearing system.

namestring<= 140 charactersrequired

Name by which an institution is known and which is usually used to identify that institution.

servicesArray of strings(ZaRppServices)>= 0 itemsrequired
Items Enum"PBPX""PBAC""RTP-PBPX""RTP-PBAC"
sponsoringAgentBicfistring^[A-Z0-9]{4,4}[A-Z]{2,2}[A-Z0-9]{2,2}([A-Z0-9...

A code allocated to a financial or non-financial institution by the ISO 9362 Registration Authority as described in ISO 9362 Banking - Banking telecommunication messages - Business identifier code (BIC)

sponsoringAgentNamestring<= 100 characters

Name by which an institution is known and which is usually used to identify that institution.

{ "bicfi": "string", "branch": { "address": {}, "identification": "string", "name": "string" }, "domainDetails": [ {} ], "memberId": "string", "name": "string", "services": [ "PBPX" ], "sponsoringAgentBicfi": "string", "sponsoringAgentName": "string" }

transactional

Operations

financial

Operations

identifier-determination

Operations

bulk

Operations

refund

Operations