> For the complete documentation index, see [llms.txt](https://docs.neox.vn/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.neox.vn/docs/global/global-collections/integration/sub-merchants/get-sub-merchant-report-status.md).

# Get Sub-Merchant Report Status

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

#### Description: Retrieve the current status of a previously submitted sub-merchant report 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

```json
// 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 | Sub-merchant report status details. |
| message       | string | Response message.                   |
| neoResponseId | string | Unique NeoX response identifier.    |

#### `data` object fields:

| Field Name    | Type   | Description                                                                                       |
| ------------- | ------ | ------------------------------------------------------------------------------------------------- |
| merchantId    | string | NeoX merchant identifier for the parent merchant.                                                 |
| requestId     | string | The original merchant-supplied `requestId` for this report submission.                            |
| subMerchantId | string | NeoX identifier assigned to the sub-merchant.                                                     |
| bankInfos     | array  | List of bank account records associated with the sub-merchant. See `bankInfos` item fields below. |
| status        | string | Current report status. Enum: `TO_BE_REVIEW`, `ACTIVATED`, `AUDIT_REJECT`, `PROCESSING`.           |

#### `bankInfos` object item fields:

| Field Name      | Type   | Description                                             |
| --------------- | ------ | ------------------------------------------------------- |
| accountType     | string | Type of bank account. Enum: `PUBLIC`, `PRIVATE`.        |
| bankAccountName | string | Name of the account holder as registered with the bank. |
| bankCardNumber  | string | Bank card number associated with the account.           |
| payeeCardNumber | string | Payee card number used for receiving funds.             |

#### Response sample

```json
{
  "code": 1,
  "state": 2,
  "data": {
    "merchantId": "MC-00012345",
    "requestId": "d5e6f7a8-2345-4d89-cabc-1122334455ee",
    "subMerchantId": "SM-00098762",
    "bankInfos": [
      {
        "accountType": "PUBLIC",
        "bankAccountName": "Bright Star Commerce Ltd",
        "bankCardNumber": "62260000123456789",
        "payeeCardNumber": "62260000987654321"
      }
    ],
    "status": "ACTIVATED"
  },
  "message": "Successful",
  "neoResponseId": "f2a3b4c5-77dc-4d34-ae15-6b8901234567"
}
```

## Example cURL

```bash
curl -X GET "https://{base_url_openapi}/v2/gc/sub-merchants/report/{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 sub-merchant report.
* Poll this endpoint to check the report result when a `notifyUrl` was not provided, or as a fallback to the `SUB_MERCHANT` webhook notification.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.neox.vn/docs/global/global-collections/integration/sub-merchants/get-sub-merchant-report-status.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
