POST
Cancel a checkout session

Path Parameters

sessionId
string
required

Checkout session ID (format: cs_xxx)

Example:

"cs_abc123"

Response

Session cancelled successfully

id
string

Checkout session ID

Example:

"cs_abc123"

url
string<uri>

Payment URL for the customer

Example:

"https://pay.simiz.io/cs/abc123"

amount
number
Example:

5000

currency
string
Example:

"XAF"

description
string | null
status
enum<string>

Checkout session lifecycle:

  • idle — Session created, waiting for payment initiation
  • processing — Payment being processed
  • pending_ussd — Waiting for USSD confirmation from payer
  • success — Payment completed
  • failed — Payment failed
  • expired — Session expired
  • cancelled — Session cancelled
Available options:
idle,
processing,
pending_ussd,
success,
failed,
expired,
cancelled
expiresAt
string<date-time>
createdAt
string<date-time>
merchantName
string
merchantLogo
string<uri> | null
successUrl
string<uri>
cancelUrl
string<uri>
paymentMethod
enum<string>

Checkout-specific payment methods (broader than core):

  • ORANGE_MONEY, MTN_MOMO, WAVE, MOOV_MONEY
Available options:
ORANGE_MONEY,
MTN_MOMO,
WAVE,
MOOV_MONEY
paymentId
string | null

Payment ID once payment is initiated

customer
object | null