Sign in
latestOpenAPI 3.1.02026-08-153864115.7 MB

c301132dbfd7

Transfers

Create Transfer

Moves money between accounts, or into a claim link anyone with the URL can redeem.

post/transfers

Headers

Idempotency-Keystring
Example:d9105228-4a08-46b1-8b91-42fed586d383

A unique key that makes this request safe to retry. See Idempotent requests.

Request body

amountnumber required

The amount to move, in the transfer currency. For example 25.00.

currencystring

Currency, such as usd. Required for ledger transfers.

destination_idstring

The recipient. Required for ledger and wallet_send (a user_/biz_/ldgr_ ID, or — for sends — an email). Omit for claim_link.

expires_atstring date-time nullable

claim_link only. Link expiry as an ISO 8601 timestamp. Defaults to 24 hours from creation.

idempotence_keystring nullable

Ledger transfers and wallet sends. A unique key that makes retries safe. Retrying with the same key returns the original transfer, or attaches to the original wallet send, instead of moving money twice.

metadataobject nullable

Ledger transfers only. Custom key-value pairs attached to the transfer. Max 50 keys, 100 chars per key, 500 chars per string value.

notesstring nullable

Ledger transfers only. A short note describing the transfer.

origin_idstring required

The account sending the funds. A user ID (user_xxx), account ID (biz_xxx), or ledger account ID (ldgr_xxx).

redeemable_countinteger

claim_link only. How many different users can claim the link. Defaults to 1.

type'ledger' | 'wallet_send' | 'claim_link'

The kind of money movement, which decides what comes back. Defaults to ledger. ledger moves credit between two Whop balances and returns a transfer; wallet_send sends USDT from the origin account's Ethereum wallet and returns a send; claim_link funds a shareable link anyone with the URL can redeem and returns a claim_link. A ledger transfer from a stablecoin-rails account settles on-chain when covered, and still returns a transfer.

Example request

{
  "amount": 25,
  "currency": "usd",
  "destination_id": "user_xxxxxxxxxxxxxx",
  "expires_at": "2026-01-01T12:00:00.000Z",
  "idempotence_key": "shine-supplies-restock-118",
  "metadata": {
    "order_id": "SHINE-1042"
  },
  "notes": "Refund for the rescheduled interior detail",
  "origin_id": "biz_xxxxxxxxxxxxxx",
  "redeemable_count": 3,
  "type": "wallet_send"
}

Response

money movement created

OR
OR

Example response

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