Synchronize Master Merchant

This API is used to synchronize information of merchants under the master merchant.

Customers and partners who are not master merchants 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

ist of merchants to be synchronized.

merchantId

String

Yes

Merchant ID: (Set to null if it is a new synchronization)

merchantFullName

String

Yes

Merchant full name.

merchantName

String

Yes

Merchant abbreviation: Must not contain Vietnamese accents, spaces, or special characters.

merchantAddress

String

Yes

Business registration address.

merchantIdentity

String

Yes

Tax ID/ID card/Business registration certificate.

checkSum

String

Yes

MD5 hash string of the combination: (password + merchantName + merchantIdentity).

contactEmail

String

Optional

Contact email address of the merchant.

contactPhone

String

Optional

Contact phone number of the merchant.

career

String

Optional

Registered business industry.

Response

{
    "status": "SUCCESS",
    "data": [
        {
            "mid": "merchant_ID",
            "merchantName": "merchant_abbreviation"
        }
    ]
}

Sample

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 MERCHANTS TO BE SYNCHRONIZED
        {
            "merchantFullName": "full_name_of_the_merchant",
            "merchantName": "short_name_of_the_merchant",
            "merchantAddress": "merchant_address",
            "merchantIdentity": "tax_code",
            "contactEmail": "contact_email",
            "contactPhone": "contact_phone_number",
            "checkSum": "MD5 HASH 128bit of: password_get_token + merchant_name + merchantIdentity"
        }
    ]
}'

Last updated