Getting started
Authentication
Resources
- Access Passes
- Attachments
- Authentication
- Chats
- Companies
- Direct Messages
- Experiences
- Forums
- Notifications
- Payments
- Users
Payments
Pay User
This operation is only available on the server.
Copy
import { whopApi } from "@/lib/whop-api";
const result = await whopApi.payUser({
input: {
// The amount to withdraw
amount: 10 /* Required! */,
// The currency that is being withdrawn.
currency:
"aed" /* Valid values: aed | all | amd | ape | ars | aud | bam | bgn | bhd | bob | brl | bsd | cad | chf | clp | cop | crc | czk | dkk | dop | dzd | egp | etb | eth | eur | gbp | ghs | gmd | gtq | gyd | hkd | huf | idr | ils | inr | jmd | jod | jpy | kes | khr | krw | kwd | lkr | mad | mdl | mga | mkd | mnt | mop | mur | mxn | myr | nad | ngn | nok | nzd | omr | pen | php | pkr | pln | pyg | qar | ron | rsd | rub | rwf | sar | sek | sgd | thb | tnd | try | ttd | twd | tzs | usd | uyu | uzs | vnd | xcd | xof | zar */ /* Required! */,
// The ID of the destination (either a User tag, Bot tag, or LedgerAccount tag)
destinationId: "xxxxxxxxxxx" /* Required! */,
// The feed identifier to notify of the transfer.
feedId: "feed_XXXXXXXX",
// The feed type to notify of the transfer.
feedType:
"chat_feed" /* Valid values: chat_feed | dms_feed | forum_feed | livestream_feed | universal_post | user */,
// A unique key to ensure idempotence. Use a UUID or similar.
idempotenceKey: "some string" /* Required! */,
// The ledger account id to transfer from.
ledgerAccountId: "ldgr_XXXXXXXX" /* Required! */,
// Notes for the transfer. Maximum of 50 characters.
notes: "some string",
// The reason for the transfer.
reason:
"bounty_payout" /* Valid values: bounty_payout | content_reward_fixed_payout | content_reward_payout | content_reward_return | creator_to_creator | creator_to_user | pool_top_up | team_member_payout | user_to_creator | user_to_user | wadmin_transferred_funds */,
// The fee that the client thinks it is being charged for the transfer. Used to verify the fee.
transferFee: 10,
},
});
Example output:
Copy
const response = {
// Transfers funds between ledger accounts
transferFunds: true,
};
Was this page helpful?
Assistant
Responses are generated using AI and may contain mistakes.