Get Detail Beneficiary

Endpoint: GET /v2/gc/beneficiaries

Description: Retrieve the registration details and current status of a specific beneficiary.

id is passed as a query parameter, not a path segment.

Request

Request Params Field Descriptions

Field Name	Type	Required	Description
id	string	Yes	The beneficiary's NeoX id, as returned by Register Beneficiary.

Response

The response is narrowed to a fixed set of fields (not the full internal beneficiary record).

Response Field Descriptions

Field Name	Type	Description
code	number	Response code. Refer to Error Codes.
data	object	Beneficiary details.
message	string	Response message.
neoResponseId	string	Unique NeoX response identifier (UUID).

There is no state field in the response envelope.

data object fields:

Field Name	Type	Description
id	string	The beneficiary's NeoX identifier (same value returned by Register Beneficiary).
requestId	string	The original merchant-provided requestId used during registration.
status	string	Current registration status. Observed/known values: PENDING, WAIT_SUPPLEMENT, APPROVED (see Webhook); other values may be returned depending on backend processing.
type	string	Beneficiary type as submitted. Enum: OVERSEAS_SUPPLIER | DOMESTIC_SUPPLIER | WITHDRAW_ACCOUNT.
supplierType	string	Enum: ENTERPRISE | INDIVIDUAL.
accountType	string	Enum: PRI | PUB.
recType	string	Enum: BANK_ACCOUNT | WALLET_ACCOUNT | GFC_ACCOUNT.
businessType	string	Business relationship type, as submitted.
businessDetail	string	Business detail, as submitted.
country	string	Beneficiary country, as submitted.
address	string	Beneficiary address, as submitted.
clearingType	string	Enum: SWIFT | LOCAL.
accountName	string	Bank/wallet account name, as submitted.
accountNumber	string	Bank/wallet account number, as submitted.
accountCurrency	string	ISO 4217 currency of the receiving account.
bankName	string	Bank/wallet provider name, as submitted.
bankCountry	string	Bank country, as submitted.
swiftCode	string	SWIFT/BIC code, as submitted.
supplierName	string	Beneficiary/payee name, as submitted.
beneficiaryId	string	A second identifier field, distinct from id, also present on this endpoint's response per the backend code. Its exact relationship to id (e.g. populated only once approved) is not confirmed — document both fields as they appear rather than assuming their semantics.
createdAt	date string	Timestamp when the beneficiary record was created (ISO 8601).

No real captured sample is available for this endpoint yet — the field names/shape above are derived from the backend code (mapResponse override); values below are placeholders.

Response sample

{
  "code": 1,
  "data": {
    "id": "",
    "requestId": "",
    "status": "",
    "type": "",
    "supplierType": "",
    "accountType": "",
    "recType": "",
    "businessType": "",
    "businessDetail": "",
    "country": "",
    "address": "",
    "clearingType": "",
    "accountName": "",
    "accountNumber": "",
    "accountCurrency": "",
    "bankName": "",
    "bankCountry": "",
    "swiftCode": "",
    "supplierName": "",
    "beneficiaryId": "",
    "createdAt": ""
  },
  "message": "Successful",
  "neoResponseId": ""
}

Example cURL

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

• Provide id as a query parameter to look up the beneficiary.

• A status of APPROVED indicates the beneficiary is verified and ready to receive payouts. A status of WAIT_SUPPLEMENT means additional material is required — see Register Beneficiary → Supplement Beneficiary Material.