Expire a Session

PUT 
/checkout/sessions/:session_id/expire

Manually expires a Session. Sessions should be in the open status.

Request

Path Parameters

session_id uuidrequired

Possible values: <= 36 characters, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Session's ID

Responses

200

Session expired

application/json

Schema

Schema

status string

Possible values: [success]

code integer

Possible values: [200]

message string

Possible values: [Successful request]

Example (from schema)

{
  "status": "success",
  "code": 200,
  "message": "Successful request"
}

401

Access token is missing or invalid

403

Access denied

404

Session not found

application/json

Schema

Schema

status string

Possible values: [not found]

code integer

Possible values: [404]

message string

Failure reason

Example (from schema)

{
  "status": "not found",
  "code": 404,
  "message": "Entity not found"
}

409

Failure due to a conflict in the provided entity

application/json

Schema

Schema

status string

Possible values: [fail]

code integer

Possible values: [409]

message string

Failure reason

Example (from schema)

{
  "status": "fail",
  "code": 409,
  "message": "Entity with Id already exists"
}

500

Server error

Loading...