> 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/collections/api-supplement-recharge-information.md).

# Supplement Recharge Information

#### Endpoint: POST /v2/gc/collection-orders/{collectionOrderId}/recharge-information

#### Description: Provide funds-nature classification and supporting documents for a recharge collection order that requires supplementary material before it can be processed.

## Request

#### Request Body Field Descriptions (JSON)

| Field Name      | Type   | Required | Description                                                                                                                                             |
| --------------- | ------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| requestId       | string | Yes      | Merchant-generated unique request ID (*UUID recommended*). Used for idempotency.                                                                        |
| fundsNatureList | array  | Yes      | List of funds-nature classification codes describing the purpose of the recharge. Enum values: `LOGISTICS_COST`, `GOODS_TRADE`, `OTHER_SERVICE_TRADE`.  |
| otherFiles      | array  | Yes      | List of supporting document file paths. Each element is a `path` returned by the File Upload API (`POST /v2/gc/files/upload`).                          |
| contractFiles   | array  | No       | List of contract document file paths to supplement the recharge. Each element is a `path` returned by the File Upload API (`POST /v2/gc/files/upload`). |

#### Request sample

```json
{
  "requestId": "f1a2b3c4-5678-4def-a901-234567890abc",
  "fundsNatureList": [
    "GOODS_TRADE"
  ],
  "otherFiles": [
    "gpt/OTHER/20240303/supporting_f1a2b3c4.pdf"
  ],
  "contractFiles": [
    "gpt/COMMERCIAL/20240303/contract_f1a2b3c4.pdf"
  ]
}
```

### Response

#### Response Field Descriptions

| Field Name    | Type   | Description                            |
| ------------- | ------ | -------------------------------------- |
| code          | number | Response code.                         |
| state         | number | State of the response.                 |
| data          | object | Recharge supplement submission result. |
| message       | string | Response message.                      |
| neoResponseId | string | Unique NeoX response identifier.       |

#### `data` object fields:

| Field Name        | Type   | Description                                                                     |
| ----------------- | ------ | ------------------------------------------------------------------------------- |
| collectionOrderId | string | NeoX identifier of the collection order for which the supplement was submitted. |
| supplyInfoId      | string | NeoX identifier assigned to this supplement submission for tracking purposes.   |

#### Response sample

```json
{
  "code": 1,
  "state": 2,
  "data": {
    "collectionOrderId": "CO-20240303-000102",
    "supplyInfoId": "SUP-20240303-000047"
  },
  "message": "Successful",
  "neoResponseId": "d4e5f6a7-8901-4bcd-2345-6789abcdef01"
}
```

## Example cURL

```bash
curl -X POST "https://{base_url_openapi}/v2/gc/collection-orders/{collectionOrderId}/recharge-information" \
  -H "Authorization: Bearer <YOUR_TOKEN>" \
  -H "Content-Type: application/json" \
  -H "Accept-Language: en" \
  -d '{
    "requestId": "f1a2b3c4-5678-4def-a901-234567890abc",
    "fundsNatureList": [
      "GOODS_TRADE"
    ],
    "otherFiles": [
      "gpt/OTHER/20240303/supporting_f1a2b3c4.pdf"
    ],
    "contractFiles": [
      "gpt/COMMERCIAL/20240303/contract_f1a2b3c4.pdf"
    ]
  }'
```

### Notes

* Requires Bearer token in the Authorization header.
* The Accept-Language header can be used to specify the response language (Support: "vi", "en").
* Use a unique `requestId` for each request to avoid duplicate submissions.
* The request body must be in JSON format.
* Replace `{collectionOrderId}` with the actual NeoX collection order identifier. This value is delivered via the `COLLECTION` webhook.
* Call this endpoint when the `COLLECTION` webhook indicates that supplementary material is required for a recharge-type collection order (`orderType=RECHARGE`).
* `otherFiles` is required; `contractFiles` is optional but recommended to support compliance review.
* All file-reference fields (`otherFiles`, `contractFiles`) must contain `path` values returned by the File Upload API (`POST /v2/gc/files/upload`).
* The result of this supplement is delivered via the `COLLECTION` webhook and can also be polled using the Get Detail Collection Order API (`GET /v2/gc/collection-orders/{collectionOrderId}`).
