Step 2: Receive Outbound Credit Transfer Response
Overview
Once the payment has been processed by the scheme, Electrum communicates the outcome to you asynchronously in a credit transfer response. This message indicates whether the authorisation was successful or not and will determine whether you finalise the transaction on your system, or return funds that have been debited from the customer's account.
The credit transfer response has a financial impact. Be sure to consider these important factors when handling this step:
- Electrum treats the credit transfer response as a must-deliver message and will repeatedly send it until you acknowledge receipt.
- Once Electrum has received your acknowledgement, then the transaction is considered complete.
- If the outcome indicates a successful authorisation, then you may finalise the transaction.
- If the outcome indicates a failed authorisation, then you should credit funds back to the sender's account.
- Refer to Step 3 for more details on how to process the possible outcomes.
Implementing the API
Receive Outcome
Electrum sends an outboundCreditTransferResponse message to your /transactions/outbound/credit-transfer-response endpoint. The request will conform to the following schema:
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.
APPROVED: The instruction has been approved.CANCELLED: The instruction has been cancelled.PENDING: The instruction is pending.REJECTED: The instruction has been rejected.
A list of StatusReasonInfo values providing detailed reason information for the outcome.
Contains key elements related to the original transaction that is being referred to.
Designates which scheme a payment status report is associated with and describes scheme-specific information for the payment status report.
Respond With Success
If you receive the message successfully and are able to process it, then respond with an HTTP 202 status. Process the message as per Step 3.
Respond With An Error
If you experience an error while handling the request and are unable to process it, then respond with an appropriate error response.