PaybytokenDocs
Payment Intents
API reference · Payment Intents

Cancel a Payment Intent

Stop an eligible intent and release any customer-balance authorization.

POST /api/v1/payment_intents/:id/cancel

curl https://api-prod.paybytoken.io/api/v1/payment_intents/pay_t24c9qLoGieNDhvHVHWo/cancel \
  -X POST \
  -H "Authorization: Bearer $PAYBYTOKEN_SECRET_KEY"

For a direct crypto_transfer, cancellation is allowed while the intent is requires_payment_method, requires_additional_payment, or requires_action. It cannot stop a transaction that the customer has already broadcast.

For customer_balance, cancellation also releases an eligible uncaptured authorization. A Paybytoken Pay intent requires a merchant secret key and cancels only its payment lifecycle; hosted handoff sessions have their own cancellation endpoint.

Cancellation cannot stop a blockchain transfer

If a customer sends funds after cancellation, the transaction still exists on-chain. Keep the destination address associated with the original order and handle late funds through operations review.

Response

Direct crypto-transfer cancellation returns a compact result:

{
  "id": "pay_t24c9qLoGieNDhvHVHWo",
  "status": "canceled"
}

Customer-balance cancellation returns the updated Payment Intent, including released capturable amounts. Treat payment_intent.canceled as the canonical asynchronous event.

On this page

API Workbench

Full Explorer

Open in new tab