➕Synchronize Points of Sale

Used to synchronize information of stores/points of sale.

POST API Sync TID

https://<vietqr-host>/<basepath>/api/tid/synchronize/v1

Headers

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

Body

If the partner provides the merchantId, there is no need to provide the merchantName.

Name	Type	Required	Description
terminals	List object	Yes	List of points of sale.
merchantId	String	Yes	Merchant ID.
merchantName	String	Yes	Merchant's short name.
terminalCode	String	Yes	Store/point of sale code.
terminalName	String	Yes	Store/point of sale name.
terminalAddress	String	Yes	Store/point of sale address.
bankCode	String	Yes	Bank code.
bankAccount	String	Yes	Bank account number.
checkSum	String	Yes	MD5 hash string of the combination: (password + bankCode + bankAccount)

Response

200

{
    "status": "SUCCESS",
    "data": [
        {
            "tid": "Store_ID",
            "terminalName": "Store_Name",
            "terminalCode": "Store_Code",
            "bankAccount": "Account_number_applied_for_store",
            "bankCode": "Bank_Code"
        }
    ]
}

400

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

---

Sample

cURL

curl --location 'https://api.vietqr.org/vqr/api/tid/synchronize/v1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhdXRob3JpdGllcyI6WyJST0xFX1VTRVIiXSwidXNlciI6IlkzVnpkRzl0WlhJdGJtZDFlV1Z1TFhWelpYSXlORGt5IiwiaWF0IjoxNzIwMDg4MDE3LCJleHAiOjE3MjAwODgwNzZ9.3_jljTg8llYVANJW4MVqW6YsJZbFl10r2AC66NNXCuSDWMyNYd2MlbnStNuyjHIqYDO5E5jD0izl4puPckYSyw' \
--header 'Cookie: JSESSIONID=EB9099326C4526CAA29AD331FFE6B789' \
--data '{
    "terminals": [ // LIST OF STORES OF THE MERCHANT THAT NEED TO BE SYNCED
        {
            "mid": "merchant_id", 
            "merchantName": "merchant_short_name", 
            "terminalName": "store_name",
            "terminalCode": "store_code",
            "terminalAddress": "store_address",
            "bankAccount": "bank_account_number",
            "bankCode": "bank_code",
            "checkSum": "HASHMD5 128 bit of: token_get_password + bank_code + bankAccount" 
        }
    ]
}'