Top up wallet

POST

/v1/wallets/{wallet_id}/top_up

Top up a wallet with credits.

Parameters

Path Parameters

wallet_id

required

Wallet Id

string format: uuid

Request Body ^required

WalletTopUp

object

credits

required

Any of:

number

number

> 0

string

string

/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

source

Source

string

default: manual /^(manual|interval|threshold)$/

Responses

200

Successful Response

WalletResponse

object

id

required

Id

string format: uuid

customer_id

required

Customer Id

string format: uuid

name

Any of:

string

string

null

null

code

Any of:

string

string

null

null

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

string format: date-time

null

null

priority

required

Priority

integer

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

400

Invalid top-up amount or wallet state

401

Unauthorized – invalid or missing API key

422

Validation Error

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

input

Input

ctx

Context

object