Skip to main content
GET
TypeScript

Autorisations

Authorization
string
header
requis

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Scopes

payout:transfer:read

En-têtes

Api-Version-Date
string

Pins the request to a dated API version.

Exemple:

"2026-11-17"

Paramètres de chemin

id
string
requis

The transfer ID.

Réponse

transfer retrieved

A transfer between Whop accounts or users.

amount
object | null
requis

Amount credited to the recipient. Null while the transfer has not succeeded.

created_at
string<date-time>
requis

When the transfer was created.

Exemple:

"2026-01-01T12:00:00.000Z"

destination
TransferParty · object | null
requis

Business account or user receiving the transfer.

failed_at
string<date-time> | null
requis

Recorded failure time. Null unless the transfer has failed.

Exemple:

null

failure_code
string | null
requis

Machine-readable failure code. Null unless the transfer has failed.

Exemple:

null

failure_reason
string | null
requis

Failure explanation. Null unless the transfer has failed.

Exemple:

null

fee
object | null
requis

All applicable transfer fees, including platform markup. Null when the authoritative total is unavailable.

id
string
requis

Transfer ID.

Exemple:

"ctt_xxxxxxxxxxxxxx"

metadata
object
requis

Custom metadata attached to the transfer.

Exemple:
notes
string | null
requis

Transfer note.

Exemple:

"Refund for the rescheduled interior detail"

object
enum<string>
requis

The object type.

Options disponibles:
transfer
Exemple:

"transfer"

origin
TransferParty · object | null
requis

Business account or user sending the transfer.

status
enum<string>
requis

Current transfer status. A transfer can be created processing and settle a few seconds later; poll Retrieve Transfer or listen for the transfer.completed and transfer.failed webhooks instead of treating the create response as final. succeeded and failed are final.

Options disponibles:
processing,
succeeded,
failed
Exemple:

"succeeded"

status_changed_at
string<date-time> | null
requis

Recorded time of the current transition. Null when the historical transition time is unknown.

Exemple:

null

succeeded_at
string<date-time> | null
requis

Recorded success time. Null when unknown.

Exemple:

null

tracking_url
string<uri>
requis

Tracking page for the transfer. Viewing it requires sign-in and access to the transfer.

Exemple:

"https://whop.com/ctt_xxxxxxxxxxxxxx/"