Skip to main content
POST
Child Address Execute
After reviewing the quote, execute it using the same session and payment method:
reference, metadata, and note are optional. Reuse reference when retrying the same withdrawal. An expired or missing quote requires a new Get Quote request. After switching payment methods, get and review a quote for the selected method before executing.

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

Execute the current quote using the same session and payment method. Optional reference, metadata, and note are stored with the transaction.

sessionId
string<uuid>
required

Session ID returned by v2 rates. Reuse it with the same authentication profile, business, and wallet.

paymentMethod
string
required

Payment-method id used to obtain the current quote in this withdrawal session. It must match the method you resolved and quoted.

Example:

"ae1f871a-f2cd-5eab-84bf-5240091d9767"

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"

Response

Successful response.

message
string
required

Human-readable result.

Example:

"Withdrawal initiated successfully"

data
object
required
status
boolean
required
Example:

true