BchainPayBchainPay

Retrieve a withdrawal


title: "Retrieve a withdrawal" description: "GET /v1/withdrawals/:id — current status, transaction hash, and fee for a withdrawal." section: "API reference" order: 32 updated: "2026-04-18" sourcePath: "content/docs/api/withdrawals/retrieve.mdx"

GET/v1/withdrawals/:id

Returns the current state of a withdrawal, including the on-chain tx_hash once broadcast.

Path parameters

FieldTypeRequiredDescription
idstringrequiredWithdrawal ID, e.g. wd_8H2x...91.

Example

curl https://api.bchainpay.com/v1/withdrawals/wd_8H2x91 \
  -H "Authorization: Bearer $BCHAINPAY_API_KEY"

Response — 200 OK

{
  "id": "wd_8H2x...91",
  "object": "withdrawal",
  "status": "completed",
  "pocket_id": "pkt_usdc_polygon",
  "amount_cents": 4999,
  "destination": "0xC0ffeeB45...",
  "network_fee_cents": 12,
  "tx_hash": "0x7d2e...01ab",
  "confirmations": 24,
  "reference": "PAYOUT-2026-04-18-001",
  "created_at": "2026-04-18T12:05:33Z",
  "completed_at": "2026-04-18T12:09:41Z"
}

Errors

StatusCodeMeaning
404withdrawal_not_foundNo withdrawal with that ID belongs to this merchant.
Last updated Edit on GitHub