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,
  "description": "<string>",
  "expiry_date": 123,
  "generate_invoice": true,
  "metadata": {},
  "purchased_credits": true,
  "reference_id": "<string>",
  "reference_type": "<string>"
}'
{
  "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

​
x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

​
id
string
required

Wallet ID

Body

application/json
Top up request
​
amount
number
required

amount is the number of credits to add to the wallet

​
description
string

description to add any specific details about the transaction

​
expiry_date
integer

expiry_date YYYYMMDD format in UTC timezone (optional to set nil means no expiry) for ex 20250101 means the credits will expire on 2025-01-01 00:00:00 UTC hence they will be available for use until 2024-12-31 23:59:59 UTC

​
generate_invoice
boolean

generate_invoice when true, an invoice will be generated for the transaction

​
metadata
object
​
purchased_credits
boolean

purchased_credits when true, the credits are added as purchased credits

​
reference_id
string

reference_id is the ID of the reference ex payment ID, invoice ID, request ID

​
reference_type
string

reference_type is the type of the reference ex payment, invoice, request

Response

200
application/json
OK
​
auto_topup_amount
number
​
auto_topup_min_balance
number
​
auto_topup_trigger
enum<string>
Available options:
disabled,
balance_below_threshold
​
balance
number
​
config
object
​
conversion_rate
number
​
created_at
string
​
credit_balance
number
​
currency
string
​
customer_id
string
​
description
string
​
id
string
​
metadata
object
​
name
string
​
updated_at
string
​
wallet_status
enum<string>
Available options:
active,
frozen,
closed
​
wallet_type
enum<string>
Available options:
PROMOTIONAL,
PRE_PAID