Cancel Session
Description
To cancel a session if it is no longer needed. This will prevent any further messages from being sent for that request_id. Any in-progress workflow steps will be cancelled.
Production Endpoint URL: https://api.cpaas.symphony.rakuten.net/twofa/v1/cancel/$request_id
Methods: POST
HTTP Headers
| Parameter | Required | Value |
|---|---|---|
| Authentication | Y | Type: Bearer Token: JWT Token |
| Accept | Y | application/json |
| Content-Type | Y | application/json; charset=UTF-8 |
Request Body Schema: application/json
| Parameter | Required | Description/Values |
|---|---|---|
| request_id | Y | This is the request_id returned by platform when a new PIN is requested for |
Response:
If successful, the API call will return an HTTP 200 OK with a Json document as a response. Please see section "Errors Codes" for a description of the failure responses.
| Parameter | Description |
|---|---|
| success | This describes the outcome of the session and will return true when PIN was sent correctly, PIN was validated correctly etc., and it will return false when PIN was invalid or incorrect etc. or the session was cancelled. |
| result_code | Refer Result Code List |
| result_message | Description of the result code |
| client_reference | Client reference is returned only when specified in request. |
| request_id | The request_id provided in the request is returned for reference |
Sample Response
{
"success" : false,
"result_code" : 215,
"result_message" : "The requested session has been cancelled",
"client_reference": "...if provided during original request...",
"request_id" : "...the request_id provided in the request is returned for reference..."
}