Skip to main content
POST
Child Address Get Quote
Include customerId when the deposit belongs to an existing customer and requires corridor-specific KYC. The provider adapter infers the corridor from the selected fiat currency. The response can include a provider schema in data.additionalDataRequirements.schema and reusable saved values in data.additionalDataRequirements.data. See Dynamic Forms for the schema-processing flow.
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

Existing deposit session. When supplied, the original route values are authoritative.

amountSide
enum<string>
default:target

source fixes the total fiat payable; target fixes the crypto amount to settle. Defaults to target.

Available options:
source,
target
customerId
string<uuid>

Optional existing active customer owned by the authenticated business. Omit for the business-owned flow. Start a new session to change customer identity. For inline KYC, validate saved values against additionalDataRequirements.schema; customer onboarding cannot unlock an inactive business provider.

assetId
string<uuid>

Stablecoin asset identifier returned by the supported-assets endpoint.

Example:

"ae455f23-3824-4125-baab-d158315cbcbd"

currency
string

ISO 4217 fiat currency code.

Required string length: 3
Example:

"NGN"

amount
string

Decimal amount encoded as a string to preserve precision.

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

"100.00"

rail
enum<string>

Payment collection rail.

Available options:
one_time_virtual_account,
payment_link,
qr_code
Example:

"one_time_virtual_account"

provider
string

Optional provider slug. Omit it to let Blockradar select an eligible provider.

Example:

"example-provider"

Response

Successful response.

message
string
required

Human-readable result.

Example:

"Deposit quote fetched successfully"

data
object
required
status
boolean
required
Example:

true