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.
https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-redoc/
https://example.com/path/payments/api/v1/
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
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.
https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-redoc/transactions/outbound/credit-transfer/status-request
https://example.com/path/payments/api/v1/transactions/outbound/credit-transfer/status-request
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-redoc/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 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.
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.
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://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-redoc/transactions/outbound/credit-transfer
https://example.com/path/payments/api/v1/transactions/outbound/credit-transfer
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-redoc/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)
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.CBPR_PLUS: Cross-Border Payments and Reporting Plus.Date at which the initiating party requests the clearing agent to process the payment.
https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-redoc/transactions/outbound/bulk/credit-transfer
https://example.com/path/payments/api/v1/transactions/outbound/bulk/credit-transfer
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-redoc/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 asynchronous. It is responded to by the [outboundBulkCreditTransferResponse operation] (https://docs.electrumsoftware.com/openapi/epc-cicd/epc-elpapi-partner-redoc/credit-transfer/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.
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 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
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.
https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-redoc/transactions/outbound/bulk/credit-transfer/status-request
https://example.com/path/payments/api/v1/transactions/outbound/bulk/credit-transfer/status-request
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-redoc/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 contentThis operation is asynchronous. It is responded to by the outboundBulkRequestToPayResponse operation
Instructs Electrum to request multiple Industry Participants to credit multiple accounts at the partner. If the debtor associated with an RTP (i.e. the Industry Participant's customer) agrees, an inboundCreditTransfer operation will be performed to credit the account associated with that RTP. If the Industry Participant or Industry Operator rejects the request, this will be communicated via an outboundRequestToPayResponse operation. These responses will be sent via an async call with the operation outboundBulkRequestToPayResponse
The bulk status can be checked with the async request with operation getOutboundBulkRequestToPayStatus
| Scheme | Applicable |
|---|---|
| ZA_RPP | ✓ |
| ZA_EFT | ✗ |
| 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.
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.CBPR_PLUS: Cross-Border Payments and Reporting Plus.This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
Universally unique identifier to identify the bulk collection itself.
List of instructions to initiate each request to pay within the bulk with other financial institutions or the partner bank.
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
This model is the basic representation of a Party. It is expanded on depending on whether the party is a person or an organisation.
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.
Date and time at which the request to pay expires. Some schemes may still permit a payment after the request to pay expires. Upon expiry, the following schemes will reject an associated payment: ZA_RPP. The date must be formatted as defined by date-time in RFC3339
Further information related to the processing of the payment instruction, provided by the initiating party, and intended for the debtor agent.
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 reference used to unambiguously identify the message between the sending and receiving party. Take note that this uniquely identifies a single message in a potentially multi-message exchange to complete a payment.
Specifies the underlying reason for the payment transaction
Describes the various aspects of a request to pay which must be accepted or to what extent they may be altered.
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. |
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. |
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.
https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-redoc/transactions/outbound/bulk/request-to-pay
https://example.com/path/payments/api/v1/transactions/outbound/bulk/request-to-pay
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-redoc/transactions/outbound/bulk/request-to-pay \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"schema": "RequestToPayInitiation",
"messageIdentifiers": {
"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"requestToPayInformationId": "5e3b27c8-3ac8-49d9-8f17-c2bdef7ca180",
"bulkPaymentSchemeName": "ZA_RPP",
"requestToPayInitiationInstructions": [
{
"messageIdentifiers": {
"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"transactionIdentifiers": {
"endToEndIdentification": "uniqueEndToEndId1",
"transactionIdentification": "RRN000000001",
"uetr": "e96b1217-b6c9-4e25-9877-fcc7aa845661"
},
"expiryDateTime": "2024-04-09T09:32:51.395+02:00",
"requestToPayConditions": {
"minAmount": {
"value": 100,
"currency": "ZAR"
},
"maxAmount": {
"value": 100,
"currency": "ZAR"
}
},
"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"
]
}
}
},
"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": {
"proxy": {
"schema": "MOBILE",
"value": "+27-721234567",
"namespace": "amazebank"
},
"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"
]
}
}
},
"paymentTypeInformation": {
"localInstrument": {
"schema": "PROPRIETARY",
"value": "PBPX"
}
},
"remittanceInformation": {
"unstructured": [
"some",
"unstructured",
"information"
],
"structured": [
{
"creditorReference": {
"reference": "ABC123XYZ999"
},
"additionalRemittanceInformation": [
"Some",
"Additional",
"Information"
]
}
]
}
}
],
"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"
}
]
}
},
"numberOfTransactions": 1
}'Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It is responded to by the outboundBulkRequestToPayResponse operation
A query for information about a previously submitted outbound bulk request to pay 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 outboundBulkRequestToPayResponse operation of the Partner API.
| Scheme | Applicable |
|---|---|
| ZA_RPP | ✓ |
| ZA_EFT | ✗ |
| 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 request to pay, 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 identify the bulk collection itself.
https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-redoc/transactions/outbound/bulk/request-to-pay/status-request
https://example.com/path/payments/api/v1/transactions/outbound/bulk/request-to-pay/status-request
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/epc-cicd/epc-elpapi-redoc/transactions/outbound/bulk/request-to-pay/status-request \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"schema": "RequestToPayInitiationStatusRequest",
"messageIdentifiers": {
"creationDateTime": "2024-05-04T03:01:01Z",
"messageIdentification": "messageId"
},
"originalMessageIdentifiers": {
"creationDateTime": "2024-05-04T03:02:01Z",
"messageIdentification": "uniqueMessageId"
},
"requestToPayInformationId": "6e831b77-3e51-4a0e-a818-dc99a08f80d4",
"includeIndividualRequestToPayStatuses": false
}'Accepted. RFC9110 - 202
No content