Initiate Refund

Refunds funds from the escrow back to the sender.

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

Request

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

Path parameters

escrowIdstring required

Request body

amountinteger required

Amount to refund (must not exceed escrow balance)

Response

200

successboolean
messagestring

Example response

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

Changes

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