This API can be used to fetch the list of all beneficiaries of a RAKBANK Digital Banking SME customer by passing his customer_id as well as fetch details of a beneficiary by passing the beneficiary_id. The beneficiary_id of the beneficiary can be used in the RAKBANK Digital Banking Transfers API to make payments to the beneficiary, without having to pass all details of the beneficiary again.
| Attachment | Size |
|---|---|
 Postman collection | 1.9 KB |
Response Codes
Click Here for API Response Codes
Basepath
/v1/tpa
API developer
production
development
https://sandboxapi.rakbank.ae/sb/api
Paths
/customers/{customer_id_type}:{customer_id}/beneficiaries
get /customers/{customer_id_type}:{customer_id}/beneficiaries
Get Beneficiaries of a customer
This API will return the list of beneficiaries associated with a customer_id.
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
oauth
oauth
(oauth2 accessCode)
Authorization URL
https://sandboxapi.rakbank.ae/sb/api/v1/customer_signin/oauth2/authorize
Token URL
https://sandboxapi.rakbank.ae/sb/api/v1/customer_signin/oauth2/token
Scopes
beneficiaries.read
To fetch beneficiaries of the customer
MsgId
Required in header
string
Unique Id sent by the client. Value should be a unique identifier of the transaction in UUID format
{
"maxLength": 50
}customer_id
Required in path
string
Customer Id of the customer who's beneficiaries are to be fetched. Allowed values - 'mine' - indicating logged-in customer
{
"enum": [
"mine"
],
"maxLength": 20
}customer_id_type
Required in path
string
Customer Id Type. Allowed values - Org_ID
{
"enum": [
"Org_ID"
]
}Accept
Optional in header
string
application/json
200
200 OK
401
Unauthorized
403
Forbidden
422
Invalid Request
500
Internal Server Error
Example Request
Example Response
GET https://sandboxapi.rakbank.ae/sb/api/v1/tpa/customers/{customer_id_type}:{customer_id}/beneficiaries
Try this operation
/customers/{customer_id_type}:{customer_id}/beneficiaries/{beneficiary_id}
get /customers/{customer_id_type}:{customer_id}/beneficiaries/{beneficiary_id}
Retrieves a specific beneficiary's details
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
oauth
oauth
(oauth2 accessCode)
Authorization URL
https://sandboxapi.rakbank.ae/sb/api/v1/customer_signin/oauth2/authorize
Token URL
https://sandboxapi.rakbank.ae/sb/api/v1/customer_signin/oauth2/token
Scopes
beneficiaries.read
To fetch beneficiaries of the customer
customer_id
Required in path
string
Customer Id of the customer who's beneficiaries are to be fetched. Allowed values - 'mine' - indiating logged-in customer
{
"enum": [
"mine"
],
"maxLength": 20
}customer_id_type
Required in path
string
Type of the Customer Id of the customer who's beneficiaries are to be fetched. Allowed values - Org_ID
{
"enum": [
"Org_ID"
]
}beneficiary_id
Required in path
string
Beneficiary id of the beneficiary
{
"maxLength": 15
}MsgId
Required in header
string
Unique Id sent by the client. Value should be a unique identifier of the transaction in UUID format
{
"maxLength": 50
}Accept
Optional in header
string
application/json
200
200 OK
401
Unauthorized
403
Forbidden
422
Invalid Request/Unprocessable Entity
500
Internal Server Error
Example Request
Example Response
GET https://sandboxapi.rakbank.ae/sb/api/v1/tpa/customers/{customer_id_type}:{customer_id}/beneficiaries/{beneficiary_id}
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": "brief details of the error"
},
"description": {
"type": "string",
"description": "detailed description of the error"
}
},
"additionalProperties": false,
"required": [
"response_message",
"response_code",
"status"
]
}
Beneficiary object
{
"type": "object",
"properties": {
"href": {
"type": "string",
"description": "href value to fetch the resource with the specific beneficiary_id.",
"example": "https://testapi.rakbank.ae/rb/api/v1/tpa/customers/Org_ID:mine/beneficiaries/23542346"
},
"beneficiary_id": {
"type": "string",
"minLength": 0,
"maxLength": 10,
"description": "Id of the beneficiary",
"example": "23542346"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Name of the beneficiary",
"example": "James Gordan"
},
"nick_name": {
"type": "string",
"minLength": 1,
"maxLength": 80,
"description": "Nick Name of the beneficiary",
"example": "James"
},
"transfer_type": {
"type": "string",
"enum": [
"WithinRAKBANK",
"WithinUAE",
"OutsideUAE"
],
"description": "Type of the beneficiary.",
"example": "OutsideUAE"
},
"other_account_id": {
"type": "string",
"minLength": 1,
"maxLength": 34,
"description": "Account id or IBAN of the beneficiary.",
"example": "963521478"
},
"other_account_currency": {
"type": "string",
"minLength": 1,
"maxLength": 3,
"description": "Currency of the beneficiary account.",
"example": "AED"
},
"other_bank_name": {
"type": "string",
"minLength": 1,
"maxLength": 254,
"description": "Bank Name of the beneficiary bank",
"example": "ICICI"
},
"other_branch_name": {
"type": "string",
"minLength": 1,
"maxLength": 254,
"description": "Branch name of the beneficiary bank",
"example": "VADODARA - KARELIBAUG"
},
"other_branch_addr1": {
"type": "string",
"minLength": 1,
"maxLength": 254,
"description": "Address of the other bank.",
"example": "15th Main,"
},
"other_branch_addr2": {
"type": "string",
"minLength": 1,
"maxLength": 254,
"description": "City of the other bank.",
"example": "Colombo"
},
"other_bank_country": {
"type": "string",
"minLength": 1,
"maxLength": 2,
"description": "ISO 2 Character country code of the beneficiary bank",
"example": "AE"
},
"other_bank_SWIFT_code": {
"type": "string",
"minLength": 1,
"maxLength": 254,
"description": "Beneficiary Bank SWIFT code",
"example": "ICICINBBNRI"
},
"intermediary_bank_SWIFT_code": {
"type": "string",
"minLength": 1,
"maxLength": 254,
"description": "Intermediary bank SWIFT code",
"example": "ABCUIPOPL"
},
"address": {
"$ref": "#/definitions/address",
"description": "Beneficiary Residence Address"
}
},
"example": "",
"additionalProperties": false,
"required": [
"name",
"beneficiary_id",
"nick_name",
"transfer_type",
"other_bank_name",
"other_account_id",
"other_bank_country"
]
}
Beneficiary Residence Address
{
"properties": {
"line_1": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Address line 1 of the beneficiary"
},
"line_2": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Address line 2 of the beneficiary"
},
"line_3": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "Address line 3 of the beneficiary"
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "City of the beneficiary"
},
"state": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "State of the beneficiary"
},
"district": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "District of the beneficiary"
},
"country": {
"type": "string",
"minLength": 1,
"maxLength": 2,
"description": "Country of the beneficiary. ISO 2 Character Country Codes.",
"example": "IN"
}
},
"additionalProperties": false,
"required": [
"country"
]
}
Returns the collection of beneficiaries along with some meta data
{
"properties": {
"total_count": {
"type": "integer",
"description": "Holds the total no. of beneficiaries returned",
"example": 10
},
"href": {
"type": "string",
"description": "href value to fetch this resource",
"example": "https://testapi.rakbank.ae/rb/api/v1/tpa/customers/Org_ID:mine/beneficiaries"
},
"beneficiaries": {
"type": "array",
"items": {
"$ref": "#/definitions/beneficiaries"
},
"description": "array of beneficiaries"
}
},
"additionalProperties": false,
"required": [
"href",
"beneficiaries"
]
}