HOhoneycoin

Initiate Payout

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

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

Request

  • Base URL
    https://api-v2.honeycoin.app
  • URL
    https://api-v2.honeycoin.app/api/b2b/escrows/payouts/{escrowId}
  • Auth
    API key in header Authorization

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"
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.