Skip to main content
GET
TypeScript

Autorisaties

Authorization
string
header
vereist

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

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Voorbeeld:

"2026-11-17"

Padparameters

id
string
vereist

The transfer ID.

Respons

transfer retrieved

A transfer between Whop accounts or users.

amount
object | null
vereist

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

created_at
string<date-time>
vereist

When the transfer was created.

Voorbeeld:

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

destination
TransferParty · object | null
vereist

Business account or user receiving the transfer.

failed_at
string<date-time> | null
vereist

Recorded failure time. Null unless the transfer has failed.

Voorbeeld:

null

failure_code
string | null
vereist

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

Voorbeeld:

null

failure_reason
string | null
vereist

Failure explanation. Null unless the transfer has failed.

Voorbeeld:

null

fee
object | null
vereist

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

id
string
vereist

Transfer ID.

Voorbeeld:

"ctt_xxxxxxxxxxxxxx"

metadata
object
vereist

Custom metadata attached to the transfer.

Voorbeeld:
notes
string | null
vereist

Transfer note.

Voorbeeld:

"Refund for the rescheduled interior detail"

object
enum<string>
vereist

The object type.

Beschikbare opties:
transfer
Voorbeeld:

"transfer"

origin
TransferParty · object | null
vereist

Business account or user sending the transfer.

status
enum<string>
vereist

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.

Beschikbare opties:
processing,
succeeded,
failed
Voorbeeld:

"succeeded"

status_changed_at
string<date-time> | null
vereist

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

Voorbeeld:

null

succeeded_at
string<date-time> | null
vereist

Recorded success time. Null when unknown.

Voorbeeld:

null

tracking_url
string<uri>
vereist

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

Voorbeeld:

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