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

Get Detail Collection Order

Endpoint: GET /v2/gc/collection-transactions

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

Request

Request Params Field Descriptions

Field Name
Type
Required
Description

orderId

string

Yes

Same identifier as the orderId field on the collection webhooks (see Webhook).

Response

Response Field Descriptions

Field Name
Type
Description

code

number

Response code.

data

object

Collection transaction details.

message

string

Response message.

neoResponseId

string

Unique NeoX response identifier.

data object fields:

Field Name
Type
Description

id

string

NeoX internal identifier of the collection transaction.

merchantId

string

NeoX merchant identifier for the account that received the funds.

requestId

string

Idempotency key associated with this transaction, if any.

orderId

string

NeoX identifier of the collection order — the same value delivered in the collection webhooks.

orderType

string

Classification of the incoming collection. Enum: TRADE_COLLECTION, PLATFORM_COLLECTION (per real webhook samples — see Webhook).

tradeOrderId

string

NeoX identifier of a matched trade order, if any.

matchAmount

number

Amount matched to a trade order, if applicable.

matchCurrency

string

Currency of matchAmount.

matchRequestId

string

The requestId of the match operation that produced this match, if applicable.

status

string

Current status. Enum (COLLECTION_STATUS): WAIT_MATCH, MATCHED, REJ_WAIT_MATCH, PENDING, SUCCESS, CANCEL, REFUND_PROCESS, REFUND_SUCCESS.

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.

payCurrency

string

Currency of the paid / settled amount.

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.

payerAccountSwiftCode

string

SWIFT/BIC code of the payer's bank.

payerAccountBankName

string

Name of the payer's bank.

feeAmount

number

Fee amount charged for this collection.

feeCurrency

string

Currency of the fee.

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.

remark

string

Free-text remark or note for this collection.

refundOrderId

string

Identifier of a refund order raised against this collection, if any.

creditedAt

date string

Timestamp when the funds were credited (ISO 8601), if applicable.

No real captured sample exists for this exact endpoint yet — field names/shape above are derived from the backend model; values below are placeholders. For real captured samples of the webhook events that carry a subset of these same fields, see Webhook.

Response sample

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.

  • Provide orderId as a query parameter.

  • There is no separate "Supplement Payer Information" or "Submit Trade Detail File" endpoint despite older documentation — see the notices on those pages. The real supplementary-information endpoint for platform collections is Supplement Recharge Information (POST /v2/gc/platform/collection-transactions/supplement).

Last updated

Was this helpful?