Expire a checkout session
curl --request POST \
--url https://merchant-api-prod.anyway.sh/v1/checkout-sessions/{id}/expire \
--header 'X-API-Key: <api-key>'import requests
url = "https://merchant-api-prod.anyway.sh/v1/checkout-sessions/{id}/expire"
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
fetch('https://merchant-api-prod.anyway.sh/v1/checkout-sessions/{id}/expire', 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://merchant-api-prod.anyway.sh/v1/checkout-sessions/{id}/expire",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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://merchant-api-prod.anyway.sh/v1/checkout-sessions/{id}/expire"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://merchant-api-prod.anyway.sh/v1/checkout-sessions/{id}/expire")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://merchant-api-prod.anyway.sh/v1/checkout-sessions/{id}/expire")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"amount": 123,
"createdAt": "<string>",
"currency": "<string>",
"customerEmail": "<string>",
"customerId": "<string>",
"expiresAt": "<string>",
"id": "<string>",
"lastError": {
"code": "<string>",
"occurredAt": "<string>",
"operation": "<string>",
"requestId": "<string>"
},
"merchantReference": "<string>",
"metadata": {},
"orderId": "<string>",
"orderStatus": "<string>",
"paymentLinkId": "<string>",
"pricing": {
"amount": 123,
"billingInterval": "DAY",
"billingIntervalCount": 123,
"currency": "<string>",
"flexibleAmount": true,
"maxAmount": 123,
"minAmount": 123,
"pricingId": "<string>",
"pricingName": "<string>",
"pricingType": "SUBSCRIPTION"
},
"product": {
"description": "<string>",
"name": "<string>",
"productId": "<string>"
},
"productName": "<string>",
"provider": "<string>",
"quantity": 123,
"status": "CREATED",
"url": "<string>"
},
"error": {
"code": "<string>",
"message": "<string>"
},
"message": "<string>",
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"message": "<string>"
},
"message": "<string>",
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"message": "<string>"
},
"message": "<string>",
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"message": "<string>"
},
"message": "<string>",
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"message": "<string>"
},
"message": "<string>",
"success": true
}Merchant API endpoints
Expire a checkout session
Expire a checkout session for your organization.
POST
/
v1
/
checkout-sessions
/
{id}
/
expire
Expire a checkout session
curl --request POST \
--url https://merchant-api-prod.anyway.sh/v1/checkout-sessions/{id}/expire \
--header 'X-API-Key: <api-key>'import requests
url = "https://merchant-api-prod.anyway.sh/v1/checkout-sessions/{id}/expire"
headers = {"X-API-Key": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'X-API-Key': '<api-key>'}};
fetch('https://merchant-api-prod.anyway.sh/v1/checkout-sessions/{id}/expire', 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://merchant-api-prod.anyway.sh/v1/checkout-sessions/{id}/expire",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"X-API-Key: <api-key>"
],
]);
$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://merchant-api-prod.anyway.sh/v1/checkout-sessions/{id}/expire"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("X-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://merchant-api-prod.anyway.sh/v1/checkout-sessions/{id}/expire")
.header("X-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://merchant-api-prod.anyway.sh/v1/checkout-sessions/{id}/expire")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"amount": 123,
"createdAt": "<string>",
"currency": "<string>",
"customerEmail": "<string>",
"customerId": "<string>",
"expiresAt": "<string>",
"id": "<string>",
"lastError": {
"code": "<string>",
"occurredAt": "<string>",
"operation": "<string>",
"requestId": "<string>"
},
"merchantReference": "<string>",
"metadata": {},
"orderId": "<string>",
"orderStatus": "<string>",
"paymentLinkId": "<string>",
"pricing": {
"amount": 123,
"billingInterval": "DAY",
"billingIntervalCount": 123,
"currency": "<string>",
"flexibleAmount": true,
"maxAmount": 123,
"minAmount": 123,
"pricingId": "<string>",
"pricingName": "<string>",
"pricingType": "SUBSCRIPTION"
},
"product": {
"description": "<string>",
"name": "<string>",
"productId": "<string>"
},
"productName": "<string>",
"provider": "<string>",
"quantity": 123,
"status": "CREATED",
"url": "<string>"
},
"error": {
"code": "<string>",
"message": "<string>"
},
"message": "<string>",
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"message": "<string>"
},
"message": "<string>",
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"message": "<string>"
},
"message": "<string>",
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"message": "<string>"
},
"message": "<string>",
"success": true
}{
"data": "<unknown>",
"error": {
"code": "<string>",
"message": "<string>"
},
"message": "<string>",
"success": true
}See the Checkout Sessions guide for purchase inputs, idempotency, and payment status.