Bank List - Retail
Retrieve list of retail banks available for FPX B2C payments
Overview
The retail banking list provides access to bank information specifically tailored for individual customers and small business transactions. This includes banks that support personal accounts, savings accounts, and small business banking services.
Request
To retrieve the list of retail banks, you need to make a GET or POST request to the /v1/banks/retail endpoint.
Http Method & URL
GET /v1/banks/retail
or
POST /v1/banks/retail
Headers
| Header | Type | Required | Description |
|---|---|---|---|
|
X-Api-Key
|
string | Yes | API key for authentication |
|
Content-Type
|
string | Yes | application/json |
Response
Response Format
The response contains an array of retail bank objects:
{
"success": true,
"message": "Banks list retrieved successfully"
"data": [
{
"name": "CIMB Bank",
"code": "BCBB0235",
"status": "Available"
},
{
"name": "HSBC Bank",
"code": "HSBC0223",
"status": "Available"
}
],
}
Response Fields
| Field | Type | Description |
|---|---|---|
|
success
|
boolean | Response status |
|
data
|
array | Array of bank objects |
|
data [].name
|
string | Bank name |
|
data [].code
|
string | Bank code |
|
data [].status
|
string | Bank status |
|
message
|
string | Response message |
Note: It is recommended to display only available banks to users, as selecting unavailable banks will result in a failed transaction.