curl --request POST \
  --url https://api.sandbox.z2pay.com/v1/checkout/charges/{id}/cancel \
  --header 'x-api-key: <api-key>'

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

fetch('https://api.sandbox.z2pay.com/v1/checkout/charges/{id}/cancel', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.sandbox.z2pay.com/v1/checkout/charges/{id}/cancel"

headers = {"x-api-key": "<api-key>"}

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

print(response.text)

{
  "id": "cs_02f232c4dcf8eec4c29e0f3748476d1339b63c0e7ffab1dc",
  "linkId": null,
  "status": "canceled",
  "mode": "payment",
  "currency": "BRL",
  "locale": "pt-BR",
  "config": {
    "paymentMethods": {
      "card": {
        "enabled": true,
        "installments": {
          "maxInstallments": 12
        }
      },
      "pix": {
        "enabled": true,
        "expiresIn": 3600
      }
    },
    "description": "Curso de Marketing Digital"
  },
  "customer": {
    "name": "Maria Souza",
    "email": "maria.souza@example.com",
    "document": "12345678909",
    "documentType": "cpf"
  },
  "customFieldValues": null,
  "paymentMethodSelected": null,
  "subtotal": 19900,
  "discountTotal": 0,
  "amount": 19900,
  "discounts": [],
  "paymentAttempts": 0,
  "transactionId": null,
  "subscriptionId": null,
  "invoiceId": null,
  "metadata": null,
  "createdAt": "2025-06-29T13:45:30.000Z",
  "updatedAt": "2025-06-29T14:10:00.000Z",
  "openedAt": "2025-06-29T13:46:02.000Z",
  "paidAt": null,
  "canceledAt": "2025-06-29T14:10:00.000Z",
  "expiresAt": "2025-06-30T13:45:30.000Z",
  "url": "https://checkout.z2pay.com.br/c/s/cs_02f232c4dcf8eec4c29e0f3748476d1339b63c0e7ffab1dc"
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Invalid API key"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "Forbidden — insufficient permissions"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Charge not found"
  }
}

{
  "error": {
    "code": "CONFLICT",
    "message": "No refundable payment found"
  }
}

{
  "error": "Idempotency key already used with a different request body"
}