Create a payout order

post

https://api-sandbox.interlace.money/open-api/v3/scan2pay/orders/payout

Creates a payout order by submitting the customer, amount, currency,
and either raw QR content or a QR parse token. Returns the Interlace
order number and the current order status.

For request structures and examples for each QR input mode, see the
Create Payout Order Request Resource.
For the response structure, see the
Payout Order Resource.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

customerId

string

required

Numeric string representing a 64-bit Interlace customer identifier

clientTradeNo

string

required

length between 10 and 64

Client-generated order number, unique for idempotency

fiatAmount

string

required

Payout amount in decimal string format, up to 6 decimal places

fiatCurrency

string

required

length between 3 and 4

Payout currency (ISO 4217)

country

string

required

length between 2 and 2

Payout country code (ISO 3166-1 alpha-2)

qrMode

string

enum

Defaults to RAW

QR input mode. RAW = raw QR payload, TOKEN = QR parse token returned by the QR parse API

Allowed:

qrToken

string

length between 0 and 128

QR parse token returned by the QR parse API. Required when qrMode is TOKEN

qrContent

string

length between 0 and 10240

Raw QR payload, used when qrMode is RAW

extendInfo

object

Client-defined metadata echoed in subsequent order queries; not used for payment routing

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200Successful operation

400Bad Request