Get Detail Collection Order

Endpoint: GET /v2/gc/collection-orders/{collectionOrderId}

Description: Retrieve the full details of an incoming-funds collection order, including payer information and any associated trade order matches.

Request

Request Params Field Descriptions

Field Name	Type	Required	Description
matchRequestId	string	No	Request ID used in a previous match operation. Include to filter the response to a specific match context.
subMerchantId	string	No	Sub-merchant identifier. Include when the collection order belongs to a specific sub-merchant.
collectionOrderId	string	No	NeoX identifier of the collection order to retrieve details for. This is the same as the orderId field in the COLLECTION webhook notification.

Response

Response Field Descriptions

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

data object fields:

Field Name	Type	Description
requestId	string(32)	Merchant-generated unique request ID for idempotency.
orderId	string	NeoX identifier assigned to the collection (incoming-funds) order.
merchantId	string	NeoX merchant identifier for the account that received the funds.
amount	number	Original incoming amount as notified by the receiving bank.
payAmount	number	Actual paid / settled amount received.
currency	string	Currency of the incoming funds (e.g. USD, EUR, HKD).
payCurrency	string	Currency of the paid / settled amount (e.g. USD).
orderType	string	Classification of the incoming collection. Enum: RECHARGE, TRADE_COLLECTION, PLATFORM_COLLECTION.
status	string	Current status of the collection order. Enum: WAIT_MATCH, MATCHED, REJ_WAIT_MATCH, PENDING, SUCCESS, CANCEL, REFUND_PROCESS, REFUND_SUCCESS.
recBankCode	string	Bank code of the virtual account that received the funds.
bankSerialNum	string	Bank serial number / reference for the incoming transaction.
vaNo	string	Virtual account number that received the funds.
payerAccountNum	string	Account number of the party that sent the funds.
payerAccountName	string	Account name of the party that sent the funds.
feeAmount	number	Fee amount charged for this collection.
feeCurrency	string	Currency of the fee (e.g. USD).
targetFeeAmount	number	Target / estimated fee amount before FX conversion.
targetFeeCurrency	string	Currency of the target fee.
targetFeeFxRate	number	FX rate applied to the target fee. Example: 100.0.
remark	string	Free-text remark or note for this collection order.
createdAt	string	Timestamp when the collection order was created. Format: YYYY-MM-DD HH:mm:ss.
tradeOrderList	array	List of trade orders matched to this collection order. See tradeOrderList object item fields below.

tradeOrderList object item fields:

Field Name	Type	Description
tradeOrderId	string	NeoX identifier of the trade order matched to this collection order.
matchAmount	number	Amount matched between this collection order and the trade order.
matchCurrency	string	Currency used for the matched amount (e.g. USD, EUR, HKD).

Response sample

{
  "code": 1,
  "state": 2,
  "data": {
    "requestId": "ORE_20260114172614013",
    "orderId": "654135070497488955",
    "merchantId": "12100990",
    "amount": 20000.00,
    "payAmount": 20000.00,
    "currency": "USD",
    "payCurrency": "USD",
    "orderType": "TRADE_COLLECTION",
    "status": "MATCHED",
    "recBankCode": "HSBCHKHH",
    "bankSerialNum": "VA0747572536",
    "vaNo": "79955102098",
    "payerAccountNum": "0013915373322",
    "payerAccountName": "DAU MINH DUC",
    "feeAmount": 0.00,
    "feeCurrency": "USD",
    "targetFeeAmount": 0.00,
    "targetFeeCurrency": "USD",
    "targetFeeFxRate": 100.00,
    "remark": "YEEPAYPAYPMENT",
    "createdAt": "2026-01-14 17:26:15",
    "tradeOrderList": [
      {
        "tradeOrderId": "TO-20240301-000182",
        "matchAmount": 20000.00,
        "matchCurrency": "USD"
      }
    ]
  },
  "message": "Successful",
  "neoResponseId": "b2c3d4e5-6789-4fae-0123-456789abcdef"
}

Example cURL

curl -X GET "https://{base_url_openapi}/v2/gc/collection-orders/{collectionOrderId}?subMerchantId=SM-00098761" \
  -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 {collectionOrderId} with the actual NeoX collection order identifier received from the COLLECTION webhook.

• Include matchRequestId to scope the response to a specific match operation when a collection order has been matched multiple times.

• If the collection order has status=WAIT_MATCH and orderType=RECHARGE, supplementary funds-nature information may be required — call the Supplement Recharge Information API.

• If payer information is missing, call the Supplement Payer Information API to provide the required details.