Skip to main content
POST
Child Address Execute
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
customerId
string<uuid>

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

assetId
string<uuid>
deprecated
amount
string
deprecated
Pattern: ^\d+(\.\d+)?$
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
Required string length: 3
paymentMethodData
object
isGaslessWithdraw
boolean
reference
string

Unique client reference used for reconciliation and safe retries.

Example:

"wd_20260719_001"

metadata
object

Your application metadata.

Example:
note
string

Human-readable transaction note.

Example:

"Vendor payout"

provider
string
deprecated
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.

code
string

2FA code, when required.

passkeyResponse
object

WebAuthn assertion, when required.

Response

Successful response.

message
string
required

Human-readable result.

Example:

"Withdrawal initiated successfully"

data
object
required
status
boolean
required
Example:

true