Create Transfer - Whop Docs

TypeScript

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.transfers.create({
    amount: 25,
    origin_id: "biz_xxxxxxxxxxxxxx"
});

curl --request POST \
  --url https://api.whop.com/api/v1/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 25,
  "currency": "usd",
  "destination_id": "user_xxxxxxxxxxxxxx",
  "origin_id": "biz_xxxxxxxxxxxxxx",
  "type": "balance",
  "feed_id": "feed_shineclub",
  "feed_type": "chat_feed",
  "idempotence_key": "shine-refund-1042",
  "metadata": {
    "order_id": "SHINE-1042"
  },
  "notes": "Refund for the rescheduled interior detail"
}
'

import requests

url = "https://api.whop.com/api/v1/transfers"

payload = {
    "amount": 25,
    "currency": "usd",
    "destination_id": "user_xxxxxxxxxxxxxx",
    "origin_id": "biz_xxxxxxxxxxxxxx",
    "type": "balance",
    "feed_id": "feed_shineclub",
    "feed_type": "chat_feed",
    "idempotence_key": "shine-refund-1042",
    "metadata": { "order_id": "SHINE-1042" },
    "notes": "Refund for the rescheduled interior detail"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 25,
    currency: 'usd',
    destination_id: 'user_xxxxxxxxxxxxxx',
    origin_id: 'biz_xxxxxxxxxxxxxx',
    type: 'balance',
    feed_id: 'feed_shineclub',
    feed_type: 'chat_feed',
    idempotence_key: 'shine-refund-1042',
    metadata: {order_id: 'SHINE-1042'},
    notes: 'Refund for the rescheduled interior detail'
  })
};

fetch('https://api.whop.com/api/v1/transfers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/transfers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 25,
    'currency' => 'usd',
    'destination_id' => 'user_xxxxxxxxxxxxxx',
    'origin_id' => 'biz_xxxxxxxxxxxxxx',
    'type' => 'balance',
    'feed_id' => 'feed_shineclub',
    'feed_type' => 'chat_feed',
    'idempotence_key' => 'shine-refund-1042',
    'metadata' => [
        'order_id' => 'SHINE-1042'
    ],
    'notes' => 'Refund for the rescheduled interior detail'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/transfers"

	payload := strings.NewReader("{\n  \"amount\": 25,\n  \"currency\": \"usd\",\n  \"destination_id\": \"user_xxxxxxxxxxxxxx\",\n  \"origin_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"type\": \"balance\",\n  \"feed_id\": \"feed_shineclub\",\n  \"feed_type\": \"chat_feed\",\n  \"idempotence_key\": \"shine-refund-1042\",\n  \"metadata\": {\n    \"order_id\": \"SHINE-1042\"\n  },\n  \"notes\": \"Refund for the rescheduled interior detail\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.whop.com/api/v1/transfers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 25,\n  \"currency\": \"usd\",\n  \"destination_id\": \"user_xxxxxxxxxxxxxx\",\n  \"origin_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"type\": \"balance\",\n  \"feed_id\": \"feed_shineclub\",\n  \"feed_type\": \"chat_feed\",\n  \"idempotence_key\": \"shine-refund-1042\",\n  \"metadata\": {\n    \"order_id\": \"SHINE-1042\"\n  },\n  \"notes\": \"Refund for the rescheduled interior detail\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/transfers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 25,\n  \"currency\": \"usd\",\n  \"destination_id\": \"user_xxxxxxxxxxxxxx\",\n  \"origin_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"type\": \"balance\",\n  \"feed_id\": \"feed_shineclub\",\n  \"feed_type\": \"chat_feed\",\n  \"idempotence_key\": \"shine-refund-1042\",\n  \"metadata\": {\n    \"order_id\": \"SHINE-1042\"\n  },\n  \"notes\": \"Refund for the rescheduled interior detail\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
  },
  "failed_at": null,
  "failure_code": null,
  "failure_reason": null,
  "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",
  "status_changed_at": null,
  "succeeded_at": null,
  "tracking_url": "https://whop.com/ctt_xxxxxxxxxxxxxx/"
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

POST

transfers

TypeScript

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.transfers.create({
    amount: 25,
    origin_id: "biz_xxxxxxxxxxxxxx"
});

curl --request POST \
  --url https://api.whop.com/api/v1/transfers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 25,
  "currency": "usd",
  "destination_id": "user_xxxxxxxxxxxxxx",
  "origin_id": "biz_xxxxxxxxxxxxxx",
  "type": "balance",
  "feed_id": "feed_shineclub",
  "feed_type": "chat_feed",
  "idempotence_key": "shine-refund-1042",
  "metadata": {
    "order_id": "SHINE-1042"
  },
  "notes": "Refund for the rescheduled interior detail"
}
'

import requests

url = "https://api.whop.com/api/v1/transfers"

