Get List Distribution Records

Endpoint: GET /v2/gc/payout-requests/distributions

Description: Query single or batch payout distribution detail records to retrieve the per-payee breakdown of a payout request.

Request

Request Params Field Descriptions

Field Name	Type	Required	Description
requestId	string	No	Merchant-assigned request ID of the individual payout to retrieve distribution records for. One of requestId or batchRequestId is required.
batchRequestId	string	No	Request ID of the parent batch payout. One of requestId or batchRequestId is required.
payoutType	string	No	Filter by payout type. Enum: DOMESTIC_PAYMENT | OVERSEA_PAYMENT | WITHDRAW | DOMESTIC_PAYMENT_FX.
subMerchantId	string	No	Sub-merchant ID. Provide when querying distributions that belong to a specific sub-merchant.

Response

Response Field Descriptions

Field Name	Type	Description
code	number	Response code.
state	number	State of the response.
data	object	Paginated list of distribution records.
message	string	Response message.
neoResponseId	string	Unique NeoX response identifier.

data object fields:

Field Name	Type	Description
docs	array	Array of individual distribution record objects.
totalDocs	number	Total number of distribution records matched.
totalPages	number	Total number of pages available.

docs object item fields:

Field Name	Type	Description
merchantId	string	Merchant identifier associated with this distribution.
requestId	string	Merchant-assigned request ID of the individual payout distribution.
serialNum	string	Platform serial number for this distribution record.
amount	number	Distribution amount in currency.
currency	string	ISO 4217 currency code of the distribution amount.
recIdNumber	string	ID number of the recipient (beneficiary identification document number).
recName	string	Full name of the recipient beneficiary.
recBankName	string	Name of the recipient's bank.
recCardNo	string	Recipient's bank account or card number.
status	string	Distribution status. Enum: PROCESSING | SUCCESS | FAIL | CLOSE.
createDt	date string	Timestamp when this distribution record was created (ISO 8601).
completeDt	date string	Timestamp when this distribution reached a terminal status (ISO 8601).

Response sample

{
  "code": 1,
  "state": 2,
  "data": {
    "docs": [
      {
        "merchantId": "10094326060",
        "requestId": "b2c3d4e5-2222-3333-4444-bbccddeeff00",
        "serialNum": "SN2024081500112233",
        "amount": 5000.00,
        "currency": "USD",
        "recIdNumber": "HK-PASSPORT-A1234567",
        "recName": "Jane Smith",
        "recBankName": "HSBC Hong Kong",
        "recCardNo": "HK8801234567890",
        "status": "SUCCESS",
        "createDt": "2024-08-15T09:00:00Z",
        "completeDt": "2024-08-15T09:45:00Z"
      }
    ],
    "totalDocs": 1,
    "totalPages": 1
  },
  "message": "Successful",
  "neoResponseId": "de7750c5-772e-4136-ac78-62c57a106cce"
}

Example cURL

curl -X GET "https://{base_url_openapi}/v2/gc/payout-requests/distributions?requestId=b2c3d4e5-2222-3333-4444-bbccddeeff00&payoutType=OVERSEA_PAYMENT" \
  -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").

• Either requestId or batchRequestId must be provided; the request will be rejected if both are omitted.

• Use requestId to retrieve the distribution for a single payout; use batchRequestId to retrieve all distributions belonging to a batch payout file.

• status=CLOSE indicates the distribution was cancelled or voided before processing completed.