This API verifies that the customer is eligible for applying for advance against salary and returns a request_id on successful verification. The response from the CheckAdvanceEligibility operation should be used to construct a pre confirmation page so that customer can review the loan request before confirming. On confirmation, the /advance_against_salary/{aas_request_id} endpoint should be called where {aas_request_id} is the aas_request_id returned by the CheckAdvanceEligibility operation.
Version 1.0.1 :
- Updated the path <i>/customers/{customer_id_type}:{customer_id}/advance_against_salary</i> and <i>/customers/{customer_id_type}:{customer_id}/advance_against_salary/{aas_request_id}/aas_status</i>
- so that the API only accepts masked customer id.
<h3>OAuth Metadata details</h3> OAuth metadata parameter to be passed at the time of generating access token using <a href="/partner-authentication">Partner Authentication API</a> for client credential grant type is mentioned below. For information on OAuth Metadata, see <a href="/security/#oauth-metadata-partnerauth">About the OAuth Metadata</a> <p class="oauth_metadata">oauth_metadata.emirates_id : {emirates_id} OR oauth_metadata.account_id : {account_id} </p>
| Attachment | Size |
|---|---|
 Postman Collection | 2.35 KB |
Basepath
/v1
Paths
/customers/{customer_id_type}:{customer_id}/advance_against_salary
API for checking customer eligibility prior to confirmation of the AAS request
This API verifies that the customer is eligible for applying for advance against salary and returns aas_request_id on successful verification. The response from this resource should be used to construct a pre confirmation page so that customer can review the AAS request before confirming.
Unique UUID for the message
Customer Id of the customer who is requesting for advance against salary
{
"maxLength": 20
}Type of the Customer Id of the customer who is requesting for advance against salary. Allowed values - Emirates_ID
{
"enum": [
"Emirates_ID"
]
}request with amount and currency along with customer last three months salary details for verification
Unauthorized
Invalid/Unprocessable Entity
Internal Server Error
/customers/{customer_id_type}:{customer_id}/advance_against_salary/{aas_request_id}/aas_status
API for confirming the AAS request
On confirmation by customer, this endpoint should be called where {aas_request_id} in the URI is the request_id returned by the CheckAdvanceEligibility api. This API processes the AAS request.
Unique UUID for the message
Customer Id of the customer who is requesting for advance against salary
{
"maxLength": 20
}Type of the Customer Id of the customer who is requesting for advance against salary. Allowed values - Emirates_ID
{
"enum": [
"Emirates_ID"
]
}The bank's unique id for the AAS request, returned in the CheckAdvanceEligibility operation.
request with the status as CONFIRMED to confirm the AAS request
OK
Unauthorized
Invalid/Unprocessed Entity
Internal Server Error
Definitions
{
"type": "object",
"properties": {
"value": {
"description": "AAS Amount",
"$ref": "#/definitions/value"
},
"last_monthly_salaries": {
"description": "Last three months salaries of the customer",
"type": "array",
"items": {
"$ref": "#/definitions/value"
}
},
"employer_code": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"description": "Employer code",
"example": "S12"
},
"card_opening_date": {
"type": "string",
"description": "Date when the prepaid card was opened.",
"example": "2018-11-25",
"format": "date"
},
"aas_request_id": {
"type": "string",
"minLength": 1,
"maxLength": 10,
"description": "The bank's unique id for the AAS request. Returned in the response.",
"example": "1234567890"
},
"href": {
"type": "string",
"description": "href value to fetch the resource with the specific aas_request_id.",
"example": "/v1/customers/Emirates_ID:12312342143243214/advance_against_salary/1234567890"
},
"aas_status": {
"$ref": "#/definitions/aas_status"
},
"fees": {
"description": "disbursement fee for the AAS",
"$ref": "#/definitions/value"
}
},
"required": [
"value",
"last_monthly_salaries",
"employer_code",
"card_opening_date"
],
"additionalProperties": false
}
This will contain the AAS status
{
"properties": {
"href": {
"type": "string",
"description": "href value to fetch the status of a specific aas_request_id.",
"example": "/v1/customers/Emirates_ID:555196916049600/advance_against_salary/1234567890/aas_status"
},
"status": {
"type": "string",
"enum": [
"PROCESSED",
"CONFIRMED"
],
"description": "Status of the AAS request.",
"example": "CONFIRMED"
}
},
"required": [
"status"
],
"additionalProperties": false
}
Details of the Amount requested as Advance on Salary. This is required in the CheckAdvanceEligibility request.
{
"properties": {
"currency": {
"type": "string",
"enum": [
"AED"
],
"description": "Currency",
"example": "AED"
},
"amount": {
"type": "string",
"minLength": 1,
"maxLength": 20,
"description": "Amount Value",
"example": 2001
}
},
"additionalProperties": false,
"required": [
"currency",
"amount"
]
}
Response in case of error
{
"properties": {
"response_code": {
"type": "string",
"description": "API specific error code"
},
"response_message": {
"type": "string",
"description": "breif details of the error"
},
"status": {
"type": "string",
"description": "HTTP Status"
},
"description": {
"type": "string",
"description": "detailed description of the error"
},
"property": {
"type": "string"
}
},
"additionalProperties": false,
"required": [
"response_code",
"response_message",
"status"
]
}