Retrieve a payee
Payees
Retrieve a payee
GET
Retrieve a payee
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
ID of the payee.
Response
The payee.
Example:
"pyee_KfIuLz83Ya"
Example:
"John"
Example:
"Doe"
Example:
"PYEE-2025-001"
E.164 formatted phone number
Available options:
Individual, Company Example:
"Individual"
Example:
true
Current status of the payee based on information completeness and active state
Available options:
Active, MissingInfo, Inactive Example:
"Active"
BCP 47 language tag (e.g. en, en-US)
Maximum string length:
20Optional metadata as key-value pairs
Example:
Last modified on July 8, 2026