Basic Message Content
Many of the operations described in this documentation have message bodies. Where operations do have request or response bodies, the content shall be formatted as JSON objects. The following basic message types build on top of each other to form the basis for all operations:
| Schema | Usage |
|---|---|
| BaseMessage | The basis for all messages. Contains the messageIdentifiers field used to uniquely identify each message. |
| BaseResponseMessage | The basis for all response messages. Contains the originalMessageIdentifiers field used to match a response to its request message. |
| BaseTransactionResponseMessage | Combines BaseResponseMessage and BaseTransactionMessage to form the basis for transaction response messages. |
BaseMessage
The following schema applies to all messages:
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.
A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.
MessageIdentifiers
Each individual message should have its own messageIdentifiers values, uniquely identifying the message. If a message is resent with the exact same content, perhaps while performing technical retries, the messageIdentifiers content should also remain unchanged.
While the value of the messageIdentification field is not prescribed there is a strong requirement for this value to be globally unique to the bank's and your own systems. We recommend that you use a randomly generated (version 4) UUID with its '-' characters stripped to ensure a sufficiently unique value.
SupplementaryData
This object is a map of keys and string values without any prescribed structure. It may be used to transport any data elements that may be needed where a suitable place cannot otherwise be found in the specification.
BaseResponseMessage
The following schema applies to all response messages:
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.
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
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.
OriginalMessageIdentifiers
Contains the same value as the messageIdentifiers field of the matching request message.
BaseTransactionResponseMessage
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.
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
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.
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.
Universally unique identifier to provide an end-to-end reference of a payment transaction. This identifier remains the same for all messages related to the same transaction.
OriginalMessageIdentifiers
As for BaseResponseMessage above.