Get Detail Payout Request

Endpoint: GET /v2/gc/payout-requests/{requestId}

Description: Retrieve the current status and full details of a payout request by its merchant-assigned request ID.

Request

Request Params Field Descriptions

Field Name	Type	Required	Description
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 a payout that belongs to a sub-merchant.

Response

Response Field Descriptions

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

data object fields:

Field Name	Type	Description
merchantId	string	Merchant identifier associated with this payout.
requestId	string	Merchant-assigned request ID echoed from the original Create Payout Request call.
serialNum	string	Platform serial number assigned to this payout transaction.
amount	number	Payout amount in the sending currency.
currency	string	ISO 4217 currency code of the payout (sending side).
creditedAmount	number	Amount credited to the beneficiary after conversion and fees.
creditedCurrency	string	ISO 4217 currency code of the credited (receiving) amount.
fxRate	number	FX rate applied to this payout, if a currency conversion occurred.
feeAmount	number	Total fee charged for this payout in feeCurrency.
feeCurrency	string	ISO 4217 currency code in which the fee is denominated.
totalNumber	number	Total number of individual distributions included in this payout (relevant for batch payouts).
createDt	date string	Timestamp when the payout request was created (ISO 8601).
completeDt	date string	Timestamp when the payout reached a terminal status (ISO 8601).
tradeMode	string	Trade mode used for this payout.
useCode	string	Remittance purpose code supplied at creation.
status	string	Current payout status. Enum: SUCCESS | FAIL | PROCESSING | REFUND.
errorFilePath	string	File reference path to an error report when status=FAIL. Download via the File Download API (GET /v2/gc/files/download).
targetFeeAmount	number	Fee amount expressed in the target currency.
targetFeeFxRate	number	FX rate applied when converting the fee to the target currency.
targetFeeCurrency	string	ISO 4217 currency code of the target-side fee.
refundAmount	number	Amount refunded to the merchant when status=REFUND.
refundCurrency	string	ISO 4217 currency code of the refunded amount.

Response sample

{
  "code": 1,
  "state": 2,
  "data": {
    "merchantId": "10094326060",
    "requestId": "b2c3d4e5-2222-3333-4444-bbccddeeff00",
    "serialNum": "SN2024081500112233",
    "amount": 5000.00,
    "currency": "USD",
    "creditedAmount": 36407.50,
    "creditedCurrency": "CNH",
    "fxRate": 7.2815,
    "feeAmount": 15.00,
    "feeCurrency": "USD",
    "totalNumber": 1,
    "createDt": "2024-08-15T09:00:00Z",
    "completeDt": "2024-08-15T09:45:00Z",
    "tradeMode": "OVERSEA_PAYMENT",
    "useCode": "GOODSTRADE",
    "status": "SUCCESS",
    "errorFilePath": null,
    "targetFeeAmount": 109.22,
    "targetFeeFxRate": 7.2815,
    "targetFeeCurrency": "CNH",
    "refundAmount": null,
    "refundCurrency": null
  },
  "message": "Successful",
  "neoResponseId": "de7750c5-772e-4136-ac78-62c57a106cce"
}

Example cURL

curl -X GET "https://{base_url_openapi}/v2/gc/payout-requests/{requestId}?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").

• Replace {requestId} with the merchant-assigned requestId used when creating the payout request.

• This endpoint is the recommended polling fallback when a PAYOUT webhook has not yet been received.

• When status=FAIL, use the errorFilePath value with the File Download API to retrieve the error detail report.

• refundAmount and refundCurrency are populated only when status=REFUND.