Payment Intents

Cancel a payment intent

Cancels a payment intent, releasing any authorization it holds. Served by the service that decides the intent (processed_by), in core-api's response shape and error answers either way. A public key may cancel with the intent's client_key in the body.

post/v1/payment_intents/{id}/cancel

Request

  • Base URL
    https://orders-api.paymongo.com
  • URL
    https://orders-api.paymongo.com/v1/payment_intents/{id}/cancel
  • Auth
    HTTP basic

Path parameters

idstring required

Payment intent ID

Request body

Example request

{
  "data": {
    "attributes": {
      "client_key": "pi_abc123_client_key"
    }
  }
}

Response

OK

Example response

{
  "data": {
    "id": "pi_abc123",
    "type": "payment_intent"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.