curl https://api.swiftpay.cx/api/checkout/sessions/sess_abc123 \
  -H "Authorization: Bearer mp_live_your_api_key"

{
  "success": true,
  "data": {
    "id": "sess_abc123",
    "amountInCents": 2999,
    "currency": "USD",
    "status": "completed",
    "checkoutUrl": "https://checkout.swiftpay.cx/sess_abc123",
    "customerEmail": "[email protected]",
    "metadata": {
      "orderId": "order_12345",
      "productName": "Premium Plan"
    },
    "successUrl": "https://yoursite.com/success",
    "cancelUrl": "https://yoursite.com/cancel",
    "expiresAt": "2024-01-15T11:30:00Z",
    "completedAt": "2024-01-15T10:35:00Z",
    "createdAt": "2024-01-15T10:30:00Z"
  }
}

GET

https://api.swiftpay.cx

api

checkout

sessions

:id

curl https://api.swiftpay.cx/api/checkout/sessions/sess_abc123 \
  -H "Authorization: Bearer mp_live_your_api_key"

{
  "success": true,
  "data": {
    "id": "sess_abc123",
    "amountInCents": 2999,
    "currency": "USD",
    "status": "completed",
    "checkoutUrl": "https://checkout.swiftpay.cx/sess_abc123",
    "customerEmail": "[email protected]",
    "metadata": {
      "orderId": "order_12345",
      "productName": "Premium Plan"
    },
    "successUrl": "https://yoursite.com/success",
    "cancelUrl": "https://yoursite.com/cancel",
    "expiresAt": "2024-01-15T11:30:00Z",
    "completedAt": "2024-01-15T10:35:00Z",
    "createdAt": "2024-01-15T10:30:00Z"
  }
}

Get Checkout Session

Retrieves the details of an existing checkout session.

Request

Authorization

string

required

Bearer token with your API key

string

required

The unique identifier of the checkout session (e.g., sess_abc123)

Response

success

boolean

Whether the request was successful

data

object

Show properties

string

Unique session identifier

status

string

Current status: pending, processing, completed, failed, cancelled, refunded

checkoutUrl

string

The URL where the customer can complete the payment

currency

string

Three-letter ISO currency code

total

integer

Total amount in cents

customerEmail

string

Customer’s email address

customerName

string

Customer’s name (if provided)

description

string

Session description

metadata

object

Custom key-value pairs

successUrl

string

Redirect URL after successful payment

cancelUrl

string

Redirect URL if payment cancelled

failureUrl

string

Redirect URL if payment failed

completedAt

string

ISO 8601 completion timestamp (if completed)

createdAt

string

ISO 8601 creation timestamp

updatedAt

string

ISO 8601 last update timestamp

curl https://api.swiftpay.cx/api/checkout/sessions/sess_abc123 \
  -H "Authorization: Bearer mp_live_your_api_key"

{
  "success": true,
  "data": {
    "id": "sess_abc123",
    "amountInCents": 2999,
    "currency": "USD",
    "status": "completed",
    "checkoutUrl": "https://checkout.swiftpay.cx/sess_abc123",
    "customerEmail": "[email protected]",
    "metadata": {
      "orderId": "order_12345",
      "productName": "Premium Plan"
    },
    "successUrl": "https://yoursite.com/success",
    "cancelUrl": "https://yoursite.com/cancel",
    "expiresAt": "2024-01-15T11:30:00Z",
    "completedAt": "2024-01-15T10:35:00Z",
    "createdAt": "2024-01-15T10:30:00Z"
  }
}

Session Statuses

Status	Description
`pending`	Session created, awaiting customer payment
`processing`	Payment is being processed
`completed`	Payment successful
`expired`	Session expired before payment
`failed`	Payment failed

Sessions expire after 1 hour by default. Check expiresAt to see when a pending session will expire.

List Checkout Sessions Create Refund

⌘I

Overview

Balance

Checkout Sessions

Refunds

Reserves

Withdrawals

Webhooks

Get Checkout Session

Get Checkout Session

Request

Response

Session Statuses

Overview

Balance

Checkout Sessions

Refunds

Reserves

Withdrawals

Webhooks

​Get Checkout Session

​Request

​Response

​Session Statuses

Get Checkout Session

Request

Response

Session Statuses