> ## Documentation Index > Fetch the complete documentation index at: https://api-reference.hyperswitch.io/llms.txt > Use this file to discover all available pages before exploring further. # Payments - 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`. ## OpenAPI ````yaml post /payments/{payment_id}/cancel openapi: 3.0.3 info: title: Hyperswitch - API Documentation description: > ## Get started Hyperswitch provides a collection of APIs that enable you to process and manage payments. Our APIs accept and return JSON in the HTTP body, and return standard HTTP response codes. You can consume the APIs directly using your favorite HTTP/REST library. We have a testing environment referred to "sandbox", which you can setup to test API calls without affecting production data. Currently, our sandbox environment is live while our production environment is under development and will be available soon. You can sign up on our Dashboard to get API keys to access Hyperswitch API. ### Environment Use the following base URLs when making requests to the APIs: | Environment | Base URL | |---------------|------------------------------------| | Sandbox | | | Production | | ## Authentication When you sign up on our [dashboard](https://app.hyperswitch.io) and create a merchant account, you are given a secret key (also referred as api-key) and a publishable key. You may authenticate all API requests with Hyperswitch server by providing the appropriate key in the request Authorization header. | Key | Description | |-----------------|-----------------------------------------------------------------------------------------------| | api-key | Private key. Used to authenticate all API requests from your merchant server | | publishable key | Unique identifier for your account. Used to authenticate API requests from your app's client | Never share your secret api keys. Keep them guarded and secure. contact: name: Hyperswitch Support url: https://hyperswitch.io email: support.global@juspay.io license: name: Apache-2.0 version: 0.1.0 servers: - url: https://sandbox.hyperswitch.io description: Sandbox Environment security: [] tags: - name: Merchant Account description: Create and manage merchant accounts - name: Profile description: Create and manage profiles - name: Merchant Connector Account description: Create and manage merchant connector accounts - name: Payments description: Create and manage one-time payments, recurring payments and mandates - name: Refunds description: Create and manage refunds for successful payments - name: Mandates description: Manage mandates - name: Customers description: Create and manage customers - name: Payment Methods description: Create and manage payment methods of customers - name: Disputes description: Manage disputes - name: API Key description: Create and manage API Keys - name: Payouts description: Create and manage payouts - name: payment link description: Create payment link - name: Routing description: Create and manage routing configurations - name: Event description: Manage events - name: Authentication description: Create and manage authentication - name: Subscriptions description: Subscription management and billing endpoints - name: Card Issuer description: Create and manage card issuers paths: /payments/{payment_id}/cancel: post: tags: - Payments summary: Payments - Cancel description: >- A Payment could can be cancelled when it is in one of these statuses: `requires_payment_method`, `requires_capture`, `requires_confirmation`, `requires_customer_action`. operationId: Cancel a Payment parameters: - name: payment_id in: path description: The identifier for payment required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/PaymentsCancelRequest' examples: Cancel the payment with cancellation reason: value: cancellation_reason: requested_by_customer Cancel the payment with minimal fields: value: {} required: true responses: '200': description: Payment canceled '400': description: Missing mandatory fields content: application/json: schema: $ref: '#/components/schemas/GenericErrorResponseOpenApi' security: - api_key: [] components: schemas: PaymentsCancelRequest: type: object properties: cancellation_reason: type: string description: The reason for the payment cancel nullable: true merchant_connector_details: allOf: - $ref: '#/components/schemas/MerchantConnectorDetailsWrap' nullable: true all_keys_required: type: boolean description: If enabled, provides whole connector response nullable: true GenericErrorResponseOpenApi: type: object required: - error_type - message - code properties: error_type: type: string example: invalid_request message: type: string example: 'Missing required param: {param}' code: type: string example: IR_04 MerchantConnectorDetailsWrap: type: object description: Merchant connector details used to make payments. required: - creds_identifier properties: creds_identifier: type: string description: >- Creds Identifier is to uniquely identify the credentials. Do not send any sensitive info, like encoded_data in this field. And do not send the string "null". encoded_data: allOf: - $ref: '#/components/schemas/MerchantConnectorDetails' nullable: true MerchantConnectorDetails: type: object properties: connector_account_details: type: object description: >- Account details of the Connector. You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long. Useful for storing additional, structured information on an object. nullable: true metadata: type: object description: >- Metadata is useful for storing additional, unstructured information on an object. nullable: true securitySchemes: api_key: type: apiKey in: header name: api-key description: >- Use the API key created under your merchant account from the HyperSwitch dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application. ````