Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

id
string
required

The unique identifier of the payout account to retrieve.

Example:

"poact_xxxxxxxxxxxx"

Response

A successful response

An object representing an account used for payouts.

address
object | null
required

The physical address associated with this payout account

business_name
string | null
required

The company's legal name

business_representative
object | null
required

The business representative for this payout account

email
string | null
required

The email address of the representative

id
string
required

The unique identifier for the payout account.

Example:

"poact_xxxxxxxxxxxx"

latest_verification
object | null
required

The latest verification for the connected account.

phone
string | null
required

The business representative's phone

status
enum<string> | null
required

The granular calculated status of the payout account reflecting its current KYC and withdrawal readiness state.

Available options:
connected,
disabled,
action_required,
pending_verification,
verification_failed,
not_started