Skip to content

Payments: Cancel

POST/payments/{payment_id}/cancel

A Payment could can be cancelled when it is in one of these statuses: requires_payment_method, requires_capture, requires_confirmation, requires_customer_action.

Path parameters

  • payment_idstringrequired

    The identifier for payment

Request body PaymentsCancelRequest (object)

  • cancellation_reasonstring, nullable

    The reason for the payment cancel

  • all_keys_requiredboolean, nullable

    If enabled, provides whole processor response

Responses

  • 200Payment canceled
  • 400Missing mandatory fields

Request

curl --request POST \
  --url https://sandbox.cardencer.com/payments/{payment_id}/cancel \
  --header 'Content-Type: application/json' \
  --header 'api-key: snd_...' \
  --data '{
    "cancellation_reason": "requested_by_customer"
  }'

Response

{
  "error_type": "invalid_request",
  "message": "Missing required param: {param}",
  "code": "IR_04"
}