Electrum Regulated Payments API (21.0.2)

The Electrum Regulated Payments API is an asynchronous API that allows partners 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.

As the Regulated Payments API is asynchronous, partners have a choice of how to integrate with Electrum:

  • Webhooks: Electrum will send events to the partner containing inbound payments to action, or responses to outbound payment requests. Webhooks are defined in this document.
  • Partner API: Electrum will call operations exposed by the partner containing inbound payments to action, or responses to outbound payment requests. The operations are defined in the Electrum Regulated Payments Partner API.

Receiving transactional events via webhooks or API are equivalent, except that it may be more familiar or convenient to implement one style or the other. Partners may request the method of communication Electrum should use when selecting which payment schemes to participate in.

Download OpenAPI description
Overview
Languages
Servers
Payments API sandbox

https://example.com/path/payments/api/v1/

transactional

Operations that participate in transaction processing, which may or may not have financial impact.

Operations

financial

Operations that participate in transaction processing and have financial impact.

Operations

credit-transfer

Operations related to credit transfer transactions.

Operations

direct-debit

Operations related to direct debit transactions.

Operations

payment-return

Operations related to payment returns.

Operations

account-management

Operations that involve customer account information.

Operations

proxy

Operations that involve the management or processing of proxies

Operations

scheme-inquiry

Operations that are related to retrieving information from industry for a particular scheme.

Operations

identifier-determination

Operations used to retrieve additional information related to an identifier

Operations

identifier-verification

Operations used to verify information relating to an account identifier

Operations

request-to-pay

Operations which pertain to a request for payment from a creditor to a debtor

Operations

funds-management

Operations related to the management of funds, including reservations, postings, and voiding of reservations.

Operations

refund

Operations related to the refund of a prior successful financial transaction.

Operations

risk-assessment

Operations related to the assessment and identification of risk in transactions.

Operations

fraud-assessment

Operations related to the processing of fraud assessments for payment transactions.

Operations

Schema

ZaEftPaymentReturnPaymentScheme

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.
  • ZA_AC : South African Authenticated Collections scheme.
  • ZA_RMS: South African Registered Mandate Service scheme.
  • CBPR_PLUS: Cross-Border Payments and Reporting Plus.
Enum"ZA_RTC""ZA_RPP""ZA_EFT""ZA_AC""ZA_RMS""CBPR_PLUS"
schemeDataobject(ZaEftPaymentReturnPaymentSchemeData)required
schemeData.​returnTypestringrequired

Identifies the type of EFT payment return.

  • UNPAID: Occurs when a payment cannot be completed successfully by the homing bank such as due to insufficient funds or account closure. Note that it is impossible for Electrum to reject unpaids received from industry, so a negative payment return response from the partner will always result in a reconciliation exception for inbound unpaids.
  • DISPUTE: Occurs when there is a disagreement between the creditor and debtor regarding a payment and, after investigation with the assistance of their respective banks, the creditor's bank (in the case of a credit) or the debtor's bank (in the case of a debit) decides that the payment should be returned. As for unpaids, it is impossible for Electrum to reject disputes received from industry, so a negative payment return response results in a reconciliation exception for inbound disputes.
  • SYSTEM_ERROR_CORRECTION_REQUEST: Only expected for inbound use and represents the case where a bank from industry has experienced a technical issue that resulted in payments to or from the partner bank being reflected incorrectly (e.g. credits or debits were duplicated) and the industry bank is requesting that the partner bank attempt to correct the error. This case is notably different from unpaids and disputes in that (1) the system error correction request is expected to be best effort and may be rejected by the partner bank if the request cannot be honoured (e.g. due to insufficient funds) and (2) the bank from industry may retry system error correction requests for the same transaction on different days if an earlier request was rejected.
  • HOME_BACK: Occurs when a payment cannot be completed successfully at the operator such as a lack of information required to route to the correct homing bank. Note that it is impossible for Electrum to reject homebacks received from industry, so a negative payment return response from the partner will always result in a reconciliation exception for inbound homebacks.
Enum"UNPAID""DISPUTE""SYSTEM_ERROR_CORRECTION_REQUEST""HOME_BACK"
schemeData.​shortenedCreditorAccountNumberstring(ShortenedAccountNumber)= 11 characters

An account number, shortened to 11 characters according to the account number reduction rules in the EFT technical standards. This field is intended for internal use by Electrum and generally should not be populated by partner implementations.

schemeData.​shortenedDebtorAccountNumberstring(ShortenedAccountNumber)= 11 characters

