URL
Electrum Support
The Electrum Regulated Payments API is an asynchronous API that allows partners to participate in various nationally regulated payment schemes.
As the Regulated Payments API is asynchronous, partners have a choice of how to integrate with Electrum:
Receiving transactional events via webhooks or API are equivalent, except that it may be more familiar or convenient to implement one style or the other.
This document describes the operations a partner must implement for Electrum to consume in order to complete the integration with the Electrum Regulated Payments API.
https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/
https://example.com/path/payments/partner-api/v1/
This operation is asynchronous. It is responded to by the createReservationResponse operation
The create reservation operation is invoked by Electrum to request that funds be reserved against an account before a payment instruction is processed further.
Funds reservations are scheme agnostic and may be used in conjunction with any scheme.
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.
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 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. |
Free text field used to inform the core banking system of which system is initiating the reservation.
An explanation of the transaction, e.g. to be printed on the account holder's statement.
https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/funds-management/reservation
https://example.com/path/payments/partner-api/v1/funds-management/reservation
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/funds-management/reservation \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"schema": "ReservationRequest",
"messageIdentifiers": {
"messageIdentification": "original-msg-12345",
"creationDateTime": "2025-01-23T06:29:01Z"
},
"transactionIdentifiers": {
"endToEndIdentification": "e2e-12345",
"transactionIdentification": "txn-12345",
"uetr": "550e8400-e29b-41d4-a716-446655440000"
},
"accountIdentification": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": 987654123
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"reference": "Reservation Ref",
"amount": {
"value": 65.23,
"currency": "ZAR"
},
"reservationType": {
"schema": "CODE",
"value": "BLKD"
},
"initiationSource": "EPC Singles",
"supplementaryData": {
"key1": "value1",
"key2": "value2"
}
}'Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It is responded to by the voidReservationResponse operation A previous reservation should exist for this to be successful createReservation operation
The void reservation operation is invoked by Electrum to request that a previous funds reservation against an account be released, making the funds available once more.
Funds reservations are scheme agnostic and may be used in conjunction with any scheme.
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.
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 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. |
Free text field used to inform the core banking system of which system is initiating the void.
UUID which links the void to a payment instruction, and its initial reservation.
https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/funds-management/reservation/void
https://example.com/path/payments/partner-api/v1/funds-management/reservation/void
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/funds-management/reservation/void \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"schema": "VoidReservationRequest",
"messageIdentifiers": {
"messageIdentification": "msg-54321",
"creationDateTime": "2025-02-01T11:00:00Z"
},
"transactionIdentifiers": {
"endToEndIdentification": "e2e-54321",
"transactionIdentification": "txn-54321",
"uetr": "123e4567-e89b-12d3-a456-426614174001"
},
"paymentUetr": "123e4567-e89b-12d3-a456-426614174000",
"accountIdentification": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode789"
},
"issuer": "Amazing Bank",
"value": 987654123
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"amount": {
"value": 50,
"currency": "ZAR"
},
"initiationSource": "EPC Singles",
"supplementaryData": {
"key1": "value1",
"key2": "value2"
}
}'Accepted. RFC9110 - 202
No contentThis operation is asynchronous. It is responded to by the createPostingResponse operation
The create posting operation is invoked by Electrum in order for a posting be made against the relevant account to reflect the movement of funds in relation to a payment that has been processed.
Postings are scheme agnostic and may be used in conjunction with any scheme.
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 count of how many payments are aggregated into this posting
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. |
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
An explanation of the transaction, e.g. to be printed on the creditor account holder's statement.
Representation of an account for payment purposes. Note that at least one of identification or proxy is expected to be present.
An explanation of the transaction, e.g. to be printed on the debtor account holder's statement.
Indicates the direction of the original payment, from the perspective of Electrum and the Partner.
Free text field used to inform the core banking system of which system is initiating the posting.
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.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.https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/funds-management/posting
https://example.com/path/payments/partner-api/v1/funds-management/posting
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/elpapi/elpapi-partner/funds-management/posting \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"schema": "PostingRequest",
"messageIdentifiers": {
"messageIdentification": "msg-67890",
"creationDateTime": "2025-02-01T10:00:00Z"
},
"transactionIdentifiers": {
"endToEndIdentification": "e2e-67890",
"transactionIdentification": "txn-67890",
"uetr": "123e4567-e89b-12d3-a456-426614174000"
},
"paymentUetr": "123e4567-e89b-12d3-a456-426614174000",
"effectiveDateTime": "2025-02-01T10:00:00Z",
"creditorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode456"
},
"issuer": "Amazing Bank",
"value": 987654123
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"creditorAccountReference": "Creditor Ref",
"creditorAgent": {
"bicfi": "RY8PEGJ0",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Plettenberg Bay"
}
},
"debtorAccount": {
"identification": {
"schema": "GENERIC",
"scheme": {
"schema": "PROPRIETARY",
"value": "AProprietaryCode123"
},
"issuer": "Amazing Bank",
"value": 123456098
},
"type": {
"schema": "CODE",
"value": "CACC"
}
},
"debtorAccountReference": "Debtor Ref",
"debtorAgent": {
"bicfi": "BB8PEGJ0",
"memberId": "AmazingBankId",
"name": "Amazing Bank Inc",
"branch": {
"identification": "210514",
"name": "ABC Cape Town"
}
},
"amount": {
"value": 100,
"currency": "ZAR"
},
"aggregatedTransactionCount": 1,
"initiationSource": "EPC Singles",
"paymentScheme": "ZA_EFT",
"localInstrument": {
"schema": "CODE",
"value": "CTR"
},
"paymentMethod": "CreditTransfer",
"direction": "OUTBOUND",
"supplementaryData": {
"key1": "value1",
"key2": "value2"
}
}'Accepted. RFC9110 - 202
No content