This is a utilitarian API .This API includes the below functionalities.
- To fetch the beneficiary bank search parameters required for a specific country by passing the ISO 2 character country code.
- To fetch the list of banks for a specific search criteria by passing search values entered by the customer for the bank search parameters obtained in the /other_banks/params endpoint.
Version 1.1.0
- Added other bank currency in request of both the operations.
| Attachment | Size |
|---|---|
 Postman collection | 1.7 KB |
Basepath
/v1
API Developer
production
development
https://sandboxapi.rakbank.ae/sb/api
Paths
/other_banks/query
post /other_banks/query
This operation of the API allows to query the list of banks for the specific country and currency code by providing the values.
oauth
oauth
(oauth2 application)
Token URL
https://sandboxapi.rakbank.ae/sb/api/v1/partner_auth/token
Scopes
utility_other_banks
To retrieve bank search parameters and list of beneficiary banks
clientId
X-IBM-Client-Id
(apiKey located in header)
other_bank_query_request
Required in body
object
Search parameters that will be used to fetch the list of other banks
MsgId
Required in header
string
Message Id for this request sent from client. Value should be a unique identifier of the request in UUID format
{
"maxLength": 50
}Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
200 OK
422
Error Response
500
Internal Server Error
Example Request
Example Response
POST https://sandboxapi.rakbank.ae/sb/api/v1/other_banks/query
/other_banks/params
get /other_banks/params
This operation of the API allows to fetch the other bank parameters required for a specific country by passing the ISO 2 character country code and optionally, the ISO 3 character currency code
oauth
oauth
(oauth2 application)
Token URL
https://sandboxapi.rakbank.ae/sb/api/v1/partner_auth/token
Scopes
utility_other_banks
To retrieve bank search parameters and list of beneficiary banks
clientId
X-IBM-Client-Id
(apiKey located in header)
other_bank_country
Required in query
string
other bank country code
{
"maxLength": 2
}MsgId
Required in header
string
Message Id for this request sent from client. Value should be a unique identifier of the request in UUID format
{
"maxLength": 50
}other_bank_currency
Optional in query
string
Other bank currency code. Mandatory for Western Union beneficiary
{
"maxLength": 3
}Accept
Optional in header
string
application/json
200
200 OK
422
Error Response
500
Internal Server Error
Example Request
Example Response
GET https://sandboxapi.rakbank.ae/sb/api/v1/other_banks/params
Definitions
This contains the list of parameter to search for other banks
{
"properties": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 50,
"description": "Unique identifier for the field",
"example": "other_bank_name"
},
"value": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "This will contain the value that is specific to the unique identifier",
"example": "ICICI"
}
},
"additionalProperties": false,
"required": [
"id",
"value"
]
}
Error Response details
{
"properties": {
"status": {
"type": "string",
"description": "HTTP Status",
"example": "422"
},
"response_code": {
"type": "string",
"description": "API specific error code",
"example": "20045"
},
"property": {
"type": "string"
},
"response_message": {
"type": "string",
"description": "brief error type",
"example": "Business Exception"
},
"response_description": {
"type": "string",
"description": "detailed error description",
"example": "other_bank_country not found"
}
},
"additionalProperties": false,
"required": [
"property",
"response_message",
"response_description",
"response_code",
"status"
]
}
This definition will hold the field details that are to be displayed.
{
"properties": {
"id": {
"type": "string",
"description": "unique id for the field",
"example": "other_bank_name"
},
"name": {
"type": "string",
"description": "field name that needs to be displayed",
"example": "Bank Name"
}
},
"additionalProperties": false
}
This will contain the details of the bank and its parameter values
{
"properties": {
"other_bank_name": {
"type": "string",
"maxLength": 60,
"description": "Bank Name of the other bank",
"example": "PEOPLES BANK - COLOMBO"
},
"identifier_code1": {
"type": "string",
"maxLength": 15,
"description": "Remittance identifier code1 that is used to route payments to external systems",
"example": "7135"
},
"identifier_code2": {
"type": "string",
"maxLength": 15,
"description": "Remittance identifier code2 that is used to route payments to external systems",
"example": "280"
},
"other_branch_addr1": {
"type": "string",
"maxLength": 100,
"description": "Address of the other bank",
"example": "15th Main,"
},
"other_branch_name": {
"type": "string",
"maxLength": 75,
"description": "Branch Name of the other bank",
"example": "PB-POTHUHERA"
},
"other_branch_addr2": {
"type": "string",
"maxLength": 100,
"description": "City of the other bank",
"example": "Colombo"
}
},
"additionalProperties": false
}
This definition contains list of other banks retrieved for a specific country code
{
"properties": {
"other_bank_country": {
"type": "string",
"maxLength": 2,
"description": "ISO 2 character country code of the other bank",
"example": "LK"
},
"has_more_records": {
"type": "boolean",
"maxLength": 4,
"description": "Has the search retrieved more records than the max records mentioned in the request. Possible values Y or N",
"example": true
},
"fields": {
"description": "This array contains the list of fields for the other bank that need to be displayed for a specific country.",
"type": "array",
"items": {
"$ref": "#/definitions/fields"
}
},
"data": {
"description": "This array contains the list of other banks for a specific country and specific parameters provided in the request",
"type": "array",
"items": {
"$ref": "#/definitions/other_banks"
}
}
},
"additionalProperties": false,
"required": [
"other_bank_country",
"has_more_records",
"fields",
"data"
]
}
This definition contains the search parameters that will be used to fetch the list of other banks
{
"properties": {
"max_records": {
"type": "string",
"minLength": 1,
"maxLength": 3,
"description": "Max no of records to return in the response",
"example": "20"
},
"params": {
"type": "array",
"maxLength": 100,
"description": "This array contains the search parameters and values that will be used to fetch the list of other banks",
"items": {
"$ref": "#/definitions/query_params"
}
},
"other_bank_country": {
"type": "string",
"minLength": 1,
"maxLength": 2,
"description": "ISO 2 character country code of the other bank",
"example": "IN"
},
"other_bank_currency": {
"type": "string",
"maxLength": 3,
"description": "ISO 3 character currency code of the other bank. Mandatory for Western Union beneficiary",
"example": "INR"
}
},
"additionalProperties": true,
"required": [
"max_records",
"params",
"other_bank_country"
]
}
This definition will contain the minimum required details for the parameters
{
"type": "object",
"properties": {
"id": {
"type": "string",
"maxLength": 50,
"example": "other_bank_name",
"description": "Unique identifier for the parameter"
},
"name": {
"type": "string",
"maxLength": 100,
"example": "Bank Name",
"description": "Display Name for the parameter"
},
"is_mandatory": {
"type": "string",
"example": "N/Y",
"description": "Indicates whether this field is Mandatory."
},
"min_characters": {
"type": "string",
"maxLength": 2,
"example": "4",
"description": "Min characters required for the parameter"
},
"max_characters": {
"type": "string",
"maxLength": 2,
"example": "100",
"description": "Max allowed characters for the parameter"
}
},
"required": [
"id",
"name",
"min_characters",
"max_characters",
"is_mandatory"
]
}
This will contain the list of search parameters for the other banks for a specific country code.
{
"type": "object",
"properties": {
"other_bank_country": {
"type": "string",
"maxLength": 2,
"example": "IN",
"description": "ISO 2 character country code of the other bank"
},
"params": {
"type": "array",
"items": {
"$ref": "#/definitions/params"
},
"description": "This array contains the list of parameters for the other bank"
}
}
}