An account number, shortened to 11 characters according to the account number reduction rules in the EFT technical standards. This field is intended for internal use by Electrum and generally should not be populated by partner implementations.

schemeData.​userCodestring<= 4 characters

A code allocated by PayInc. Sometimes also referred to as BankCode. May equal Installation code for in-house operation.

{ "schema": "ZA_RTC", "schemeData": { "returnType": "UNPAID", "shortenedCreditorAccountNumber": "stringstrin", "shortenedDebtorAccountNumber": "stringstrin", "userCode": "stri" } }

PaymentReturnPaymentScheme

Designates which scheme a payment return is associated with and describes scheme-specific information for the return.

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.
  • ZA_AC : South African Authenticated Collections scheme.
  • ZA_RMS: South African Registered Mandate Service scheme.
  • CBPR_PLUS: Cross-Border Payments and Reporting Plus.
Enum"ZA_RTC""ZA_RPP""ZA_EFT""ZA_AC""ZA_RMS""CBPR_PLUS"
Discriminator
schemeDataobject(ZaEftPaymentReturnPaymentSchemeData)required
schemeData.​returnTypestringrequired

Identifies the type of EFT payment return.

  • UNPAID: Occurs when a payment cannot be completed successfully by the homing bank such as due to insufficient funds or account closure. Note that it is impossible for Electrum to reject unpaids received from industry, so a negative payment return response from the partner will always result in a reconciliation exception for inbound unpaids.
  • DISPUTE: Occurs when there is a disagreement between the creditor and debtor regarding a payment and, after investigation with the assistance of their respective banks, the creditor's bank (in the case of a credit) or the debtor's bank (in the case of a debit) decides that the payment should be returned. As for unpaids, it is impossible for Electrum to reject disputes received from industry, so a negative payment return response results in a reconciliation exception for inbound disputes.
  • SYSTEM_ERROR_CORRECTION_REQUEST: Only expected for inbound use and represents the case where a bank from industry has experienced a technical issue that resulted in payments to or from the partner bank being reflected incorrectly (e.g. credits or debits were duplicated) and the industry bank is requesting that the partner bank attempt to correct the error. This case is notably different from unpaids and disputes in that (1) the system error correction request is expected to be best effort and may be rejected by the partner bank if the request cannot be honoured (e.g. due to insufficient funds) and (2) the bank from industry may retry system error correction requests for the same transaction on different days if an earlier request was rejected.
  • HOME_BACK: Occurs when a payment cannot be completed successfully at the operator such as a lack of information required to route to the correct homing bank. Note that it is impossible for Electrum to reject homebacks received from industry, so a negative payment return response from the partner will always result in a reconciliation exception for inbound homebacks.
Enum"UNPAID""DISPUTE""SYSTEM_ERROR_CORRECTION_REQUEST""HOME_BACK"
schemeData.​shortenedCreditorAccountNumberstring(ShortenedAccountNumber)= 11 characters

An account number, shortened to 11 characters according to the account number reduction rules in the EFT technical standards. This field is intended for internal use by Electrum and generally should not be populated by partner implementations.

schemeData.​shortenedDebtorAccountNumberstring(ShortenedAccountNumber)= 11 characters

An account number, shortened to 11 characters according to the account number reduction rules in the EFT technical standards. This field is intended for internal use by Electrum and generally should not be populated by partner implementations.

schemeData.​userCodestring<= 4 characters

A code allocated by PayInc. Sometimes also referred to as BankCode. May equal Installation code for in-house operation.

{ "schema": "ZA_EFT", "schemeData": { "returnType": "UNPAID", "shortenedCreditorAccountNumber": "stringstrin", "shortenedDebtorAccountNumber": "stringstrin", "userCode": "stri" } }

ReturnReasonInfo

Provides detailed information on the return reason.

additionalInformationstring

A human friendly description of the return reason including any further details if applicable.

reasonobject(ReturnReasonType)required
reason.​schemastringrequired

Identifies the value as being a pre-defined code. Always CODE.

