Creators · Treasury

Get the card fee for a top-up

Fetches the card fee for a top-up.

GEThttps://api.pozy.ai/v1/balance/top-ups/card-fee
Enabled on requestgetTopupCardFee

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.

Query parameters

NameTypeNotes
paymentMethodIdstring

Example

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

Response

200 on success

  • feeBpsintegerrequired
  • fixedCentsintegerrequired
  • feeIsExactbooleanrequired
200 response
{
  "feeBps": 1,
  "fixedCents": 1,
  "feeIsExact": true
}

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.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Treasury