Creators · Treasury

Create a top-up

Creates a top-up.

POSThttps://api.pozy.ai/v1/balance/top-ups
Enabled on requestcreateTopup

Guide: Pay creators

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the money resource group disabled get 403 resource_group_disabled. Authentication

This endpoint is enabled per workspace. Until it is, calls return 403 feature_not_available. Email support@pozy.ai to turn it on.

Headers

NameTypeNotes
Idempotency-KeystringUp to 255 charactersRetries with the same key return the original result. See Idempotency

Request body

application/json, required

  • amountCentsintegerrequired

    1000 to 10000000.

  • methodstringrequired

    One of card, bank_transfer.

  • paymentMethodIdstring

Example

curl -X POST "https://api.pozy.ai/v1/balance/top-ups" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "amountCents": 1000,
  "method": "card"
}'

Response

201 on success

  • topupIdstringrequired
  • statusstringrequired

    One of succeeded, processing, requires_action.

  • clientSecretstringrequired

    Can be null.

201 response
{
  "topupId": "661baaf62e351f4bf7700103",
  "status": "succeeded",
  "clientSecret": "string"
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Treasury