Skip to main content
GET
Retrieve a payee

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

payee_id
string
required

ID of the payee.

Response

The payee.

id
string
Example:

"pyee_KfIuLz83Ya"

given_name
string
Example:

"John"

family_name
string
Example:

"Doe"

middle_name
string | null
name
string
identifier
string
Example:

"PYEE-2025-001"

email
string<email> | null
phone
string | null

E.164 formatted phone number

company
string | null
entity_type
enum<string>
Available options:
Individual,
Company
Example:

"Individual"

address
object | null
active
boolean
Example:

true

status
enum<string>

Current status of the payee based on information completeness and active state

Available options:
Active,
MissingInfo,
Inactive
Example:

"Active"

preferred_language
string | null

BCP 47 language tag (e.g. en, en-US)

Maximum string length: 20
metadata
object | null

Optional metadata as key-value pairs

Example:
created_at
string<date-time>
updated_at
string<date-time>
Last modified on July 8, 2026