Creators · Treasury

Get a transfer

Fetches a transfer.

GEThttps://api.pozy.ai/v1/transfers/{transferId}
Enabled on requestgetTransfer

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
transferIdrequiredstring

Example

curl -X GET "https://api.pozy.ai/v1/transfers/6f5f6fe5901ca25e11c24ddb" \
  -H "Authorization: Bearer $POZY_API_KEY"

Response

200 on success

  • idstring
  • payeeIdstring

    24 to 24 characters.

  • payeeNamestring

    Can be null.

  • destinationTypestring

    One of creator, ad_account.

  • amountCentsinteger
  • feeCentsinteger
  • totalCentsinteger
  • currencystring
  • referenceobject
    • typestring
    • idstring
    • namestring

      Can be null.

  • statusstring

    One of pending, paid, failed, reversed.

  • failureReasonstring

    Can be null.

  • createdAtstring (date-time)
200 response
{
  "id": "6bfebd43ddc270f6d2c56fc5",
  "payeeId": "6e2802af63395e8f1a4ddc25",
  "payeeName": "Acme",
  "destinationType": "creator",
  "amountCents": 1,
  "feeCents": 1,
  "totalCents": 42,
  "currency": "USD",
  "reference": {
    "type": "string",
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme"
  },
  "status": "pending",
  "failureReason": "string",
  "createdAt": "2026-10-02T09:00:00.000Z"
}

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