TransactionStateEvent

All of the data supplied as part of the state event.

The stage change that triggered the event is provided by the type field. Each event also carries a globally unique value in the inherited name field which is simply the class (which is always STATE for state-triggered events) concatenated (using an underscore) with the type.

The specific states which elicit an event are:

State Circumstance

|CREDIT_AUTH_ACCEPTED|Deprecated; use PAYMENT_AUTH_REQUEST_ACCEPTED instead. Indicates that the prior auth request passed all technical validation and will be functionally processed. Corresponds to an HTTP 2xx back to where the auth request originated from.| |CREDIT_AUTH_DELIVERY_PENDING|Deprecated; use PAYMENT_AUTH_REQUEST_PENDING instead. Indicates that Electrum has performed functional processing of an auth request (which was previously accepted) and Electrum is forwarding it on to the partner or industry for processing, depending on whether the transaction is an inbound or outbound transaction.| |CREDIT_AUTH_DELIVERED|Deprecated; no alternative state provided. Indicates that Electrum has successfully delivered the auth request to the intended recipient.| |CREDIT_AUTH_DELIVERY_FAILURE|Deprecated; use PAYMENT_AUTH_REQUEST_DELIVERY_FAILURE instead. Indicates that Electrum encountered a technical error while delivering the auth request to the intended recipient (for example receiving HTTP 5xx responses from the partner).| |CREDIT_AUTH_RECEIVED|Deprecated; use PAYMENT_AUTH_REQUEST_RECEIVED instead. Indicates that Electrum received an auth request.| |CREDIT_AUTH_REJECTED|Deprecated; use PAYMENT_AUTH_REQUEST_REJECTED instead. The opposite of CREDIT_AUTH_REQUEST_ACCEPTED. No further processing of the credit auth is performed. Corresponds with an HTTP 4xx or 5xx back to where the auth request originated from.| |CREDIT_AUTH_RESPONSE_ACCEPTED|Deprecated; use PAYMENT_AUTH_RESPONSE_ACCEPTED instead. Indicates that the prior auth response passed all technical validation and will be functionally processed. Corresponds with an HTTP 2xx back to where the auth response originated from.| |CREDIT_AUTH_RESPONSE_RECEIVED|Deprecated; use PAYMENT_AUTH_RESPONSE_RECEIVED instead. Electrum received an auth response for a prior auth request that Electrum had forwarded.| |CREDIT_AUTH_RESPONSE_REJECTED|Deprecated; use PAYMENT_AUTH_RESPONSE_REJECTED instead. The opposite of CREDIT_AUTH_RESPONSE_ACCEPTED. No further processing of the credit auth response is performed. Corresponds to an HTTP 4xx or 5xx back to the sender of the credit auth response.| |CREDIT_AUTH_TIMEOUT|Deprecated; use PAYMENT_AUTH_TIMEOUT instead. No accepted credit auth response was received by Electrum timeously.| |CREDIT_COMPLETION_ACCEPTED|Deprecated; use PAYMENT_COMPLETION_ACCEPTED instead. Indicates that the prior credit transfer completion request passed all technical validation and will be functionally processed. Corresponds with an HTTP 2xx back to where the credit completion originated from.| |CREDIT_COMPLETION_RECEIVED|Deprecated; use PAYMENT_COMPLETION_RECEIVED instead. Indicates that Electrum received a request to complete a previously approved credit transfer authorsation.| |CREDIT_COMPLETION_DELIVERY_PENDING|Deprecated; use PAYMENT_COMPLETED instead. Indicates that Electrum has performed functional processing of a completion request (which was previously accepted) and Electrum is forwarding it on to the partner or industry for processing, depending on whether the transaction is an inbound or outbound transaction.| |CREDIT_COMPLETION_DELIVERED|Deprecated; no alternative state provided. Electrum successfully delivered the credit completion to the intended recipient.| |CREDIT_COMPLETION_DELIVERY_FAILURE|Deprecated; use PAYMENT_COMPLETION_DELIVERY_FAILURE instead. Indicates that a credit transfer completion message was not successfully delivered to the intended recipient.| |CREDIT_TRANSFER_STATUS_PENDING|Deprecated; use PAYMENT_STATUS_PENDING instead. Indicates that Electrum is awaiting the status of a credit transfer after sending a status request to industry.| |CREDIT_COMPLETION_REJECTED|Deprecated; use PAYMENT_COMPLETION_REJECTED instead. The opposite of CREDIT_COMPLETION_ACCEPTED. No further processing of the credit transfer completion request is performed. Corresponds to an HTTP 4xx or 5xx back to where the completion originated from.| |CREDIT_AUTH_RESPONSE_DELIVERED|Deprecated; no alternative state provided. Electrum successfully delivered the authorisation response (either approved or declined) to industry.| |CREDIT_AUTH_RESPONSE_DELIVERY_FAILURE|Deprecated; use PAYMENT_AUTH_RESPONSE_DELIVERY_FAILURE instead. Indicates that Electrum encountered a technical error while delivering an authorisation response (either approved or declined) to the partner or industry.| |CREDIT_AUTH_RESPONSE_DELIVERY_PENDING|Deprecated; use PAYMENT_AUTH_APPROVED or PAYMENT_AUTH_FAILED instead. Indicates that Electrum has performed functional processing of an auth response (which was previously accepted) and Electrum is forwarding it on to intended recipient for processing.| |CREDIT_TRANSFER_RECEIVED|Deprecated; use PAYMENT_REQUEST_RECEIVED instead. Indicates that Electrum received a credit transfer request.| |CREDIT_TRANSFER_ACCEPTED|Deprecated; use PAYMENT_REQUEST_ACCEPTED instead. Indicates that the prior credit transfer request passed all technical validation and will be functionally processed. Corresponds to an HTTP 2xx back to where the credit transfer request originated from.| |CREDIT_TRANSFER_REJECTED|Deprecated; use PAYMENT_REQUEST_REJECTED instead. The opposite of CREDIT_TRANSFER_ACCEPTED. No further processing of the credit transfer request is performed. Corresponds with an HTTP 4xx or 5xx back to where the credit transfer request originated from.| |CREDIT_TRANSFER_DELIVERY_PENDING|Deprecated; use PAYMENT_PENDING instead. Indicates that Electrum has performed functional processing of a credit transfer request (which was previously accepted) and Electrum is forwarding it on to the partner or industry for processing, depending on whether the transaction is an inbound or outbound transaction. Electrum has not yet received an acknowledgement of the credit transfer request.| |CREDIT_TRANSFER_DELIVERED|Deprecated; no alternative state provided. Indicates that Electrum has successfully delivered the credit transfer request to the intended recipient.| |CREDIT_TRANSFER_DELIVERY_FAILURE|Deprecated; use PAYMENT_REQUEST_DELIVERY_FAILURE instead. Indicates that Electrum encountered a technical error while delivering the credit transfer request to the intended recipient (for example receiving HTTP 5xx responses from the partner).| |CREDIT_TRANSFER_TIMEOUT|Deprecated; use PAYMENT_TIMEOUT instead. No accepted credit transfer response was received by Electrum timeously.| |CREDIT_TRANSFER_RESPONSE_RECEIVED|Deprecated; use PAYMENT_RESPONSE_RECEIVED instead. Electrum received a credit transfer response for a prior credit transfer request that Electrum had forwarded.| |CREDIT_TRANSFER_RESPONSE_ACCEPTED|Deprecated; use PAYMENT_RESPONSE_ACCEPTED instead. Indicates that the prior credit transfer response passed all technical validation and will be functionally processed. Corresponds with an HTTP 2xx back to where the credit transfer response originated from.| |CREDIT_TRANSFER_RESPONSE_REJECTED|Deprecated; use PAYMENT_RESPONSE_REJECTED instead. The opposite of CREDIT_TRANSFER_RESPONSE_ACCEPTED. No further processing of the credit transfer response is performed. Corresponds to an HTTP 4xx or 5xx back to the sender of the credit transfer response.| |CREDIT_TRANSFER_APPROVED|Deprecated; use PAYMENT_APPROVED instead. Indicates that the credit transfer request has been approved and settlement is expected.| |CREDIT_TRANSFER_DECLINED|Deprecated; use PAYMENT_FAILED instead. Indicates that a credit transfer attempt has failed. The cause of the failure is contained in the payload.| |IDENTIFIER_DEREGISTRATION_RECEIVED|Indicates that Electrum received a request to deregister an identifier with a scheme.| |IDENTIFIER_DEREGISTRATION_FAILED|Indicates that the request to deregister an identifier with a scheme failed. This could be because it was rejected, or because no response was received within the time limit.| |IDENTIFIER_DEREGISTRATION_SUCCEEDED|Indicates that the request to deregister an identifier with a scheme succeeded.| |IDENTIFIER_DETERMINATION_FAILED|Indicates that the identifier determination response received from industry has been forwarded to the partner. The response from industry was not an approval.| |IDENTIFIER_DETERMINATION_PENDING|Indicates that Electrum has performed functional processing of an identifier determination request (which was previously accepted) and that Electrum is forwarding it on to industry for processing.| |IDENTIFIER_DETERMINATION_REQUEST_DELIVERY_PENDING|Deprecated; use IDENTIFIER_DETERMINATION_PENDING instead. Indicates that Electrum has performed functional processing of an identifier determination request (which was previously accepted) and that Electrum is forwarding it on to industry for processing. No acknowledgement has been received.| |IDENTIFIER_DETERMINATION_REQUEST_DELIVERED|Deprecated; no alternative state provided. Indicates that an accepted identifier determination request was successfully delivered to the intended recipient.| |IDENTIFIER_DETERMINATION_REQUEST_DELIVERY_FAILURE|Indicates that Electrum encountered a technical error while delivering the identifier determination request to the intended recipient (for example receiving HTTP 5xx responses from the partner).| |IDENTIFIER_DETERMINATION_PROVIDED|Indicates that the identifier determination response received from industry has been forwarded to the partner. The response from industry was an approval.| |IDENTIFIER_DETERMINATION_REQUEST_ACCEPTED|Indicates that the prior identifier determination request passed all technical validation and will be functionally processed. Corresponds to an HTTP 2xx back to industry.| |IDENTIFIER_DETERMINATION_REQUEST_RECEIVED|Electrum received a request to provide industry with identifying information of a recipient based on the provided information| |IDENTIFIER_DETERMINATION_REQUEST_REJECTED|The opposite of IDENTIFIER_DETERMINATION_REQUEST_ACCEPTED. No further processing of the identifier determination request is performed. Corresponds to an HTTP 4xx or 5xx back to the sender of the identifier determination request.| |IDENTIFIER_DETERMINATION_RESPONSE_ACCEPTED|Indicates that the prior identifier determination response passed all technical validation and will be functionally processed. Corresponds to an HTTP 2xx back to industry.| |IDENTIFIER_DETERMINATION_RESPONSE_RECEIVED|Electrum received a response from industry to a request to retrieve identifying information for a recipient (creditor).| |IDENTIFIER_DETERMINATION_RESPONSE_REJECTED|The opposite of IDENTIFIER_DETERMINATION_RESPONSE_ACCEPTED. No further processing of the identifier determination response is performed. Corresponds to an HTTP 4xx or 5xx back to the sender of the identifier determination response.| |IDENTIFIER_DETERMINATION_RESPONSE_DELIVERY_FAILURE|Indicates that Electrum encountered a technical error while delivering the identifier determination response to the intended recipient (for example receiving HTTP 5xx responses from the partner).| |IDENTIFIER_DETERMINATION_TIMEOUT|No accepted identifier determination response was received from industry timeously.| |IDENTIFIER_REGISTRATION_RECEIVED|Indicates that Electrum received a request to register an identifier with a scheme| |IDENTIFIER_REGISTRATION_FAILED|Indicates that the request to register an identifier with a scheme failed. This could be because it was rejected, or because no response was received within the time limit.| |IDENTIFIER_REGISTRATION_SUCCEEDED|Indicates that the request to register an identifier with a scheme succeeded.| |PAYMENT_AUTH_REQUEST_RECEIVED|Indicates that Electrum received an auth request.| |PAYMENT_AUTH_REQUEST_ACCEPTED|Indicates that the prior auth request passed all technical validation and will be functionally processed. Corresponds to an HTTP 2xx back to where the auth request originated from.| |PAYMENT_AUTH_REQUEST_REJECTED|The opposite of PAYMENT_AUTH_ACCEPTED. No further processing of the payment auth is performed. Corresponds with an HTTP 4xx or 5xx back to where the auth request originated from.| |PAYMENT_AUTH_REQUEST_PENDING|Indicates that Electrum has performed functional processing of an auth request (which was previously accepted) and Electrum is forwarding it on to the partner or industry for processing, depending on whether the transaction is an inbound or outbound transaction.| |PAYMENT_AUTH_REQUEST_DELIVERY_FAILURE|Indicates that Electrum encountered a technical error while delivering the auth request to the intended recipient (for example receiving HTTP 5xx responses from the partner).| |PAYMENT_AUTH_RESPONSE_RECEIVED|Electrum received an auth response for a prior auth request that Electrum had forwarded.| |PAYMENT_AUTH_RESPONSE_ACCEPTED|Indicates that the prior auth response passed all technical validation and will be functionally processed. Corresponds with an HTTP 2xx back to where the auth response originated from.| |PAYMENT_AUTH_RESPONSE_REJECTED|The opposite of PAYMENT_AUTH_RESPONSE_ACCEPTED. No further processing of the payment auth response is performed. Corresponds to an HTTP 4xx or 5xx back to the sender of the payment auth response.| |PAYMENT_AUTH_APPROVED|Indicates that the payment authorisation request has been approved.| |PAYMENT_AUTH_APPROVED_DELIVERY_FAILURE|Indicates that the payment authorisation request has been approved but the delivery of the payment authorisation response has failed.| |PAYMENT_AUTH_APPROVED_DELIVERY_PENDING|Indicates that the payment authorisation request has been approved and the delivery of the payment authorisation response is still in progress.| |PAYMENT_AUTH_FAILED|Indicates that a payment authorisation attempt has failed. The cause of the failure is contained in the payload.| |PAYMENT_AUTH_FAILED_DELIVERY_FAILURE|Indicates that a payment authorisation attempt has failed and the delivery of the payment authorisation response has failed.| |PAYMENT_AUTH_FAILED_DELIVERY_PENDING|Indicates that a payment authorisation attempt has failed and the delivery of the payment authorisation response is still in progress.| |PAYMENT_AUTH_TIMEOUT|No accepted payment auth response was received by Electrum timeously.| |PAYMENT_AUTH_RESPONSE_DELIVERY_FAILURE|Indicates that Electrum encountered a technical error while delivering an authorisation response (either approved or declined) to the intended recipient.| |PAYMENT_COMPLETION_RECEIVED|Indicates that Electrum received a request to complete a previously approved payment authorsation.| |PAYMENT_COMPLETION_ACCEPTED|Indicates that the prior payment completion request passed all technical validation and will be functionally processed. Corresponds with an HTTP 2xx back to where the completion originated from.| |PAYMENT_COMPLETION_REJECTED|The opposite of PAYMENT_COMPLETION_ACCEPTED. No further processing of the payment completion request is performed. Corresponds to an HTTP 4xx or 5xx back to where the completion originated from.| |PAYMENT_COMPLETED|Indicates that a payment completion has been queued to be delivered to the intended recipient.| |PAYMENT_COMPLETION_DELIVERY_FAILURE|Indicates that a payment completion message was not successfully delivered to the intended recipient.| |PAYMENT_REQUEST_RECEIVED|Indicates that Electrum received a payment request.| |PAYMENT_REQUEST_ACCEPTED|Indicates that the prior payment request passed all technical validation and will be functionally processed. Corresponds to an HTTP 2xx back to where the payment request originated from.| |PAYMENT_REQUEST_REJECTED|The opposite of PAYMENT_REQUEST_ACCEPTED. No further processing of the payment request is performed. Corresponds with an HTTP 4xx or 5xx back to where the payment request originated from.| |PAYMENT_PENDING|Indicates that Electrum has performed functional processing of a payment request (which was previously accepted) and Electrum is forwarding it on to the partner or industry for processing, depending on whether the transaction is an inbound or outbound transaction.| |PAYMENT_REQUEST_DELIVERY_FAILURE|Indicates that Electrum encountered a technical error while delivering the payment request to the intended recipient (for example receiving HTTP 5xx responses from the partner).| |PAYMENT_TIMEOUT|No accepted payment response was received by Electrum timeously.| |PAYMENT_STATUS_PENDING|Indicates that Electrum is awaiting the status of a payment after sending a status request to either the partner or industry.| |PAYMENT_RESPONSE_RECEIVED|Electrum received a payment response for a prior payment request that Electrum had forwarded.| |PAYMENT_RESPONSE_ACCEPTED|Indicates that the prior payment response passed all technical validation and will be functionally processed. Corresponds with an HTTP 2xx back to where the payment response originated from.| |PAYMENT_RESPONSE_REJECTED|The opposite of PAYMENT_RESPONSE_ACCEPTED. No further processing of the payment response is performed. Corresponds to an HTTP 4xx or 5xx back to the sender of the payment response.| |PAYMENT_APPROVED|Indicates that the payment request has been approved and settlement is expected.| |PAYMENT_FAILED|Indicates that a payment attempt has failed. The cause of the failure is contained in the payload.| |REQUEST_TO_PAY_INITIATION_RECEIVED|Indicates that Electrum received a request to pay.| |REQUEST_TO_PAY_INITIATION_ACCEPTED|Indicates that the prior request to pay passed all technical validation and will be functionally processed. Corresponds to an HTTP 2xx back to where the request to pay originated from.| |REQUEST_TO_PAY_INITIATION_REJECTED|The opposite of REQUEST_TO_PAY_INITIATION_ACCEPTED. No further processing of the request to pay is performed. Corresponds with an HTTP 4xx or 5xx back to where the request to pay originated from.| |REQUEST_TO_PAY_INITIATION_PENDING|Indicates that Electrum has performed functional processing of a request to pay (which was previously accepted) and Electrum is forwarding it on to the partner or industry for processing, depending on whether the request to pay is an inbound or outbound request to pay.| |REQUEST_TO_PAY_INITIATION_DELIVERY_FAILED|Indicates that Electrum encountered a technical error while delivering the request to pay to the intended recipient (for example receiving HTTP 5xx responses from the partner).| |REQUEST_TO_PAY_RESPONSE_RECEIVED|Electrum received a request to pay response for a prior request to pay that Electrum had forwarded.| |REQUEST_TO_PAY_RESPONSE_ACCEPTED|Indicates that the prior request to pay response passed all technical validation and will be functionally processed. Corresponds with an HTTP 2xx back to where the request to pay response originated from.| |REQUEST_TO_PAY_RESPONSE_REJECTED|The opposite of REQUEST_TO_PAY_RESPONSE_ACCEPTED. No further processing of the request to pay response is performed. Corresponds to an HTTP 4xx or 5xx back to the sender of the request to pay response.| |REQUEST_TO_PAY_PRESENTED|Indicates that the request to pay has been accepted by the partner or payer participant and it will be shown to the payer to be accepted or rejected.| |REQUEST_TO_PAY_INITIATION_TIMEOUT|No accepted request to pay response was received by Electrum timeously when processing a request to pay initiation.| |REQUEST_TO_PAY_INITIATION_ENQUIRY_PENDING|Indicates that Electrum is awaiting the status of a request to pay after sending a status request to either the partner or industry.| |REQUEST_TO_PAY_INITIATION_ENQUIRY_TIMEOUT|Subsequent to the REQUEST_TO_PAY_INITIATION_ENQUIRY_PENDING state, this indicates no accepted request to pay response was received timeously. |REQUEST_TO_PAY_CANCELLATION_REQUEST_RECEIVED|Indicates that Electrum received a request to cancel a prior request to pay.| |REQUEST_TO_PAY_CANCELLATION_REQUEST_ACCEPTED|Indicates that the prior request to cancel a prior request to pay passed all technical validation and will be functionally processed. Corresponds to an HTTP 2xx back to where the request to cancel a prior request to pay originated from.| |REQUEST_TO_PAY_CANCELLATION_REQUEST_REJECTED|The opposite of REQUEST_TO_PAY_INITIATION_ACCEPTED. No further processing of the request to cancel a prior request to pay is performed. Corresponds with an HTTP 4xx or 5xx back to where the request to cancel a prior request to pay originated from.| |REQUEST_TO_PAY_CANCELLATION_REQUEST_PENDING|Indicates that Electrum has performed functional processing of a request to cancel a prior request to pay (which was previously accepted) and Electrum is forwarding it on to the partner or industry for processing, depending on whether the request to pay is an inbound or outbound request to pay.| |REQUEST_TO_PAY_CANCELLATION_REQUEST_DELIVERY_FAILED|Indicates that Electrum encountered a technical error while delivering the request to cancel a prior request to pay to the intended recipient (for example receiving HTTP 5xx responses from the partner).| |REQUEST_TO_PAY_CANCELLATION_RESPONSE_RECEIVED|Electrum received a response for a prior request to cancel a prior request to pay that Electrum had forwarded.| |REQUEST_TO_PAY_CANCELLATION_RESPONSE_ACCEPTED|Indicates that the prior request to pay cancellation response passed all technical validation and will be functionally processed. Corresponds with an HTTP 2xx back to where the request to pay cancellation response originated from.| |REQUEST_TO_PAY_CANCELLATION_RESPONSE_REJECTED|The opposite of REQUEST_TO_PAY_CANCELLATION_RESPONSE_ACCEPTED. No further processing of the request to pay cancellation response is performed. Corresponds to an HTTP 4xx or 5xx back to the sender of the request to pay cancellation response.| |REQUEST_TO_PAY_CANCELLATION_TIMEOUT|No accepted response to the request to pay cancellation was timeously received by Electrum.| |REQUEST_TO_PAY_CANCELLATION_ENQUIRY_PENDING|Indicates that Electrum is awaiting the status of a request to pay cancellation after sending a request to pay status request to either the partner or industry.| |REQUEST_TO_PAY_CANCELLATION_ENQUIRY_TIMEOUT|Subsequent to the REQUEST_TO_PAY_CANCELLATION_TIMEOUT state, this indicates no accepted request to pay cancellation response was received timeously.| |REQUEST_TO_PAY_ACCEPTED|Indicates that the payer has accepted the request to pay. A payment transaction will be subsequently initiated to fulfil the request to pay. Note: not all schemes express this payer decision via a dedicated message. Please consult with Electrum in this regard prior to designing a solution.| |REQUEST_TO_PAY_CANCELLATION_FAILURE|Indicates that a request to pay cancellation failed i.e. the cancellation failed. This could be due to a number of reasons e.g. the request to pay has already been fulfilled.| |REQUEST_TO_PAY_CANCELLED|Indicates that a request to pay cancellation was successful i.e. a subsequent payment which attempts to fulfil the request to pay is expected to be rejected.| |REQUEST_TO_PAY_DECLINED|Indicates that the payer (or an agent on their behalf) has explicitly chosen to reject the request to pay. No subsequent payment transaction should be expected.| |REQUEST_TO_PAY_FAILED|Indicates that the request to pay failed for a technical reason (as opposed to an explicit decision on the part of the payer or their agent) e.g. the payer identified in the request to pay was not found.| |SCHEME_INQUIRY_RECEIVED|Indicates that Electrum received a request to perform an inquiry against a scheme.| |SCHEME_INQUIRY_FAILED|Indicates that an inquiry against a scheme failed. This could be because it was rejected, or because no response was received within the time limit.| |SCHEME_INQUIRY_SUCCEEDED|Indicates that an inquiry against a scheme succeeded.| |ACCOUNT_VERIFICATION_REQUEST_RECEIVED|Indicates that Electrum received a request to verify that the information provided in the request regarding an account (store of value) is correct| |ACCOUNT_VERIFICATION_REQUEST_ACCEPTED|Indicates that the prior account verification request passed all technical validation and will be functionally processed. Corresponds to an HTTP 2xx back to the sender of the account verification request.| |ACCOUNT_VERIFICATION_REQUEST_REJECTED|The opposite of ACCOUNT_VERIFICATION_REQUEST_ACCEPTED. No further processing of the account verification request is performed. Corresponds to an HTTP 4xx or 5xx back to the sender of the account verification request.| |ACCOUNT_VERIFICATION_PENDING|Indicates that Electrum has performed functional processing of an account verification request (which was previously accepted) and that Electrum is forwarding it on for further processing.| |ACCOUNT_VERIFICATION_REQUEST_DELIVERY_FAILURE|Indicates that Electrum encountered a technical error while delivering the account verification request to the intended recipient (for example receiving HTTP 5xx responses from the partner). |ACCOUNT_VERIFICATION_RESPONSE_RECEIVED|Indicates that Electrum received an account verification response for a prior account verification request that Electrum had forwarded.| |ACCOUNT_VERIFICATION_RESPONSE_ACCEPTED|Indicates that the prior account verification response passed all technical validation and will be functionally processed. Corresponds with an HTTP 2xx back to where the account verification response originated from.| |ACCOUNT_VERIFICATION_RESPONSE_REJECTED|The opposite of ACCOUNT_VERIFICATION_RESPONSE_ACCEPTED. No further processing of the payment response is performed. Corresponds to an HTTP 4xx or 5xx back to the sender of the account verification response.| |ACCOUNT_VERIFICATION_RESPONSE_DELIVERY_FAILURE| Indicates that Electrum encountered a technical error while delivering the account verification response to the intended recipient (for example receiving HTTP 5xx responses from the partner).| |ACCOUNT_VERIFICATION_TIMEOUT|No accepted response to the account verification request was timeously received by Electrum. |ACCOUNT_VERIFICATION_SUCCESSFUL|Indicates that the account verification response received has been forwarded back to where the original account verification request originated from, and that the status of the response is APPROVED.| |ACCOUNT_VERIFICATION_FAILED|Indicates that an account verification response has been forwarded back to where the original account verification request originated from, and that the status of the response is not APPROVED.| |VALIDATION_FAILED|The prior validation request did not yield a valid outcome. Note that this is the final state for validations regardless of the failure (i.e. timeouts, technical declines and business-rule declines all end up here).| |VALIDATION_PENDING|Electrum received a validation request and it is being processed.| |VALIDATION_SUCCESSFUL|The prior validation request yielded an "is valid" outcome.| |VALIDATION_TIMEOUT|If Electrum takes too long to perform a validation operation, a timeout is triggered.| |SWITCH_FAILURE|A special stage which signifies a technical error within Electrum.| |TRANSACTION_BROKEN|A terminal stage indicating that parties may disagree on the outcome of a transaction due to an error during processing, such as a timeout waiting to receive a completion message, or the permanent failure to deliver a completion message.| |VIGILANCE_AUTH_REQUESTED|Indicates that a request to perform a vigilance auth has been been sent. This breakout is synchronous| |VIGILANCE_AUTH_SUCCESSFUL|Indicates that the response received contained a positive outcome. This breakout is synchronous| |VIGILANCE_AUTH_FAILED|Indicates that the response received contained a negative outcome. This breakout is synchronous| |VIGILANCE_AUTH_TIMEOUT|Indicates that a timeout has occurred while waiting for a response. This breakout is synchronous| |RESERVATION_REQUESTED|Indicates that an asynchronous request to perform a reservation has been sent| |RESERVATION_ACCEPTED|Indicates that Electrum has received a positive technical response (ACK) for a previously sent reservation request. Use of this state indicates that the breakout is asynchronous| |RESERVATION_REJECTED|Indicates that Electrum has received a negative technical response (NACK) for a previously sent reservation request. Use of this state indicates that the breakout is asynchronous| |RESERVATION_RESPONSE_RECEIVED|Indicates that Electrum has received a functional response for a previously sent reservation request. Use of this state indicates that the breakout is asynchronous| |RESERVATION_RESPONSE_ACCEPTED|Indicates that Electrum has found a reservation functional response to be technically valid. Use of this state indicates that the breakout is asynchronous| |RESERVATION_RESPONSE_REJECTED|Indicates that Electrum has found a reservation functional response to be technically invalid. Use of this state indicates that the breakout is asynchronous| |RESERVATION_SUCCESSFUL|Indicates that the response received contained a positive outcome| |RESERVATION_FAILED|Indicates that the response received contained a negative outcome| |RESERVATION_TIMEOUT|A timeout occurred while waiting for a response| Note that all of these events are emitted when a transaction transitions into the associated state.

apiVersion
required
string

The version of the Electrum Regulated Payments Events API which the event format conforms to i.e. the version of this API.

class
required
string

The class of the event.

actionDate
required
string <date>

The date at which the transaction should take effect. The date must be formatted as defined by date-time in RFC3339

creationDateTime
required
string <date-time>

The date and time at which the event was created, in senders local timezone or UTC. The date must be formatted as defined by date-time in RFC3339

object (EventEsmPayload)
required
object (EventEsmIdentifiers)

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

required
object (EventEsmState)
required
object (EventEsmTransactionInfo)
{
  • "apiVersion": "string",
  • "class": "ESM_STATE",
  • "actionDate": "2019-08-24",
  • "creationDateTime": "2019-08-24T14:15:22Z",
  • "eftDataRecord": {
    },
  • "identifiers": {
    },
  • "state": {
    },
  • "transactionInfo": {
    }
}
Copyright © Electrum Payments (Pty) Ltd. 2019-2023. All right reserved.