Skip to main content
POST

Overview

Partners can decode a VietQR string or QR image URL into structured payment information — bank BIN code, destination account number, amount, and purpose. Pass exactly one of qr_string or qr_image_url per request.

Authentication

Partner-App-Key
string
required
Your partner app key.
X-HSPay-Signature
string
required
Base64-encoded Ed25519 signature of the sign data.
X-HSPay-Timestamp
string
required
Unix timestamp (seconds) of the request. Must be within 60 seconds of server time.

Body Parameters

qr_string
string
Raw VietQR string. Mutually exclusive with qr_image_url.
qr_image_url
string
HTTPS URL pointing to a QR code image. Mutually exclusive with qr_string.

Error Codes

When decoding fails, the response includes a non-zero error_code: