Expire a checkout session

POST

/api/v1/checkout/sessions/{id}/expire

POST

/api/v1/checkout/sessions/{id}/expire

Stops new payments. Refused if it is already paid.

Authorization

apiKey

headerx-api-key<token>

Path Parameters

id*string

Response Body

application/json

response

code*number

HTTP status code

message*string

Human-readable message

data?

Response payload

metadata?

errors?array<string>

Validation errors, when the request was rejected

Example Request

curl -X POST 'https://api.landedfx.com/api/v1/checkout/sessions/string/expire'

Example Request

curl -X POST 'https://api.landedfx.com/api/v1/checkout/sessions/string/expire'

Example ResponseSchema200

{
  "message": "string",
  "metadata": {
    "page": 1,
    "limit": 20,
    "totalDocs": 42,
    "prevPage": null,
    "nextPage": 2,
    "totalPages": 3
  },
  "errors": [
    "string"
  ],
  "code": 200,
  "data": {
    "id": "cs_C-uVukE6A_gp",
    "object": "checkout.session",
    "status": "open",
    "paymentStatus": "unpaid",
    "url": "string",
    "amount": 0,
    "currency": "usd",
    "settlesIn": "USDC:base",
    "clientReferenceId": "string",
    "metadata": {},
    "paymentId": "string",
    "expiresAt": "string"
  }
}

{  "message": "string",  "metadata": {    "page": 1,    "limit": 20,    "totalDocs": 42,    "prevPage": null,    "nextPage": 2,    "totalPages": 3  },  "errors": [    "string"  ],  "code": 200,  "data": {    "id": "cs_C-uVukE6A_gp",    "object": "checkout.session",    "status": "open",    "paymentStatus": "unpaid",    "url": "string",    "amount": 0,    "currency": "usd",    "settlesIn": "USDC:base",    "clientReferenceId": "string",    "metadata": {},    "paymentId": "string",    "expiresAt": "string"  }}

Expire a checkout session

AuthorizationCopy Anchor Link

Path ParametersCopy Anchor Link

Response BodyCopy Anchor Link

Authorization

Path Parameters

Response Body