INinterlace
Common

Parse QR content

Parses raw QR payload content and returns a normalized representation of the payment data. Optional customer and fiat currency inputs can be supplied to apply country- or channel-specific parsing rules.

customerId is optional for parsing-only requests. It is required if the returned qrToken will be used to create a payout order with qrMode set to TOKEN, because the token is associated with the specified customer.

For the request structure, see the QR Parse Request Resource. For the response structure, see the QR Parse Response Resource.

post/open-api/v3/scan2pay/common/qr/parse

Request

  • Base URL
    https://api-sandbox.interlace.money
  • URL
    https://api-sandbox.interlace.money/open-api/v3/scan2pay/common/qr/parse
  • Auth
    API key in header x-access-token

Request body

qrContentstring

Raw QR payload content

customerIdstring

Numeric string representing a 64-bit Interlace customer identifier. Optional for parsing-only requests; required if the returned qrToken will be used to create a payout order with qrMode set to TOKEN, because the token is associated with the specified customer

fiatCurrencystring

Optional transaction currency (ISO 4217) used to assist QR parsing

Example request

{
  "qrContent": "00020101021138560010A0000007270126000697040701128888123456780208QRIBFTTA53037045802VN63042249",
  "customerId": "1986466477083709441",
  "fiatCurrency": "VND"
}

Response

Successful operation

codestring

Business code, 000000 means success

messagestring

Message description

Example response

{
  "code": "000000",
  "message": "success",
  "data": {
    "country": "VN",
    "transactionCurrency": "VND",
    "transactionAmount": "100000.0",
    "bankCode": "970407",
    "bankAccountNumber": "888812345678",
    "bankName": "Techcombank",
    "merchantName": "INTERLACE SHOP",
    "qrType": "VIET_QR",
    "content": "00020101021138560010A0000007270126000697040701128888123456780208QRIBFTTA53037045802VN63042249",
    "crc": "2249",
    "merchantCategoryCode": "0000",
    "dynamic": true,
    "qrToken": "qr_token_abc123"
  }
}

Changes

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