URL
Electrum Support
The Electrum Regulated Payments API is an asynchronous API that allows partners to participate in various nationally regulated payment schemes.
As the Regulated Payments API is asynchronous, partners have a choice of how to integrate with Electrum:
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.
This document describes the operations a partner must implement for Electrum to consume in order to complete the integration with the Electrum Regulated Payments API.
https://example.com/path/payments/partner-api/v1/
This operation is asynchronous. It starts with the outboundDirectDebit operation.
Invoked when a response to an outbound FI-to-FI-customer direct debit is available. The response will indicate the success or failure of the outbound direct debit.
| Scheme | Applicable |
|---|---|
| CBPR+ | ✗ |
| TCIB | ✗ |
| ZA_AC | ✓ |
| ZA_AVS | ✗ |
| ZA_CDV | ✗ |
| ZA_EFT | ✓ |
| ZA_RMS | ✓ |
| ZA_RPP | ✗ |
| ZA_RTC | ✗ |
A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the tracestate element defined in the W3C Trace Context Level 2 specification.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.
APPROVED: The instruction has been approved.CANCELLED: The instruction has been cancelled.PENDING: The instruction is pending.REJECTED: The instruction has been rejected.Provides a reference to the direct debit mandate signed between the creditor and the debtor.
Note: This model is not relevant to the ZA_EFT scheme. Electrum will not process these fields for EFT payments (e.g. tracking days are not honoured for EFT).
Contains key elements related to the original transaction that is being referred to.
Designates which scheme a payment status report is associated with and describes scheme-specific information for the payment status report.
https://example.com/path/payments/partner-api/v1/transactions/outbound/direct-debit-response
{ "schema": "PaymentStatusReport", "messageIdentifiers": { "messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da", "creationDateTime": "2022-05-04T03:22:11Z" }, "originalMessageIdentifiers": { "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da", "creationDateTime": "2022-05-04T03:02:01Z" }, "paymentScheme": { "schema": "ZA_EFT" }, "transactionIdentifiers": { "endToEndIdentification": "6249118655591098", "transactionIdentification": "RRN000000001", "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa" }, "status": { "outcome": "APPROVED", "reasonInfo": [ … ] }, "instructingAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "instructedAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "originalTransactionData": { "paymentMethod": "CreditTransfer", "creditor": { … }, "creditorAccount": { … }, "creditorAgent": { … }, "creditorAgentAccount": { … }, "amounts": { … }, "remittanceInformation": { … }, "debtor": { … }, "debtorAccount": { … }, "debtorAgent": { … }, "debtorAgentAccount": { … }, "initiatingParty": { … }, "purpose": { … }, "supplementaryData": { … }, "paymentTypeInformation": { … } } }
Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It starts with the outboundCreditTransfer operation.
Invoked when a response to an outbound FI-to-FI-customer credit transfer is available. The response will indicate the success or failure of the outbound credit transfer.
| Scheme | Applicable |
|---|---|
| CBPR+ | ✗ |
| TCIB | ✓ |
| ZA_AC | ✗ |
| ZA_AVS | ✗ |
| ZA_CDV | ✗ |
| ZA_EFT | ✓ |
| ZA_RMS | ✗ |
| ZA_RPP | ✓ |
| ZA_RTC | ✓ |
A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the tracestate element defined in the W3C Trace Context Level 2 specification.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.
APPROVED: The instruction has been approved.CANCELLED: The instruction has been cancelled.PENDING: The instruction is pending.REJECTED: The instruction has been rejected.Provides a reference to the direct debit mandate signed between the creditor and the debtor.
Note: This model is not relevant to the ZA_EFT scheme. Electrum will not process these fields for EFT payments (e.g. tracking days are not honoured for EFT).
Contains key elements related to the original transaction that is being referred to.
Designates which scheme a payment status report is associated with and describes scheme-specific information for the payment status report.
https://example.com/path/payments/partner-api/v1/transactions/outbound/credit-transfer-response
{ "schema": "PaymentStatusReport", "messageIdentifiers": { "messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da", "creationDateTime": "2022-05-04T03:22:11Z" }, "originalMessageIdentifiers": { "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da", "creationDateTime": "2022-05-04T03:02:01Z" }, "paymentScheme": { "schema": "ZA_RTC", "schemeData": { … }, "originalSchemeData": { … } }, "transactionIdentifiers": { "endToEndIdentification": "6249118655591098", "transactionIdentification": "RRN000000001", "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa" }, "status": { "outcome": "APPROVED", "reasonInfo": [ … ] }, "instructingAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "instructedAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "originalTransactionData": { "creditor": { … }, "creditorAccount": { … }, "creditorAgent": { … }, "amounts": { … }, "remittanceInformation": { … }, "debtor": { … }, "debtorAccount": { … }, "debtorAgent": { … } } }
Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It starts with the outboundFiToFiCreditTransfer operation or getOutboundCreditTransferStatus operation.
Invoked when a response to an outbound FI-to-FI credit transfer is available. The response will indicate the success or failure of the outbound credit transfer.
See the outboundCreditTransferResponse operation for responses to outbound FI-to-FI-customer credit transfers.
| Scheme | Applicable |
|---|---|
| CBPR+ | ✓ |
| TCIB | ✗ |
| ZA_AC | ✗ |
| ZA_AVS | ✗ |
| ZA_CDV | ✗ |
| ZA_EFT | ✗ |
| ZA_RMS | ✗ |
| ZA_RPP | ✗ |
| ZA_RTC | ✗ |
A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the tracestate element defined in the W3C Trace Context Level 2 specification.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.
APPROVED: The instruction has been approved.CANCELLED: The instruction has been cancelled.PENDING: The instruction is pending.REJECTED: The instruction has been rejected.Contains key elements related to the original transaction that is being referred to.
Designates which scheme an FI-to-FI payment status report is associated with and describes scheme-specific information for the payment status report.
https://example.com/path/payments/partner-api/v1/transactions/outbound/fi-to-fi-credit-transfer-response
{ "schema": "FiToFiPaymentStatusReport", "messageIdentifiers": { "messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da", "creationDateTime": "2022-05-04T03:22:11Z" }, "originalMessageIdentifiers": { "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da", "creationDateTime": "2022-05-04T03:02:01Z" }, "paymentScheme": { "schema": "CBPR_PLUS" }, "transactionIdentifiers": { "instructionIdentification": "a1db-0181ab0897d2", "endToEndIdentification": "6249118655591098", "transactionIdentification": "RRN000000001", "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa" }, "status": { "outcome": "PENDING", "reasonInfo": [ … ] }, "instructingAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "instructedAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "originalTransactionData": { "paymentMethod": "CreditTransfer", "creditor": { … }, "creditorAccount": { … }, "creditorAgent": { … }, "amounts": { … }, "remittanceInformation": { … }, "debtor": { … }, "debtorAccount": { … }, "debtorAgent": { … }, "supplementaryData": { … } } }
Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It starts with the outboundBulkCreditTransfer operation.
Invoked when a response to an outbound bulk credit transfer is available. The response will indicate the success or failure of the outbound bulk credit transfer.
| Scheme | Applicable |
|---|---|
| CBPR+ | ✗ |
| TCIB | ✗ |
| ZA_AC | ✗ |
| ZA_AVS | ✗ |
| ZA_CDV | ✗ |
| ZA_EFT | ✗ |
| ZA_RMS | ✗ |
| ZA_RPP | ✓ |
| ZA_RTC | ✓ |
A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the tracestate element defined in the W3C Trace Context Level 2 specification.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
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)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
Name by which an institution is known and which is usually used to identify that institution
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
Number of individual credit transfer instructions within the bulk that should be initiated.
Universally unique identifier to provide an end-to-end reference to the bulk initiation. This identifier remains the same for all messages related to the bulk transaction. Note: this is distinct from the UETR's of the individual credit transfers.
RECEIVED: The bulk initiation has been received.PENDING: The bulk initiation is undergoing pre-checks.ACCEPTED: The bulk initiation has been accepted and individual transactions are being processed.COMPLETED: The bulk initiation processing is complete, with all individual payment status reports received.REJECTED: The bulk initiation has been rejected.List of payment status reports relating to each credit initiation instruction received and actioned
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.TCIB: Transactions Cleared on an Immediate Basis scheme.A detailed breakdown of the number of transactions by their status. Each property corresponds to a status outcome and contains the transaction count for that status.
Count of transactions with the APPROVED status.
Count of transactions with the CANCELLED status.
Count of transactions with the PENDING status.
https://example.com/path/payments/partner-api/v1/transactions/outbound/bulk/credit-transfer-response
{ "schema": "PaymentInitiationStatusReport", "paymentInformationId": "uniqueUUID", "messageIdentifiers": { "messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da", "creationDateTime": "2024-05-04T03:22:11Z" }, "originalMessageIdentifiers": { "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da", "creationDateTime": "2024-05-04T03:02:01Z" }, "paymentSchemeName": "ZA_RPP", "paymentInitiationStatus": { "outcome": "COMPLETED", "reasonInfo": [ … ] }, "transactionStatistics": { "numberOfApprovedTransactions": 2, "numberOfPendingTransactions": 0, "numberOfCancelledTransactions": 0, "numberOfRejectedTransactions": 0 }, "numberOfTransactions": 2, "controlSum": { "amount": { … } }, "debtorAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "paymentInstructionStatusReports": [ { … }, { … } ] }
Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It is responded to by invoking the inboundCreditTransferResponse operation.
The inbound customer credit transfer operation is called when a credit transfer to one of your account holders is received. This event must be followed by a call to the inboundCreditTransferResponse operation to indicate whether the credit payment was actioned or not. Note that the payment is expected to have immediate financial impact if approved; there is no completion leg such as for credit transfers carried out via the inboundCreditTransferAuthorisation operation.
This operation must be idempotent, i.e., no action should be taken if the operation is received more than once with an identical request body. This allows Electrum to retry the request if the initial request fails. An identical HTTP response is expected to be returned for each retry.
Note: | This operation differs from the inboundCreditTransferAuthorisation operation as this operation has immediate | financial impact and does not include a completion leg.
| Scheme | Applicable |
|---|---|
| CBPR+ | ✗ |
| TCIB | ✓ |
| ZA_AC | ✗ |
| ZA_AVS | ✗ |
| ZA_CDV | ✗ |
| ZA_EFT | ✓ |
| ZA_RMS | ✗ |
| ZA_RPP | ✗ |
| ZA_RTC | ✗ |
A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the tracestate element defined in the W3C Trace Context Level 2 specification.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.
A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.
The payment amount in the denomination of the indicated currency, in the format '
| Currency Code | Example | Valid | Notes |
|---|---|---|---|
| USD | 10.0 | ✓ | Represents 10 USD and no cents. |
| USD | 10.00 | ✓ | |
| USD | 10.001 | ✗ | US dollar does not support three decimal places. |
| JPY | 10.0 | ✓ | Represents 10 Japanese Yen. |
| JPY | 10.1 | ✗ | Japanese Yen does not support decimal places. |
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
The identification of a party, either a person or an organisation.
The name by which this party is commonly known in day to day use. For example, a shortening of their legal name or a nickname that they commonly use. This is "non-official". However, it is acceptable for this field to be set to the same as legalName.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
Identification of the currency in which the account is held.
Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.
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)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
Name by which an institution is known and which is usually used to identify that institution
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
The identification of a party, either a person or an organisation.
The name by which this party is commonly known in day to day use. For example, a shortening of their legal name or a nickname that they commonly use. This is "non-official". However, it is acceptable for this field to be set to the same as legalName.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
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)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
Name by which an institution is known and which is usually used to identify that institution
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.
Agents between the debtor's agent and the creditor's agent. Usage: If more than one intermediary agent is present, then IntermediaryAgent1 identifies the agent between the DebtorAgent and the IntermediaryAgent2
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 schemeAgent(s) between the debtor's agent and the instructing agent.
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.
https://example.com/path/payments/partner-api/v1/transactions/inbound/credit-transfer
{ "paymentScheme": { "schema": "ZA_EFT", "schemeData": { … } }, "amounts": { "bankSettlementAmount": { … }, "instructedAmount": { … } }, "paymentTypeInformation": { "localInstrument": { … } }, "creditor": { "address": { … }, "contactDetails": { … }, "countryOfResidence": "ZA", "identification": { … } }, "creditorAccount": { "identification": { … }, "type": { … }, "currency": "ZAR" }, "creditorAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "creditorAgentAccount": { "identification": { … }, "type": { … } }, "debtor": { "address": { … }, "contactDetails": { … }, "countryOfResidence": "ZA", "identification": { … } }, "debtorAccount": { "identification": { … }, "type": { … }, "currency": "ZAR" }, "debtorAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "debtorAgentAccount": { "identification": { … }, "type": { … } }, "instructedAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "instructingAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "instructionForCreditorAgent": [ { … } ], "intermediaryAgents": [ { … } ], "previousInstructingAgents": [ { … } ], "initiatingParty": { "address": { … }, "contactDetails": { … }, "countryOfResidence": "ZA", "identification": { … } }, "purpose": { "schema": "CODE", "value": "BKDF" }, "remittanceInformation": { "unstructured": [ … ], "structured": [ … ] }, "tax": { "totalAmount": { … } }, "schema": "CreditTransfer", "messageIdentifiers": { "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da", "creationDateTime": "2022-05-04T03:02:01Z" }, "transactionIdentifiers": { "endToEndIdentification": "6249118655591098", "transactionIdentification": "RRN000000001", "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa" } }
Accepted. RFC9110 - 202
No contentThis operation is invoked to complete a successful inbound customer credit transfer that was authorized by an earlier call to the inboundCreditTransferAuthorisation operation.
| Scheme | Applicable |
|---|---|
| CBPR+ | ✗ |
| TCIB | ✗ |
| ZA_AC | ✗ |
| ZA_AVS | ✗ |
| ZA_CDV | ✗ |
| ZA_EFT | ✗ |
| ZA_RMS | ✗ |
| ZA_RPP | ✓ |
| ZA_RTC | ✓ |
A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the tracestate element defined in the W3C Trace Context Level 2 specification.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.
APPROVED: The instruction has been approved.CANCELLED: The instruction has been cancelled.PENDING: The instruction is pending.REJECTED: The instruction has been rejected.Provides a reference to the direct debit mandate signed between the creditor and the debtor.
Note: This model is not relevant to the ZA_EFT scheme. Electrum will not process these fields for EFT payments (e.g. tracking days are not honoured for EFT).
Contains key elements related to the original transaction that is being referred to.
Designates which scheme a payment status report is associated with and describes scheme-specific information for the payment status report.
https://example.com/path/payments/partner-api/v1/transactions/inbound/credit-transfer-completion
{ "schema": "PaymentStatusReport", "messageIdentifiers": { "messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da", "creationDateTime": "2022-05-04T03:22:11Z" }, "originalMessageIdentifiers": { "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da", "creationDateTime": "2022-05-04T03:02:01Z" }, "paymentScheme": { "schema": "ZA_RPP" }, "transactionIdentifiers": { "endToEndIdentification": "6249118655591098", "transactionIdentification": "RRN000000001", "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa" }, "status": { "outcome": "APPROVED", "reasonInfo": [ … ] }, "instructingAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "instructedAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "originalTransactionData": { "creditor": { … }, "creditorAccount": { … }, "creditorAgent": { … }, "amounts": { … }, "remittanceInformation": { … }, "debtor": { … }, "debtorAccount": { … }, "debtorAgent": { … } } }
Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It is responded to by the inboundDirectDebitResponse operation.
The inbound customer direct debit operation is called when a direct debit against one of your accounts is received. This must be followed by a call to the inboundDirectDebitResponse operation to indicate whether the debit payment was actioned or not. Note that the payment is expected to have immediate financial impact if approved; there is no completion leg.
This operation must be idempotent, i.e., no action should be taken if the operation is received more than once with an identical request body. This allows Electrum to retry the request if the initial request fails. An identical HTTP response is expected to be returned for each retry.
| Scheme | Applicable |
|---|---|
| CBPR+ | ✗ |
| TCIB | ✗ |
| ZA_AC | ✗ |
| ZA_AVS | ✗ |
| ZA_CDV | ✗ |
| ZA_EFT | ✓ |
| ZA_RMS | ✗ |
| ZA_RPP | ✗ |
| ZA_RTC | ✗ |
A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the tracestate element defined in the W3C Trace Context Level 2 specification.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.
A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.
The payment amount in the denomination of the indicated currency, in the format '
| Currency Code | Example | Valid | Notes |
|---|---|---|---|
| USD | 10.0 | ✓ | Represents 10 USD and no cents. |
| USD | 10.00 | ✓ | |
| USD | 10.001 | ✗ | US dollar does not support three decimal places. |
| JPY | 10.0 | ✓ | Represents 10 Japanese Yen. |
| JPY | 10.1 | ✗ | Japanese Yen does not support decimal places. |
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
The identification of a party, either a person or an organisation.
The name by which this party is commonly known in day to day use. For example, a shortening of their legal name or a nickname that they commonly use. This is "non-official". However, it is acceptable for this field to be set to the same as legalName.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
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)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
Name by which an institution is known and which is usually used to identify that institution
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
The identification of a party, either a person or an organisation.
The name by which this party is commonly known in day to day use. For example, a shortening of their legal name or a nickname that they commonly use. This is "non-official". However, it is acceptable for this field to be set to the same as legalName.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
Identification of the currency in which the account is held.
Name of the account, as assigned by the account servicing institution, in agreement with the account owner in order to provide an additional means of identification of the account.
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)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
Name by which an institution is known and which is usually used to identify that institution
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
Provides details about whether and how a debit may be disputed by the debtor. This model encapsulates dispute eligibility metadata which can be passed through pacs.003 payloads to downstream systems.
Indicates that this direct debit was submitted via an emergency collection service. The action date must equal the current processing date.
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
Agents between the debtor's agent and the creditor's agent. If more than one intermediary agent is present, then IntermediaryAgent1 identifies the agent between the DebtorAgent and the IntermediaryAgent2.
Provides a reference to the direct debit mandate signed between the creditor and the debtor.
Note: This model is not relevant to the ZA_EFT scheme. Electrum will not process these fields for EFT payments (e.g. tracking days are not honoured for EFT).
Designates which scheme a direct debit is associated with and describes scheme-specific information for the direct debit.
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.TCIB: Transactions Cleared on an Immediate Basis scheme.Scheme-specific data for Authenticated Collections (DebiCheck) direct debits. Unlike EFT, DebiCheck only supports debit transactions (collections), so shortened account numbers used for EFT file generation are not applicable here.
The Creditor Abbreviated Short Name (ABSN). This is a 3 to 10 character description of the Ultimate Creditor's name, business, or product that will appear on the debtor's bank statement. This value MUST perfectly match the ABSN stored on the active Mandate Register at the Debtor Bank (i.e. must match the short name provided for the ultimateCreditor during mandate initiation). Mismatches will result in scheme rejections.
The unique contract reference number issued by the Ultimate Creditor to the Payer/Debtor when the contract was concluded. This value MUST perfectly match the Contract Reference stored on the active Mandate Register at the Debtor Bank. (i.e must match the identifier provided for mandate.mandateRequestIdentification during mandate initiation). Mismatches will result in scheme rejections.
Under the DebiCheck scheme, the user reference expected to appear on debtor statements comprises the following:
creditorAbbreviatedShortName - right-padded with spaces to exactly 10 characters (Characters 1–10)creditorContractReference - right-padded with spaces to exactly 14 characters (Characters 11–24)requestedCollectionDate (also known as cycle date) - formatted as YYMMDD (Characters 25–30)remittanceInformation in the DirectDebit. Only the first 30 characters are required to appear on debtor statements. Allowed characters are limited to printable characters.This field will be provided for all inbound requests to the partner. Do NOT populate this field for outbound requests. Instead, provide any bill presentment text (up to 110 characters) in the DirectDebit model under remittanceInformation.unstructured. The engine will automatically concatenate the Creditor Short Name, Contract Reference, the DirectDebit requestedCollectionDate, and your unstructured remittance text to construct the final 140-character string required by the scheme.
Date and time at which the creditor requests that the amount of money is to be collected from the debtor.
Identifies the direct debit sequence:
FRST : First collection of a series of direct debit instructions.RCUR : Direct debit instruction where the debtor's authorisation is used for regular direct debit transactions initiated by the creditor.FNAL : Final collection of a series of direct debit instructions.OOFF : Direct debit instruction where the debtor's authorisation is used to initiate one single direct debit transaction.RPRE : Collection used to represent previously reversed or returned direct debit transactions.https://example.com/path/payments/partner-api/v1/transactions/inbound/direct-debit
{ "paymentScheme": { "schema": "ZA_EFT", "schemeData": { … } }, "instructingAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "instructedAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "paymentTypeInformation": { "localInstrument": { … } }, "sequenceType": "FRST", "amounts": { "bankSettlementAmount": { … }, "instructedAmount": { … } }, "purpose": { "schema": "CODE", "value": "BKDF" }, "remittanceInformation": { "unstructured": [ … ], "structured": [ … ] }, "creditor": { "address": { … }, "contactDetails": { … }, "countryOfResidence": "ZA", "identification": { … } }, "creditorAccount": { "identification": { … }, "type": { … }, "currency": "ZAR" }, "creditorAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "creditorAgentAccount": { "identification": { … }, "type": { … } }, "debtor": { "address": { … }, "contactDetails": { … }, "countryOfResidence": "ZA", "identification": { … } }, "debtorAccount": { "identification": { … }, "type": { … }, "currency": "ZAR" }, "debtorAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "debtorAgentAccount": { "identification": { … }, "type": { … } }, "intermediaryAgents": [ { … } ], "initiatingParty": { "address": { … }, "contactDetails": { … }, "countryOfResidence": "ZA", "identification": { … } }, "requestedCollectionDate": "2022-05-04", "mandateInformation": { "mandateIdentification": "A mandate ID", "trackingDays": 4 }, "schema": "DirectDebit", "messageIdentifiers": { "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da", "creationDateTime": "2022-05-04T03:02:01Z" }, "transactionIdentifiers": { "endToEndIdentification": "6249118655591098", "transactionIdentification": "RRN000000001", "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa" } }
Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It is responded to with the inboundPaymentReturnResponse operation.
Invoked when an inbound return is received for an earlier outbound customer direct debit or customer credit transfer. The response to this operation will indicate the success or failure of the return. Note that some payment schemes may not support rejecting the return. In these cases, a rejected response will cause Electrum to flag the transaction as broken.
The return is expected to have immediate financial impact if approved; there is no completion leg associated with this operation.
This operation must be idempotent, i.e., no action should be taken if the operation is received more than once with an identical request body. This allows Electrum to retry the request if the initial request fails. An identical HTTP response is expected to be returned for each retry.
| Scheme | Applicable |
|---|---|
| CBPR+ | ✗ |
| TCIB | ✓ |
| ZA_AC | ✓ |
| ZA_AVS | ✗ |
| ZA_CDV | ✗ |
| ZA_EFT | ✓ |
| ZA_RMS | ✗ |
| ZA_RPP | ✗ |
| ZA_RTC | ✗ |
A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the tracestate element defined in the W3C Trace Context Level 2 specification.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
The identification of a party, either a person or an organisation.
The name by which this party is commonly known in day to day use. For example, a shortening of their legal name or a nickname that they commonly use. This is "non-official". However, it is acceptable for this field to be set to the same as legalName.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
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)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
Name by which an institution is known and which is usually used to identify that institution
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
A code to identify a country, a dependency, or another area of particular geopolitical interest, on the basis of country names obtained from the United Nations (ISO 3166, Alpha-2 code).
The identification of a party, either a person or an organisation.
The name by which this party is commonly known in day to day use. For example, a shortening of their legal name or a nickname that they commonly use. This is "non-official". However, it is acceptable for this field to be set to the same as legalName.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
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)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
Name by which an institution is known and which is usually used to identify that institution
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
Provides a reference to the direct debit mandate signed between the creditor and the debtor.
Note: This model is not relevant to the ZA_EFT scheme. Electrum will not process these fields for EFT payments (e.g. tracking days are not honoured for EFT).
Holds a point-to-point unique message identification string as well as a message's creation date time.
Contains key elements related to the original transaction that is being referred to.
Designates which scheme a payment return is associated with and describes scheme-specific information for the return.
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.TCIB: Transactions Cleared on an Immediate Basis scheme.A list of ReturnReasonInfo values providing detailed reason information for the return.
A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.
The payment amount in the denomination of the indicated currency, in the format '
| Currency Code | Example | Valid | Notes |
|---|---|---|---|
| USD | 10.0 | ✓ | Represents 10 USD and no cents. |
| USD | 10.00 | ✓ | |
| USD | 10.001 | ✗ | US dollar does not support three decimal places. |
| JPY | 10.0 | ✓ | Represents 10 Japanese Yen. |
| JPY | 10.1 | ✗ | Japanese Yen does not support decimal places. |
https://example.com/path/payments/partner-api/v1/transactions/inbound/payment-return
{ "schema": "PaymentReturn", "messageIdentifiers": { "messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da", "creationDateTime": "2022-05-04T03:22:11Z" }, "originalMessageIdentifiers": { "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da", "creationDateTime": "2022-05-04T03:02:01Z" }, "paymentScheme": { "schema": "ZA_EFT", "schemeData": { … } }, "paymentTypeInformation": { "localInstrument": { … } }, "transactionIdentifiers": { "endToEndIdentification": "6249118655591098", "transactionIdentification": "RRN000000001", "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa" }, "reasonInfo": [ { … } ], "returnedAmounts": { "bankSettlementAmount": { … }, "instructedAmount": { … } }, "settlementDate": "2022-05-04", "instructingAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "instructedAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "initiatingParty": { "address": { … }, "contactDetails": { … }, "countryOfResidence": "ZA", "identification": { … } }, "creditor": { "address": { … }, "contactDetails": { … }, "countryOfResidence": "ZA", "identification": { … } }, "creditorAccount": { "identification": { … }, "type": { … } }, "creditorAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "creditorAgentAccount": { "identification": { … }, "type": { … } }, "debtor": { "address": { … }, "contactDetails": { … }, "countryOfResidence": "ZA", "identification": { … } }, "debtorAccount": { "identification": { … }, "type": { … } }, "debtorAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "debtorAgentAccount": { "identification": { … }, "type": { … } }, "originalTransactionData": { "settlementDate": "2022-05-04", "creditor": { … }, "creditorAccount": { … }, "creditorAgent": { … }, "creditorAgentAccount": { … }, "amounts": { … }, "remittanceInformation": { … }, "debtor": { … }, "debtorAccount": { … }, "debtorAgent": { … }, "debtorAgentAccount": { … }, "initiatingParty": { … }, "purpose": { … } } }
Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It starts with the outboundPaymentReturn operation.
Invoked when a response to an outbound payment return for an inbound customer credit transfer or inbound customer direct debit is available. The response will indicate the success or failure of the return.
| Scheme | Applicable |
|---|---|
| CBPR+ | ✗ |
| TCIB | ✓ |
| ZA_AC | ✓ |
| ZA_AVS | ✗ |
| ZA_CDV | ✗ |
| ZA_EFT | ✓ |
| ZA_RMS | ✗ |
| ZA_RPP | ✗ |
| ZA_RTC | ✗ |
A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the tracestate element defined in the W3C Trace Context Level 2 specification.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.
APPROVED: The instruction has been approved.CANCELLED: The instruction has been cancelled.PENDING: The instruction is pending.REJECTED: The instruction has been rejected.Provides a reference to the direct debit mandate signed between the creditor and the debtor.
Note: This model is not relevant to the ZA_EFT scheme. Electrum will not process these fields for EFT payments (e.g. tracking days are not honoured for EFT).
Contains key elements related to the original transaction that is being referred to.
Designates which scheme a payment status report is associated with and describes scheme-specific information for the payment status report.
https://example.com/path/payments/partner-api/v1/transactions/outbound/payment-return-response
{ "schema": "PaymentStatusReport", "messageIdentifiers": { "messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da", "creationDateTime": "2022-05-04T03:22:11Z" }, "originalMessageIdentifiers": { "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da", "creationDateTime": "2022-05-04T03:02:01Z" }, "paymentScheme": { "schema": "ZA_EFT" }, "transactionIdentifiers": { "endToEndIdentification": "6249118655591098", "transactionIdentification": "RRN000000001", "uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa" }, "status": { "outcome": "APPROVED", "reasonInfo": [ … ] }, "instructingAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "instructedAgent": { "bicfi": "RY8PEG0L", "memberId": "AmazingBankId", "name": "Amazing Bank Inc", "branch": { … } }, "originalTransactionData": { "paymentMethod": "CreditTransfer", "creditor": { … }, "creditorAccount": { … }, "creditorAgent": { … }, "creditorAgentAccount": { … }, "amounts": { … }, "remittanceInformation": { … }, "debtor": { … }, "debtorAccount": { … }, "debtorAgent": { … }, "debtorAgentAccount": { … }, "initiatingParty": { … }, "purpose": { … }, "supplementaryData": { … }, "paymentTypeInformation": { … } } }
Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It starts with the outboundBulkRequestToPay operation orgetOutboundBulkRequestToPayStatus operation.
Communicates the bulk status of a prior bulk request to pay.
An outboundBulkRequestToPayResponse contains the information indicating the state of the bulk as a whole and the status of the individual request to pay transactions
If the partner is unsure of the status of an outboundBulkRequestToPay, an getOutboundBulkRequestToPayStatus may be used to solicit an up-to-date outboundBulkRequestToPayResponse.
| Scheme | Applicable |
|---|---|
| CBPR+ | ✗ |
| TCIB | ✗ |
| ZA_AC | ✗ |
| ZA_AVS | ✗ |
| ZA_CDV | ✗ |
| ZA_EFT | ✗ |
| ZA_RMS | ✗ |
| ZA_RPP | ✓ |
| ZA_RTC | ✗ |
A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the tracestate element defined in the W3C Trace Context Level 2 specification.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
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.TCIB: Transactions Cleared on an Immediate Basis scheme.Universally unique identifier to identify the bulk collection itself.
RECEIVED: The bulk initiation has been received.PENDING: The bulk initiation is undergoing pre-checks.ACCEPTED: The bulk initiation has been accepted and individual transactions are being processed.COMPLETED: The bulk initiation processing is complete, with all individual payment status reports received.REJECTED: The bulk initiation has been rejected.List of RequestToPayInstructionStatusReports relating to each request to pay initiation instruction received and actioned. Unsubmitted transactions will not be in this list.
A detailed breakdown of the number of request to pay transactions by their status. Each property corresponds to a status outcome and contains the transaction count for that status.
Count of transactions with the ACCEPTED status.
Count of transactions with the CANCELLED status.
Count of transactions with the EXPIRED status.
Count of transactions with the PAID status.
Count of transactions with the PENDING status.
Count of transactions with the PRESENT status.
Count of transactions with the REJECTED status.
https://example.com/path/payments/partner-api/v1/transactions/outbound/bulk/request-to-pay-response
{ "schema": "RequestToPayInitiationResponse", "requestToPayInformationId": "6e831b77-3e51-4a0e-a818-dc99a08f80d4", "messageIdentifiers": { "messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da", "creationDateTime": "2024-05-04T03:22:11Z" }, "originalMessageIdentifiers": { "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da", "creationDateTime": "2024-05-04T03:02:01Z" }, "bulkPaymentSchemeName": "ZA_RPP", "requestToPayInitiationStatus": { "outcome": "COMPLETED", "reasonInfo": [ … ] }, "transactionStatistics": { "numberOfPaidTransactions": 2, "numberOfAcceptedTransactions": 2, "numberOfCancelledTransactions": 0, "numberOfExpiredTransactions": 0, "numberOfPendingTransactions": 0, "numberOfPresentedTransactions": 0, "numberOfRejectedTransactions": 0, "numberOfUnsubmittedTransactions": 0 }, "numberOfTransactions": 2, "requestToPayInstructionStatusReports": [ { … } ] }
Accepted. RFC9110 - 202
No contentThis operation is invoked by Electrum to request the cancellation of a prior payment instruction such as a direct-debit or credit-transfer.
This operation is asynchronous. For ZA_AC and ZA_EFT cancellations of type SYSTEM_ERROR_CORRECTION_REQUEST a successful correction should result in the initiation of a financial payment return.
Otherwise, the result of the payment cancellation is delivered back to Electrum by invoking the inboundPaymentCancellationResolution operation which conveys the outcome of payment cancellation request.
| Scheme | Applicable |
|---|---|
| CBPR+ | ✓ |
| TCIB | ✗ |
| ZA_AC | ✓ |
| ZA_AVS | ✗ |
| ZA_CDV | ✗ |
| ZA_EFT | ✓ |
| ZA_RMS | ✗ |
| ZA_RPP | ✗ |
| ZA_RTC | ✗ |
A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the tracestate element defined in the W3C Trace Context Level 2 specification.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
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)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
Name by which an institution is known and which is usually used to identify that institution
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
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)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
Name by which an institution is known and which is usually used to identify that institution
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.
Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain. Note: this is distinct from the UETR.
Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction. The instruction identification is a point to point reference that can be used between the instructing party and the instructed party to refer to the individual instruction. It can be included in several messages related to the instruction.
Unique identification, as assigned by the first instructing agent, to unambiguously identify the transaction that is passed on, unchanged, throughout the entire interbank chain. Usage: The transaction identification can be used for reconciliation, tracking or to link tasks relating to the transaction on the interbank level. Usage: The instructing agent has to make sure that the transaction identification is unique for a pre-agreed period.
Designates which scheme a payment cancellation is associated with and describes scheme-specific information for the cancellation.
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.TCIB: Transactions Cleared on an Immediate Basis scheme.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.
Contains key elements related to the original transaction that is being referred to.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
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.Specifies the underlying reason for the payment transaction
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.
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
Provides a reference to the direct debit mandate signed between the creditor and the debtor.
Note: This model is not relevant to the ZA_EFT scheme. Electrum will not process these fields for EFT payments (e.g. tracking days are not honoured for EFT).
https://example.com/path/payments/partner-api/v1/transactions/inbound/payment-cancellation
{ "messageIdentifiers": { "creationDateTime": "2019-08-24T14:15:22Z", "messageIdentification": "string" }, "supplementaryData": { "property1": "string", "property2": "string" }, "assignment": { "assignee": { … }, "assigner": { … }, "creationDateTime": "2019-08-24T14:15:22Z", "identification": "string" }, "case": { "creator": { … }, "identification": "string", "reopenCaseIndication": true }, "originalTransactionIdentifiers": { "endToEndIdentification": "string", "instructionIdentification": "string", "transactionIdentification": "string", "uetr": "string" }, "paymentScheme": { "schema": "ZA_RTC", "schemeData": { … } }, "schema": "FiToFiPaymentCancellationRequest", "underlyingTransaction": { "amounts": { … }, "creditorAccount": { … }, "creditorAgent": { … }, "creditorAgentAccount": { … }, "debtorAccount": { … }, "debtorAgent": { … }, "debtorAgentAccount": { … }, "paymentMethod": "CreditTransfer", "paymentTypeInformation": { … }, "purpose": { … }, "remittanceInformation": { … }, "settlementDate": "2019-08-24", "supplementaryData": { … }, "creditor": { … }, "debtor": { … }, "mandateInformation": { … }, "cancellationId": "string", "cancellationReasonInfo": [ … ] } }
Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It starts with the outboundPaymentCancellation operation.
This operation begins with the partner sending a request to cancel a prior payment instruction such as a direct-debit or credit-transfer. Electrum will invoke this operation to deliver a ResolutionOfInvestigation which contains the resolution outcome of the payment cancellation request.
| Scheme | Applicable |
|---|---|
| CBPR+ | ✗ |
| TCIB | ✗ |
| ZA_AC | ✓ |
| ZA_AVS | ✗ |
| ZA_CDV | ✗ |
| ZA_EFT | ✓ |
| ZA_RMS | ✗ |
| ZA_RPP | ✗ |
| ZA_RTC | ✗ |
A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the tracestate element defined in the W3C Trace Context Level 2 specification.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
Holds a point-to-point unique message identification string as well as a message's creation date time.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
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)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
Name by which an institution is known and which is usually used to identify that institution
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
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)
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
Name by which an institution is known and which is usually used to identify that institution
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
The date and time at which the message was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339
Specifies the details of the underlying transaction being cancelled
Designates which scheme a resolution of investigation is associated with and describes scheme-specific information.
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.TCIB: Transactions Cleared on an Immediate Basis scheme.https://example.com/path/payments/partner-api/v1/transactions/outbound/payment-cancellation-resolution
{ "schema": "ResolutionOfInvestigation", "paymentScheme": { "schema": "ZA_AC" }, "messageIdentifiers": { "messageIdentification": "MSG20251206195003001", "creationDateTime": "2025-12-06T17:50:03.639Z" }, "originalMessageIdentifiers": { "messageIdentification": "MSG20251206120000001", "creationDateTime": "2025-12-06T10:00:00.000Z" }, "assignment": { "creationDateTime": "2025-12-06T17:50:03.639Z", "identification": "021/CLOUT/999001/20240115/000001", "assigner": { … }, "assignee": { … } }, "resolvedCase": { "identification": "CASE001", "creator": { … }, "reopenCaseIndication": false }, "status": { "statusType": "CONFIRMATION", "confirmationCode": "RJCR" }, "cancellationDetails": { "originalTransactionIdentifiers": { … }, "transactionCancellationStatus": "RJCR", "cancellationStatusReasonInfo": { … }, "originalTransaction": { … } } }
Accepted. RFC9110 - 202
No content