v1

latestOpenAPI 3.0.12026-07-24128351404.9 KB

Orders

Create a payout order

Creates a payout order by submitting the customer, amount, currency, and either QR data or structured recipient information. Returns the Interlace order number and the current order status.

post/open-api/v3/scan2pay/orders/payout

Request body

customerIdstring required

Numeric string representing a 64-bit Interlace customer identifier

clientTradeNostring required

Client-generated order number, unique for idempotency

fiatAmountstring required

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

fiatCurrencystring required

Payout currency (ISO 4217)

countrystring required

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

qrMode'RAW' | 'DATA' | 'TOKEN'

QR input mode. RAW = raw QR payload, DATA = structured QR or recipient data, TOKEN = QR parse token returned by the QR parse API

qrTokenstring

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

extendInfoobject

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

Example request

{
  "customerId": "1986466477083709441",
  "clientTradeNo": "MERCHANT_ORDER_20250120123456789",
  "fiatAmount": "100.5",
  "fiatCurrency": "VND",
  "country": "VN",
  "qrMode": "RAW",
  "qrInfo": {
    "content": "00020101021226600010com.vnpay..."
  }
}

Response

Successful operation