CreditTransferPaymentScheme

Electrum Regulated Payments Events API (17.1.0)

The Electrum Regulated Payments Events API is a synchronous API that describes the events emitted by the Electrum Regulated Payments platform during the course of transaction processing.

This document describes the single endpoint that you will need to implement in order to receive event notifications posted by Electrum.

As transactions are processed by Electrum, events are emitted to provide information about the status of the transactions and the operations preformed on them. These events do not affect processing, but provide information that can be used for operational support and monitoring purposes.

All events are posted to the same single URL. Event are differentiated by a unique descriptor contained in the name field of the message body. This descriptor serves to allow the receiver to determine whether the particular event is of interest.

state

Transactions transition through different states. As each state is entered, an event is emitted. This event provides information about the state entered by the transaction. Included in this information is the message payload of the operation that triggered the state transition in the Electrum Regulated Payments. Note: The message payload attached to an event might be an internally-triggered message and not the message sent to or received from the Electrum Regulated Payments API.

ZaRtcCreditTransferPaymentScheme

schemastring(PaymentSchemeName)required

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.
CBPR_PLUS: Cross-Border Payments and Reporting Plus.

Enum"ZA_RTC""ZA_RPP""ZA_EFT""CBPR_PLUS"

schemeDataobject(ZaRtcCreditTransferPaymentSchemeData)required

schemeData.businessReferencestring<= 10 characters^\d{2}[\dA-z]{8}$required

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).

schemeData.originatorEchoDatastring<= 20 characters^[\dA-z ]*$

Echo data reserved for originator use. Must remain unaltered by the beneficiary.

schemeData.userReferencestring<= 20 characters^[\dA-z ]*$

An explanation of the transaction, e.g. to be printed on the account holder's statement.

{
  "schema": "ZA_RTC",
  "schemeData": {
    "businessReference": "string",
    "originatorEchoData": "string",
    "userReference": "string"
  }
}

CreditTransferPaymentScheme

Designates which scheme a customer credit transfer is associated with and describes scheme-specific information for the credit transfer.

schemastringrequired

Discriminator

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": "CBPR_PLUS",
  "schemeData": {
    "chargeBearer": "DEBT",
    "charges": [ … ],
    "exchangeRate": 0.1,
    "regulatoryReporting": [ … ]
  }
}

ExternalCategoryPurpose1Code

