Get Detail Payout Request

Endpoint: GET /v2/gc/payment-requests

Description: Retrieve the current status and full details of a payout request.

id is passed as a query parameter, not a path segment. Neither this endpoint nor Query Payment Request Status below is schema-validated (no Zod DTO) — both simply take {id}.

Request

Request Params Field Descriptions

Field Name	Type	Required	Description
id	string	Yes	The payout request's NeoX id, as returned by Create Payout Request.

Response

Response Field Descriptions

Field Name	Type	Description
code	number	Response code.
data	object	Payout request detail.
message	string	Response message.
neoResponseId	string	Unique NeoX response identifier.

There is no state field in the response envelope. The data field set, per the backend's PaymentRequestSchema, is below.

data object fields:

Field Name	Type	Description
id	string	The payout request's NeoX identifier.
requestId	string	Merchant-assigned requestId echoed from the original create call.
payoutCurrency	string	ISO 4217 currency code of the payout (sending side).
amount	string	Payout amount.
payoutType	string	Enum: DOMESTIC_PAYMENT | OVERSEA_PAYMENT | DOMESTIC_PAYMENT_FX | WITHDRAW.
subMerchantId	string	Sub-merchant identifier, if applicable.
subMerchantEmail	string	Email of the sub-merchant, if applicable.
beneficiaryId	string	Registered beneficiary identifier, if used.
beneficiary	object	{ accountName, accountNumber, swiftCode, bankCode } — snapshot of the beneficiary's account details used for this payout.
remitType	string	Enum: SPEED | NORMAL | FAST.
clearingType	string	Enum: AUTO | SWIFT | LOCAL.
tradeSide	string	Enum: CUSTOMER_SELL | CUSTOMER_BUY.
feeBear	string	Enum: SHA | OUR | BEN.
remitPurpose	string	Enum: GOODSTRADE | SERVICETRADE | OTHERS.
clearingNetwork	string	Enum: UNIONPAY | NCPS.
receiveCurrency	string	Currency received by the beneficiary, if applicable.
remark	string	Free-text remark, as submitted.
payerId	string	Payer identifier, as submitted.
feeChargeMode	string	Fee collection method, as submitted.
webhookUrl	string	Callback URL, as submitted.
merchantId	string	NeoX merchant identifier.
merchantEmail	string	Merchant's email.
status	string	Current payout status.
serialNum	string	Platform serial number assigned to this payout transaction.
errorCode	string	Error code, if the payout failed.
errorMsg	string	Human-readable error description, if the payout failed.
logs	array	Processing log entries for this payout request.
extraData	object	Additional data from the processor, if any.
completedAt	date string	Timestamp when the payout reached a terminal status (ISO 8601).
createdAt	date string	Timestamp when the payout request was created (ISO 8601).
updatedAt	date string	Timestamp of the most recent update (ISO 8601).

No real captured sample is available for this endpoint yet — field names above are derived from code; example values below are placeholders.

Response sample

{
  "code": 1,
  "data": {
    "id": "",
    "requestId": "",
    "payoutCurrency": "",
    "amount": "",
    "payoutType": "",
    "subMerchantId": "",
    "beneficiaryId": "",
    "beneficiary": {
      "accountName": "",
      "accountNumber": "",
      "swiftCode": "",
      "bankCode": ""
    },
    "status": "",
    "serialNum": "",
    "createdAt": "",
    "updatedAt": ""
  },
  "message": "Successful"
}

Query Payment Request Status

Endpoint: GET /v2/gc/payment-requests/query

A lighter-weight, status-only variant — same request shape ({id}), also not schema-validated. Use this when you only need the current status rather than the full detail record above.

Example cURL

curl -X GET "https://{base_url_openapi}/v2/gc/payment-requests?id={id}" \
  -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.

• Pass the id returned by Create Payout Request, not the merchant-supplied requestId.

• There is no GET /v2/gc/payout-requests/distributions endpoint despite older documentation — see the notice on Get List Distribution Records.