Skip to main content
GET
TypeScript

Autorizaciones

Authorization
string
header
requerido

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

Encabezados

Api-Version-Date
string

Pins the request to a dated API version.

Ejemplo:

"2026-11-17"

Parámetros de ruta

id
string
requerido

The transfer ID.

Respuesta

transfer retrieved

A transfer between Whop accounts or users.

amount
object | null
requerido

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

created_at
string<date-time>
requerido

When the transfer was created.

Ejemplo:

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

destination
TransferParty · object | null
requerido

Business account or user receiving the transfer.

failed_at
string<date-time> | null
requerido

Recorded failure time. Null unless the transfer has failed.

Ejemplo:

null

failure_code
string | null
requerido

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

Ejemplo:

null

failure_reason
string | null
requerido

Failure explanation. Null unless the transfer has failed.

Ejemplo:

null

fee
object | null
requerido

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

id
string
requerido

Transfer ID.

Ejemplo:

"ctt_xxxxxxxxxxxxxx"

metadata
object
requerido

Custom metadata attached to the transfer.

Ejemplo:
notes
string | null
requerido

Transfer note.

Ejemplo:

"Refund for the rescheduled interior detail"

object
enum<string>
requerido

The object type.

Opciones disponibles:
transfer
Ejemplo:

"transfer"

origin
TransferParty · object | null
requerido

Business account or user sending the transfer.

status
enum<string>
requerido

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.

Opciones disponibles:
processing,
succeeded,
failed
Ejemplo:

"succeeded"

status_changed_at
string<date-time> | null
requerido

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

Ejemplo:

null

succeeded_at
string<date-time> | null
requerido

Recorded success time. Null when unknown.

Ejemplo:

null

tracking_url
string<uri>
requerido

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

Ejemplo:

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