Skip to main content
POST
Child Address Create Payment Order
Send the object completed from the quote’s requirements schema as additionalData. With a session, the customerId supplied to the quote is inherited by the order. Inline KYC submitted for an existing customer is saved for reuse by the same provider and corridor.
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 deposit quote. Recommended instead of resending routing fields.

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
currency
string
deprecated

ISO 4217 fiat currency paid by the customer.

Required string length: 3
Example:

"NGN"

assetId
string<uuid>
deprecated

Stablecoin asset to settle.

Example:

"ae455f23-3824-4125-baab-d158315cbcbd"

amount
string
deprecated

Stablecoin amount to receive, encoded as a decimal string.

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

"100.00"

rail
enum<string>
deprecated

Collection method. Use one of the rails returned by the rails endpoint.

Available options:
one_time_virtual_account,
payment_link,
qr_code
reference
string

Unique client reference used for reconciliation and safe retries.

Maximum string length: 250
Example:

"dep_20260719_001"

validityTimeMinutes
number

Time before the payment instructions expire.

Required range: 30 <= x <= 1440
Example:

30

code
string
passkeyResponse
object
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.

customer
object

Optional payer contact details (name/email/phone); not a substitute for customerId and provider customer onboarding.

additionalData
object

Values collected from the quote requirements schema.

Example:
metadata
object

Your application metadata returned with the order.

Example:
provider
string
deprecated

Optional provider slug. Omit for automatic routing.

Example:

"example-provider"

Response

Created successfully.

message
string
required

Human-readable result.

Example:

"Payment order created successfully"

data
object
required
status
boolean
required
Example:

true