For the complete documentation index, see llms.txt. This page is also available as Markdown.

Download File

Endpoint: GET https://{base_url_openapi}/v2/gc/files/download

Description: Download a statement, receipt, or declaration form as a raw binary file.

Request

Standard Request Headers

Header
Required
Description

Authorization

Yes

Bearer <access_token> obtained from API authenPlatform.

Content-Type

Yes

application/json

Accept-Language

No

Response language. Supported: vi, en. Default: en.

Request Params Field Descriptions

Field Name
Type
Required
Description

path

string

No

File reference path returned by the Upload File API. Provide either path or type.

type

string

No

Named file type for pre-generated platform files. Provide either path or type. Values: ACCOUNT_HISTORY|YYYYMMDD (daily statement), DAILY_BALANCE|YYYYMMDD (daily balance), DECLARATION_FILE, OVERSEA_PAYMENT, WITHDRAW.

requestId

string

No

Original request ID of the associated transaction. Mandatory when type is DECLARATION_FILE, OVERSEA_PAYMENT, or WITHDRAW.

childMerchantId

string

No

Sub-merchant ID. Required when downloading files scoped to a specific sub-merchant.

outPath

string

No

Local file system path where the downloaded file should be saved.

Response

Response Field Descriptions

Field Name
Type
Description

(body)

binary

Raw binary file content. This endpoint does not return the standard JSON envelope.

Response headers

Header Name
Description

x-neo-request-id

Unique request identifier assigned by the platform.

x-neo-sign

Platform response signature for integrity verification.

x-neo-hash-crc64ecma

CRC-64/ECMA checksum of the file content for corruption detection.

content-disposition

Contains the filename of the downloaded file (e.g. attachment; filename="statement_20240815.zip").

Response sample

Example cURL

Notes

  • Authentication follows the standard OAuth 2.0 Bearer Token mechanism described in Security Method.

  • {base_url_openapi} is environment-specific and provided by NeoX (see Security Method).

  • Provide either path or type as the download source — both are not required simultaneously.

  • requestId is mandatory when type is DECLARATION_FILE, OVERSEA_PAYMENT, or WITHDRAW.

  • Daily files (statements, balances) become available after 06:00 the following day.

  • The response body is raw binary content, not the standard JSON envelope. Use --output or equivalent to save the file locally.

  • Verify file integrity using the x-yop-hash-crc64ecma checksum in the response header.

Last updated

Was this helpful?