Retrieve Transfer

Retrieves a single transfer.

GET /transfers/{id}

JavaScript

JavaScript

import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const transfer = await client.transfers.retrieve('id');

console.log(transfer.id);

200

{
  "amount": 25,
  "created_at": "2026-01-01T12:00:00.000Z",
  "created_by_user": {
    "id": "user_xxxxxxxxxxxxxx",
    "username": "marcuswebb",
    "name": "Marcus Webb"
  },
  "currency": "usd",
  "destination": {
    "id": "biz_xxxxxxxxxxxxxx",
    "typename": "Company",
    "route": "biz_xxxxxxxxxxxxxx",
    "title": "Shine Time Auto Detailing"
  },
  "destination_ledger_account_id": "ldgr_xxxxxxxxxxxxxx",
  "id": "ctt_xxxxxxxxxxxxxx",
  "object": "transfer",
  "origin": {
    "id": "biz_xxxxxxxxxxxxxx",
    "typename": "Company",
    "route": "biz_xxxxxxxxxxxxxx",
    "title": "Shine Time Auto Detailing"
  },
  "origin_ledger_account_id": "ldgr_xxxxxxxxxxxxxx",
  "status": "succeeded",
  "failed_at": "2023-11-07T05:31:56Z",
  "failure_code": "<string>",
  "failure_reason": "<string>",
  "fee_amount": 0.5,
  "metadata": {
    "order_id": "SHINE-1042"
  },
  "notes": "Refund for the rescheduled interior detail"
}

Authorizations

Authorization · string · header · required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date · string

Pins the request to a dated API version.

Example:

"2026-08-21"

Path Parameters

id · string · required

The transfer ID.

Response

200

application/json

transfer retrieved

A transfer of credit between two ledger accounts.

amount · number · required

Transfer amount.

Example:

25

created_at · string<date-time> · required

When the transfer was created.

Example:

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

created_by_user · TransferCreatedByUser · object | null · required

The user who initiated the transfer, such as the team member who sent a manual payout. Null if the creator is unavailable.

Show child attributes

currency · string · required

Transfer currency.

Example:

"usd"

destination · Company · object · required

Account or user receiving funds.

Company

User

Show child attributes

destination_ledger_account_id · string · required

Destination ledger account ID.

Example:

"ldgr_xxxxxxxxxxxxxx"

id · string · required

Transfer ID.

Example:

"ctt_xxxxxxxxxxxxxx"

object · enum<string> · required

The object type. Discriminates the create response from a send or a claim link.

Available options: transfer

Example:

"transfer"

origin · Company · object · required

Account or user sending funds.

Company

User

Show child attributes

origin_ledger_account_id · string · required

Source ledger account ID.

Example:

"ldgr_xxxxxxxxxxxxxx"

status · enum<string> · required

Transfer status. processing means the on-chain leg is still executing — poll the transfer until it resolves to succeeded or failed. A failed transfer may be retried under the same ID and later resolve to succeeded.

Available options: processing, succeeded, failed

Example:

"succeeded"

failed_at · string<date-time> | null

When the transfer failed, as an ISO 8601 timestamp. Null unless the transfer has failed.

failure_code · string | null

Machine-readable code for why the transfer failed. Null unless the transfer has failed.

failure_reason · string | null

Human-readable explanation of why the transfer failed. Null unless the transfer has failed.

fee_amount · number | null

Fee charged for the transfer.

Example:

0.5

metadata · object | null

Custom metadata attached to the transfer.

Example:

{ "order_id": "SHINE-1042" }

notes · string | null

Transfer note.

Example:

"Refund for the rescheduled interior detail"