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 synchronous.
The scheme inquiry operation can be called to perform an inquiry on some information relevant to the given scheme, typically for the purposes of retrieving administrative or operational information. For example, this operation would be used to retrieve a list of valid domains for the ZA_RPP scheme.
In this context, a partner sends Electrum an inquiry destined for a particular industry and 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.
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).
curl -i -X POST \
https://docs.electrumsoftware.com/_mock/openapi/epc/bpp-elpapi/schemes/inquiry \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"schema": "SchemeInquiryRequest",
"messageIdentifiers": {
"messageIdentification": "8fd51c7124ba4819b9253e296a68e1da",
"creationDateTime": "2022-05-04T03:02:01Z"
},
"inquiry": {
"schema": "ZA_RPP_LIST_DOMAINS",
"agent": {
"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
]
}
}
}
}
}'OK. RFC9110 - 200
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
{ "schema": "SchemeInquiryResponse", "messageIdentifiers": { "messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da", "creationDateTime": "2022-05-04T03:22:11Z" }, "originalMessageIdentifiers": { "messageIdentification": "8fd51c7124ba4819b9253e296a68e1da", "creationDateTime": "2022-05-04T03:02:01Z" }, "report": { "schema": "ZA_RPP_LIST_DOMAINS", "agent": { … }, "domains": [ … ] } }