Creators · Treasury

Get a top-up receipt

Fetches a top-up receipt.

GEThttps://api.pozy.ai/v1/balance/top-ups/{topupId}/receipt
Enabled on requestgetTopupReceipt

Guide: Pay creators

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can 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.

Path parameters

NameTypeNotes
topupIdrequiredstring

Example

curl -X GET "https://api.pozy.ai/v1/balance/top-ups/661baaf62e351f4bf7700103/receipt" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • urlstring (URL)required
  • formatstringrequired

    One of pdf, page.

200 response
{
  "url": "https://pozy.ai/media/example-1.jpg",
  "format": "pdf"
}

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 scoped to other profiles or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Treasury