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/
This operation is asynchronous, and is responded to by the sanctionsAssessmentResponse operation.
This operation is invoked by Electrum during transaction processing so that the transaction can be assessed for sanctions before being processed further. The result of the sanctions assessment is delivered back to Electrum by invoking the sanctionsAssessmentResponse operation, whose outcome determines how the transaction is handled thereafter by Electrum.
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.
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.
The payment message that must undergo sanctions screening.
The point after which the result of the SanctionsAssessmentRequest is no longer valid. The date must be formatted as defined by date-time in RFC3339
https://example.com/path/payments/partner-api/v1/risk-assessment/sanctions-assessment-request
curl -i -X POST \
https://example.com/path/payments/partner-api/v1/risk-assessment/sanctions-assessment-request \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"schema": "SanctionsAssessmentRequest",
"transactionIdentifiers": {
"endToEndIdentification": "uniqueEndToEndId",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
},
"messageIdentifiers": {
"messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da",
"creationDateTime": "2022-05-04T03:22:11Z"
},
"requestExpiry": "2022-05-04T03:22:11Z",
"paymentMessage": {
"schema": "Base64EncodedData",
"contentType": "XML",
"contentMessageType": "pacs.008.001.08",
"payload": "PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9InllcyI/Pgo8RGF0YVBEVSB4bWxucz0idXJuOnN3aWZ0OnNhYTp4c2Q6c2FhLjIuMCIKICAgICAgICAgeG1sbnM6bnMyPSJ1cm46aXNvOnN0ZDppc286MjAwMjI6dGVjaDp4c2Q6aGVhZC4wMDEuMDAxLjAyIgogICAgICAgICB4bWxuczpuczM9InVybjppc286c3RkOmlzbzoyMDAyMjp0ZWNoOnhzZDpwYWNzLjAwOC4wMDEuMDgiPgogIDxSZXZpc2lvbj4yLjAuMTM8L1JldmlzaW9uPgogIDxIZWFkZXI+CiAgICA8TWVzc2FnZT4KICAgICAgPFNlbmRlclJlZmVyZW5jZT5JVkVTMjAyNjA1MTVSRUYwMDE8L1NlbmRlclJlZmVyZW5jZT4KICAgICAgPE1lc3NhZ2VJZGVudGlmaWVyPnBhY3MuMDA4LjAwMS4wODwvTWVzc2FnZUlkZW50aWZpZXI+CiAgICAgIDxGb3JtYXQ+TVg8L0Zvcm1hdD4KICAgICAgPFNlbmRlcj4KICAgICAgICA8RE4+b3U9eHh4LG89aXZlc3phamosbz1zd2lmdDwvRE4+CiAgICAgICAgPEZ1bGxOYW1lPgogICAgICAgICAgPFgxPklWRVNaQUpKWFhYPC9YMT4KICAgICAgICA8L0Z1bGxOYW1lPgogICAgICA8L1NlbmRlcj4KICAgICAgPFJlY2VpdmVyPgogICAgICAgIDxETj5vdT14eHgsbz1jaXRpdXMzMyxvPXN3aWZ0PC9ETj4KICAgICAgICA8RnVsbE5hbWU+CiAgICAgICAgICA8WDE+Q0lUSVVTMzNYWFg8L1gxPgogICAgICAgIDwvRnVsbE5hbWU+CiAgICAgIDwvUmVjZWl2ZXI+CiAgICAgIDxJbnRlcmZhY2VJbmZvPgogICAgICAgIDxVc2VyUmVmZXJlbmNlPlVTRVItUkVGLTIwMjYtMDUtMTUtWDk5PC9Vc2VyUmVmZXJlbmNlPgogICAgICA8L0ludGVyZmFjZUluZm8+CiAgICAgIDxOZXR3b3JrSW5mbz4KICAgICAgICA8U2VydmljZT5zd2lmdC5maW5wbHVzPC9TZXJ2aWNlPgogICAgICAgIDxTV0lGVE5ldE5ldHdvcmtJbmZvPgogICAgICAgICAgPFJlcXVlc3RUeXBlPnBhY3MuMDA4LjAwMS4wODwvUmVxdWVzdFR5cGU+CiAgICAgICAgICA8UmVxdWVzdFN1YnR5cGU+c3dpZnQuY2JwcnBsdXMuMDI8L1JlcXVlc3RTdWJ0eXBlPgogICAgICAgIDwvU1dJRlROZXROZXR3b3JrSW5mbz4KICAgICAgPC9OZXR3b3JrSW5mbz4KICAgIDwvTWVzc2FnZT4KICA8L0hlYWRlcj4KICA8Qm9keT4KICAgIDxuczI6QXBwSGRyPgogICAgICA8bnMyOkZyPgogICAgICAgIDxuczI6RklJZD4KICAgICAgICAgIDxuczI6RmluSW5zdG5JZD4KICAgICAgICAgICAgPG5zMjpCSUNGST5JVkVTWkFKSlhYWDwvbnMyOkJJQ0ZJPgogICAgICAgICAgPC9uczI6RmluSW5zdG5JZD4KICAgICAgICA8L25zMjpGSUlkPgogICAgICA8L25zMjpGcj4KICAgICAgPG5zMjpUbz4KICAgICAgICA8bnMyOkZJSWQ+CiAgICAgICAgICA8bnMyOkZpbkluc3RuSWQ+CiAgICAgICAgICAgIDxuczI6QklDRkk+Q0lUSVVTMzNYWFg8L25zMjpCSUNGST4KICAgICAgICAgIDwvbnMyOkZpbkluc3RuSWQ+CiAgICAgICAgPC9uczI6RklJZD4KICAgICAgPC9uczI6VG8+CiAgICAgIDxuczI6Qml6TXNnSWRyPkIyMDI2MDUxNUlWRVMwMDAwMTIzPC9uczI6Qml6TXNnSWRyPgogICAgICA8bnMyOk1zZ0RlZklkcj5wYWNzLjAwOC4wMDEuMDg8L25zMjpNc2dEZWZJZHI+CiAgICAgIDxuczI6Qml6U3ZjPnN3aWZ0LmNicHJwbHVzLjAyPC9uczI6Qml6U3ZjPgogICAgICA8bnMyOkNyZUR0PjIwMjYtMDUtMTVUMDk6MTc6MzkrMDI6MDA8L25zMjpDcmVEdD4KICAgIDwvbnMyOkFwcEhkcj4KICAgIDxuczM6RG9jdW1lbnQ+CiAgICAgIDxuczM6RklUb0ZJQ3N0bXJDZHRUcmY+CiAgICAgICAgPG5zMzpHcnBIZHI+CiAgICAgICAgICA8bnMzOk1zZ0lkPkIyMDI2MDUxNUlWRVMwMDAwMTIzPC9uczM6TXNnSWQ+CiAgICAgICAgICA8bnMzOkNyZUR0VG0+MjAyNi0wNS0xNVQwOToxNzozOSswMjowMDwvbnMzOkNyZUR0VG0+CiAgICAgICAgICA8bnMzOk5iT2ZUeHM+MTwvbnMzOk5iT2ZUeHM+CiAgICAgICAgICA8bnMzOlN0dGxtSW5mPgogICAgICAgICAgICA8bnMzOlN0dGxtTXRkPkNMUkc8L25zMzpTdHRsbU10ZD4KICAgICAgICAgIDwvbnMzOlN0dGxtSW5mPgogICAgICAgIDwvbnMzOkdycEhkcj4KICAgICAgICA8bnMzOkNkdFRyZlR4SW5mPgogICAgICAgICAgPG5zMzpQbXRJZD4KICAgICAgICAgICAgPG5zMzpJbnN0cklkPklOU1RSLTk5ODg3NzY2NTU0NDwvbnMzOkluc3RySWQ+CiAgICAgICAgICAgIDxuczM6RW5kVG9FbmRJZD5DVVNULVJFRi1QQVktMDA5OTE8L25zMzpFbmRUb0VuZElkPgogICAgICAgICAgICA8bnMzOlVFVFI+ZWIzNGYxOWItNzM0Zi00NjBkLTgzNWMtODkwODg2NTY2MjcwPC9uczM6VUVUUj4KICAgICAgICAgIDwvbnMzOlBtdElkPgogICAgICAgICAgPG5zMzpQbXRUcEluZj4KICAgICAgICAgICAgPG5zMzpTdmNMdmw+CiAgICAgICAgICAgICAgPG5zMzpDZD5HMDAxPC9uczM6Q2Q+CiAgICAgICAgICAgIDwvbnMzOlN2Y0x2bD4KICAgICAgICAgIDwvbnMzOlBtdFRwSW5mPgogICAgICAgICAgPG5zMzpJbnRyQmtTdHRsbUFtdCBDY3k9IlVTRCI+Mjc0NDIuNjg8L25zMzpJbnRyQmtTdHRsbUFtdD4KICAgICAgICAgIDxuczM6SW50ckJrU3R0bG1EdD4yMDI2LTA1LTE1PC9uczM6SW50ckJrU3R0bG1EdD4KICAgICAgICAgIDxuczM6SW5zdGRBbXQgQ2N5PSJVU0QiPjI3NDQyLjY4PC9uczM6SW5zdGRBbXQ+CiAgICAgICAgICA8bnMzOlhjaGdSYXRlPjE4LjUwPC9uczM6WGNoZ1JhdGU+CiAgICAgICAgICA8bnMzOkNocmdCcj5DUkVEPC9uczM6Q2hyZ0JyPgogICAgICAgICAgPG5zMzpDaHJnc0luZj4KICAgICAgICAgICAgPG5zMzpBbXQgQ2N5PSJVU0QiPjAuMDA8L25zMzpBbXQ+CiAgICAgICAgICAgIDxuczM6QWd0PgogICAgICAgICAgICAgIDxuczM6RmluSW5zdG5JZD4KICAgICAgICAgICAgICAgIDxuczM6QklDRkk+SVZFU1pBSkpYWFg8L25zMzpCSUNGST4KICAgICAgICAgICAgICA8L25zMzpGaW5JbnN0bklkPgogICAgICAgICAgICA8L25zMzpBZ3Q+CiAgICAgICAgICA8L25zMzpDaHJnc0luZj4KICAgICAgICAgIDxuczM6SW5zdGdBZ3Q+CiAgICAgICAgICAgIDxuczM6RmluSW5zdG5JZD4KICAgICAgICAgICAgICA8bnMzOkJJQ0ZJPklWRVNaQUpKWFhYPC9uczM6QklDRkk+CiAgICAgICAgICAgIDwvbnMzOkZpbkluc3RuSWQ+CiAgICAgICAgICA8L25zMzpJbnN0Z0FndD4KICAgICAgICAgIDxuczM6SW5zdGRBZ3Q+CiAgICAgICAgICAgIDxuczM6RmluSW5zdG5JZD4KICAgICAgICAgICAgICA8bnMzOkJJQ0ZJPkNJVElVUzMzWFhYPC9uczM6QklDRkk+CiAgICAgICAgICAgIDwvbnMzOkZpbkluc3RuSWQ+CiAgICAgICAgICA8L25zMzpJbnN0ZEFndD4KICAgICAgICAgIDxuczM6RGJ0cj4KICAgICAgICAgICAgPG5zMzpObT5BY21lIEdsb2JhbCBUcmFkaW5nPC9uczM6Tm0+CiAgICAgICAgICAgIDxuczM6UHN0bEFkcj4KICAgICAgICAgICAgICA8bnMzOkFkckxpbmU+MTIzIEluZHVzdHJpYWwgV2F5PC9uczM6QWRyTGluZT4KICAgICAgICAgICAgICA8bnMzOkFkckxpbmU+U2FuZHRvbiwgSm9oYW5uZXNidXJnPC9uczM6QWRyTGluZT4KICAgICAgICAgICAgPC9uczM6UHN0bEFkcj4KICAgICAgICAgICAgPG5zMzpDdGN0RHRscz4KICAgICAgICAgICAgICA8bnMzOk1vYk5iPisyNy03MjEyMzQ1Njc8L25zMzpNb2JOYj4KICAgICAgICAgICAgPC9uczM6Q3RjdER0bHM+CiAgICAgICAgICA8L25zMzpEYnRyPgogICAgICAgICAgPG5zMzpEYnRyQWNjdD4KICAgICAgICAgICAgPG5zMzpJZD4KICAgICAgICAgICAgICA8bnMzOk90aHI+CiAgICAgICAgICAgICAgICA8bnMzOklkPjEyMzQ1Njc4OTEwPC9uczM6SWQ+CiAgICAgICAgICAgICAgICA8bnMzOlNjaG1lTm0+PG5zMzpDZD5CQkFOPC9uczM6Q2Q+PC9uczM6U2NobWVObT4KICAgICAgICAgICAgICA8L25zMzpPdGhyPgogICAgICAgICAgICA8L25zMzpJZD4KICAgICAgICAgICAgPG5zMzpObT5BY21lIE9wZXJhdGluZyBBY2NvdW50PC9uczM6Tm0+CiAgICAgICAgICA8L25zMzpEYnRyQWNjdD4KICAgICAgICAgIDxuczM6RGJ0ckFndD4KICAgICAgICAgICAgPG5zMzpGaW5JbnN0bklkPgogICAgICAgICAgICAgIDxuczM6QklDRkk+SVZFU1pBSkpYWFg8L25zMzpCSUNGST4KICAgICAgICAgICAgICA8bnMzOlBzdGxBZHI+CiAgICAgICAgICAgICAgICA8bnMzOkN0cnk+WkE8L25zMzpDdHJ5PgogICAgICAgICAgICAgIDwvbnMzOlBzdGxBZHI+CiAgICAgICAgICAgIDwvbnMzOkZpbkluc3RuSWQ+CiAgICAgICAgICA8L25zMzpEYnRyQWd0PgogICAgICAgICAgPG5zMzpDZHRyQWd0PgogICAgICAgICAgICA8bnMzOkZpbkluc3RuSWQ+CiAgICAgICAgICAgICAgPG5zMzpCSUNGST5OV0JLR0IyTFhYWDwvbnMzOkJJQ0ZJPgogICAgICAgICAgICA8L25zMzpGaW5JbnN0bklkPgogICAgICAgICAgICA8bnMzOkJybmNoSWQ+CiAgICAgICAgICAgICAgPG5zMzpQc3RsQWRyPgogICAgICAgICAgICAgICAgPG5zMzpDdHJ5PkdCPC9uczM6Q3RyeT4KICAgICAgICAgICAgICA8L25zMzpQc3RsQWRyPgogICAgICAgICAgICA8L25zMzpCcm5jaElkPgogICAgICAgICAgPC9uczM6Q2R0ckFndD4KICAgICAgICAgIDxuczM6Q2R0cj4KICAgICAgICAgICAgPG5zMzpObT5HbG9iYWwgTG9naXN0aWNzIEx0ZDwvbnMzOk5tPgogICAgICAgICAgICA8bnMzOlBzdGxBZHI+CiAgICAgICAgICAgICAgPG5zMzpBZHJMaW5lPjQ1IE1hcml0aW1lIFBsYXphPC9uczM6QWRyTGluZT4KICAgICAgICAgICAgICA8bnMzOkFkckxpbmU+TG9uZG9uLCBVSzwvbnMzOkFkckxpbmU+CiAgICAgICAgICAgIDwvbnMzOlBzdGxBZHI+CiAgICAgICAgICAgIDxuczM6Q3RjdER0bHM+CiAgICAgICAgICAgICAgPG5zMzpNb2JOYj4rNDQtMjA3MTIzNDU2NzwvbnMzOk1vYk5iPgogICAgICAgICAgICA8L25zMzpDdGN0RHRscz4KICAgICAgICAgIDwvbnMzOkNkdHI+CiAgICAgICAgICA8bnMzOkNkdHJBY2N0PgogICAgICAgICAgICA8bnMzOklkPgogICAgICAgICAgICAgIDxuczM6T3Rocj4KICAgICAgICAgICAgICAgIDxuczM6SWQ+MTQwMDc5MTUzMDM1MTwvbnMzOklkPgogICAgICAgICAgICAgICAgPG5zMzpTY2htZU5tPjxuczM6UHJ0cnk+QUhISDwvbnMzOlBydHJ5PjwvbnMzOlNjaG1lTm0+CiAgICAgICAgICAgICAgPC9uczM6T3Rocj4KICAgICAgICAgICAgPC9uczM6SWQ+CiAgICAgICAgICAgIDxuczM6Tm0+TWFpbiBDb2xsZWN0aW9uIEFjY291bnQ8L25zMzpObT4KICAgICAgICAgIDwvbnMzOkNkdHJBY2N0PgogICAgICAgICAgPG5zMzpSbXRJbmY+CiAgICAgICAgICAgIDxuczM6VXN0cmQ+SU5WT0lDRSBOTyBTSU4wMDAzMDQwMjU8L25zMzpVc3RyZD4KICAgICAgICAgIDwvbnMzOlJtdEluZj4KICAgICAgICA8L25zMzpDZHRUcmZUeEluZj4KICAgICAgPC9uczM6RklUb0ZJQ3N0bXJDZHRUcmY+CiAgICA8L25zMzpEb2N1bWVudD4KICA8L0JvZHk+CjwvRGF0YVBEVT4=="
},
"supplementaryData": {
"key1": "value1",
"key2": "value2"
}
}'Accepted. RFC9110 - 202
No content