PaybytokenDocs
Customer Deposits
API reference · Customer Deposits

Deposits and customer balances

Inspect detected transfers, confirmation state and exact-asset customer balances.

MethodEndpointPurpose
GET/api/v1/depositsList deposits across the merchant account.
GET/api/v1/deposits/:depositIdRetrieve one deposit.
GET/api/v1/customers/:customerId/depositsList deposits for one customer.
GET/api/v1/customers/:customerId/balancesList the customer's chain-and-asset balances.

The merchant-wide list supports filters for customer, deposit address, chain, asset and status. Use cursor pagination; do not repeatedly scan every blockchain from the merchant application.

A detected transaction is not yet spendable. Wait until the deposit reaches its credited state or consume the corresponding signed webhook before reflecting available funds. Below-minimum, restricted and reversed deposits remain visible for audit and support.

Amounts are decimal strings and atomic amounts are integer strings. A Base USDC balance and an Ethereum USDC balance are distinct even when both display USDC.

API Workbench

Full Explorer

Open in new tab