Saltar al contenido principal
POST
Child Address Get Quote
Para identidad, sesiones, recuperación y comisiones, consulte Flujos fiat para clientes.

Autorizaciones

x-api-key
string
header
requerido

Parámetros de ruta

walletId
string<uuid>
requerido

Wallet identifier.

addressId
string<uuid>
requerido

Child address identifier.

Cuerpo

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>
requerido

Session ID returned by the v2 rates endpoint.

paymentMethod
string
requerido

Payment-method id returned by discovery.

Ejemplo:

"bank_transfer"

customerId
string<uuid>

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

assetId
string<uuid>
obsoleto

Stablecoin asset identifier.

Ejemplo:

"ae455f23-3824-4125-baab-d158315cbcbd"

amount
string
obsoleto

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

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

"100.00"

amountSide
enum<string>
predeterminado: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.

Opciones disponibles:
source,
target
currency
string
obsoleto

ISO 4217 payout currency.

Required string length: 3
Ejemplo:

"NGN"

paymentMethodData
object

Values validated against the payment-method requirements schema.

Ejemplo:
isGaslessWithdraw
boolean

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

Ejemplo:

false

provider
string
obsoleto

Optional provider slug. Omit for automatic routing.

Ejemplo:

"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.

Respuesta

Created successfully.

message
string
requerido

Human-readable result.

Ejemplo:

"Withdrawal quote fetched successfully"

data
object
requerido
status
boolean
requerido
Ejemplo:

true