BONU (BonusPayment): Transaction is the payment of a bonus.
CASH (CashManagementTransfer): Transaction is a general cash management instruction.
CBLK (CardBulkClearing): A service that is settling money for a bulk of card transactions, while referring to a specific transaction file or other information like terminal ID, card acceptor ID or other transaction details.
CCRD (CreditCardPayment): Transaction is related to a payment of credit card.
CORT (TradeSettlementPayment): Transaction is related to settlement of a trade, eg a foreign exchange deal or a securities transaction.
DCRD (DebitCardPayment): Transaction is related to a payment of debit card.
DIVI (Dividend): Transaction is the payment of dividends.
DVPM (DeliverAgainstPayment): Code used to pre-advise the account servicer of a forthcoming deliver against payment instruction.
EPAY (Epayment): Transaction is related to ePayment.
FCIN (FeeCollectionAndInterest): Transaction is related to the payment of a fee and interest.
FCOL (FeeCollection): A service that is settling card transaction related fees between two parties.
GP2P (PersontoPersonPayment): General Person-to-Person Payment. Debtor and Creditor are natural persons.
GOVT (GovernmentPayment): Transaction is a payment to or from a government department.
HEDG (Hedging): Transaction is related to the payment of a hedging operation.
ICCP (IrrevocableCreditCardPayment): Transaction is reimbursement of credit card payment.
IDCP (IrrevocableDebitCardPayment): Transaction is reimbursement of debit card payment.
INTC (IntraCompanyPayment): Transaction is an intra-company payment, ie, a payment between two companies belonging to the same group.
INTE (Interest): Transaction is the payment of interest.
LBOX (LockboxTransactions): Transaction is related to identify cash handling via Night Safe or Lockbox by bank or vendor on behalf of a physical store.
LOAN (Loan): Transaction is related to the transfer of a loan to a borrower.
MP2B (Commercial): Mobile P2B Payment
MP2P (Consumer): Mobile P2P Payment
OTHR (OtherPayment): Other payment purpose.
PENS (PensionPayment): Transaction is the payment of pension.
RPRE (Represented): Collection used to re-present previously reversed or returned direct debit transactions.
RRCT (ReimbursementReceivedCreditTransfer): Transaction is related to a reimbursement for commercial reasons of a correctly received credit transfer.
RVPM (ReceiveAgainstPayment): Code used to pre-advise the account servicer of a forthcoming receive against payment instruction.
SALA (SalaryPayment): Transaction is the payment of salaries.
SECU (Securities): Transaction is the payment of securities.
SSBE (SocialSecurityBenefit): Transaction is a social security benefit, ie payment made by a government to support individuals.
SUPP (SupplierPayment): Transaction is related to a payment to a supplier.
TAXS (TaxPayment): Transaction is the payment of taxes.
TRAD (Trade): Transaction is related to the payment of a trade finance transaction.
TREA (TreasuryPayment): Transaction is related to treasury operations. E.g. financial contract settlement.
VATX (ValueAddedTaxPayment): Transaction is the payment of value added tax.
WHLD (WithHolding): Transaction is the payment of withholding tax.
SWEP (CashManagementSweepAccount): Classification - Cash Management. Transaction relates to a cash management instruction, requesting a sweep of the account of the Debtor above an agreed floor amount, up to a target or zero balance. The purpose is to move the funds from multiple accounts to a single bank account. Funds can move domestically or across border and more than one bank can be used.
TOPG (CashManagementTopAccount): Classification - Cash Management. Transaction relates to a cash management instruction, requesting to top the account of the Creditor above a certain floor amount, up to a target or zero balance. The floor amount, if not pre-agreed by the parties involved, may be specified.
ZABA (CashManagementZeroBalanceAccount): Transaction relates to a cash management instruction, requesting to zero balance the account of the Debtor. Zero Balance Accounts empty or fill the balances in accounts at the same bank, in the same country into or out of a main account each day.
VOST (CrossborderMIPayments): Transaction to be processed as a domestic payment instruction originated from a foreign bank.
FCDT (ForeignCurrencyDomesticTransfer): Foreign Currency Transaction that is processed between two domestic financial institutions.
CIPC (CashInPreCredit): Transaction is a direct debit for a cash order of notes and/or coins.
CONC (CashOutNotesCoins): Transaction is a direct debit for a cash order of notes and/or coins.
CGWV (CarrierGuardedWholesaleValuables): Transaction is a payment towards a Party for the collection of cash by the Cash in Transit company.
SAVG (Savings): Transfer to / from savings or to retirement account.
CTDF (DoddFrank1073Payment): Cross border transaction initiated by US natural person that is subject to compliance with Dodd Frank 1073.

string(ExternalCategoryPurpose1Code)

