Skip to content
BoxBilling

Request a wallet top-up

POST
/portal/wallet/{wallet_id}/top_up

Top up a customer’s wallet with credits.

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
wallet_id
required
Wallet Id
string format: uuid

Query Parameters

Section titled “Query Parameters ”
token
required
Token
string

Request Body required

Section titled “Request Body required ”
PortalTopUpRequest
object
credits
required
Any of:
number
> 0

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

PortalTopUpResponse
object
wallet_id
required
Wallet Id
string format: uuid
credits_added
required
Credits Added
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
new_balance_cents
required
New Balance Cents
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/
new_credits_balance
required
New Credits Balance
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

400

Section titled “400 ”

Wallet is not active or invalid credits

401

Section titled “401 ”

Invalid or expired portal token

404

Section titled “404 ”

Wallet not found

422

Section titled “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