Skip to main content
POST
Child Address Get Quote
For customer identity, session binding, onboarding recovery and fee semantics, see Customer fiat flows.

Authorizations

x-api-key
string
header
required

Path Parameters

walletId
string<uuid>
required

Wallet identifier.

addressId
string<uuid>
required

Child address identifier.

Body

application/json

Supply sessionId, or all original routing fields. Repeated fields must match the session. Customer identity is inherited from the session.

sessionId
string<uuid>
required

Session ID returned by the v2 rates endpoint.

paymentMethod
string
required

Payment-method id returned by discovery.

Example:

"bank_transfer"

customerId
string<uuid>

ID of an existing active customer owned by the authenticated business.

assetId
string<uuid>
deprecated

Stablecoin asset identifier.

Example:

"ae455f23-3824-4125-baab-d158315cbcbd"

amount
string
deprecated

Amount as a decimal string. Interpreted as the stablecoin amount to send or the fiat amount to deliver, depending on amountSide.

Pattern: ^\d+(\.\d+)?$
Example:

"100.00"

amountSide
enum<string>
default:source

source fixes the total source-asset budget, with fees allocated inside it; target fixes the fiat payout before beneficiary deductions and derives the required source debit.

Available options:
source,
target
currency
string
deprecated

ISO 4217 payout currency.

Required string length: 3
Example:

"NGN"

paymentMethodData
object

Values validated against the payment-method requirements schema.

Example:
isGaslessWithdraw
boolean

Whether Blockradar should sponsor the on-chain gas where supported.

Example:

false

provider
string
deprecated

Optional provider slug. Omit for automatic routing.

Example:

"example-provider"

resolvedPaymentMethod
object

Completed payment-method resolution, including the provider resolutionId. Required when the provider returned a resolution session. Complete every nextStep before quoting or executing.

Response

Created successfully.

message
string
required

Human-readable result.

Example:

"Withdrawal quote fetched successfully"

data
object
required
status
boolean
required
Example:

true