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:
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.
https://example.com/path/payments/api/v1/
This operation is asynchronous. It is responded to by the outboundCreditTransferResponse operation.
Instructs Electrum to execute an outbound FI-to-FI-customer credit transfer transaction that will credit funds to a beneficiary who is a customer at another financial institution, using the indicated scheme.
| Scheme | Applicable |
|---|---|
| ZA_EFT | ✓ |
| ZA_RPP | ✓ |
| ZA_RTC | ✓ |
| CBPR+ | ✓ |
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 traceparent 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 schemeFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.
Agent(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/api/v1/transactions/outbound/credit-transfer
curl -i -X POST \
https://example.com/path/payments/api/v1/transactions/outbound/credit-transfer \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"schema": "CreditTransfer",
"messageIdentifiers": {
"creationDateTime": "2022-05-04T03:02:01Z",
"messageIdentification": "uniqueMessageId"
},
"paymentScheme": {
"schema": "ZA_RPP"
},
"amounts": {
"bankSettlementAmount": {
"value": 1,
"currency": "ZAR"
}
},
"creditor": {
"legalName": "PersonLegalName",
"knownAsName": "PersonCommonName"
},
"creditorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"proxy": {
"namespace": "NeoBank",
"schema": "MOBILE",
"value": "+27-0214620000"
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"creditorAgent": {
"memberId": "ABSAZAJ"
},
"debtor": {
"legalName": "PersonLegalName",
"knownAsName": "PersonCommonName"
},
"debtorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"debtorAgent": {
"memberId": "FIRNMZM"
},
"transactionIdentifiers": {
"endToEndIdentification": "uniqueEndToEndId",
"transactionIdentification": "RRN000000001",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
},
"instructingAgent": {
"memberId": "FIRNMZM"
},
"instructedAgent": {
"memberId": "ABSAZAJ"
},
"remittanceInformation": {
"structured": [
{
"creditorReference": {
"type": {
"value": "RADM",
"schema": "CODE",
"issuer": "AnotherAmazeBank1234"
},
"reference": "Their statement reference"
},
"originatorReference": "My statement reference"
}
]
},
"supplementaryData": {
"customData1": "My custom data 1",
"customData2": "My custom data 2"
}
}'Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It is responded to by the outboundFiToFiCreditTransferResponse operation.
Instructs Electrum to execute an outbound FI-to-FI credit transfer transaction that will credit funds to a financial institution, using the indicated scheme.
To credit funds to a customer at a financial institution, see outboundCreditTransfer
| Scheme | Applicable |
|---|---|
| ZA_EFT | x |
| ZA_RPP | x |
| ZA_RTC | x |
| CBPR+ | ✓ |
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 traceparent 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 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.
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.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.
Further information related to the processing of the payment instruction that may need to be acted upon by the next agent, which is not the creditor agent.
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. |
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 an FI to FI credit transfer is associated with and describes scheme-specific information for it.
Information supplied to enable the matching of an entry with the items that the transfer is intended to settle, such as commercial invoices in an accounts' receivable system
https://example.com/path/payments/api/v1/transactions/outbound/fi-to-fi-credit-transfer
curl -i -X POST \
https://example.com/path/payments/api/v1/transactions/outbound/fi-to-fi-credit-transfer \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"schema": "FiToFiCreditTransfer",
"messageIdentifiers": {
"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2025-05-14T03:02:01Z"
},
"transactionIdentifiers": {
"instructionIdentification": "a1db-0181ab0897d2",
"endToEndIdentification": "6249118655591098",
"transactionIdentification": "RRN000000001",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
},
"paymentScheme": {
"schema": "CBPR_PLUS"
},
"settlementDate": "2025-05-14",
"paymentTypeInformation": {
"localInstrument": {
"schema": "CODE",
"value": "BTR"
}
},
"interbankSettlementAmount": {
"value": 12.34,
"currency": "ZAR"
},
"instructingAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"instructedAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"intermediaryAgents": [
{
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
}
],
"debtor": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"debtorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"debtorAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"debtorAgentAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"creditorAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"creditorAgentAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"creditor": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"creditorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"instructionForCreditorAgent": [
{
"code": "TELB",
"information": "Please email example@example.com"
}
],
"instructionForNextAgent": [
{
"code": "TELA",
"information": "Please email example@example.com"
}
],
"purpose": {
"schema": "CODE",
"value": "BKDF"
},
"remittanceInformation": {
"unstructured": [
"some",
"unstructured",
"information"
]
}
}'Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It is responded to by the outboundBulkCreditTransferResponse operation.
Instructs Electrum to execute multiple outbound credit transfer transactions that will credit funds to different beneficiaries at other financial institutions or the partner bank using the indicated scheme.
| Scheme | Applicable |
|---|---|
| ZA_EFT | x |
| ZA_RPP | ✓ |
| ZA_RTC | ✓ |
| CBPR+ | x |
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 traceparent 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 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. |
List of instructions to initiate each credit transfer within the bulk with other financial institutions or the partner bank
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
Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the creditor agent.
Designates which scheme a customer credit transfer is associated with and describes scheme-specific information for the credit transfer.
Information necessary for FI to FI customer credit transfers, specifically for CBPR+
DEBT (BorneByDebtor): All transaction charges are to be borne by the debtorCRED (BorneByCreditor): All transaction charges are to be borne by the creditorSHAR (Shared): In a credit transfer context, means that transaction charges on the sender side are to be borne by the debtor, transaction charges on the receiver side are to be borne by the creditor. In a direct debit context, means that transaction charges on the sender side are to be borne by the creditor, transaction charges on the receiver side are to be borne by the debtor.SLEV (FollowingServiceLevel): Charges are to be applied following the rules agreed in the service level and/or schemeFactor used to convert an amount from one currency into another. This reflects the price at which one currency was bought with another currency.
Specifies the underlying reason for the payment transaction
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.
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.
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
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 transactions
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.Date at which the initiating party requests the clearing agent to process the payment.
https://example.com/path/payments/api/v1/transactions/outbound/bulk/credit-transfer
curl -i -X POST \
https://example.com/path/payments/api/v1/transactions/outbound/bulk/credit-transfer \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"schema": "CreditTransferInitiation",
"paymentInformationId": "uniqueUUID",
"messageIdentifiers": {
"creationDateTime": "2024-05-04T03:02:01Z",
"messageIdentification": "uniqueMessageId"
},
"paymentSchemeName": "ZA_RPP",
"numberOfTransactions": 2,
"controlSum": {
"value": 100,
"currency": "ZAR"
},
"debtor": {
"legalName": "PersonLegalName",
"knownAsName": "PersonCommonName"
},
"debtorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"debtorAgent": {
"bicfi": "FIRNMZM"
},
"requestedExecutionDate": "2024-05-04",
"supplementaryData": {
"customData1": "My custom data 1",
"customData2": "My custom data 2"
},
"creditTransferInitiationInstructions": [
{
"transactionIdentifiers": {
"endToEndIdentification": "uniqueEndToEndId1",
"transactionIdentification": "RRN000000001",
"uetr": "uniqueUUID1"
},
"amounts": {
"bankSettlementAmount": {
"value": 50,
"currency": "ZAR"
}
},
"creditor": {
"legalName": "PersonLegalName",
"knownAsName": "PersonCommonName"
},
"creditorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"proxy": {
"namespace": "NeoBank",
"schema": "MOBILE",
"value": "+27-0214620000"
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"creditorAgent": {
"bicfi": "ABSAZAJ"
},
"purpose": {
"schema": "CODE",
"value": "BONU"
},
"remittanceInformation": {
"structured": [
{
"referredDocuments": [
{
"type": {
"value": "CINV",
"schema": "CODE",
"issuer": "AmazeBank123456"
},
"documentIdentifier": "A0123456789"
}
],
"referredDocumentAmount": {
"duePayableAmount": {
"value": 1,
"currency": "ZAR"
},
"remittedAmount": {
"value": 1,
"currency": "ZAR"
}
},
"creditorReference": {
"reference": "Their statement reference",
"type": {
"value": "RADM",
"schema": "CODE",
"issuer": "AnotherAmazeBank1234"
}
},
"originatorReference": "My statement reference"
}
]
}
},
{
"transactionIdentifiers": {
"endToEndIdentification": "uniqueEndToEndId2",
"transactionIdentification": "RRN000000002",
"uetr": "uniqueUUID2"
},
"amounts": {
"bankSettlementAmount": {
"value": 50,
"currency": "ZAR"
}
},
"creditor": {
"legalName": "PersonLegalName",
"knownAsName": "PersonCommonName"
},
"creditorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"proxy": {
"namespace": "NeoBank",
"schema": "MOBILE",
"value": "+27-0214620000"
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"creditorAgent": {
"bicfi": "ABSAZAJ"
},
"purpose": {
"schema": "CODE",
"value": "BONU"
},
"remittanceInformation": {
"structured": [
{
"referredDocuments": [
{
"type": {
"value": "CINV",
"schema": "CODE",
"issuer": "AmazeBank123456"
},
"documentIdentifier": "A0123456789"
}
],
"referredDocumentAmount": {
"duePayableAmount": {
"value": 1,
"currency": "ZAR"
},
"remittedAmount": {
"value": 1,
"currency": "ZAR"
}
},
"creditorReference": {
"type": {
"value": "RADM",
"schema": "CODE",
"issuer": "AnotherAmazeBank1234"
},
"reference": "ABC123XYZ999"
}
}
]
}
}
]
}'Accepted. RFC9110 - 202
No contentThis operation is invoked by the partner to request the cancellation of a prior payment instruction such as a direct-debit or credit-transfer.
This operation is asynchronous. For ZA_AC 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 the partner by invoking the outboundPaymentCancellationResolution operation which conveys the outcome of payment cancellation request.
| Scheme | Applicable |
|---|---|
| ZA_RPP | ✗ |
| ZA_EFT | ✓ |
| ZA_RTC | ✗ |
| CBPR+ | ✗ |
| ZA_AC | ✓ |
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 traceparent 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.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 details of the direct debit mandate signed between the creditor and the debtor.
NOTE: This model is a work in progress and may change. In particular, it lacks properties relating to mandate amendments which we may need in the future. Note also that this model is not relevant to the ZA_EFT scheme, and therefore Electrum will not do any special processing for these fields for EFT (e.g. Electrum cannot honour tracking days for EFT payments).
https://example.com/path/payments/api/v1/transactions/outbound/payment-cancellation
curl -i -X POST \
https://example.com/path/payments/api/v1/transactions/outbound/payment-cancellation \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"messageIdentifiers": {
"creationDateTime": "2019-08-24T14:15:22Z",
"messageIdentification": "string"
},
"supplementaryData": {
"property1": "string",
"property2": "string"
},
"assignment": {
"assignee": {
"party": {
"address": {
"addressLine": [
"string"
],
"addressType": "ADDR",
"buildingName": "string",
"buildingNumber": "string",
"country": "string",
"countrySubDivision": "string",
"department": "string",
"districtName": "string",
"floor": "string",
"postBox": "string",
"postCode": "string",
"room": "string",
"streetName": "string",
"subDepartment": "string",
"townLocationName": "string",
"townName": "string"
},
"contactDetails": {
"emailAddress": "user@example.com",
"mobileNumber": "string",
"phoneNumber": "string"
},
"countryOfResidence": "string",
"identification": {
"identifiers": [
{
"identification": "string",
"issuer": "string",
"scheme": {}
}
],
"schema": "string"
},
"knownAsName": "string",
"legalName": "string"
},
"schema": "PARTY"
},
"assigner": {
"party": {
"address": {
"addressLine": [
"string"
],
"addressType": "ADDR",
"buildingName": "string",
"buildingNumber": "string",
"country": "string",
"countrySubDivision": "string",
"department": "string",
"districtName": "string",
"floor": "string",
"postBox": "string",
"postCode": "string",
"room": "string",
"streetName": "string",
"subDepartment": "string",
"townLocationName": "string",
"townName": "string"
},
"contactDetails": {
"emailAddress": "user@example.com",
"mobileNumber": "string",
"phoneNumber": "string"
},
"countryOfResidence": "string",
"identification": {
"identifiers": [
{
"identification": "string",
"issuer": "string",
"scheme": {}
}
],
"schema": "string"
},
"knownAsName": "string",
"legalName": "string"
},
"schema": "PARTY"
},
"creationDateTime": "2019-08-24T14:15:22Z",
"identification": "string"
},
"case": {
"creator": {
"party": {
"address": {
"addressLine": [
"string"
],
"addressType": "ADDR",
"buildingName": "string",
"buildingNumber": "string",
"country": "string",
"countrySubDivision": "string",
"department": "string",
"districtName": "string",
"floor": "string",
"postBox": "string",
"postCode": "string",
"room": "string",
"streetName": "string",
"subDepartment": "string",
"townLocationName": "string",
"townName": "string"
},
"contactDetails": {
"emailAddress": "user@example.com",
"mobileNumber": "string",
"phoneNumber": "string"
},
"countryOfResidence": "string",
"identification": {
"identifiers": [
{
"identification": "string",
"issuer": "string",
"scheme": {}
}
],
"schema": "string"
},
"knownAsName": "string",
"legalName": "string"
},
"schema": "PARTY"
},
"identification": "string",
"reopenCaseIndication": true
},
"originalTransactionIdentifiers": {
"endToEndIdentification": "string",
"instructionIdentification": "string",
"transactionIdentification": "string",
"uetr": "string"
},
"paymentScheme": {
"schema": "ZA_RTC",
"schemeData": {
"cancellationType": "SYSTEM_ERROR_CORRECTION_REQUEST"
}
},
"schema": "FiToFiPaymentCancellationRequest",
"underlyingTransaction": {
"amounts": {
"bankSettlementAmount": {
"currency": "string",
"value": 0.1
},
"instructedAmount": {
"currency": "string",
"value": 0.1
}
},
"creditorAccount": {
"currency": "string",
"identification": {
"schema": "string",
"value": "string"
},
"name": "string",
"proxy": {
"namespace": "string",
"schema": "string"
},
"type": {
"schema": "string",
"value": "CACC"
}
},
"creditorAgent": {
"additionalIdentifications": [
{
"accountKnownAs": "string",
"identifier": {
"schema": "string",
"value": "string"
},
"registeredSchemes": [
"ZA_RTC"
]
}
],
"address": {
"addressLine": [
"string"
],
"addressType": "ADDR",
"buildingName": "string",
"buildingNumber": "string",
"country": "string",
"countrySubDivision": "string",
"department": "string",
"districtName": "string",
"floor": "string",
"postBox": "string",
"postCode": "string",
"room": "string",
"streetName": "string",
"subDepartment": "string",
"townLocationName": "string",
"townName": "string"
},
"bicfi": "string",
"branch": {
"address": {
"addressLine": [
"string"
],
"addressType": "ADDR",
"buildingName": "string",
"buildingNumber": "string",
"country": "string",
"countrySubDivision": "string",
"department": "string",
"districtName": "string",
"floor": "string",
"postBox": "string",
"postCode": "string",
"room": "string",
"streetName": "string",
"subDepartment": "string",
"townLocationName": "string",
"townName": "string"
},
"identification": "string",
"name": "string"
},
"clearingSystemMemberId": {
"clearingSystem": {
"schema": "string",
"value": "MA"
},
"memberId": "string"
},
"companyRegistration": "string",
"lei": "string",
"memberId": "string",
"name": "string"
},
"creditorAgentAccount": {
"currency": "string",
"identification": {
"schema": "string",
"value": "string"
},
"name": "string",
"proxy": {
"namespace": "string",
"schema": "string"
},
"type": {
"schema": "string",
"value": "CACC"
}
},
"debtorAccount": {
"currency": "string",
"identification": {
"schema": "string",
"value": "string"
},
"name": "string",
"proxy": {
"namespace": "string",
"schema": "string"
},
"type": {
"schema": "string",
"value": "CACC"
}
},
"debtorAgent": {
"additionalIdentifications": [
{
"accountKnownAs": "string",
"identifier": {
"schema": "string",
"value": "string"
},
"registeredSchemes": [
"ZA_RTC"
]
}
],
"address": {
"addressLine": [
"string"
],
"addressType": "ADDR",
"buildingName": "string",
"buildingNumber": "string",
"country": "string",
"countrySubDivision": "string",
"department": "string",
"districtName": "string",
"floor": "string",
"postBox": "string",
"postCode": "string",
"room": "string",
"streetName": "string",
"subDepartment": "string",
"townLocationName": "string",
"townName": "string"
},
"bicfi": "string",
"branch": {
"address": {
"addressLine": [
"string"
],
"addressType": "ADDR",
"buildingName": "string",
"buildingNumber": "string",
"country": "string",
"countrySubDivision": "string",
"department": "string",
"districtName": "string",
"floor": "string",
"postBox": "string",
"postCode": "string",
"room": "string",
"streetName": "string",
"subDepartment": "string",
"townLocationName": "string",
"townName": "string"
},
"identification": "string",
"name": "string"
},
"clearingSystemMemberId": {
"clearingSystem": {
"schema": "string",
"value": "MA"
},
"memberId": "string"
},
"companyRegistration": "string",
"lei": "string",
"memberId": "string",
"name": "string"
},
"debtorAgentAccount": {
"currency": "string",
"identification": {
"schema": "string",
"value": "string"
},
"name": "string",
"proxy": {
"namespace": "string",
"schema": "string"
},
"type": {
"schema": "string",
"value": "CACC"
}
},
"paymentMethod": "CreditTransfer",
"paymentTypeInformation": {
"categoryPurpose": {
"schema": "string",
"value": "BONU"
},
"localInstrument": {
"schema": "string",
"value": "0000"
},
"serviceLevel": [
{
"schema": "string",
"value": "BKTR"
}
]
},
"purpose": {
"schema": "string",
"value": "BKDF"
},
"remittanceInformation": {
"structured": [
{
"additionalRemittanceInformation": [
"string"
],
"creditorReference": {
"reference": "string",
"type": {
"issuer": "string",
"schema": "CODE"
}
},
"invoicer": {
"address": {
"addressLine": [
null
],
"addressType": "ADDR",
"buildingName": "string",
"buildingNumber": "string",
"country": "string",
"countrySubDivision": "string",
"department": "string",
"districtName": "string",
"floor": "string",
"postBox": "string",
"postCode": "string",
"room": "string",
"streetName": "string",
"subDepartment": "string",
"townLocationName": "string",
"townName": "string"
},
"contactDetails": {
"emailAddress": "user@example.com",
"mobileNumber": "string",
"phoneNumber": "string"
},
"countryOfResidence": "string",
"identification": {
"identifiers": [
null
],
"schema": "string"
},
"knownAsName": "string",
"legalName": "string"
},
"originatorReference": "string",
"referredDocumentAmount": {
"duePayableAmount": {
"currency": "string",
"value": 0.1
},
"remittedAmount": {
"currency": "string",
"value": 0.1
}
},
"referredDocuments": [
{
"documentIdentifier": "string",
"relatedDate": "2019-08-24",
"type": {}
}
],
"taxRemittance": {
"creditor": {
"registrationIdentification": "string",
"taxIdentification": "string",
"taxType": "string"
},
"date": "2019-08-24",
"debtor": {
"registrationIdentification": "string",
"taxIdentification": "string",
"taxType": "string",
"authorisation": {}
},
"referenceNumber": "string",
"sequenceNumber": 0,
"totalTaxAmount": {
"currency": "string",
"value": 0.1
},
"totalTaxableBaseAmount": {
"currency": "string",
"value": 0.1
},
"ultimateDebtor": {
"registrationIdentification": "string",
"taxIdentification": "string",
"taxType": "string",
"authorisation": {}
}
}
}
],
"unstructured": [
"string"
]
},
"settlementDate": "2019-08-24",
"supplementaryData": {
"property1": "string",
"property2": "string"
},
"creditor": {
"party": {
"address": {
"addressLine": [
"string"
],
"addressType": "ADDR",
"buildingName": "string",
"buildingNumber": "string",
"country": "string",
"countrySubDivision": "string",
"department": "string",
"districtName": "string",
"floor": "string",
"postBox": "string",
"postCode": "string",
"room": "string",
"streetName": "string",
"subDepartment": "string",
"townLocationName": "string",
"townName": "string"
},
"contactDetails": {
"emailAddress": "user@example.com",
"mobileNumber": "string",
"phoneNumber": "string"
},
"countryOfResidence": "string",
"identification": {
"identifiers": [
{
"identification": "string",
"issuer": "string",
"scheme": {}
}
],
"schema": "string"
},
"knownAsName": "string",
"legalName": "string"
},
"schema": "PARTY"
},
"debtor": {
"party": {
"address": {
"addressLine": [
"string"
],
"addressType": "ADDR",
"buildingName": "string",
"buildingNumber": "string",
"country": "string",
"countrySubDivision": "string",
"department": "string",
"districtName": "string",
"floor": "string",
"postBox": "string",
"postCode": "string",
"room": "string",
"streetName": "string",
"subDepartment": "string",
"townLocationName": "string",
"townName": "string"
},
"contactDetails": {
"emailAddress": "user@example.com",
"mobileNumber": "string",
"phoneNumber": "string"
},
"countryOfResidence": "string",
"identification": {
"identifiers": [
{
"identification": "string",
"issuer": "string",
"scheme": {}
}
],
"schema": "string"
},
"knownAsName": "string",
"legalName": "string"
},
"schema": "PARTY"
},
"mandateInformation": {
"dateOfSignature": "2019-08-24",
"electronicSignature": "string",
"finalCollectionDate": "2019-08-24",
"firstCollectionDate": "2019-08-24",
"frequency": {
"dayOfMonth": 1,
"schema": "MonthlyFrequency"
},
"mandateIdentification": "string",
"reason": {
"schema": "string",
"value": "stri"
},
"trackingDays": 1
},
"cancellationId": "string",
"cancellationReasonInfo": [
{
"additionalInformation": [
"string"
],
"originator": {
"address": {
"addressLine": [
"string"
],
"addressType": "ADDR",
"buildingName": "string",
"buildingNumber": "string",
"country": "string",
"countrySubDivision": "string",
"department": "string",
"districtName": "string",
"floor": "string",
"postBox": "string",
"postCode": "string",
"room": "string",
"streetName": "string",
"subDepartment": "string",
"townLocationName": "string",
"townName": "string"
},
"contactDetails": {
"emailAddress": "user@example.com",
"mobileNumber": "string",
"phoneNumber": "string"
},
"countryOfResidence": "string",
"identification": {
"identifiers": [
{}
],
"schema": "string"
},
"knownAsName": "string",
"legalName": "string"
},
"reason": {
"schema": "string",
"value": "AC02"
}
}
]
}
}'Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It starts with the inboundPaymentCancellation operation.
This operation begins with Electrum sending a request to cancel a prior payment instruction such as a direct-debit or credit-transfer. The partner will invoke this operation to deliver a ResolutionOfInvestigation which contains the resolution outcome of the payment cancellation request.
| Scheme | Applicable |
|---|---|
| ZA_RPP | ✗ |
| ZA_EFT | ✓ |
| ZA_RTC | ✗ |
| CBPR+ | ✗ |
| ZA_AC | ✓ |
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 traceparent 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.https://example.com/path/payments/api/v1/transactions/inbound/payment-cancellation-resolution
curl -i -X POST \
https://example.com/path/payments/api/v1/transactions/inbound/payment-cancellation-resolution \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"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": {
"schema": "PARTY",
"party": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Misty Town",
"townLocationName": "Misty Location",
"districtName": "Misty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "bob@grey.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": 90001236549870,
"issuer": "Dept of Home Affairs",
"scheme": {
"schema": "CODE",
"value": "NIDN"
}
}
]
}
}
},
"assignee": {
"schema": "INSTITUTION",
"institution": {
"bicfi": "RY8PEG50",
"name": "Electrum Bank Inc",
"clearingSystemMemberId": {
"clearingSystem": {
"schema": "CODE",
"value": "ZANCC"
},
"memberId": "999037"
}
}
}
},
"resolvedCase": {
"identification": "CASE001",
"creator": {
"schema": "INSTITUTION",
"institution": {
"bicfi": "RY8PEG50",
"name": "Electrum Bank Inc",
"clearingSystemMemberId": {
"clearingSystem": {
"schema": "CODE",
"value": "ZANCC"
},
"memberId": "999037"
}
}
},
"reopenCaseIndication": false
},
"status": {
"statusType": "CONFIRMATION",
"confirmationCode": "RJCR"
},
"cancellationDetails": {
"originalTransactionIdentifiers": {
"endToEndIdentification": "E2E20251206001",
"uetr": "97ed4827-7b6f-4491-a06f-b548d5a7512d",
"transactionIdentification": "TXN001"
},
"transactionCancellationStatus": "RJCR",
"cancellationStatusReasonInfo": {
"reason": {
"schema": "CODE",
"value": "AACR"
}
},
"originalTransaction": {
"creditorAgent": {
"bicfi": "RY8PEG0L",
"name": "Amazing Bank Inc",
"clearingSystemMemberId": {
"clearingSystem": {
"schema": "CODE",
"value": "ZANCC"
},
"memberId": "999000"
}
},
"amounts": {
"bankSettlementAmount": {
"value": 100,
"currency": "ZAR"
},
"instructedAmount": {
"value": 100,
"currency": "ZAR"
}
},
"debtorAgent": {
"bicfi": "RY8PEG50",
"name": "Electrum Bank Inc",
"clearingSystemMemberId": {
"clearingSystem": {
"schema": "CODE",
"value": "ZANCC"
},
"memberId": "999037"
}
},
"settlementDate": "2025-11-28",
"mandateInformation": {
"mandateIdentification": "42ovy14ac36d3lba80344jfa3355e2ef"
}
}
}
}'Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It is responded to by the outboundDirectDebitResponse operation.
Instructs Electrum to execute an outbound FI-to-FI-customer direct debit transaction that will debit funds from a debtor at another financial institution using the indicated scheme.
| Scheme | Applicable |
|---|---|
| ZA_EFT | ✓ |
| ZA_AC | ✓ |
| ZA_RMS | ✓ |
| ZA_RPP | ✗ |
| ZA_RTC | ✗ |
| CBPR+ | ✗ |
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 traceparent 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.
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 details of the direct debit mandate signed between the creditor and the debtor.
NOTE: This model is a work in progress and may change. In particular, it lacks properties relating to mandate amendments which we may need in the future. Note also that this model is not relevant to the ZA_EFT scheme, and therefore Electrum will not do any special processing for these fields for EFT (e.g. Electrum cannot honour tracking days for EFT payments).
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.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.
A reference for the Authenticated Collections (DebiCheck) transaction. This value is mapped to the RmtInf/Ustrd field in the pacs.003 message and will be printed on the debtor's statement. The first 30 characters are guaranteed to appear on statements. Allowed characters are limited to printable ASCII U+0020 to U+007A (space through 'z').
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/api/v1/transactions/outbound/direct-debit
curl -i -X POST \
https://example.com/path/payments/api/v1/transactions/outbound/direct-debit \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"paymentScheme": {
"schema": "ZA_EFT",
"schemeData": {
"userReference": "REF 1234",
"userCode": 1234
}
},
"instructingAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"instructedAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"paymentTypeInformation": {
"localInstrument": {
"schema": "CODE",
"value": "BTR"
}
},
"sequenceType": "FRST",
"amounts": {
"bankSettlementAmount": {
"value": 1,
"currency": "ZAR"
},
"instructedAmount": {
"value": 1,
"currency": "ZAR"
}
},
"purpose": {
"schema": "CODE",
"value": "BKDF"
},
"remittanceInformation": {
"unstructured": [
"some",
"unstructured",
"information"
],
"structured": [
{
"referredDocuments": [
{
"type": {
"value": "CINV",
"schema": "CODE",
"issuer": "AmazeBank123456"
},
"documentIdentifier": "A0123456789"
}
],
"referredDocumentAmount": {
"duePayableAmount": {
"value": 1,
"currency": "ZAR"
},
"remittedAmount": {
"value": 1,
"currency": "ZAR"
}
},
"creditorReference": {
"type": {
"value": "RADM",
"schema": "CODE",
"issuer": "AnotherAmazeBank1234"
},
"reference": "ABC123XYZ999"
},
"additionalRemittanceInformation": [
"Some",
"Additional",
"Information"
]
}
]
},
"creditor": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"creditorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
},
"currency": "ZAR"
},
"creditorAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"creditorAgentAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode456"
},
"issuer": "Amazing Bank",
"value": 541239876
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"debtor": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"debtorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
},
"currency": "ZAR"
},
"debtorAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
},
"debtorAgentAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": 609812345
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"intermediaryAgents": [
{
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
}
}
}
],
"initiatingParty": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"requestedCollectionDate": "2022-05-04",
"mandateInformation": {
"mandateIdentification": "A mandate ID",
"dateOfSignature": "2022-05-04",
"electronicSignature": "A digital signature",
"firstCollectionDate": "2022-05-04",
"finalCollectionDate": "2022-06-04",
"frequency": {
"schema": "MonthlyFrequency",
"dayOfMonth": 4
},
"reason": {
"schema": "CODE",
"value": "ABCD"
},
"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 starts with the inboundDirectDebit operation.
Invoked when a response to an FI-to-FI-customer direct debit is available. The response will indicate the success or failure of the inbound customer direct debit.
| Scheme | Applicable |
|---|---|
| ZA_EFT | ✓ |
| ZA_RPP | ✗ |
| ZA_RTC | ✗ |
| CBPR+ | ✗ |
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 traceparent 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 details of the direct debit mandate signed between the creditor and the debtor.
NOTE: This model is a work in progress and may change. In particular, it lacks properties relating to mandate amendments which we may need in the future. Note also that this model is not relevant to the ZA_EFT scheme, and therefore Electrum will not do any special processing for these fields for EFT (e.g. Electrum cannot honour tracking days for EFT payments).
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/api/v1/transactions/inbound/direct-debit-response
curl -i -X POST \
https://example.com/path/payments/api/v1/transactions/inbound/direct-debit-response \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"schema": "PaymentStatusReport",
"messageIdentifiers": {
"messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da",
"creationDateTime": "2022-05-04T03:22:11Z"
},
"originalMessageIdentifiers": {
"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"paymentScheme": {
"schema": "ZA_EFT",
"originalSchemeData": {
"userReference": "Ab1 xxxxxxxxxxxxxxxx",
"userCode": 1234
}
},
"transactionIdentifiers": {
"endToEndIdentification": "6249118655591098",
"transactionIdentification": "RRN000000001",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
},
"status": {
"outcome": "APPROVED",
"reasonInfo": [
{
"reason": {
"schema": "CODE",
"value": "ACSC"
},
"additionalInformation": "Settlement completed on debtor account"
}
]
},
"instructingAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": 210514,
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
}
}
},
"instructedAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": 210514,
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
}
}
},
"originalTransactionData": {
"paymentMethod": "CreditTransfer",
"creditor": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"creditorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"creditorAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": 210514,
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
}
}
},
"creditorAgentAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode456"
},
"issuer": "Amazing Bank",
"value": 541239876
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"amounts": {
"bankSettlementAmount": {
"value": 1,
"currency": "ZAR"
},
"instructedAmount": {
"value": 1,
"currency": "ZAR"
}
},
"remittanceInformation": {
"unstructured": [
"some",
"unstructured",
"information"
],
"structured": [
{
"referredDocuments": [
{
"type": {
"issuer": "AmazeBank123456",
"schema": "CODE",
"value": "CINV"
},
"documentIdentifier": "A0123456789"
}
],
"referredDocumentAmount": {
"duePayableAmount": {
"value": 1,
"currency": "ZAR"
},
"remittedAmount": {
"value": 1,
"currency": "ZAR"
}
},
"creditorReference": {
"type": {
"issuer": "AnotherAmazeBank1234",
"schema": "CODE",
"value": "RADM"
},
"reference": "ABC123XYZ999"
},
"additionalRemittanceInformation": [
"Some",
"Additional",
"Information"
]
}
]
},
"debtor": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"debtorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"debtorAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": 210514,
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
}
}
},
"debtorAgentAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": 609812345
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"initiatingParty": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"purpose": {
"schema": "CODE",
"value": "ACCT"
},
"supplementaryData": {
"customData1": "My custom data 1",
"customData2": "My custom data 2"
},
"paymentTypeInformation": {
"localInstrument": {
"schema": "CODE",
"value": "BTR"
}
}
}
}'Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It starts with the inboundPaymentReturn operation.
This operation is called by partners to provide a response to an inbound payment return for an earlier outbound FI-to-FI-customer credit transfer or FI-to-FI-customer direct debit. Note that some payment schemes may not support rejecting the return. In these cases, a rejected response will cause Electrum to mark the transaction as broken.
| Scheme | Applicable |
|---|---|
| ZA_EFT | ✓ |
| ZA_RPP | ✗ |
| ZA_RTC | ✗ |
| CBPR+ | ✗ |
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 traceparent 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 details of the direct debit mandate signed between the creditor and the debtor.
NOTE: This model is a work in progress and may change. In particular, it lacks properties relating to mandate amendments which we may need in the future. Note also that this model is not relevant to the ZA_EFT scheme, and therefore Electrum will not do any special processing for these fields for EFT (e.g. Electrum cannot honour tracking days for EFT payments).
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/api/v1/transactions/inbound/payment-return-response
curl -i -X POST \
https://example.com/path/payments/api/v1/transactions/inbound/payment-return-response \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"schema": "PaymentStatusReport",
"messageIdentifiers": {
"messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da",
"creationDateTime": "2022-05-04T03:22:11Z"
},
"originalMessageIdentifiers": {
"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"paymentScheme": {
"schema": "ZA_EFT",
"originalSchemeData": {
"userReference": "Ab1 xxxxxxxxxxxxxxxx",
"userCode": 1234
}
},
"transactionIdentifiers": {
"endToEndIdentification": "6249118655591098",
"transactionIdentification": "RRN000000001",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
},
"status": {
"outcome": "APPROVED",
"reasonInfo": [
{
"reason": {
"schema": "CODE",
"value": "ACSC"
},
"additionalInformation": "Settlement completed on debtor account"
}
]
},
"instructingAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": 210514,
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
}
}
},
"instructedAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": 210514,
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
}
}
},
"originalTransactionData": {
"paymentMethod": "CreditTransfer",
"creditor": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"creditorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"creditorAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": 210514,
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
}
}
},
"creditorAgentAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode456"
},
"issuer": "Amazing Bank",
"value": 541239876
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"amounts": {
"bankSettlementAmount": {
"value": 1,
"currency": "ZAR"
},
"instructedAmount": {
"value": 1,
"currency": "ZAR"
}
},
"remittanceInformation": {
"unstructured": [
"some",
"unstructured",
"information"
],
"structured": [
{
"referredDocuments": [
{
"type": {
"issuer": "AmazeBank123456",
"schema": "CODE",
"value": "CINV"
},
"documentIdentifier": "A0123456789"
}
],
"referredDocumentAmount": {
"duePayableAmount": {
"value": 1,
"currency": "ZAR"
},
"remittedAmount": {
"value": 1,
"currency": "ZAR"
}
},
"creditorReference": {
"type": {
"issuer": "AnotherAmazeBank1234",
"schema": "CODE",
"value": "RADM"
},
"reference": "ABC123XYZ999"
},
"additionalRemittanceInformation": [
"Some",
"Additional",
"Information"
]
}
]
},
"debtor": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"debtorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"debtorAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": 210514,
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
}
}
},
"debtorAgentAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": 609812345
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"initiatingParty": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"purpose": {
"schema": "CODE",
"value": "ACCT"
},
"supplementaryData": {
"customData1": "My custom data 1",
"customData2": "My custom data 2"
},
"paymentTypeInformation": {
"localInstrument": {
"schema": "CODE",
"value": "BTR"
}
}
}
}'Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It is responded to by the outboundPaymentReturnResponse operation.
Instructs Electrum to execute a return transaction that will return funds to the debtor of an earlier inbound FI-to-FI-customer direct debit or deduct funds from the creditor of an earlier inbound FI-to-FI-customer credit transfer.
| Scheme | Applicable |
|---|---|
| ZA_EFT | ✓ |
| ZA_RPP | ✗ |
| ZA_RTC | ✗ |
| CBPR+ | ✗ |
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 traceparent 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 details of the direct debit mandate signed between the creditor and the debtor.
NOTE: This model is a work in progress and may change. In particular, it lacks properties relating to mandate amendments which we may need in the future. Note also that this model is not relevant to the ZA_EFT scheme, and therefore Electrum will not do any special processing for these fields for EFT (e.g. Electrum cannot honour tracking days for EFT payments).
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.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.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.
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.
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/api/v1/transactions/outbound/payment-return
curl -i -X POST \
https://example.com/path/payments/api/v1/transactions/outbound/payment-return \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"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": {
"returnType": "UNPAID",
"userCode": 1234
}
},
"paymentTypeInformation": {
"localInstrument": {
"schema": "CODE",
"value": "BTR"
}
},
"transactionIdentifiers": {
"endToEndIdentification": "6249118655591098",
"transactionIdentification": "RRN000000001",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
},
"reasonInfo": [
{
"reason": {
"schema": "CODE",
"value": "AC01"
},
"additionalInformation": "string"
}
],
"returnedAmounts": {
"bankSettlementAmount": {
"value": 1,
"currency": "ZAR"
},
"instructedAmount": {
"value": 1,
"currency": "ZAR"
}
},
"settlementDate": "2022-05-04",
"instructingAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": 210514,
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
}
}
},
"instructedAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": 210514,
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
}
}
},
"initiatingParty": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"creditor": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"creditorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"creditorAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": 210514,
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
}
}
},
"creditorAgentAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode456"
},
"issuer": "Amazing Bank",
"value": 541239876
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"debtor": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"debtorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"debtorAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": 210514,
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
}
}
},
"debtorAgentAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": 609812345
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"originalTransactionData": {
"settlementDate": "2022-05-04",
"creditor": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"creditorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"creditorAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": 210514,
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
}
}
},
"creditorAgentAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode456"
},
"issuer": "Amazing Bank",
"value": 541239876
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"amounts": {
"bankSettlementAmount": {
"value": 1,
"currency": "ZAR"
},
"instructedAmount": {
"value": 1,
"currency": "ZAR"
}
},
"remittanceInformation": {
"unstructured": [
"some",
"unstructured",
"information"
],
"structured": [
{
"referredDocuments": [
{
"type": {
"issuer": "AmazeBank123456",
"schema": "CODE",
"value": "CINV"
},
"documentIdentifier": "A0123456789"
}
],
"referredDocumentAmount": {
"duePayableAmount": {
"value": 1,
"currency": "ZAR"
},
"remittedAmount": {
"value": 1,
"currency": "ZAR"
}
},
"creditorReference": {
"type": {
"issuer": "AnotherAmazeBank1234",
"schema": "CODE",
"value": "RADM"
},
"reference": "ABC123XYZ999"
},
"additionalRemittanceInformation": [
"Some",
"Additional",
"Information"
]
}
]
},
"debtor": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"debtorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": "abcdef987654"
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"debtorAgent": {
"bicfi": "RY8PEG0L",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": 210514,
"name": "ABC Plettenberg Bay",
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": 42,
"buildingName": "Mysterious Building",
"floor": 42,
"postBox": 1024,
"postCode": 4242,
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
8001
]
}
}
},
"debtorAgentAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": 609812345
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"initiatingParty": {
"address": {
"addressType": "ADDR",
"department": "Department of Mysteries",
"streetName": "Street of Mysteries",
"buildingNumber": "42",
"buildingName": "Mysterious Building",
"floor": "42",
"postBox": "1024",
"postCode": "4242",
"townName": "Mysty Town",
"townLocationName": "Mysty Location",
"districtName": "Mysty District",
"countrySubDivision": "Mysterious Cape",
"country": "ZA",
"addressLine": [
"16A",
"New market street",
"Foreshore",
"Cape Town",
"ZA",
"8001"
]
},
"contactDetails": {
"phoneNumber": "+27-0214620000",
"mobileNumber": "+27-08230000000",
"emailAddress": "developer.dave@electrum.com"
},
"countryOfResidence": "ZA",
"identification": {
"schema": "PERSON",
"identifiers": [
{
"identification": "90001236549870",
"scheme": {
"schema": "CODE",
"value": "NIDN"
},
"issuer": "Dept of Home Affairs"
}
]
}
},
"purpose": {
"schema": "CODE",
"value": "BKDF"
}
}
}'Accepted. RFC9110 - 202
No content