Sign in

v1

latestOpenAPI 3.1.02026-08-042453938.9 KB
Customers

Sync customer balance

Triggers an immediate balance sync for a customer. This fetches the current on-chain balance and updates the database snapshot.

Use this endpoint:

  • After a customer deposits funds on-chain
  • To verify balance accuracy before a charge
  • For debugging balance discrepancies

The response includes both previous and new balances, along with whether a change was detected. Requires a secret key (sk_*).

post/v1/customers/{id}/sync-balance

Path parameters

idstring required

Customer ID

Response

Balance sync completed

customerIdstring

Customer ID

previousBalancestring

Previous balance in USDC

newBalancestring

Current on-chain balance in USDC

changedboolean

Whether the balance changed

blockNumberstring

Block number when balance was checked

syncedAtstring date-time

Timestamp of sync