API Reference
Deplete User
Debit USDZ points from a widget user’s point balance.
POST
Description
Debit publisher points from a widget user’s point balance and return them to the project’s configured sink/source account. Amount is in currency minor units. For USDZ,100 equals $1.00 worth of points.
This endpoint is idempotent on idempotency_key. The user must already have enough point balance for the debit.
Configuration
Header Parameters
string
required
Your ZBD project API key (production scope).
string
Content Type
Body Parameters
string
required
The ZBD user ID returned by Create User.
integer
required
Amount in currency minor units. For USDZ:
100 = 10.00.string
required
Point currency code. Use
USDZ unless your project has a different configured point currency.string
required
Unique key to prevent duplicate transfers. Use a UUID.