Orders

Create a payout order

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.

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

Request

Base URL
https://api-sandbox.interlace.money
URL
https://api-sandbox.interlace.money/open-api/v3/scan2pay/orders/payout
Auth
API key in header x-access-token

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' | 'TOKEN'

QR input mode. RAW = raw QR payload, 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

qrContentstring

Raw QR payload, used when qrMode is RAW

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",
  "qrContent": "00020101021226600010com.vnpay..."
}

Response

Successful operation

codestring

Business code, 000000 means success

messagestring

Message description

Example response

{
  "code": "000000",
  "message": "success",
  "data": {
    "customerId": "1986466477083709441",
    "tradeNo": "1965738216225083393",
    "clientTradeNo": "ORD20260722000001",
    "fiatAmount": "100.5",
    "fiatCurrency": "VND",
    "country": "VN",
    "status": "READY",
    "description": "Customer payout order for Vietnam QR payment",
    "createTime": "1784683200000",
    "completeTime": "1784683265000",
    "type": "PAYMENT",
    "transaction": {
      "amount": "98.5",
      "currency": "USDT"
    },
    "fee": {
      "amount": "1.5",
      "currency": "USDT"
    },
    "statusCode": "SUCCESS",
    "statusMsg": "Transaction completed successfully"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.