Step 3: Process Outbound Request-To-Pay Response
Once you have acknowledged receipt of an outboundRequestToPayResponse
, you must process it according to the transaction status, as indicated in the status.status
field of the message payload.
Status | Action |
---|---|
PAID | The RTP was approved by the debtor and the payment has been processed. Note that the outcome of the payment itself is not communicated. |
CANCELLED | The RTP has been successfully cancelled after a cancellation request was sent. |
EXPIRED | The RTP has expired. |
PENDING | The RTP has been forwarded and an intial status report is still expected. |
PRESENTED | The RTP has been accepted by the payer participant and will be presented to the debtor. |
REJECTED | The RTP has been rejected. |
REFUND_IN_PROGRESS | The refund of the original request to pay is currently in progress and does not yet have an outcome. |
REFUNDED | The refund of the original request to pay has been completed successfully. |
Payment Success Flow
Once the RTP has been successfully delivered to the payer and the payer has accepted, the clearing of funds is performed according to the inbound payment flow as described here.
Alternative Flows
There are three possible alternative outcomes that can occur after the RTP has been successfully delivered to the payer:
- The Payer can explicitly reject the PayShap Request To Pay. This will result in a Electrum sending an
outboundRequestToPayResponse
message to your/transactions/outbound/credit-transfer-response
endpoint with the fieldstatus.status
set toREJECTED
. - The RTP expires before a payment was initiated or rejected. This will result in a Electrum sending an
outboundRequestToPayResponse
message to your/transactions/outbound/credit-transfer-response
endpoint with the fieldstatus.status
set toEXPIRED
. - You communicate the request to cancel a prior PayShap request-to-pay. This is described in further detail here.