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

FiToFiPaymentCancellationPaymentScheme

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

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(ZaAcFiToFiPaymentCancellationPaymentSchemeData)required
schemeData.​cancellationTypestringrequired

Identifies the specific business process applicable to the cancellation request.

  • RECALL: A request to revoke a payment instruction that has not yet settled or is currently in tracking. If successful, the instruction is cancelled without financial movement (no settlement occurs). If the partner makes use of Electrum's collections capabilities, this type is only expected for outbound use.

  • SYSTEM_ERROR_CORRECTION_REQUEST: Represents the case where a bank has experienced a technical issue that resulted in settled debit collections being processed incorrectly (e.g., a batch of debits was duplicated), and the industry bank is requesting that the partner bank correct the error.

    A successful correction means the partner bank initiates a financial Payment Return to recover the funds from the industry bank in order to refund the debtor.

    This case is notably different from standard recalls and disputes in that: (1) This strictly requires prior industry/PASA authorisation to invoke, (2) it may be rejected by the partner bank if the correction cannot be applied (e.g., original transaction not found, or the transaction was already reversed via a customer dispute), (3) partial reversals are not permitted, and (4) the bank from industry is limited to exactly 2 (two) retry attempts for the same transaction if an earlier request was rejected.

Enum"RECALL""SYSTEM_ERROR_CORRECTION_REQUEST"
{ "schema": "ZA_AC", "schemeData": { "cancellationType": "RECALL" } }

PaymentMethod

  • CreditTransfer - Transfer of an amount of money in the books of the account servicer.
  • DirectDebit - Collection of an amount of money from the debtor's account by the creditor, the amount and date of collection may vary.
string(PaymentMethod)
  • CreditTransfer - Transfer of an amount of money in the books of the account servicer.
  • DirectDebit - Collection of an amount of money from the debtor's account by the creditor, the amount and date of collection may vary.
Enum"CreditTransfer""DirectDebit"
"CreditTransfer"

BaseOriginalTransactionData

amountsobject(TransactionAmounts)
creditorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

creditorAgentobject(InstitutionIdentification)
creditorAgentAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

debtorAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

debtorAgentobject(InstitutionIdentification)
debtorAgentAccountobject(PaymentAccount)

Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.

paymentMethodstring(PaymentMethod)
  • CreditTransfer - Transfer of an amount of money in the books of the account servicer.
  • DirectDebit - Collection of an amount of money from the debtor's account by the creditor, the amount and date of collection may vary.
Enum"CreditTransfer""DirectDebit"
paymentTypeInformationobject(PaymentTypeInformation)
purposeobject(PurposeType)

Specifies the underlying reason for the payment transaction

remittanceInformationobject(RemittanceInformation)
settlementDatestring(date)

Date on which the amount of money ceases to be available to the agent that owes it and when the amount of money becomes available to the agent to which it is due.

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

{ "amounts": { "bankSettlementAmount": {}, "instructedAmount": {} }, "creditorAccount": { "currency": "string", "identification": {}, "name": "string", "proxy": {}, "type": {} }, "creditorAgent": { "additionalIdentifications": [], "address": {}, "bicfi": "string", "branch": {}, "clearingSystemMemberId": {}, "companyRegistration": "string", "lei": "string", "memberId": "string", "name": "string" }, "creditorAgentAccount": { "currency": "string", "identification": {}, "name": "string", "proxy": {}, "type": {} }, "debtorAccount": { "currency": "string", "identification": {}, "name": "string", "proxy": {}, "type": {} }, "debtorAgent": { "additionalIdentifications": [], "address": {}, "bicfi": "string", "branch": {}, "clearingSystemMemberId": {}, "companyRegistration": "string", "lei": "string", "memberId": "string", "name": "string" }, "debtorAgentAccount": { "currency": "string", "identification": {}, "name": "string", "proxy": {}, "type": {} }, "paymentMethod": "CreditTransfer", "paymentTypeInformation": { "categoryPurpose": {}, "localInstrument": {}, "serviceLevel": [] }, "purpose": { "schema": "string", "value": "BKDF" }, "remittanceInformation": { "structured": [], "unstructured": [] }, "settlementDate": "2019-08-24", "supplementaryData": { "property1": "string", "property2": "string" } }

operational

Operations

bulk

Operations

accounts

Operations

account-verification

Operations