BchainPayBchainPay

Retrieve a pocket


title: "Retrieve a pocket" description: "GET /v1/pockets/:id — current balance and last-updated timestamp for a single pocket." section: "API reference" order: 22 updated: "2026-04-18" sourcePath: "content/docs/api/pockets/retrieve.mdx"

GET/v1/pockets/:id

Returns the current state of a single pocket.

Path parameters

FieldTypeRequiredDescription
idstringrequiredPocket ID, e.g. pkt_usdc_polygon.

Example

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

Response — 200 OK

{
  "id": "pkt_usdc_polygon",
  "object": "pocket",
  "network": "polygon",
  "coin": "USDC",
  "balance_cents": 124900,
  "pending_cents": 0,
  "updated_at": "2026-04-18T10:11:02Z"
}

Errors

StatusCodeMeaning
404pocket_not_foundNo pocket with that ID belongs to this merchant.
Last updated Edit on GitHub