The Electrum Regulated Payments API is an asynchronous API that allows partners 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.
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. Partners may request the method of communication Electrum should use when selecting which payment schemes to participate in.
https://example.com/path/payments/api/v1/
This operation is asynchronous, and is a response to the sanctionsAssessment operation.
Invoked when a response to a sanctions assessment request is available. The response will indicate the success, failure or ongoing nature of the sanctions assessment request.
Sanctions assessments are scheme agnostic and may be used in conjunction with any payment 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 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 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
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 latest point the outcome of the sanctions assessment has changed. The date must be formatted as defined by date-time in RFC3339
The outcome of the performed sanctions assessment.
Indicates the outcome of the sanctions assessment of the submitted payment instruction.
ALLOWED: Message is allowed to continue along the normal flow.BLOCKED: Message must be blocked.PENDING: The sanctions assessment is still being processed.ERROR: An error occurred while performing the sanctions check for this request and the request is unable to be processed further.Provide the reason for the outcome of the sanctions assessment of the submitted payment instruction.
SYSTEM_PROCESSING: The system is performing automated screening on the sanction request.USER_INVESTIGATION_UNDERWAY: A user is performing manual screening on the sanction request.NO_SCREENING_REQUIRED: No screening for the message was required, thus the message was ALLOWED.SCREENED_NO_ALERT: Screening took place but no alert was triggered.SCREENED_NON_BLOCKING_ALERT: Screening took place and an alert was triggered, but the alert did not block the transaction.INVESTIGATION_RESULT: Screening took place and an alert was triggered to require user investigation. The outcome was then decided by the user.ERROR_PROCESSING_REQUEST: An error occurred while performing the sanctions check for this request.https://example.com/path/payments/api/v1/risk-assessment/sanctions-assessment-report
curl -i -X POST \
https://example.com/path/payments/api/v1/risk-assessment/sanctions-assessment-report \
-H 'Content-Type: application/json' \
-H 'traceparent: string' \
-H 'tracestate: string' \
-d '{
"schema": "SanctionsAssessmentReport",
"messageIdentifiers": {
"messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da",
"creationDateTime": "2022-05-04T03:22:11Z"
},
"originalMessageIdentifiers": {
"messageIdentification": "9fd51c1234ba4819bbheyde296a68e1da",
"creationDateTime": "2022-05-04T03:22:11Z"
},
"transactionIdentifiers": {
"endToEndIdentification": "6249118655591098",
"uetr": "f27a34ad-c5ab-4b70-a3f9-946d743eaeaa"
},
"lastUpdated": "2022-05-04T03:22:11Z",
"status": {
"outcome": "ALLOWED",
"reasonCode": "SCREENED_NO_ALERT"
},
"supplementaryData": {
"key1": "value1",
"key2": "value2"
}
}'Accepted. RFC9110 - 202
No content