Check Transaction

Used to inquire about information on transactions that have been conducted.

POST

https://<vietqr-host>/<basepath>/api/transactions/check-order

Headers

Name	Value
Content-Type	application/json
Authorization	Bearer <token>

Body

Name	Type	Required	Description
bankAccount	String	Yes	Transaction bank account
type	String	Yes	Check by orderId: 0 Check by referenceNumber: 1
value	String	Yes	Value isorderId if type = 0 Value isreferenceNumber if type = 1
checkSum	String	Yes	Encrypted String MD5 of combination: (bankAccount + username)

Response

200

[
    {
        "referenceNumber": "transaction_id",
        "orderId": "order_id",
        "amount": transaction_amount,
        "content": "payment_content",
        "transType": "incoming_or_outgoing_transaction",
        "status": transaction_status_classification_by_number,
        "type": transaction_classification_by_number,
        "timeCreated": QR_code_creation_timestamp,
        "timePaid": payment_timestamp,
        "terminalCode": "point_of_sale_code",
        "note": "transaction_note",
        "refundCount": number_of_refunds_for_this_transaction,
        "amountRefunded": amount_refunded_for_this_transaction
    }
]

Return values for type:

• 0: Transaction from the VietQR system.

• 2: Transaction outside the VietQR system.

• 6: Refund transaction.

Return values for status:

• 0: Transaction pending payment.

• 1: Transaction paid.

• 2: Transaction payment expired.

400

{
    "status": "FAILED",
    "message": "error_code_and_description"
}