BONU (BonusPayment): Transaction is the payment of a bonus.
CASH (CashManagementTransfer): Transaction is a general cash management instruction.
CBLK (CardBulkClearing): A service that is settling money for a bulk of card transactions, while referring to a specific transaction file or other information like terminal ID, card acceptor ID or other transaction details.
CCRD (CreditCardPayment): Transaction is related to a payment of credit card.
CORT (TradeSettlementPayment): Transaction is related to settlement of a trade, eg a foreign exchange deal or a securities transaction.
DCRD (DebitCardPayment): Transaction is related to a payment of debit card.
DIVI (Dividend): Transaction is the payment of dividends.
DVPM (DeliverAgainstPayment): Code used to pre-advise the account servicer of a forthcoming deliver against payment instruction.
EPAY (Epayment): Transaction is related to ePayment.
FCIN (FeeCollectionAndInterest): Transaction is related to the payment of a fee and interest.
FCOL (FeeCollection): A service that is settling card transaction related fees between two parties.
GP2P (PersontoPersonPayment): General Person-to-Person Payment. Debtor and Creditor are natural persons.
GOVT (GovernmentPayment): Transaction is a payment to or from a government department.
HEDG (Hedging): Transaction is related to the payment of a hedging operation.
ICCP (IrrevocableCreditCardPayment): Transaction is reimbursement of credit card payment.
IDCP (IrrevocableDebitCardPayment): Transaction is reimbursement of debit card payment.
INTC (IntraCompanyPayment): Transaction is an intra-company payment, ie, a payment between two companies belonging to the same group.
INTE (Interest): Transaction is the payment of interest.
LBOX (LockboxTransactions): Transaction is related to identify cash handling via Night Safe or Lockbox by bank or vendor on behalf of a physical store.
LOAN (Loan): Transaction is related to the transfer of a loan to a borrower.
MP2B (Commercial): Mobile P2B Payment
MP2P (Consumer): Mobile P2P Payment
OTHR (OtherPayment): Other payment purpose.
PENS (PensionPayment): Transaction is the payment of pension.
RPRE (Represented): Collection used to re-present previously reversed or returned direct debit transactions.
RRCT (ReimbursementReceivedCreditTransfer): Transaction is related to a reimbursement for commercial reasons of a correctly received credit transfer.
RVPM (ReceiveAgainstPayment): Code used to pre-advise the account servicer of a forthcoming receive against payment instruction.
SALA (SalaryPayment): Transaction is the payment of salaries.
SECU (Securities): Transaction is the payment of securities.
SSBE (SocialSecurityBenefit): Transaction is a social security benefit, ie payment made by a government to support individuals.
SUPP (SupplierPayment): Transaction is related to a payment to a supplier.
TAXS (TaxPayment): Transaction is the payment of taxes.
TRAD (Trade): Transaction is related to the payment of a trade finance transaction.
TREA (TreasuryPayment): Transaction is related to treasury operations. E.g. financial contract settlement.
VATX (ValueAddedTaxPayment): Transaction is the payment of value added tax.
WHLD (WithHolding): Transaction is the payment of withholding tax.
SWEP (CashManagementSweepAccount): Classification - Cash Management. Transaction relates to a cash management instruction, requesting a sweep of the account of the Debtor above an agreed floor amount, up to a target or zero balance. The purpose is to move the funds from multiple accounts to a single bank account. Funds can move domestically or across border and more than one bank can be used.
TOPG (CashManagementTopAccount): Classification - Cash Management. Transaction relates to a cash management instruction, requesting to top the account of the Creditor above a certain floor amount, up to a target or zero balance. The floor amount, if not pre-agreed by the parties involved, may be specified.
ZABA (CashManagementZeroBalanceAccount): Transaction relates to a cash management instruction, requesting to zero balance the account of the Debtor. Zero Balance Accounts empty or fill the balances in accounts at the same bank, in the same country into or out of a main account each day.
VOST (CrossborderMIPayments): Transaction to be processed as a domestic payment instruction originated from a foreign bank.
FCDT (ForeignCurrencyDomesticTransfer): Foreign Currency Transaction that is processed between two domestic financial institutions.
CIPC (CashInPreCredit): Transaction is a direct debit for a cash order of notes and/or coins.
CONC (CashOutNotesCoins): Transaction is a direct debit for a cash order of notes and/or coins.
CGWV (CarrierGuardedWholesaleValuables): Transaction is a payment towards a Party for the collection of cash by the Cash in Transit company.
SAVG (Savings): Transfer to / from savings or to retirement account.
CTDF (DoddFrank1073Payment): Cross border transaction initiated by US natural person that is subject to compliance with Dodd Frank 1073.

Enum"BONU""CASH""CBLK""CCRD""CORT""DCRD""DIVI""DVPM""EPAY""FCIN"

"BONU"

Electrum Regulated Payments Events API (17.1.0)

state

Schema

ZaRtcCreditTransferPaymentScheme

CreditTransferPaymentScheme

ExternalCategoryPurpose1Code