Create Checkout Message Sequence - Escrow
Diagrams and steps for using a hosted page to create a payment with escrow.
When the funds are received, they are placed in the 'received balance' of the wallet. When the escrow closes, the funds are moved to the available balance. See Escrow.
Success - Escrow Release on Demand
This diagram shows the sequence of events when funds are held in escrow until the client requests release.
The client sends Create Checkout Page request containing escrow instructions to Rapyd. See Creating a Payment with Escrow.
Rapyd sends the client a response containing a redirect URL.
The client sends the URL to the customer.
The customer completes the checkout page and submits it directly to Rapyd. The customer also completes all steps necessary to complete the payment and Rapyd receives the funds.
Rapyd creates a payment with status set to ACT (active) and sends Webhook - Payment Succeeded to the client.
The funds are deposited into the wallet, in the ‘received balance’. See Wallet Balance Types. Rapyd sends Webhook - Payment Completed to the client. The status of the escrow is set to on hold and the status of the payment is set to CLO (closed).
The client sends a Release Funds from Escrow request to Rapyd.
The funds are moved from ‘received balance’ to ‘available balance’ in the designated wallet and Rapyd sends a response. The status of the escrow is set to released.
Success - Automatic Release
This diagram shows the sequence of events when you specify the escrow release date in the Create Checkout Page request. See Escrow Objectescrow_release_days.
The client sends Create Checkout Page request with
escrow release daysset. See Creating a Payment with Escrow.Rapyd sends a response containing a redirect URL to the client.
The client sends the URL to the customer.
The customer completes the checkout page and submits it directly to Rapyd. The customer also completes all steps necessary to complete the payment and Rapyd receives the funds.
Rapyd creates a payment with status set to ACT (active) and sends Webhook - Payment Succeeded to the client.
The funds are deposited into the wallet, in the ‘received balance’. See Wallet Balance Types. Rapyd sends Webhook - Payment Completed to the client. The status of the escrow is set to on hold and the status of the payment is set to CLO (closed).
At the end of the defined period, the funds in the wallet are moved from ‘received balance’ to ‘available balance'. Rapyd sends Webhook - Escrow Payment Released. The status of the escrow is set to released.
Failure - Payment Expired
This diagram shows the sequence of events when the customer fails to complete the payment requirements before the payment expires. See Create Checkout Page expiration and payment_expiration for more information.
The client sends Create Checkout Page request containing escrow instructions to Rapyd. See Creating a Payment with Escrow.
Rapyd sends a response containing a redirect URL to the client.
The client sends the URL to the customer.
The customer completes the checkout page and submits it directly to Rapyd.
Rapyd sends Webhook - Payment Succeeded to client. The status of the escrow is set to pending and the status of the payment is set to ACT (active).
The customer fails to complete all the required payment steps before the payment period expires. Rapyd sends Webhook - Payment Expired. The status of the escrow is canceled and the status of the payment is set to EXP (expired).