This is a utilitarian API .This API includes the below functionalities.
- To fetch the beneficiary field list for a specific country by passing the ISO 2 character country code, ISO 3 character Currency Code and Payment Type.
To fetch the list of values for the particular field by passing FieldId that is obtained in the /fetch/field_lists endpoint.
Version 1.1.0
- Added two new fields display_value and value in the response for operation FetchFieldLists.
Version 1.2.0
- Added a new field beneficiary_id in the request for operation FetchFieldValues.
| Attachment | Size |
|---|---|
 Postman Collection | 2.69 KB |
Basepath
/v1
production
development
https://sandboxapi.rakbank.ae/sb/api
Paths
/fetch/field_values
post /fetch/field_values
Returns the list of values for the particular field if the FieldType is Combo.
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
oauth
oauth
(oauth2 application)
Token URL
https://sandboxapi.rakbank.ae/rb/api/v1/partner_auth/token
Scopes
fetch_fields
To retrieve beneficiary fields and list
MsgId
Required in header
string
Unique Id sent by the client. Value should be a unique identifier of the transaction in UUID format
beneficiary_fields_request
Required in body
object
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
200 OK
401
Unauthorized
403
Forbidden
422
Error
500
Internal Server Error
Example Request
Example Response
POST https://sandboxapi.rakbank.ae/sb/api/v1/fetch/field_values
Try this operation
/fetch/field_lists
post /fetch/field_lists
Returns the field information to display while adding or updating the beneficiary
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
oauth
oauth
(oauth2 application)
Token URL
https://sandboxapi.rakbank.ae/rb/api/v1/partner_auth/token
Scopes
fetch_fields
To retrieve beneficiary fields and list
MsgId
Required in header
string
Unique Id sent by the client. Value should be a unique identifier of the transaction in UUID format
beneficiary_fields_request
Optional in body
object
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
200 OK
401
Unauthorized
403
Forbidden
422
Error
500
Internal Server Error
Example Request
Example Response
POST https://sandboxapi.rakbank.ae/sb/api/v1/fetch/field_lists
Try this operation
Definitions
Response in case of error
{
"properties": {
"status": {
"type": "string",
"description": "HTTP Status"
},
"response_code": {
"type": "string",
"description": "API specific error code"
},
"property": {
"type": "string",
"description": ""
},
"response_message": {
"type": "string",
"description": "breif details of the error"
},
"description": {
"type": "string",
"description": "detailed description of the error"
}
},
"additionalProperties": false,
"required": [
"response_message",
"response_code",
"status"
]
}
{
"properties": {
"country_code": {
"type": "string",
"description": "ISO 2 letter country code",
"example": "IN",
"maxLength": 2
},
"currency_code": {
"type": "string",
"description": "ISO 3 letter currency code",
"example": "INR",
"maxLength": 3
},
"payment_type": {
"type": "string",
"enum": [
"C",
"A",
"W"
],
"maxLength": 1,
"description": "Payment Types. Values can include :\n- \"C\" - Cash,\n- \"A\" - Account Transfer,\n- \"W\" - Wallet\n",
"example": "C"
},
"field_id": {
"type": "string",
"maxLength": 50,
"description": "Unique Identifier to identify the field. Required in the FetchFieldValues operation.",
"example": "BeneCity"
},
"reference_value": {
"type": "string",
"maxLength": 50,
"description": "Value selected by the user in the ReferenceFor field. Required in the FetchFieldValues operation."
},
"beneficiary_id": {
"type": "string",
"description": "Mandatory for field_id “PURPOSE”. For getting list of purposes during RAKMoneyTransfer. Used only for FetchFieldValues operation."
}
},
"additionalProperties": false,
"required": [
"country_code",
"currency_code",
"payment_type"
]
}
{
"type": "array",
"items": {
"$ref": "#/definitions/field_list"
}
}
{
"type": "array",
"items": {
"$ref": "#/definitions/display_details"
}
}
{
"properties": {
"display_value": {
"type": "string",
"maxLength": 100,
"description": "Value to display for the user.",
"example": "Arizona"
},
"value": {
"type": "string",
"maxLength": 50,
"description": "Value for the selection which should pass for the field.",
"example": "Ari"
}
},
"additionalProperties": false,
"required": [
"display_value",
"value"
]
}
{
"properties": {
"field_id": {
"type": "string",
"maxLength": 50,
"example": "BenfFirstName",
"description": "Unique identifier to identify the field. Refer annexures"
},
"field_name": {
"type": "string",
"maxLength": 100,
"example": "BeneficiaryName",
"description": "Display Name for the field"
},
"field_max_length": {
"type": "string",
"maxLength": 3,
"description": "Max length filed can hold.",
"example": "75"
},
"field_mandatory": {
"type": "string",
"maxLength": 1,
"description": "Mandatory Condtions: Possible values Y or N",
"example": "Y"
},
"field_type": {
"type": "string",
"maxLength": 15,
"description": "DataType for the field. Possible values are String/Decimal/Combo If the field is combo GET_FIELD_VALUE_BENE API should be called to get the value list.",
"example": "String"
},
"reference_for": {
"type": "string",
"maxLength": 50,
"description": "Whether this particular field is the reference for corresponding field value retrieval. Ex: state list?city list"
},
"priority": {
"type": "string",
"maxLength": 2,
"description": "Order for the field placement",
"example": "1"
},
"display_value": {
"type": "string",
"maxLength": 100,
"description": "Value to display for the user.",
"example": "Arizona"
},
"value": {
"type": "string",
"maxLength": 50,
"description": "Value for the selection which should pass for the field.",
"example": "Ari"
}
},
"additionalProperties": false,
"required": [
"field_id",
"field_name",
"field_max_length",
"field_mandatory",
"field_type",
"priority"
]
}