Skip to main content
GET
TypeScript

Authorizations

Authorization
string
header
required

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.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-10-09-2"

Path Parameters

id
string
required

The transfer ID.

Response

transfer retrieved

A transfer between Whop accounts or users.

amount
object | null
required

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

created_at
string<date-time>
required

When the transfer was created.

Example:

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

destination
TransferParty · object | null
required

Business account or user receiving the transfer.

failed_at
string<date-time> | null
required

Recorded failure time. Null unless the transfer has failed.

Example:

null

failure_code
string | null
required

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

Example:

null

failure_reason
string | null
required

Failure explanation. Null unless the transfer has failed.

Example:

null

fee
object | null
required

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

id
string
required

Transfer ID.

Example:

"ctt_xxxxxxxxxxxxxx"

metadata
object
required

Custom metadata attached to the transfer.

Example:
notes
string | null
required

Transfer note.

Example:

"Refund for the rescheduled interior detail"

object
enum<string>
required

The object type.

Available options:
transfer
Example:

"transfer"

origin
TransferParty · object | null
required

Business account or user sending the transfer.

status
enum<string>
required

Current transfer status.

Available options:
processing,
succeeded,
failed
Example:

"succeeded"

status_changed_at
string<date-time> | null
required

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

Example:

null

succeeded_at
string<date-time> | null
required

Recorded success time. Null when unknown.

Example:

null

tracking_url
string<uri>
required

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

Example:

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