Wallets
Top up wallet
Customers
Wallets
Invoices
Entitlements
Environments
Events
Features
Payments
Integrations
Subscriptions
Tenants
Users
Wallets
Top up wallet
Add credits to a wallet
POST
/
wallets
/
{id}
/
top-up
curl --request POST \
--url https://api.cloud.flexprice.io/v1/wallets/{id}/top-up \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"amount": 123,
"credits_to_add": 123,
"description": "<string>",
"expiry_date_utc": "<string>",
"idempotency_key": "<string>",
"metadata": {},
"transaction_reason": "INVOICE_PAYMENT"
}'
{
"auto_topup_amount": 123,
"auto_topup_min_balance": 123,
"auto_topup_trigger": "disabled",
"balance": 123,
"config": {
"allowed_price_types": [
"ALL"
]
},
"conversion_rate": 123,
"created_at": "<string>",
"credit_balance": 123,
"currency": "<string>",
"customer_id": "<string>",
"description": "<string>",
"id": "<string>",
"metadata": {},
"name": "<string>",
"updated_at": "<string>",
"wallet_status": "active",
"wallet_type": "PROMOTIONAL"
}
Authorizations
Enter your API key in the format x-api-key <api-key>*
Path Parameters
Wallet ID
Body
application/json
Top up request
The body is of type object
.
Response
200
application/json
OK
The response is of type object
.
curl --request POST \
--url https://api.cloud.flexprice.io/v1/wallets/{id}/top-up \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"amount": 123,
"credits_to_add": 123,
"description": "<string>",
"expiry_date_utc": "<string>",
"idempotency_key": "<string>",
"metadata": {},
"transaction_reason": "INVOICE_PAYMENT"
}'
{
"auto_topup_amount": 123,
"auto_topup_min_balance": 123,
"auto_topup_trigger": "disabled",
"balance": 123,
"config": {
"allowed_price_types": [
"ALL"
]
},
"conversion_rate": 123,
"created_at": "<string>",
"credit_balance": 123,
"currency": "<string>",
"customer_id": "<string>",
"description": "<string>",
"id": "<string>",
"metadata": {},
"name": "<string>",
"updated_at": "<string>",
"wallet_status": "active",
"wallet_type": "PROMOTIONAL"
}