> ## Documentation Index
> Fetch the complete documentation index at: https://docs.payaza.africa/llms.txt
> Use this file to discover all available pages before exploring further.

# Void Transaction

> This endpoint voids a previously authorized transaction. This request can only be done on transactions that are fully authorized and have not been captured 

> **Notes:**
>
> 1. **Partially captured authorizations cannot be voided**: If any amount has been captured, void is not allowed. The response will indicate the remaining capturable amount..
> 2. **Fully captured authorizations cannot be voided::** Once a transaction is fully captured (status becomes CAPTURED), it cannot be voided. You must use the refund API instead.
> 3. **Authentication:** Valid Authorization header required (same format as authorize endpoint). 
> 4. **Only fully authorized (uncaptured) transactions can be voided:** Void is only allowed for authorizations that have never been captured.



## OpenAPI

````yaml /openapi.json post /card/auth_capture/void
openapi: 3.0.1
info:
  title: Payaza Documentation
  version: 2.0.0
  description: >-
    API reference for processing payments using Card, Bank Transfer, USSD, and
    QR Code methods.
servers:
  - url: https://api.payaza.africa/live
security:
  - ApiKeyAuth: []
  - TenantID: []
  - ProductID: []
tags:
  - name: Transfers
    description: >-
      Transfers are transactions made from your Payaza account to beneficiaries.
      Merchants can instantly transfer funds from their available balance. For
      every transfer, you need to specify the amount and the beneficiary’s
      details. You become eligible to make transfers after you have been
      verified. (you sign up, finish account activation and KYC verification).
  - name: Payaza Account
    description: >-
      This is our internal account that can be used to make payouts to other
      bank accounts, in single or in bulk. The Payaza account can also be used
      to receive settlements. It can also be used to track the transfer status
      of your transactions and check your balance instantly
  - name: Sub Accounts
    description: >-
      This enables you to establish Sub Payaza accounts for your customers. Each
      sub-account comes with an assigned static virtual account, facilitating
      direct funding for individual accounts. Furthermore, the Main Payaza
      account can directly initiate funding for each sub-account. These
      sub-accounts serve the purpose of managing unique account positions or
      balances and facilitating disbursements from these positions to specified
      beneficiaries.
  - name: EUR Accounts
    description: >-
      This endpoints enable you to create EUR subaccounts which can be used to
      make transfers as required .
  - name: Apple Pay and Google Pay
    description: >-
      Apple Pay and Google Pay give your customers a fast, familiar, and secure
      way to complete payments. Our APIs provide a gateway to provide these
      services to your users for a smooth payment experience.
  - name: Virtual Accounts
    description: >-
      Virtual Accounts are bank accounts that are created for a specific purpose
      and last for specified durations. Virtual accounts are issued by Payaza’s
      partner banks. Our virtual account APIs can be used to create virtual
      accounts and perform other tasks relevant to virtual accounts. Virtual
      accounts are created to foster easy payment collections for your business
      and platform. 

      Static/Reserved Account: This virtual account is created by the merchant
      and remains valid indefinitely. It can be used multiple times and does not
      expire. 

      Dynamic Account: This virtual account is generated for a specific
      transaction or purpose. Please note that dynamic virtual account remains
      valid for a temporary period of time or until a payment of the specified
      amount is received. Upon expiry, a merchant can generate another one for a
      different purpose.
  - name: Card Collection
    description: >-
      The Card Collection APIs can be used to make card transactions, refund
      transactions that have been performed, check the status of a transaction
      and so much more.
  - name: Card Tokenisation
    description: >-
      The Card Tokenisation APIs are used to create card tokens, charge cards
      using tokens, retrieve all tokens created by a merchant account and
      deleting any card token as desired.
  - name: Refunds And Chargebacks
    description: >-
      The Refunds and Chargeback APIs are used to initiate refunds, view your
      refund and chargeback history and so much more.
  - name: Branches
    description: >-
      The Refunds and Chargeback APIs are used to initiate refunds, view your
      refund and chargeback history and so much more.
  - name: Auth-Capture-Void
    description: >-
      The Auth-Capture-Void APIs provide a two-phase payment process where
      transactions are first authorized, then captured or voided. This allows
      merchants to hold funds and complete the transaction in the future.
  - name: Momo and ZAR Collections
    description: APIs for MoMo, ZAR and XOF collections.
  - name: Check Transaction Status(Merchant Reference)
    description: >-
      This endpoint is used to check the transaction status of a transaction
      using the Merchant Reference..
