Skip to main content
GET
Get One Payee

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

payee_id
string<uuid>
required

Query Parameters

user_id
string<uuid> | null

Optional. The unique ID of the user who owns this payee. Omit to look the payee up by its ID within your tenant.

Example:

"b3a9b622-cc63-4d3c-aad6-2d8e29e6f9d4"

includeDestinations
boolean
default:false

Set to true to also include the payee's payout destinations in the response.

includeMethods
boolean
default:false

Set to true to also include the payee's payout destinations in the response.

Response

The requested payee. The destinations array is included only when includeDestinations=true is passed.

status_code
integer
required

HTTP status code for the response.

data
PayeeRead · object
required

Payee representation returned by the API.

query_generated_time
integer
required

UTC timestamp (milliseconds since epoch) when response was generated.