Get List Beneficiary Banks

Endpoint: GET /v2/gc/beneficiary-banks

Description: Retrieve a paginated list of beneficiary banks supported for the merchant's payout operations.

Request

Request Params Field Descriptions

Field Name	Type	Required	Description
pageNo	number	No	Page number to retrieve, starting from 1 (default: 1).
pageSize	number	No	Number of bank records per page (default: 20, maximum: 100).
bankCountry	string	No	ISO 3166-1 alpha-3 country code to filter banks by country (e.g. USA, GBR, SGP).

Response

Response Field Descriptions

Field Name	Type	Description
code	number	Response code. Refer to Error Codes.
state	number	State of the response.
data.docs	array	List of beneficiary bank records on the current page.
data.totalDocs	number	Total number of bank records matching the query.
data.totalPages	number	Total number of pages available.
message	string	Response message.
neoResponseId	string	Unique NeoX response identifier (UUID).

docs object item fields:

Field Name	Type	Description
bankCode	string	Internal bank code used by NeoX to identify the bank.
bankName	string	Full display name of the bank.
bankCountry	string	ISO 3166-1 alpha-3 country code of the bank (e.g. USA, GBR, HKG).
swiftCode	string	SWIFT/BIC code of the bank, if available.
clearingType	string	Supported clearing network for this bank. Enum: SWIFT | LOCAL.

Response sample

{
  "code": 1,
  "state": 2,
  "data": {
    "docs": [
      {
        "bankCode": "BANK-US-001",
        "bankName": "JPMorgan Chase Bank",
        "bankCountry": "USA",
        "swiftCode": "CHASUS33",
        "clearingType": "SWIFT"
      },
      {
        "bankCode": "BANK-US-002",
        "bankName": "Bank of America",
        "bankCountry": "USA",
        "swiftCode": "BOFAUS3N",
        "clearingType": "LOCAL"
      }
    ],
    "totalDocs": 48,
    "totalPages": 3
  },
  "message": "Successful",
  "neoResponseId": "c9d0e1f2-a3b4-5678-9012-cdef34567890"
}

Example cURL

curl -X GET "https://{base_url_openapi}/v2/gc/beneficiary-banks?pageNo=1&pageSize=20&bankCountry=USA" \
  -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.

• Use bankCountry (ISO 3166-1 alpha-3) to filter results to a specific country.

• Use pageNo and pageSize together for pagination. The default page size is 20; the maximum is 100.

• The bankCode returned in docs can be referenced when registering a beneficiary via Register Beneficiary.

• swiftCode may be empty for banks that only support local clearing.