v1

latestOpenAPI 3.1.02026-07-24620123.6 KB

Initiate Payout

Initiates a payout from the escrow to the receiver. You can specify the amount to payout.

post/api/b2b/escrows/payouts/{escrowId}

Path parameters

escrowIdstring required

Request body

amountinteger required

Amount to payout (must not exceed escrow balance)

Response

200

successboolean
messagestring

Example response

{
  "success": true,
  "message": "Payout initiated successfully.",
  "data": {
    "transactionId": "mF7VKAbN7C1TEM4bTaOG"
  }
}