Get Sub-Merchant Onboarding Status

Endpoint: GET /v2/gc/sub-merchants

Description: Retrieve the full detail record of a previously submitted sub-merchant by requestId, including its current status.

Request

Request Query Parameter Descriptions

Field Name	Type	Required	Description
requestId	string	Yes	The requestId used in the original Onboard Sub-Merchant submission.

GET /v2/gc/sub-merchants?requestId=1785378822666

Response

Response Field Descriptions

Field Name	Type	Description
code	number	Response code.
data	object	Sub-merchant detail record.
message	string	Response message.

data object fields:

Field Name	Type	Description
(all Onboard Sub-Merchant request fields)	—	Every field from the Onboard Sub-Merchant request table is echoed back 1:1.
id	string	Internal sub-merchant record identifier.
requestId	string	The requestId used in the original onboarding submission.
subMerchantId	string	Platform-assigned sub-merchant identifier (populated once the application has been processed).
status	string	Current sub-merchant status. Full enum per the Merchant Portal frontend's SUB_MERCHANT_STATUS: INIT, PENDING, PROCESSING, APPROVED, SUPPLEMENT_SUBMITTED, WAIT_SUPPLEMENT, REJECTED.

Response sample

{
    "code": 1,
    "data": {
        "id": "b212afb2e0eb4881bddae82fc07b58eb",
        "requestId": "1785807917468",
        "subMerchantId": "46000002",
        "status": "APPROVED",
        "userType": "COMPANY",
        "mobile": "0911111009",
        "mobileAreaCode": "84",
        "email": "[e-mail]",
        "regCountry": "VNM",
        "englishName": "Example Trading API 09",
        "incorporationCertNo": "01111111009",
        "createDate": "2022-10-22",
        "effectiveDate": "2022-10-10",
        "expiryDate": "9999-12-31",
        "regAddress": "123 Example St, Hanoi",
        "businessCountry": "VNM",
        "businessAddress": "123 Example St, Hanoi",
        "companyType": "LIMITED_COMPANY",
        "website": "https://example.com",
        "sourceType": "API",
        "industryCategory": "EC",
        "serviceCategory": [
            "EC_CLOTHING_BAGS"
        ],
        "businessRegion": [
            "VNM",
            "USA"
        ],
        "employeeRank": "B",
        "salesVolumeRank": "B",
        "wealthSource": [
            "BUSINESS_INCOME"
        ],
        "fundsSource": [
            "BUSINESS_INCOME"
        ],
        "franchiseBiz": [],
        "supplyServiceType": [],
        "middleShareholders": [],
        "merchantNetinPersons": [
            {
                "type": "ADMIN",
                "idDetailCode": "PASSPORT",
                "name": "Nguyen Van A",
                "idNumber": "P1234567",
                "birthDate": "1990-01-01",
                "idAddress": "Hanoi",
                "effectiveDate": "2020-01-01",
                "expiryDate": "2030-01-01",
                "address": "Hanoi",
                "country": "VNM"
            },
            {
                "type": "SHAREHOLDER",
                "idDetailCode": "PASSPORT",
                "name": "Tran Thi B",
                "idNumber": "P7654321",
                "birthDate": "1985-05-05",
                "idAddress": "HCMC",
                "effectiveDate": "2020-01-01",
                "expiryDate": "2030-01-01",
                "address": "HCMC",
                "country": "VNM",
                "shareholderRatio": "30"
            },
            {
                "type": "DIRECTOR",
                "idDetailCode": "PASSPORT",
                "name": "Le Van C",
                "idNumber": "P1112223",
                "birthDate": "1980-03-03",
                "idAddress": "Hanoi",
                "effectiveDate": "2020-01-01",
                "expiryDate": "2030-01-01",
                "address": "Hanoi",
                "country": "VNM",
                "shareholderRatio": "30"
            }
        ],
        "kycFiles": [
            {
                "type": "BUSINESS_LICENSE",
                "path": "1781834930316-test.png"
            }
        ]
    },
    "message": "Successful",
    "neoResponseId": "79e6dce6-5742-4dc7-bb8a-ff1c2a6f7c4e"
}

Notes

• Requires Bearer token in the Authorization header.

• The Accept-Language header can be used to specify the response language (Support: "vi", "en").

• subMerchantId may be empty until the application has been reviewed.

• Poll this endpoint to check the onboarding result when a webhookUrl was not provided, or as a fallback to the SUBMERCHANT_ONBOARDING_RESULT webhook.