URL
Electrum Support
The Electrum Regulated Payments API is an asynchronous API that allows partners to participate in various nationally regulated payment schemes.
As the Regulated Payments API is asynchronous, partners have a choice of how to integrate with Electrum:
Receiving transactional events via webhooks or API are equivalent, except that it may be more familiar or convenient to implement one style or the other.
This document describes the operations a partner must implement for Electrum to consume in order to complete the integration with the Electrum Regulated Payments API.
https://example.com/path/payments/partner-api/v1/
A value used to trace an HTTP message within an Electrum Regulated Payments implementation. This field must be set as per the traceparent element defined in the W3C Trace Context Level 2 specification.
A value used to provide context to an HTTP message as it is traced within an Electrum Regulated Payments implementation. This field must be set as per the tracestate element defined in the W3C Trace Context Level 2 specification.
An identifier's namespace provides a context for the identifier to distinguish different identifiers which may have the same value but be intended to identify different accounts. For example, a bank may use the same MSISDN (identifier) with different namespaces to distinguish between a customer's cheque or savings accounts.
This may be used by the following schemes:
https://example.com/path/payments/partner-api/v1/accounts/get
curl -i -X POST \
https://example.com/path/payments/partner-api/v1/accounts/get \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"namespace": "string",
"schema": "CUSTOM",
"value": "string"
}'OK. RFC9110 - 200
An account within the Electrum Account mirror. Note that the primaryIdentification is permanent and immutable.
A valid, active currency code as defined in ISO 4217 indicating the currency of the amount.
Holds details pertaining to an identifier of an account or store of value.
An identifier's namespace provides a context for the identifier to distinguish different identifiers which may have the same value but be intended to identify different accounts. For example, a bank may use the same MSISDN (identifier) with different namespaces to distinguish between a customer's cheque or savings accounts.
This may be used by the following schemes:
Indicates the schema of the identifier, e.g. MOBILE, CUSTOM.
A set of codes that describe the status of an account
Contains information detailing the owner of an account, which can be either a person or organisation.
A unique identifier used to identify this Account Owner record. This is distinct from the identification of the Account Owner, which may or may not be unique within this system, but which is typically used for identification outside of the system, such as passport numbers or national identification numbers. This identifier is used exclusively to identify the owner within this system.
Defines the type of owner.
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).
{ "account": { "type": { … }, "accountName": "MyCashAccount", "currency": "ZAR", "openingDate": "2022-05-03T15:02:01Z", "status": "ENABLED", "restrictions": [ … ], "primaryIdentification": { … }, "additionalIdentifications": [ … ] }, "primaryAccountOwnerDetails": { "schema": "INDIVIDUAL", "recordIdentifier": 123456789, "name": { … }, "identifiers": [ … ], "address": { … }, "contactDetails": { … }, "countryOfResidence": "ZA" }, "otherAccountOwnerDetails": [ { … } ] }