This API is available to Partner Institutions to create a lien on their customer's RAKBANK account, when the customer uses the corresponding debit card, issued by the partner, in a POS transaction. The lien will be lifted and the account would be debited as part of Master & Visa settlement process.
Version 1.1.0
- For CreateAccountLienById, PUT method changed to POST since operation is not idempotent. If duplicate lien_id with same hold_indicator is passed in the request, transaction will be rejected with a Response code 20405 indicating "Duplicate Transaction". In case a previously created lien needs to be negated, pass the same lien_id and hold_indicator as "N".
| Attachment | Size |
|---|---|
 Postman Collection | 1.34 KB |
Basepath
/v1
API developer
production
development
https://sandboxapi.rakbank.ae/sb/api
Paths
/accounts/{account_id}/liens
post /accounts/{account_id}/liens
Place a lien on account by passing the lien id
clientIdHeader
X-IBM-Client-Id
(apiKey located in header)
oauth
oauth
(oauth2 application)
Token URL
https://sandboxapi.rakbank.ae/rb/api/oauth2/token
Scopes
account_liens
Place Lien on Account
MsgId
Required in header
string
Unique Id sent by client. Value should be a unique identifier of the request in UUID format.
{
"maxLength": 50
}account_id
Required in path
string
Account id of the customer on which lien to be placed. Masked value should be passed in the UAT and Production environments. For information on the masking logic to be followed, see Masking Logic
{
"maxLength": 13
}liens
Required in body
object
Lien to be placed
Content-Type
Optional in header
string
application/json
Accept
Optional in header
string
application/json
200
401
UnAuthorized
403
Forbidden
422
Error
500
Internal Server Error
Example Request
Example Response
POST https://sandboxapi.rakbank.ae/sb/api/v1/accounts/{account_id}/liens
Try this operation
Definitions
{
"properties": {
"lien_id": {
"type": "string",
"maxLength": 25,
"description": "Lien Id of the lien to be placed.",
"example": 12323
},
"lien_amount": {
"description": "Holds the lien amount.",
"$ref": "#/definitions/value"
},
"hold_indicator": {
"type": "string",
"enum": [
"P",
"N"
],
"description": "Allowed values: 'P' - for positive lien, 'N' - for negative lien",
"example": "N"
},
"value_date": {
"type": "string",
"description": "Holds value date of the transaction in ISO 8601 format YYYY-MM-DD.",
"format": "date",
"example": "2019-02-01"
},
"lien_reason_code": {
"type": "string",
"maxLength": 5,
"description": "Reason code for placing the lien.",
"example": "AUT"
},
"remarks": {
"type": "string",
"maxLength": 50,
"description": "Remarks for the lien transaction.",
"example": "12334"
},
"expiry_date": {
"type": "string",
"description": "Expiry date of the lien in ISO 8601 format YYYY-MM-DD.",
"format": "date",
"example": "2019-02-01"
}
},
"additionalProperties": false,
"required": [
"lien_id",
"lien_amount",
"hold_indicator",
"value_date",
"lien_reason_code"
]
}
Response object.
{
"properties": {
"lien_id": {
"type": "string",
"maxLength": 25,
"description": "Lien Id of the lien placed.",
"example": 12323
},
"value_date": {
"type": "string",
"description": "Holds value date of the transaction in ISO 8601 format YYYY-MM-DD.",
"format": "date",
"example": "2019-02-01"
}
},
"additionalProperties": false,
"required": [
"lien_id",
"value_date"
]
}
Amount details
{
"properties": {
"amount": {
"type": "string",
"description": "amount",
"maxLength": 20,
"example": "200.00"
},
"currency": {
"type": "string",
"description": "currency",
"maxLength": 3,
"example": "AED"
}
},
"additionalProperties": false,
"required": [
"amount",
"currency"
]
}
Response in case of error
{
"properties": {
"status": {
"type": "string",
"description": "HTTP Status"
},
"response_code": {
"type": "string",
"description": "API specific error code"
},
"property": {
"type": "string"
},
"response_message": {
"type": "string",
"description": "brief type of the error"
},
"description": {
"type": "string",
"description": "detailed description of the error"
}
},
"additionalProperties": false,
"required": [
"status",
"response_code",
"response_message"
]
}