API allows Third Party App (TPA) back-ends to intimate us whenever our customers register on their App, instantly allowing the customer to link his/her bank account to the Third Party App (TPA). The API is also to be invoked during customer induced deregistration from the Third Party App.
Version 1.1.0
- This API must be invoked by the client even in the scenario of customer induced account de-linkage from the TPA. The "status" field value should be passed as "REG".
| Attachment | Size |
|---|---|
 Postman Collection | 2.3 KB |
Basepath
/v1
Paths
/customers/{customer_id_type}:{customer_id}/tpa_registration_status
Update status of a customer's TPA registration at RAKBank
Allows status of a customer's TPA registration to be updated
Client Secret of the client App
Client Id of the client App
Unique Id sent by the client. Value should be a unique identifier of the transaction in UUID format
{
"maxLength": 50
}Customer Id of the customer who's details are to be updated. E.g. customer UUID.
{
"maxLength": 32
}Type of the Customer Id of the customer who's TPA registration status is to be updated. Allowed values - UUID
{
"enum": [
"UUID"
]
}Details to update a customer's TPA registration status
Error Response
Internal Server Error
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"
]
}
TPA registration status details
{
"properties": {
"status": {
"type": "string",
"enum": [
"REG",
"DRG"
],
"example": "REG",
"description": "TPA registration status. Allowed values: \n- REG – Registered at TPA.\n - Passed along with UUID when a specific business banking user registers himself/herself on the TPA or when the customer delinks a previously linked bank account.\n \n- DRG - Deregistered at TPA. \n - Passed along with UUID when a specific business banking user is deregisters himself/herself on the TPA.\n"
}
},
"additionalProperties": false,
"required": [
"status"
]
}