Get Bank List
This API serves as the initial gateway for accessing the roster of issuing participants that endorse DuitNow Online Banking/Wallets or DuitNow Consent. Upon invoking this endpoint, the response furnishes information regarding bank details, status, and redirection mechanisms. Subsequently, payers are seamlessly redirected to their chosen issuing participants for authentication, ensuring a smooth and secure authentication process.
Process Flow
Step | Sender | Receiver | Process |
---|---|---|---|
1 | Payer | Acquirer | Payer initiates a payment via DuitNow Pay. |
2 | Acquirer | API Gateway | The bank list and available payment methods will be parsing back acquirer for user to select their preferred payment method. |
Request
GET /v2/bw/banks
Response
Data Object | ||||||
retail / corporate Object | ||||||
bicCode | String | Max length: 35 | Required | |||
Bank Identification Code (BIC) of the acquirer. | ||||||
name | String | Max length: 35 | Required | |||
Name of issuing participant. | ||||||
browser | String | Max length: 140 | Required | |||
Browser information and version. | ||||||
androidAppId | String | Max length: 140 | Required | |||
Application identifier for Android platform. | ||||||
iosAppId | String | Max length: 140 | Required | |||
Application identifier for iOS platform. | ||||||
url | String | Max length: 140 | Required | |||
Bank URL to be redirected. | ||||||
isConsent | Boolean | Max length: 5 | Required | |||
To notify if issuing participant support DuitNow Consent: isConsent = true, the issuing bank is currently supporting DuitNow Consent. isConsent = false, the issuing bank is currently not supporting DuitNow Consent. | ||||||
isActive | Boolean | Max length: 5 | Required | |||
To notify if issuing participant is active in production: isActive = true, the issuing participant is active. isActive = false, the issuing participant is inactive. | ||||||
isFpx | Boolean | Max length: 5 | Required | |||
To notify if issuing participant supporting FPX: isFpx = true, the issuing bank is currently with FPX. isFpx = false, the issuing bank is not with FPX. | ||||||
isBank | Boolean | Max length: 5 | Required | |||
To notify if issuing participant is bank or non-bank financial institution: isBank = true, the issuing participant is a bank. isBank = false, the issuing participant is e-wallet. | ||||||
isObw | Boolean | Max length: 5 | Required | |||
To notify if issuing participant supporting DuitNow Online Banking/Wallets: isObw = true, the issuing bank is currently with DuitNow Online Banking/Wallets. isObw = false, the issuing bank is not with DuitNow Online Banking/Wallets. | ||||||
priority | Integer | Max length: 9999 | Optional | |||
The sequence to sort the issuer. The lower the number, the higher the priority. If the value is 0, suggest to sort by alphabetical order. | ||||||
End retail / corporate Object | ||||||
End Data Object | ||||||
message | String | Max length: 1024 | Required | |||
Refer to the reason codes in the appendix. |
Sample Response:
{
"data": {
"retail": [
{
"bicCode": "CIBBMYKL",
"name": "CIMB Bank",
"browser": "https://uat.cimb.com/",
"androidAppId": "novuscimboctouat://",
"iosAppId": "novuscimboctouat://",
"url": "https://uat2.cimbclicks.com.my/dobb2c",
"isConsent": false,
"isActive": true,
"isFpx": false,
"isBank": true,
"isObw": true,
"priority": 3
}
],
"corporate": [
{
"bicCode": "CIBBMYKL",
"name": "CIMB Bank",
"browser": "https://uat.cimb.com/",
"androidAppId": "novuscimboctouat://",
"iosAppId": "novuscimboctouat://",
"url": "https://uat2.cimbclicks-corporate.com.my/dobb2c",
"isConsent": false,
"isActive": true,
"isFpx": null,
"isBank": null,
"isObw": true,
"priority": 3
}
]
},
"message": "U000"
}
This API will respond with a list of banks, including FPX banks (until the end of 2024) and RPP banks, along with the supported RPP services. The acquirer should prioritize the order as follows:
- One-Time Payment
- Save Payment
- isActive = true
- isBank = true
- isObw = true
- isFpx = true
Note:
Prioritize listing the bank if isObw = true. If not, list the FPX bank if isFpx = true. Only one type of bank should be listed, not both.
- isActive = true
- isBank = true
- isConsent = true
Note:
Only list the RPP bank that supporting Consent and AutoDebit where isConsent = true.