paths:
  /card/auth_capture/void:
    post:
      tags:
        - Auth-Capture-Void
      summary: Void Transaction
      description: >-
        This endpoint voids a previously authorized transaction. This request
        can only be done on transactions that are fully authorized and have not
        been captured 


        > **Notes:**

        >

        > 1. **Partially captured authorizations cannot be voided**: If any
        amount has been captured, void is not allowed. The response will
        indicate the remaining capturable amount..

        > 2. **Fully captured authorizations cannot be voided::** Once a
        transaction is fully captured (status becomes CAPTURED), it cannot be
        voided. You must use the refund API instead.

        > 3. **Authentication:** Valid Authorization header required (same
        format as authorize endpoint). 

        > 4. **Only fully authorized (uncaptured) transactions can be voided:**
        Void is only allowed for authorizations that have never been captured.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
                - $ref: '#/components/schemas/voidTransactionRequest'
            examples:
              Void Transaction:
                summary: Void Transaction
                value:
                  authorization_reference: AUTH-ABCD1234EFGH5678IJKL
                  void_reference: VOID-001
                  void_reason: Customer cancellation
      responses:
        '200':
          description: Void Transaction
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/voidTransactionResponse'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    void_reference: VOID-1705123456-WXYZ5678
                    status: VOIDED
                    voided_amount: 100
                    remaining_amount: 0
                    message: Void successful
                Error Response Fully Captured:
                  summary: Error Response Fully Captured
                  value:
                    status: ERROR
                    message: >-
                      A captured authorization cannot be voided. Please use the
                      refund API to reverse captured transactions.
                Error Response Partially Captured:
                  summary: Error Response Partially Captured
                  value:
                    status: ERROR
                    message: >-
                      A partially captured authorization cannot be voided.
                      Remaining capturable amount: 70.00
        '400':
          description: Invalid request
      security:
        - ApiKeyAuth: []
components:
  schemas:
    voidTransactionRequest:
      title: Void Transaction
      type: object
      required:
        - authorization_reference
        - void_reference
      properties:
        authorization_reference:
          type: string
          description: The reference of the authorization to be voided.
          example: AUTH-ABCD1234EFGH5678IJKL
        void_reference:
          type: string
          description: >-
            A unique reference for this void transaction generated by the
            merchant.
          example: VOID-001
        void_reason:
          type: string
          nullable: true
          description: Reason for voiding the transaction.
          example: Customer cancellation
    voidTransactionResponse:
      title: Void Transaction Response
      type: object
      properties:
        status:
          type: string
          description: Status of the void operation (e.g., VOIDED, ERROR).
          example: VOIDED
        message:
          type: string
          description: Descriptive message about the operation status.
          example: Void successful
        void_reference:
          type: string
          nullable: true
          description: Unique reference for the void transaction (present on success).
          example: VOID-1705123456-WXYZ5678
        voided_amount:
          type: number
          nullable: true
          description: The amount successfully voided.
          example: 100
        remaining_amount:
          type: number
          nullable: true
          description: >-
            Any remaining amount on the authorization (usually 0 after a full
            void).
          example: 0
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Payaza {{Public API Key in Base 64}}
    TenantID:
      type: apiKey
      in: header
      name: X-TenantID
      description: live or test
    ProductID:
      type: apiKey
      in: header
      name: X-ProductID
      description: 'default value is ‟app” '

````