RiskAssessmentStatus

Electrum Regulated Payments Events API (18.1.0)

The Electrum Regulated Payments Events API is a synchronous API that describes the events emitted by the Electrum Regulated Payments platform during the course of transaction processing.

This document describes the single endpoint that you will need to implement in order to receive event notifications posted by Electrum.

As transactions are processed by Electrum, events are emitted to provide information about the status of the transactions and the operations preformed on them. These events do not affect processing, but provide information that can be used for operational support and monitoring purposes.

All events are posted to the same single URL. Event are differentiated by a unique descriptor contained in the name field of the message body. This descriptor serves to allow the receiver to determine whether the particular event is of interest.

state

Transactions transition through different states. As each state is entered, an event is emitted. This event provides information about the state entered by the transaction. Included in this information is the message payload of the operation that triggered the state transition in the Electrum Regulated Payments. Note: The message payload attached to an event might be an internally-triggered message and not the message sent to or received from the Electrum Regulated Payments API.

FraudReportDetail

The response to a fraud assessment request, containing the score and other details of the performed assessment.

detailsArray of strings

A list of strings acting as reasons or details associated with the risk score

scorestring

Indicates the measure of fraud associated with the submitted payment instruction after fraud evaluation.

{
  "details": [
    "string"
  ],
  "score": "string"
}

RiskAssessmentStatus

The outcome of the performed risk assessment on a submitted payment message.

outcomestringrequired

Indicates the outcome of the fraud assessment of the submitted payment instruction.

PASSED: The provided data passed the fraud assessment.
FAILED: The provided data failed the fraud assessment.
PENDING: The fraud assessment is still processing.

Enum"PASSED""FAILED""PENDING"

{
  "outcome": "PASSED"
}

FraudAssessmentReport

This model provides the outcome information of the fraud assessment.

messageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

messageIdentifiers.creationDateTimestring(date-time)required

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

messageIdentifiers.messageIdentificationstring<= 35 charactersrequired

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.

supplementaryDataobject(SupplementaryData)

A list of key-value pairs to support adding any supplementary/additional data to an Electrum Regulated Payments API message.

originalMessageIdentifiersobject(MessageIdentifiers)required

Holds a point-to-point unique message identification string as well as a message's creation date time.

originalMessageIdentifiers.creationDateTimestring(date-time)required

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

originalMessageIdentifiers.messageIdentificationstring<= 35 charactersrequired

transactionIdentifiersobject(TransactionIdentifiers)required

Holds a series of identifiers to identify the transaction or an individual message that is part of a transaction.

transactionIdentifiers.endToEndIdentificationstring<= 35 charactersrequired

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.

transactionIdentifiers.instructionIdentificationstring<= 35 characters

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.

transactionIdentifiers.transactionIdentificationstring<= 35 characters

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.

transactionIdentifiers.uetrstring(UUID)required

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.

reportobject(FraudReportDetail)

The response to a fraud assessment request, containing the score and other details of the performed assessment.

schemastringrequired

Value"FraudAssessmentReport"

statusobject(RiskAssessmentStatus)required

The outcome of the performed risk assessment on a submitted payment message.

status.outcomestringrequired

Indicates the outcome of the fraud assessment of the submitted payment instruction.

PASSED: The provided data passed the fraud assessment.
FAILED: The provided data failed the fraud assessment.
PENDING: The fraud assessment is still processing.

Enum"PASSED""FAILED""PENDING"

{
  "messageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "supplementaryData": {
    "property1": "string",
    "property2": "string"
  },
  "originalMessageIdentifiers": {
    "creationDateTime": "2019-08-24T14:15:22Z",
    "messageIdentification": "string"
  },
  "transactionIdentifiers": {
    "endToEndIdentification": "string",
    "instructionIdentification": "string",
    "transactionIdentification": "string",
    "uetr": "string"
  },
  "report": {
    "details": [ … ],
    "score": "string"
  },
  "schema": "FraudAssessmentReport",
  "status": {
    "outcome": "PASSED"
  }
}

Electrum Regulated Payments Events API (18.1.0)

state

Schema

FraudReportDetail

RiskAssessmentStatus

FraudAssessmentReport