Skip to main content
POST
/
topups
Create topup
curl --request POST \
  --url https://api.whop.com/api/v1/topups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 6.9,
  "company_id": "biz_xxxxxxxxxxxxxx",
  "currency": "usd",
  "payment_method_id": "pmt_xxxxxxxxxxxxxx"
}
'
{
  "id": "pay_xxxxxxxxxxxxxx",
  "status": "draft",
  "created_at": "2023-12-01T05:00:00.401Z",
  "paid_at": "2023-12-01T05:00:00.401Z",
  "currency": "usd",
  "total": 6.9,
  "billing_reason": "subscription_create",
  "failure_message": "<string>"
}

Authorizations

​
Authorization
string
header
required

The app API key from an app from the /dashboard/developer page

Body

application/json

Parameters for CreateTopup

​
amount
number
required

The amount to add to the balance.

Example:

6.9

​
company_id
string
required

The ID of the company to add funds to.

Example:

"biz_xxxxxxxxxxxxxx"

​
currency
enum<string>
required

The currency of the top-up.

Available options:
usd,
sgd,
inr,
aud,
brl,
cad,
dkk,
eur,
nok,
gbp,
sek,
chf,
hkd,
huf,
jpy,
mxn,
myr,
pln,
czk,
nzd,
aed,
eth,
ape,
cop,
ron,
thb,
bgn,
idr,
dop,
php,
try,
krw,
twd,
vnd,
pkr,
clp,
uyu,
ars,
zar,
dzd,
tnd,
mad,
kes,
kwd,
jod,
all,
xcd,
amd,
bsd,
bhd,
bob,
bam,
khr,
crc,
xof,
egp,
etb,
gmd,
ghs,
gtq,
gyd,
ils,
jmd,
mop,
mga,
mur,
mdl,
mnt,
nad,
ngn,
mkd,
omr,
pyg,
pen,
qar,
rwf,
sar,
rsd,
lkr,
tzs,
ttd,
uzs,
rub,
btc,
cny
​
payment_method_id
string
required

The ID of the payment method to charge for the top-up.

Example:

"pmt_xxxxxxxxxxxxxx"

Response

A successful response

An object representing a receipt for a membership.

​
id
string
required

The payment ID

Example:

"pay_xxxxxxxxxxxxxx"

​
status
enum<string> | null
required

The current state of the payment.

Available options:
draft,
open,
paid,
pending,
uncollectible,
unresolved,
void
​
created_at
string<date-time>
required

The datetime the payment was created

Example:

"2023-12-01T05:00:00.401Z"

​
paid_at
string<date-time> | null
required

The datetime the payment was paid

Example:

"2023-12-01T05:00:00.401Z"

​
currency
enum<string> | null
required

The currency of the payment.

Available options:
usd,
sgd,
inr,
aud,
brl,
cad,
dkk,
eur,
nok,
gbp,
sek,
chf,
hkd,
huf,
jpy,
mxn,
myr,
pln,
czk,
nzd,
aed,
eth,
ape,
cop,
ron,
thb,
bgn,
idr,
dop,
php,
try,
krw,
twd,
vnd,
pkr,
clp,
uyu,
ars,
zar,
dzd,
tnd,
mad,
kes,
kwd,
jod,
all,
xcd,
amd,
bsd,
bhd,
bob,
bam,
khr,
crc,
xof,
egp,
etb,
gmd,
ghs,
gtq,
gyd,
ils,
jmd,
mop,
mga,
mur,
mdl,
mnt,
nad,
ngn,
mkd,
omr,
pyg,
pen,
qar,
rwf,
sar,
rsd,
lkr,
tzs,
ttd,
uzs,
rub,
btc,
cny
​
total
number | null
required

The total to show to the creator (excluding buyer fees).

Example:

6.9

​
billing_reason
enum<string> | null
required

The reason for the charge.

Available options:
subscription_create,
subscription_cycle,
subscription_update,
one_time,
manual,
subscription
​
failure_message
string | null
required

If the payment failed, the reason for the failure.