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

# Check Transaction Status(Merchant Reference)

> This endpoint is used to check the transaction status of a transaction using the Merchant Reference value placed in the checkout or payment page request. 

| Status | Meaning |
| :--- | :--- |
| Initialized | The transaction is in progress |
| Completed | The transaction is successful |
| Failed | The transaction has failed |



## OpenAPI

````yaml /openapi.json get /merchant-collection/transfer_notification_controller/merchant/transaction-query?merchant_reference={merchantReference}
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:
  /merchant-collection/transfer_notification_controller/merchant/transaction-query?merchant_reference={merchantReference}:
    get:
      tags:
        - Check Transaction Status(Merchant Reference)
      summary: Check Transaction Status(Merchant Reference)
      description: >-
        This endpoint is used to check the transaction status of a transaction
        using the Merchant Reference value placed in the checkout or payment
        page request. 


        | Status | Meaning |

        | :--- | :--- |

        | Initialized | The transaction is in progress |

        | Completed | The transaction is successful |

        | Failed | The transaction has failed |
      parameters:
        - name: merchantReference
          in: path
          required: true
          schema:
            type: string
          description: >-
            The reference generated to the transaction that is placed in the
            Checkout or Payment page request
      responses:
        '200':
          description: Request Successful
          content:
            application/json:
              schema:
                oneOf:
                  - $ref: '#/components/schemas/tsqMerchantReferenceResponse'
              examples:
                Merchant Reference TSQ Response:
                  summary: Merchant Reference TSQ
                  value:
                    message: Transaction data found
                    data:
                      transaction_reference: null
                      amount_received: 20.28
                      transaction_fee: 0.28
                      transaction_status: Completed
                      sender_name: Ray Phil
                      sender_account_number: null
                      source_bank_name: MASTERCARD
                      initiated_date: '2023-02-11 09:49:09.254'
                      current_status_date: '2023-02-11 09:49:09.254'
                      currency: NGN
                      session_id: '419309171231'
                      merchant_transaction_reference: 3bf267326
                      transaction_type: Card
                      virtual_account_number: null
                      status_reason: Payment Approved
                    success: true
        '400':
          description: Payment failed
      security:
        - ApiKeyAuth:
            - Payaza {{Public API Key In Base64}}
components:
  schemas:
    tsqMerchantReferenceResponse:
      title: Check Transaction Status(Merchant Reference)
      type: object
      properties:
        message:
          type: string
          description: Descriptive message regarding the response.
          example: Transaction data found
        data:
          type: object
          description: The detailed transaction information.
          properties:
            transaction_reference:
              type: string
              nullable: true
              description: Payaza's unique transaction reference.
              example: null
            amount_received:
              type: number
              format: double
              description: The actual amount received.
              example: 20.28
            transaction_fee:
              type: number
              format: double
              description: Fee deducted for processing the transaction.
              example: 0.28
            transaction_status:
              type: string
              description: Current status of the transaction.
              example: Completed
            sender_name:
              type: string
              nullable: true
              description: Name of the sender or cardholder.
              example: Ray Phil
            sender_account_number:
              type: string
              nullable: true
              description: Sender's account number (if applicable).
              example: null
            source_bank_name:
              type: string
              nullable: true
              description: Name of the source bank or card network.
              example: MASTERCARD
            initiated_date:
              type: string
              description: Timestamp when the transaction was initiated.
              example: '2023-02-11 09:49:09.254'
            current_status_date:
              type: string
              description: Timestamp when the transaction reached its current status.
              example: '2023-02-11 09:49:09.254'
            currency:
              type: string
              description: 3-letter currency code.
              example: NGN
            session_id:
              type: string
              description: Unique session identifier for the transaction.
              example: '419309171231'
            merchant_transaction_reference:
              type: string
              description: The merchant's original transaction reference.
              example: 3bf267326
            transaction_type:
              type: string
              description: The channel or method used for the transaction.
              example: Card
            virtual_account_number:
              type: string
              nullable: true
              description: Virtual account number used, if applicable.
              example: null
            status_reason:
              type: string
              description: Detailed reason or message corresponding to the status.
              example: Payment Approved
        success:
          type: boolean
          description: Indicates whether the request was successful.
          example: true
  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” '

````