Skip to main content
GET
Get an ultimate payor

Authorizations

Authorization
string
header
required

The data.access_token value from Get access token.

Headers

X-Api-Version
string

Version applied to this request. It wins over your account's pinned version — see Versioning.

Example:

"2026-04-14"

Path Parameters

ultimate_payor_id
string<uuid>
required

The id the payor was created with.

Response

The payor.

A business one of your sub-clients pays on behalf of — see The ultimate payor object.

id
string<uuid>

The payor's identifier. Send it as ultimate_payor_id on a payout made on its behalf.

The payor's legal name.

city
string

The city the payor is based in.

country
string

The payor's country, as an upper-case ISO 3166-1 alpha-3 code.

sub_client_id
string<uuid>

The user_id of the sub-client that pays on this payor's behalf.

status
string | null

The status of the payor's screening, which decides whether a payout can go out on its behalf — see Values. Available options: verifying, verified, failed, rejected.

null when the payor has no screening.

created_at
string<date-time>

When the payor was registered, ISO 8601.

updated_at
string<date-time>

When the payor itself last changed, ISO 8601. A new screening status does not change it.