Get Sub-Merchant Onboarding Status

Endpoint: GET /v2/gc/sub-merchants/onboarding/{requestId}

Description: Retrieve the current status of a previously submitted sub-merchant onboarding application by its request ID.

Request

Request Body Field Descriptions (JSON)

Field Name	Type	Required	Description
N/A	N/A	N/A	GET request does not require a JSON body.

Request sample

// No request body required for this GET endpoint.

Response

Response Field Descriptions

Field Name	Type	Description
code	number	Response code.
state	number	State of the response.
data	object	Onboarding application status details.
message	string	Response message.
neoResponseId	string	Unique NeoX response identifier.

data object fields:

Field Name	Type	Description
requestId	string	The original merchant-supplied requestId for this onboarding application.
merchantId	string	NeoX merchant identifier for the parent merchant.
subMerchantId	string	NeoX identifier assigned to the sub-merchant.
status	string	Current onboarding status. Enum: PROCESS, SUCCESS, FAILED.
errCode	string	Error code if the onboarding application failed; empty when not applicable.
errMsg	string	Human-readable error description if the application failed; empty otherwise.

Response sample

{
  "code": 1,
  "state": 2,
  "data": {
    "requestId": "a3f1e2d4-1234-4c78-b9ab-0987654321cd",
    "merchantId": "MC-00012345",
    "subMerchantId": "SM-00098761",
    "status": "SUCCESS",
    "errCode": "",
    "errMsg": ""
  },
  "message": "Successful",
  "neoResponseId": "c9d4eb23-55fa-4b12-8a93-4f6789012345"
}

Example cURL

curl -X GET "https://{base_url_openapi}/v2/gc/sub-merchants/onboarding/{requestId}" \
  -H "Authorization: Bearer <YOUR_TOKEN>" \
  -H "Content-Type: application/json" \
  -H "Accept-Language: en"

Notes

• Requires Bearer token in the Authorization header.

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

• No request body required.

• Replace {requestId} with the actual requestId used when submitting the onboarding application.

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