Skip to content

Transfer credits between wallets

POST
/v1/wallets/transfer

Transfer credits from one wallet to another.

WalletTransferRequest
object
source_wallet_id
required
Source Wallet Id
string format: uuid
target_wallet_id
required
Target Wallet Id
string format: uuid
credits
required
Any of:
number
> 0

Successful Response

WalletTransferResponse
object
source_wallet
required
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
target_wallet
required
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
credits_transferred
required
Credits Transferred
string
/^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$/

Invalid transfer request

Unauthorized – invalid or missing API key

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