Skip to content

Create wallet

POST
/v1/wallets/

Create a wallet for a customer.

WalletCreate
object
customer_id
required
Customer Id
string format: uuid
name
Any of:
string
<= 255 characters
code
Any of:
string
<= 255 characters
rate_amount
Any of:
number
> 0
currency
Currency
string
default: USD >= 3 characters <= 3 characters
expiration_at
Any of:
string format: date-time
priority
Priority
integer
default: 1 >= 1 <= 50
initial_granted_credits
Any of:
number

Successful Response

WalletResponse
object
id
required
Id
string format: uuid
customer_id
required
Customer Id
string format: uuid
name
Any of:
string
code
Any of:
string
status
required
Status
string
balance_cents
required
Balance Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
credits_balance
required
Credits Balance
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
consumed_amount_cents
required
Consumed Amount Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
consumed_credits
required
Consumed Credits
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
rate_amount
required
Rate Amount
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
currency
required
Currency
string
expiration_at
Any of:
string format: date-time
priority
required
Priority
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time

Invalid customer reference or validation error

Unauthorized – invalid or missing API key

Validation error