Discriminator
reason.​valuestringrequired
  • AC01: IncorrectAccountNumber
  • AC03: InvalidCreditorAccountNumber
  • AC04: ClosedAccountNumber
  • AC06: BlockedAccount
  • AC13: InvalidDebtorAccountType
  • AC14: InvalidAgent
  • AC15: AccountDetailsChanged
  • AC16: AccountInSequestration
  • AC17: AccountInLiquidation
  • AG01: TransactionForbidden
  • AG02: InvalidBankOperationCode
  • AM01: ZeroAmount
  • AM02: NotAllowedAmount
  • AM03: NotAllowedCurrency
  • AM04: InsufficientFunds
  • AM05: Duplication
  • AM06: TooLowAmount
  • AM07: BlockedAmount
  • AM09: WrongAmount
  • AM10: InvalidControlSum
  • ARDT: AlreadyReturnedTransaction
  • BE01: InconsistenWithEndCustomer
  • BE04: MissingCreditorAddress
  • BE05: UnrecognisedInitiatingParty
  • BE06: UnknownEndCustomer
  • BE07: MissingDebtorAddress
  • BE08: BankError
  • CN01: AuthorisationCancelled
  • CNOR: CreditorBankIsNotRegistered
  • CNPC: CashNotPickedUp
  • CURR: IncorrectCurrency
  • CUST: RequestedByCustomer
  • DNOR: DebtorBankIsNotRegistered
  • DS28: ReturnForTechnicalReason
  • DT01: InvalidDate
  • DT02: ChequeExpired
  • ED01: CorrespondentBankNotPossible
  • ED03: BalanceInfoRequest
  • ED05: SettlementFailed
  • EMVL: EMVLiabilityShift
  • ERIN: ERIOptionNotSupported
  • FF05: InvalidLocalInstrumentCode
  • FOCR: FollowingCancellationRequest
  • FR01: Fraud
  • FRTR: FinalResponseMandateCancelled
  • MD01: NoMandate
  • MD02: MissingMandatoryInformationInMandate
  • MD06: RefundRequestByEndCustomer
  • MD07: EndCustomerDeceased
  • MS02: NotSpecifiedReasonCustomerGenerated
  • MS03: NotSpecifiedReasonAgentGenerated
  • NARR: Narrative
  • NOAS: NoAnswerFromCustomer
  • NOCM: NotCompliant
  • NOOR: NoOriginalTransactionReceived
  • PINL: PINLiabilityShift
  • RC01: BankIdentifierIncorrect
  • RC07: InvalidCreditorBICIdentifier
  • RF01: NotUniqueTransactionReference
  • RR01: MissingDebtorAccountOrIdentification
  • RR02: MissingDebtorNameOrAddress
  • RR03: MissingCreditorNameOrAddress
  • RR04: RegulatoryReason
  • RUTA: ReturnUponUnableToApply
  • SL01: SpecificServiceOfferedByDebtorAgent
  • SL02: SpecificServiceOfferedByCreditorAgent
  • SL11: CreditorNotOnWhitelistOfDebtor
  • SL12: CreditorOnBlacklistOfDebtor
  • SL13: MaximumNumberOfDirectDebitTransactionsExceeded
  • SL14: MaximumDirectDebitTransactionAmountExceeded
  • SP01: PaymentStopped
  • SP02: PreviouslyStopped
  • SVNR: ServiceNotRendered
  • TM01: CutOffTime
  • TRAC: RemovedFromTracking
  • UPAY: UnduePayment
  • AGNT: IncorrectAgent
  • FF06: InvalidCategoryPurposeCode
  • RC08: InvalidClearingSystemMemberIdentifier
  • BE11: InvalidCreditorCountry
  • BE17: InvalidCreditorIdentificationCode
  • AC02: InvalidDebtorAccountNumber
  • RR11: InvalidDebtorAgentServiceIdentification
  • BE10: InvalidDebtorCountry
  • BE16: InvalidDebtorIdentificationCode
  • RC11: InvalidIntermediaryAgent
  • RR12: InvalidPartyIdentification
  • FF03: InvalidPaymentTypeInformation
  • FF07: InvalidPurpose
  • FF04: InvalidServiceLevelCode
  • RR09: InvalidStructuredCreditorReference
  • RR05: RegulatoryInformationInvalid
  • RR07: RemittanceInformationInvalid
  • RR08: RemittanceInformationTruncated
  • RR06: TaxInformationInvalid
  • AG07: UnsuccesfulDirectDebit
  • G004: CreditPendingFunds
  • MD05: CollectionNotDue
  • AC07: ClosedCreditorAccountNumber
Enum"AC01""AC03""AC04""AC06""AC13""AC14""AC15""AC16""AC17""AG01"
{ "additionalInformation": "string", "reason": { "schema": "string", "value": "AC01" } }

operational

Operations

bulk

Operations

accounts

Operations

account-verification

Operations