Cancel a Payment Link

Cancel a payment link

curl --request POST \
  --url https://api.sbx.moduluslabs.io/ecom/v1/checkout/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Customer requested cancellation"
}
'

import requests

url = "https://api.sbx.moduluslabs.io/ecom/v1/checkout/{id}/cancel"

payload = { "reason": "Customer requested cancellation" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'Customer requested cancellation'})
};

fetch('https://api.sbx.moduluslabs.io/ecom/v1/checkout/{id}/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.sbx.moduluslabs.io/ecom/v1/checkout/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => 'Customer requested cancellation'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sbx.moduluslabs.io/ecom/v1/checkout/{id}/cancel"

	payload := strings.NewReader("{\n  \"reason\": \"Customer requested cancellation\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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.sbx.moduluslabs.io/ecom/v1/checkout/{id}/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"Customer requested cancellation\"\n}")
  .asString();

using RestSharp;


var options = new RestClientOptions("https://api.sbx.moduluslabs.io/ecom/v1/checkout/{id}/cancel");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"reason\": \"Customer requested cancellation\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "merchant_branch_reference_number": "SH-ANG-001",
    "merchant_branch_name": "SM City Angeles - Branch 1",
    "currency": "PHP",
    "amount": 150000,
    "line_items": [
      {
        "sku": "PROD-001",
        "name": "Wireless Earbuds",
        "unit_price": 75000,
        "quantity": 2,
        "metadata": {}
      }
    ],
    "expires_at": "2026-07-18T00:00:00Z",
    "hosted_url": "https://pay.moduluslabs.io/checkout/550e8400-e29b-41d4-a716-446655440000",
    "successful_payment_count": 3,
    "metadata": {},
    "created_at": "2026-06-18T10:30:00Z",
    "updated_at": "2026-06-18T14:22:00Z",
    "description": "Order for wireless earbuds",
    "order_reference": "ORD-2026-0618-001",
    "redirect_urls": {
      "success": "https://merchant.com/payment/success",
      "declined": "https://merchant.com/payment/declined",
      "expired": "https://merchant.com/payment/expired"
    },
    "max_uses": 10,
    "cancelled_at": "2023-11-07T05:31:56Z",
    "cancellation_reason": "<string>"
  }
}

POST

checkout

{id}

cancel

Cancel a payment link

curl --request POST \
  --url https://api.sbx.moduluslabs.io/ecom/v1/checkout/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Customer requested cancellation"
}
'

import requests

url = "https://api.sbx.moduluslabs.io/ecom/v1/checkout/{id}/cancel"

payload = { "reason": "Customer requested cancellation" }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({reason: 'Customer requested cancellation'})
};

fetch('https://api.sbx.moduluslabs.io/ecom/v1/checkout/{id}/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.sbx.moduluslabs.io/ecom/v1/checkout/{id}/cancel",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'reason' => 'Customer requested cancellation'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sbx.moduluslabs.io/ecom/v1/checkout/{id}/cancel"

	payload := strings.NewReader("{\n  \"reason\": \"Customer requested cancellation\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	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.sbx.moduluslabs.io/ecom/v1/checkout/{id}/cancel")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"Customer requested cancellation\"\n}")
  .asString();

using RestSharp;


var options = new RestClientOptions("https://api.sbx.moduluslabs.io/ecom/v1/checkout/{id}/cancel");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"reason\": \"Customer requested cancellation\"\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "merchant_branch_reference_number": "SH-ANG-001",
    "merchant_branch_name": "SM City Angeles - Branch 1",
    "currency": "PHP",
    "amount": 150000,
    "line_items": [
      {
        "sku": "PROD-001",
        "name": "Wireless Earbuds",
        "unit_price": 75000,
        "quantity": 2,
        "metadata": {}
      }
    ],
    "expires_at": "2026-07-18T00:00:00Z",
    "hosted_url": "https://pay.moduluslabs.io/checkout/550e8400-e29b-41d4-a716-446655440000",
    "successful_payment_count": 3,
    "metadata": {},
    "created_at": "2026-06-18T10:30:00Z",
    "updated_at": "2026-06-18T14:22:00Z",
    "description": "Order for wireless earbuds",
    "order_reference": "ORD-2026-0618-001",
    "redirect_urls": {
      "success": "https://merchant.com/payment/success",
      "declined": "https://merchant.com/payment/declined",
      "expired": "https://merchant.com/payment/expired"
    },
    "max_uses": 10,
    "cancelled_at": "2023-11-07T05:31:56Z",
    "cancellation_reason": "<string>"
  }
}

Cancellation is permanent. Cancelled links cannot be reactivated — create a new link to accept payments again. Only ACTIVE links can be cancelled.

Returns the cancelled payment link with status: "CANCELLED", cancelled_at populated, and cancellation_reason if a reason was provided.

Idempotency

An Idempotency-Key header is optional here — cancel is idempotent by nature, so re-cancelling an already-cancelled link is a safe no-op. If you do send one, use a unique client-generated identifier (letters, digits, dot, hyphen, underscore; 8–64 characters). The optional reason is stored for audit purposes.

Required scope

payment_links.cancel

Authorizations

Authorization

string

header

required

API key passed as a bearer token. Use sk_live_ keys for production and sk_test_ keys for sandbox. Keys are provisioned during merchant onboarding.

Headers

Idempotency-Key

string

Optional. Cancel is idempotent by nature — re-cancelling an already-cancelled link is a safe no-op — so a key is accepted but not required. Same charset as create: letters, digits, dot (.), hyphen (-), underscore (_); 8–64 characters.

Pattern: ^[A-Za-z0-9._-]{8,64}$

Path Parameters

string<uuid>

required

The payment link ID (UUID v4).

Body

application/json

reason

string

Why the link is being cancelled. Stored for audit purposes.

Maximum string length: 500

Example:

"Customer requested cancellation"

Response

The cancelled payment link

data

object

required

The payment link object returned by all endpoints.

Show child attributes

QR API

Onboarding API

Transaction Reporting API

Terminal Gateway API

Ecom API

Idempotency

Required scope

Authorizations

Headers

Path Parameters

Body

Response

​Idempotency

​Required scope

Authorizations

Headers

Path Parameters

Body

Response

Idempotency

Required scope