The Electrum EPC API for calling Electrum is an asynchronous API that allows Corporate Clients 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.
This operation is asynchronous. It is responded to by the outboundCreditTransferResponse operation
A query for information about a previously submitted outbound credit transfer. This operation may be called at any time by the partner in order to query the state of the outbound transfer. If acknowledged by the server, the current status of the transaction will be communicated to the partner via the outboundCreditTransferResponse operation of the Partner API.
| Scheme | Applicable |
|---|---|
| ZA_EFT | ✓ |
| ZA_RPP | ✓ |
| ZA_RTC | ✓ |
A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the 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
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 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.
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/epc/bpp-elpapi/transactions/outbound/credit-transfer/status-request \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"schema": "CreditTransferStatusRequest",
"messageIdentifiers": {
"creationDateTime": "2022-05-04T03:01:01Z",
"messageIdentification": "messageId"
},
"originalMessageIdentifiers": {
"creationDateTime": "2022-05-04T03:02:01Z",
"messageIdentification": "uniqueMessageId"
},
"originalTransactionIdentifiers": {
"endToEndIdentification": "uniqueEndToEndId",
"transactionIdentification": "RRN000000001",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
}
}'Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It is responded to by the outboundCreditTransferResponse operation
Instructs Electrum to execute an outbound credit transfer transaction that will credit funds to a beneficiary at another financial institution using the indicated scheme.
| Scheme | Applicable |
|---|---|
| ZA_EFT | ✓ |
| ZA_RPP | ✓ |
| ZA_RTC | ✓ |
A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the 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 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)
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
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)
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
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 credit transfer is associated with and describes scheme-specific information for the credit transfer.
Identifies the scheme used for the payment
ZA_RTC: South African Realtime Clearing schemeZA_RPP: South African Realtime Payments Platform scheme.ZA_EFT: South African Electronic Funds Transfer scheme.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.
An explanation of an EFT transaction, which will be printed on the debtor's statement for direct debits or the creditor's statement for credit transfers. Note that when populating a value for a direct debit, the first 10 characters must contain the Banks user code as configured at Bankserv. If configured, Electrum will populate this value automatically, in which case at most 20 characters should be used as a reference to avoid truncation.
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.
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/epc/bpp-elpapi/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 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 | ✓ |
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)
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
Identification of a member of a clearing system.
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 credit transfer is associated with and describes scheme-specific information for the credit transfer.
Identifies the scheme used for the payment
ZA_RTC: South African Realtime Clearing schemeZA_RPP: South African Realtime Payments Platform scheme.ZA_EFT: South African Electronic Funds Transfer scheme.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.
An explanation of an EFT transaction, which will be printed on the debtor's statement for direct debits or the creditor's statement for credit transfers. Note that when populating a value for a direct debit, the first 10 characters must contain the Banks user code as configured at Bankserv. If configured, Electrum will populate this value automatically, in which case at most 20 characters should be used as a reference to avoid truncation.
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 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)
A unique identifier assigned to a company or organisation by a duly appointed authority within a country.
An organisation identified by a code allocated to a party as described in ISO 17442 Financial Services - Legal Entity Identifier (LEI).
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 schemeZA_RPP: South African Realtime Payments Platform scheme.ZA_EFT: South African Electronic Funds Transfer scheme.Date at which the initiating party requests the clearing agent to process the payment.
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/epc/bpp-elpapi/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"
},
"bulkPaymentSchemeName": "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": "ABCD"
},
"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": "ABCD"
},
"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 asynchronous. It is responded to by the [outboundBulkCreditTransferResponse operation] (https://bpp-developer-portal.redoc.ly/openapi/elpapi-bpp-partner/operation/outboundBulkCreditTransferResponse//)
A query for information about a previously submitted outbound bulk credit transfer initiation. This operation may be called at any time by the partner in order to query the state of the outbound request. If acknowledged by the server, the current status of the 'bulk' will be communicated to the partner via the outboundBulkCreditTransferResponse operation of the Partner API.
| Scheme | Applicable |
|---|---|
| ZA_EFT | ✗ |
| ZA_RPP | ✓ |
| ZA_RTC | ✓ |
A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A flag to indicate if the status of each individual credit transfer, as per Electrum's view, should be reflected in the response
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 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
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.
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/epc/bpp-elpapi/transactions/outbound/bulk/credit-transfer/status-request \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"schema": "CreditTransferInitiationStatusRequest",
"messageIdentifiers": {
"creationDateTime": "2024-05-04T03:03:01Z",
"messageIdentification": "messageId"
},
"originalMessageIdentifiers": {
"creationDateTime": "2024-05-04T03:02:01Z",
"messageIdentification": "uniqueMessageId"
},
"paymentInformationId": "uniqueUUID",
"includeIndividualCreditsStatuses": false
}'Accepted. RFC9110 - 202
No content