Skip to main content
PUT
Update a wallet

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

Update wallet request

alert_settings
object
auto_topup
object
config
object
description
string
metadata
object
name
string

Response

OK

alert_settings
object
alert_state
enum<string>
Available options:
ok,
info,
warning,
in_alarm
auto_topup
object
balance
string
config
object
conversion_rate
string

amount in the currency = number of credits * conversion_rate ex if conversion_rate is 1, then 1 USD = 1 credit ex if conversion_rate is 2, then 1 USD = 0.5 credits ex if conversion_rate is 0.5, then 1 USD = 2 credits

created_at
string<date-time>
created_by
string
credit_balance
string
credits_available_breakdown
object
currency
string
customer_id
string
description
string
environment_id
string
id
string
metadata
object
name
string
real_time_balance
string
real_time_credit_balance
string
status
enum<string>
Available options:
published,
deleted,
archived
tenant_id
string
topup_conversion_rate
string

topup_conversion_rate is the conversion rate for the topup to the currency ex if topup_conversion_rate is 1, then 1 USD = 1 credit ex if topup_conversion_rate is 2, then 1 USD = 0.5 credits ex if topup_conversion_rate is 0.5, then 1 USD = 2 credits

updated_at
string<date-time>
updated_by
string
wallet_status
enum<string>
Available options:
active,
frozen,
closed
wallet_type
enum<string>
Available options:
PRE_PAID,
POST_PAID