Cancels an existing redirect session

POST 
/redirect-sessions/:redirectSessionId/cancel

Cancels an existing redirect session

Request

Path Parameters

redirectSessionId uuidrequired

The id of the redirect session

Responses

200

Expected response to a valid request

application/json

Schema

Schema

id uuidrequired

The unique id of the redirect session

state RedirectSessionState (string)required

Possible values: [Cancelled]

The type of the event, defining also the attributes of which entity are to be found in the data property

createdOn date-timerequired

The creation datetime of the entity, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time

lastModifiedOn date-timerequired

The last modification datetime of the entity, in ISO 8601 format of YYYY-MM-DDThh:mm:ssZ in UTC time

Example (from schema)

{
  "id": "d80d9e26-ffa0-43f2-8c2b-c96513cc9351",
  "state": "Cancelled",
  "createdOn": "2019-01-31T11:59:59Z",
  "lastModifiedOn": "2019-01-31T11:59:59Z"
}

400

Validation failed

application/json

Schema

Schema

code stringrequired

Possible values: [Validation, InvalidTriggeredBy, InvalidRedirectSessionStateTransition]

The type of error. Used for defining which sub-element will be present in the details property.

message stringrequired

A short text describing the error.

moreInfo string

A link to the online documentation describing the error in detail.

correlationId uuid

Identifies the conversation within which the error got generated.

details

object

Contains additional details of the error

customerPermissionDeniedReason CustomerPermissionDeniedReason (string)

The reason for CustomerPermissionDenied declineReason

validationErrorReasons

object[]

A collection of Validation error details

Array [

fieldName string

name of filed that failed validation

errorMessage stringrequired

error message

]

limitThresholdExceededReason LimitThresholdExceededReason (string)

The reason for LimitThresholdExceeded declineReason

Example (from schema)

{
  "code": "Validation",
  "message": "The field \"customerId\" could not be validated.",
  "moreInfo": "https://developer.example.com/v1.0/reference#error-handling",
  "correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
  "details": {
    "customerPermissionDeniedReason": "string",
    "validationErrorReasons": [
      {
        "fieldName": "customerId",
        "errorMessage": "Value must not be empty"
      }
    ],
    "limitThresholdExceededReason": "string"
  }
}

404

Redirect Session or entity it depends on was not found

application/json

Schema

Schema

code stringrequired

Possible values: [RedirectSessionNotFound, CustomerNotFound]

The type of error. Used for defining which sub-element will be present in the details property.

message stringrequired

A short text describing the error.

moreInfo string

A link to the online documentation describing the error in detail.

correlationId uuid

Identifies the conversation within which the error got generated.

details

object

Contains additional details of the error

customerPermissionDeniedReason CustomerPermissionDeniedReason (string)

The reason for CustomerPermissionDenied declineReason

validationErrorReasons

object[]

A collection of Validation error details

Array [

fieldName string

name of filed that failed validation

errorMessage stringrequired

error message

]

limitThresholdExceededReason LimitThresholdExceededReason (string)

The reason for LimitThresholdExceeded declineReason

Example (from schema)

{
  "code": "RedirectSessionNotFound",
  "message": "The field \"customerId\" could not be validated.",
  "moreInfo": "https://developer.example.com/v1.0/reference#error-handling",
  "correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
  "details": {
    "customerPermissionDeniedReason": "string",
    "validationErrorReasons": [
      {
        "fieldName": "customerId",
        "errorMessage": "Value must not be empty"
      }
    ],
    "limitThresholdExceededReason": "string"
  }
}

409

Redirect Session was updated in the meantime, or duplicate

application/json

Schema

Schema

code stringrequired

Possible values: [EntityVersionMismatch]

The type of error. Used for defining which sub-element will be present in the details property.

message stringrequired

A short text describing the error.

moreInfo string

A link to the online documentation describing the error in detail.

correlationId uuid

Identifies the conversation within which the error got generated.

details

object

Contains additional details of the error

customerPermissionDeniedReason CustomerPermissionDeniedReason (string)

The reason for CustomerPermissionDenied declineReason

validationErrorReasons

object[]

A collection of Validation error details

Array [

fieldName string

name of filed that failed validation

errorMessage stringrequired

error message

]

limitThresholdExceededReason LimitThresholdExceededReason (string)

The reason for LimitThresholdExceeded declineReason

Example (from schema)

{
  "code": "EntityVersionMismatch",
  "message": "The field \"customerId\" could not be validated.",
  "moreInfo": "https://developer.example.com/v1.0/reference#error-handling",
  "correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
  "details": {
    "customerPermissionDeniedReason": "string",
    "validationErrorReasons": [
      {
        "fieldName": "customerId",
        "errorMessage": "Value must not be empty"
      }
    ],
    "limitThresholdExceededReason": "string"
  }
}

500

Unexpected technical error

application/json

Schema

Schema

code stringrequired

Possible values: [GeneralErrorOccurred]

The type of error. Used for defining which sub-element will be present in the details property.

message stringrequired

A short text describing the error.

moreInfo string

A link to the online documentation describing the error in detail.

correlationId uuid

Identifies the conversation within which the error got generated.

details

object

Contains additional details of the error

customerPermissionDeniedReason CustomerPermissionDeniedReason (string)

The reason for CustomerPermissionDenied declineReason

validationErrorReasons

object[]

A collection of Validation error details

Array [

fieldName string

name of filed that failed validation

errorMessage stringrequired

error message

]

limitThresholdExceededReason LimitThresholdExceededReason (string)

The reason for LimitThresholdExceeded declineReason

Example (from schema)

{
  "code": "GeneralErrorOccurred",
  "message": "The field \"customerId\" could not be validated.",
  "moreInfo": "https://developer.example.com/v1.0/reference#error-handling",
  "correlationId": "ce8056cd-ae4d-4f2d-87de-7562c92f92cc",
  "details": {
    "customerPermissionDeniedReason": "string",
    "validationErrorReasons": [
      {
        "fieldName": "customerId",
        "errorMessage": "Value must not be empty"
      }
    ],
    "limitThresholdExceededReason": "string"
  }
}

Loading...