> ## 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.

# Get Single Authorization

> This endpoint retrieves details of a single authorization by its authorization_reference. 

> **Notes:**
>
> 1. **authorization_reference:**: Must exist and belong to the requesting merchant.
> 2. **Merchant Ownership:** Strictly enforced - only the business that created the authorization can retrieve it. Attempting to access another business’s authorization returns 403 Forbidden.
> 3. **Authentication:** Valid Authorization header required (same format as authorize endpoint). 
> 4. **Security:** The system verifies business ownership by comparing the authenticated business.



## OpenAPI

````yaml /openapi.json get /card/auth_capture/authorize/{authorization_reference}
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/authorize/{authorization_reference}:
    get:
      tags:
        - Auth-Capture-Void
      summary: Get Single Authorization
      description: >-
        This endpoint retrieves details of a single authorization by its
        authorization_reference. 


        > **Notes:**

        >

        > 1. **authorization_reference:**: Must exist and belong to the
        requesting merchant.

        > 2. **Merchant Ownership:** Strictly enforced - only the business that
        created the authorization can retrieve it. Attempting to access another
        business’s authorization returns 403 Forbidden.

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

        > 4. **Security:** The system verifies business ownership by comparing
        the authenticated business.
      parameters:
        - name: authorization_reference
          in: path
          required: true
          schema:
            type: string
          description: The authorization reference from the Authorize response
      responses:
        '200':
          description: Payment successful
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/getSingleAuthorizationResponse'
              examples:
                Success Response:
                  summary: Success Response
                  value:
                    authorization_reference: AUTH-1234567890
                    status: AUTHORIZED
                    authorization_amount: 100
                    captured_amount: 0
                    remaining_amount: 100
                    currency: NGN
                    authorization_code: '123456'
                    expires_at: '2025-01-19T10:30:00'
                    created_at: '2025-01-12T10:30:00'
                    updated_at: '2025-01-12T10:30:00'
                    captured_at: null
                    voided_at: null
                    card_last_4: '2346'
                    card_brand: MASTERCARD
                    order_reference: ORD-001
                    merchant_reference: MR-001
                    customer_email: customer@example.com
                    customer_name: John Doe
                    error_reason: null
                    void_reason: null
                Error Response Not Found:
                  summary: Error Response Not Found
                  value:
                    status: ERROR
                    message: Authorization not found
                Error Response Wrong Business:
                  summary: Error Response Wrong Business
                  value:
                    status: ERROR
                    message: >-
                      Unauthorized access: Authorization does not belong to
                      requesting business
        '400':
          description: Payment failed
      security:
        - ApiKeyAuth:
            - Payaza {{Public API Key In Base64}}
components:
  schemas:
    getSingleAuthorizationResponse:
      title: Get Single Authorization
      type: object
      properties:
        status:
          type: string
          description: Current status of the authorization (e.g., AUTHORIZED, ERROR).
          example: AUTHORIZED
        message:
          type: string
          description: Descriptive message about the status.
          example: Authorization successful
        authorization_reference:
          type: string
          nullable: true
          description: Unique reference for the authorization.
          example: AUTH-1234567890
        authorization_amount:
          type: number
          nullable: true
          description: Total amount originally authorized.
          example: 100
        captured_amount:
          type: number
          nullable: true
          description: Amount that has been captured so far.
          example: 0
        remaining_amount:
          type: number
          nullable: true
          description: Amount remaining available to capture.
          example: 100
        currency:
          type: string
          nullable: true
          description: Currency code.
          example: NGN
        authorization_code:
          type: string
          nullable: true
          description: Issuer's authorization code.
          example: '123456'
        expires_at:
          type: string
          format: date-time
          nullable: true
          description: Timestamp when the authorization expires.
          example: '2025-01-19T10:30:00'
        created_at:
          type: string
          format: date-time
          nullable: true
          description: Timestamp when the authorization was created.
          example: '2025-01-12T10:30:00'
        updated_at:
          type: string
          format: date-time
          nullable: true
          description: Timestamp of the last update.
          example: '2025-01-12T10:30:00'
        captured_at:
          type: string
          format: date-time
          nullable: true
          description: Timestamp when the capture occurred.
          example: null
        voided_at:
          type: string
          format: date-time
          nullable: true
          description: Timestamp when the void occurred.
          example: null
        card_last_4:
          type: string
          nullable: true
          description: Last 4 digits of the card used.
          example: '2346'
        card_brand:
          type: string
          nullable: true
          description: Brand of the card (e.g., MASTERCARD).
          example: MASTERCARD
        order_reference:
          type: string
          nullable: true
          description: Order ID associated with the transaction.
          example: ORD-001
        merchant_reference:
          type: string
          nullable: true
          description: Merchant's internal reference.
          example: MR-001
        customer_email:
          type: string
          format: email
          nullable: true
          description: Customer's email.
          example: customer@example.com
        customer_name:
          type: string
          nullable: true
          description: Customer's full name.
          example: John Doe
        error_reason:
          type: string
          nullable: true
          description: Reason for error if applicable.
          example: null
        void_reason:
          type: string
          nullable: true
          description: Reason for void if applicable.
          example: null
  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” '

````