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.
https://example.com/path/payments/partner-api/v1/
Identifies the scheme used for the payment
ZA_RTC: South African Realtime Clearing scheme.ZA_RPP: South African Realtime Payments Platform scheme.ZA_EFT: South African Electronic Funds Transfer scheme.ZA_AC : South African Authenticated Collections scheme.ZA_RMS: South African Registered Mandate Service scheme.CBPR_PLUS: Cross-Border Payments and Reporting Plus.{ "schema": "ZA_RTC", "schemeData": { "hasRtp": true } }
Identifies the scheme used for the payment
ZA_RTC: South African Realtime Clearing scheme.ZA_RPP: South African Realtime Payments Platform scheme.ZA_EFT: South African Electronic Funds Transfer scheme.ZA_AC : South African Authenticated Collections scheme.ZA_RMS: South African Registered Mandate Service scheme.CBPR_PLUS: Cross-Border Payments and Reporting Plus.Business reference number. The first two numeric digits identify the bank and the last 8 characters contain a unique alphanumeric value generated by the originating bank (unique for the transaction).
Echo data reserved for originator use. Must remain unaltered by the beneficiary.
{ "schema": "ZA_RTC", "schemeData": { "businessReference": "string", "originatorEchoData": "string", "userReference": "string" } }
Designates which scheme a customer credit transfer is associated with and describes scheme-specific information for the credit transfer.
Information necessary for FI to FI customer credit transfers, specifically for CBPR+
DEBT (BorneByDebtor): All transaction charges are to be borne by the debtorCRED (BorneByCreditor): All transaction charges are to be borne by the creditorSHAR (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 schemeFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.
{ "schema": "CBPR_PLUS", "schemeData": { "chargeBearer": "DEBT", "charges": [ … ], "exchangeRate": 0.1, "regulatoryReporting": [ … ] } }