Skip to main content

Documentation

Creating a Payment with Escrow

Create a payment that temporarily holds collected funds in escrow.

When you create a payment with escrow, collected funds are placed in the designated wallet's received balance. When released from escrow, the funds move to the available balance. See Wallet Balance Types.

Reasons to create a payment with escrow include:

  • Legal or contractual requirements.

  • Releasing funds only when an item is shipped.

Procedure

Create a payment as described in Create Payment, with the following settings:

  • escrow - Determines whether the payment is held in escrow for later release. Set to true.

  • ewallets - An array of 1-10 objects that describe the wallets that the money is paid into. For details, see Create Payment, For each wallet in the wallets array, specify an amount or percentage.

    • Example request - partial

      • {

//         . . .

    "escrow": true,
    "ewallets": [
        {
            "ewallet": "ewallet_c1943cfeda5f98247ab117e5d2648861",
            "percentage": 100
        }
    ]
}

The response includes an Escrow object, as described in Release Funds From Escrow.

{
//         . . .

    "data": {
//         . . .

        "ewallets": [
            {
                "ewallet_id": "ewallet_c1943cfeda5f98247ab117e5d2648861",
                "amount": 10,
                "percent": 100,
                "released_amount": 0,
                "refunded_amount": 0
            }
        ],
//         . . .

        "escrow": {
            "id": "escrow_cb3a20a8ed0f7d01767098b53d616afc",
            "payment": "payment_6b0207d6e5aa3e36d5d0cca1f5cb2332",
            "currency": "USD",
            "amount_on_hold": 10,
            "total_amount_released": 0,
            "status": "on_hold",
            "escrow_release_days": null,
            "created_at": 1662986994,
            "updated_at": 1662986994,
            "last_payment_completion": 1662986994
        },
//         . . .
                }
}

Code Examples

For a full code example, see Create Payment:

  • Create payment with escrow

In this section: