Cancel a checkout session
curl --request POST \
--url https://api.simiz.io/v1/checkout/sessions/{sessionId}/cancelimport requests
url = "https://api.simiz.io/v1/checkout/sessions/{sessionId}/cancel"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.simiz.io/v1/checkout/sessions/{sessionId}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.simiz.io/v1/checkout/sessions/{sessionId}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.simiz.io/v1/checkout/sessions/{sessionId}/cancel"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.simiz.io/v1/checkout/sessions/{sessionId}/cancel")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.simiz.io/v1/checkout/sessions/{sessionId}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"id": "cs_abc123",
"url": "https://pay.simiz.io/cs/abc123",
"amount": 5000,
"currency": "XAF",
"description": "<string>",
"status": "idle",
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"merchantName": "<string>",
"merchantLogo": "<string>",
"successUrl": "<string>",
"cancelUrl": "<string>",
"paymentMethod": "ORANGE_MONEY",
"paymentId": "<string>",
"customer": {
"email": "<string>",
"phone": "<string>"
}
}{
"statusCode": 400,
"message": "amount must not be less than 100",
"error": "Bad Request"
}{
"statusCode": 404,
"message": "Payment not found",
"error": "Not Found"
}Checkout (Public)
Cancel a checkout session
Cancel an in-progress checkout session. Once cancelled, the session cannot be used. No authentication required.
POST
/
checkout
/
sessions
/
{sessionId}
/
cancel
Cancel a checkout session
curl --request POST \
--url https://api.simiz.io/v1/checkout/sessions/{sessionId}/cancelimport requests
url = "https://api.simiz.io/v1/checkout/sessions/{sessionId}/cancel"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.simiz.io/v1/checkout/sessions/{sessionId}/cancel', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.simiz.io/v1/checkout/sessions/{sessionId}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.simiz.io/v1/checkout/sessions/{sessionId}/cancel"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.simiz.io/v1/checkout/sessions/{sessionId}/cancel")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.simiz.io/v1/checkout/sessions/{sessionId}/cancel")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"id": "cs_abc123",
"url": "https://pay.simiz.io/cs/abc123",
"amount": 5000,
"currency": "XAF",
"description": "<string>",
"status": "idle",
"expiresAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"merchantName": "<string>",
"merchantLogo": "<string>",
"successUrl": "<string>",
"cancelUrl": "<string>",
"paymentMethod": "ORANGE_MONEY",
"paymentId": "<string>",
"customer": {
"email": "<string>",
"phone": "<string>"
}
}{
"statusCode": 400,
"message": "amount must not be less than 100",
"error": "Bad Request"
}{
"statusCode": 404,
"message": "Payment not found",
"error": "Not Found"
}Path Parameters
Checkout session ID (format: cs_xxx)
Example:
"cs_abc123"
Response
Session cancelled successfully
Checkout session ID
Example:
"cs_abc123"
Payment URL for the customer
Example:
"https://pay.simiz.io/cs/abc123"
Example:
5000
Example:
"XAF"
Checkout session lifecycle:
idle— Session created, waiting for payment initiationprocessing— Payment being processedpending_ussd— Waiting for USSD confirmation from payersuccess— Payment completedfailed— Payment failedexpired— Session expiredcancelled— Session cancelled
Available options:
idle, processing, pending_ussd, success, failed, expired, cancelled Checkout-specific payment methods (broader than core):
ORANGE_MONEY,MTN_MOMO,WAVE,MOOV_MONEY
Available options:
ORANGE_MONEY, MTN_MOMO, WAVE, MOOV_MONEY Payment ID once payment is initiated
Show child attributes
Show child attributes

