Access tokens1

Account links1

Accounts20

Ad Campaigns9

Ad Conversion Value Rules7

Ad Groups10

Ad Pixels5

Ads8

Affiliates10

Ai chats5

API Keys7

Api Logs1

App Builds4

Apps8

Audiences5

Authorized users4

Bounties7

Bounty Submissions5

Cards6

Cashback Rules4

Chat channels3

Checkout Configurations4

Company token transactions3

Confirmation Tokens1

Course chapters5

Course lesson interactions2

Course lessons8

Course students2

Courses5

Deposits1

Dispute alerts2

Disputes7

Dm channels5

Dm members5

Domains6

Economic Intelligence2

Events4

Experiences8

Experiments8

Exports3

External Accounts10

Fee markups3

Feedback1

Files4

Forum posts4

Forums3

Identity profiles4

Invoices9

Leads4

Ledger accounts1

Ledgers3

Media2

Members5

Memberships13

Messages5

Notifications6

Partner Referral Requests6

Partners11

Payment Method Domains5

Payment methods3

Payment Quotes2

Payment Rules9

Payments14

Payout accounts1

Payout methods2

Payouts11

People2

Permissions1

Plans6

Product Affiliates1

Products7

Promo Codes6

Reactions4

Refunds2

Resolution Center Cases11

Reviews3

Setup Intents6

Shipments4

Social Accounts10

Stats6

Support channels3

Swaps4

Team Members5

Trades3

Transfers6

Users19

Variants6

Verifications4

Waitlist Entries7

Webhooks9

Webhooks

Accounts4

Ad Campaigns2

Ad Groups1

Ads1

Cards13

Course lesson interactions1

Deposits1

Dispute alerts1

Disputes2

Entries4

Exports2

Invoices5

Ledger accounts1

Ledgers1

Members2

Memberships3

Messages1

Payments7

Payout accounts1

Payouts4

Products5

Reactions1

Refunds2

Resolution Center Cases3

Setup Intents3

Shipments2

Swaps1

Transfers3

Variants3

Verifications2

Transfers

Retrieve Transfer

Changed on Oct 10, 2026

Retrieves a single transfer.

get/transfers/{id}

Request

Base URL: https://api.whop.com/api/v1
URL: https://api.whop.com/api/v1/transfers/{id}
Auth: HTTP bearer

Response

transfer retrieved

created_atstring date-time required

When the transfer was created.

failed_atstring date-time nullable required

Recorded failure time. Null unless the transfer has failed.

failure_codestring nullable required

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

failure_reasonstring nullable required

Failure explanation. Null unless the transfer has failed.

idstring required

Transfer ID.

metadataobject required

Custom metadata attached to the transfer.

notesstring nullable required

Transfer note.

object'transfer' required

The object type.

status'processing' | 'succeeded' | 'failed' required

Current transfer status.

status_changed_atstring date-time nullable required

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

succeeded_atstring date-time nullable required

Recorded success time. Null when unknown.

tracking_urlstring uri required

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

Example response

{
  "amount": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "created_at": "2026-01-01T12:00:00.000Z",
  "destination": {
    "id": "biz_xxxxxxxxxxxxxx",
    "logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/shine-time-logo",
    "name": "Shine Time Auto Detailing",
    "object": "account"
  },
  "fee": {
    "amount": "-1234.56",
    "currency": "usd",
    "decimals": 2,
    "display_decimals": 2
  },
  "id": "ctt_xxxxxxxxxxxxxx",
  "metadata": {
    "order_id": "SHINE-1042"
  },
  "notes": "Refund for the rescheduled interior detail",
  "object": "transfer",
  "origin": {
    "id": "biz_xxxxxxxxxxxxxx",
    "logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/shine-time-logo",
    "name": "Shine Time Auto Detailing",
    "object": "account"
  },
  "status": "succeeded",
  "tracking_url": "https://whop.com/ctt_xxxxxxxxxxxxxx/"
}

Changes

Oct 10, 20267d2eaa643369 Revision changes
- breaking
  the response property became nullable for the status
- breaking
  the response property became nullable for the status
- breaking
  added subschema #2 to the response property oneOf list for the response status
- breaking
  the response's property type changed from number to no type for status
- breaking
  the response's property type changed from no type to object null for status
- breaking
  the response's property type changed from no type to object null for status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  removed the optional property from the response with the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  removed discriminator from response property for the response status
- info
  removed discriminator from response property for the response status
- info
  removed subschema #1: Company subschema #2: User from the response property oneOf list for the response status
- info
  removed subschema #1: Company subschema #2: User from the response property oneOf list for the response status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
- info
  added the required property to the response with the status
Aug 15, 2026c301132dbfd7 Revision changes
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history (6 revisions)