➕Synchronize master agent

This API is used to synchronize the information of agents under the master agent.

Customers and partners who are not under the master agent category can skip this step.

POST API Sync MID

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

Headers

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

Body

Name	Type	Required	Description
merchants	List object	Yes	List of agents to be synchronized.
merchantId	String	Yes	Agent ID. (Set to null if it is a new synchronization)
merchantFullName	String	Yes	Agent name.
merchantName	String	Yes	Agent short name. Must not contain Vietnamese accents, spaces, or special characters.
merchantAddress	String	Yes	Registered business address.
merchantIdentity	String	Yes	Tax Identification Number (MST) / Citizen Identification Number (CCCD) / Business Registration Number (ĐKKD)
checkSum	String	Yes	MD5 hash string of the combination: (password + merchantName + merchantIdentity) (password+ merchantName+merchantIdentity)
contactEmail	String	Optional	Agent’s contact email address.
contactPhone	String	Optional	Agent’s contact phone number.
career	String	Optional	Registered business industry.

Response

200

{
    "status": "SUCCESS",
    "data": [
        {
            "mid": "ID_đại_lý",
            "merchantName": "tên_rút_gọn_đại_lý"
        }
    ]
}

400

{
    "status": "FAILED",
    "message": "mã_lỗi_và_mô_tả_lỗi"
}

Sample Code

cURL

curl --location 'https://api.vietqr.org/vqr/api/mid/synchronize/v1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhdXRob3JpdGllcyI6WyJST0xFX1VTRVIiXSwidXNlciI6IlkzVnpkRzl0WlhJdGJtZDFlV1Z1TFhWelpYSXlORGt5IiwiaWF0IjoxNzIxMzc1MzUzLCJleHAiOjE3MjEzNzU2NTN9.Wi5BTmJ63f7h_p7rimfaycfGIs4TNBkzVGlCUSkOxzWU-QaYZF3rCNndlgPjO89LpRmU3VliSYcf5iHHNrnC7A' \
--header 'Cookie: JSESSIONID=068E5AFD023BFA9AAFBA841C0BF00B62' \
--data-raw '{
    "merchants": [ // List of stores to be synchronized.
        {
            "merchantFullName": "Full name of the agent.",
            "merchantName": "Abbreviated name.",
            "merchantAddress": "Agent’s address.",
            "merchantIdentity": "Tax Identification Number.",
            "contactEmail": "Contact email",
            "contactPhone": "Contact phone number",
            "checkSum": "HASHMD5 128bit của: mật_khẩu_get_token + merchant_name + merchantIdentity"
        }
    ]
}'

Frequently Asked Questions (FAQs)