payload = {
    "amount": 25,
    "currency": "usd",
    "destination_id": "user_xxxxxxxxxxxxxx",
    "origin_id": "biz_xxxxxxxxxxxxxx",
    "type": "balance",
    "feed_id": "feed_shineclub",
    "feed_type": "chat_feed",
    "idempotence_key": "shine-refund-1042",
    "metadata": { "order_id": "SHINE-1042" },
    "notes": "Refund for the rescheduled interior detail"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 25,
    currency: 'usd',
    destination_id: 'user_xxxxxxxxxxxxxx',
    origin_id: 'biz_xxxxxxxxxxxxxx',
    type: 'balance',
    feed_id: 'feed_shineclub',
    feed_type: 'chat_feed',
    idempotence_key: 'shine-refund-1042',
    metadata: {order_id: 'SHINE-1042'},
    notes: 'Refund for the rescheduled interior detail'
  })
};

fetch('https://api.whop.com/api/v1/transfers', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/transfers",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 25,
    'currency' => 'usd',
    'destination_id' => 'user_xxxxxxxxxxxxxx',
    'origin_id' => 'biz_xxxxxxxxxxxxxx',
    'type' => 'balance',
    'feed_id' => 'feed_shineclub',
    'feed_type' => 'chat_feed',
    'idempotence_key' => 'shine-refund-1042',
    'metadata' => [
        'order_id' => 'SHINE-1042'
    ],
    'notes' => 'Refund for the rescheduled interior detail'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/transfers"

	payload := strings.NewReader("{\n  \"amount\": 25,\n  \"currency\": \"usd\",\n  \"destination_id\": \"user_xxxxxxxxxxxxxx\",\n  \"origin_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"type\": \"balance\",\n  \"feed_id\": \"feed_shineclub\",\n  \"feed_type\": \"chat_feed\",\n  \"idempotence_key\": \"shine-refund-1042\",\n  \"metadata\": {\n    \"order_id\": \"SHINE-1042\"\n  },\n  \"notes\": \"Refund for the rescheduled interior detail\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.whop.com/api/v1/transfers")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 25,\n  \"currency\": \"usd\",\n  \"destination_id\": \"user_xxxxxxxxxxxxxx\",\n  \"origin_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"type\": \"balance\",\n  \"feed_id\": \"feed_shineclub\",\n  \"feed_type\": \"chat_feed\",\n  \"idempotence_key\": \"shine-refund-1042\",\n  \"metadata\": {\n    \"order_id\": \"SHINE-1042\"\n  },\n  \"notes\": \"Refund for the rescheduled interior detail\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/transfers")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 25,\n  \"currency\": \"usd\",\n  \"destination_id\": \"user_xxxxxxxxxxxxxx\",\n  \"origin_id\": \"biz_xxxxxxxxxxxxxx\",\n  \"type\": \"balance\",\n  \"feed_id\": \"feed_shineclub\",\n  \"feed_type\": \"chat_feed\",\n  \"idempotence_key\": \"shine-refund-1042\",\n  \"metadata\": {\n    \"order_id\": \"SHINE-1042\"\n  },\n  \"notes\": \"Refund for the rescheduled interior detail\"\n}"

response = http.request(request)
puts response.read_body

{
  "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"
  },
  "failed_at": null,
  "failure_code": null,
  "failure_reason": null,
  "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",
  "status_changed_at": null,
  "succeeded_at": null,
  "tracking_url": "https://whop.com/ctt_xxxxxxxxxxxxxx/"
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

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

Idempotency-Key

string

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

Maximum string length: 255

Example:

"d9105228-4a08-46b1-8b91-42fed586d383"

Api-Version-Date

string

Pins the request to a dated API version.

Example:

"2026-10-09-2"

Body

application/json

CreateBalanceTransfer
CreateClaimLink

Moves credit between two Whop balances and returns a transfer. A transfer from a stablecoin-rails account settles on-chain when covered, and still returns a transfer.

amount

number

required

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

Example:

25

currency

string

required

Currency, such as usd.

Example:

"usd"

destination_id

string

required

The recipient. A user ID (user_xxx), account ID (biz_xxx), or ledger account ID (ldgr_xxx).

Example:

"user_xxxxxxxxxxxxxx"

origin_id

string

required

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

Example:

"biz_xxxxxxxxxxxxxx"

type

enum<string>

required

The kind of money movement.

Available options:

balance

Example:

"balance"

feed_id

string | null

The feed the transfer was initiated from. Given with feed_type, the payment receipt posts into that feed instead of a direct message.

Example:

"feed_shineclub"

feed_type

enum<string> | null

The type of the feed named by feed_id.

Available options:

dms_feed,

chat_feed,

forum_feed,

livestream_feed,

universal_post,

user,

null

Example:

"chat_feed"

idempotence_key

string | null

A unique key that makes retries safe. Retrying with the same key returns the original transfer instead of moving money twice.

Example:

"shine-refund-1042"

metadata

object | null

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

Example:

{ "order_id": "SHINE-1042" }

notes

string | null

A short note describing the transfer.

Example:

"Refund for the rescheduled interior detail"

Response

money movement created

Transfer
ClaimLink

A transfer between Whop accounts or users.

amount

object | null

required

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

Show child attributes

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.

Show child attributes

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.

Show child attributes

string

required

Transfer ID.

Example:

"ctt_xxxxxxxxxxxxxx"

metadata

object

required

Custom metadata attached to the transfer.

Example:

{ "order_id": "SHINE-1042" }

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.

Show child attributes

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/"