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

# Transaction Status Query

> This retrieves the details of a transaction using the transaction reference value that was placed in the Initiate A Transfer request.



## OpenAPI

````yaml /openapi.json get /payaza-account/api/v1/mainaccounts/merchant/transaction/{transaction_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:
  /payaza-account/api/v1/mainaccounts/merchant/transaction/{transaction_reference}:
    get:
      tags:
        - Transfers
      summary: Transaction Status Query
      description: >-
        This retrieves the details of a transaction using the transaction
        reference value that was placed in the Initiate A Transfer request.
      parameters:
        - name: transaction_reference
          in: path
          required: true
          schema:
            type: string
          description: The unique identifier given to a particular transaction
      responses:
        '200':
          description: Payment successful
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/transactionStatusQueryResponse'
              examples:
                TSQ:
                  summary: TSQ Response
                  value:
                    message: Transaction fetched
                    status: true
                    retry_count: 0
                    data:
                      transactionDateTime: '2023-02-02T17:08:55.084673'
                      transactionReference: '1242368116'
                      creditAccount: '1023213616'
                      bankCode: '000004'
                      beneficiaryName: WILSON JAMES
                      transactionAmount: 300
                      fee: 10
                      sessionId: '999999240902170916631388211854'
                      transactionStatus: NIP_SUCCESS
                      narration: Remittance
                      transactionType: DEBIT
                      responseMessage: Approved or Completely Successful
                      responseCode: '00'
                      currency: NGN
                      balanceBefore: 431.1
                      balanceAfter: 121.1
                      duration: {}
        '400':
          description: Payment failed
      security:
        - ApiKeyAuth:
            - Payaza {{Public API Key In Base64}}
          TenantID:
            - test or live
components:
  schemas:
    transactionStatusQueryResponse:
      title: Transaction Status Query Response
      type: object
      properties:
        message:
          type: string
          description: Response message.
          example: Transaction fetched
        status:
          type: boolean
          description: Request status.
          example: true
        retry_count:
          type: integer
          description: Number of retries attempted.
          example: 0
        data:
          type: object
          description: Transaction details.
          properties:
            transactionDateTime:
              type: string
              format: date-time
              description: Date and time of the transaction.
              example: '2023-02-02T17:08:55.084673'
            transactionReference:
              type: string
              description: Unique transaction reference.
              example: '1242368116'
            creditAccount:
              type: string
              description: Account credited.
              example: '1023213616'
            bankCode:
              type: string
              description: Bank code of the beneficiary.
              example: '000004'
            beneficiaryName:
              type: string
              description: Name of the beneficiary.
              example: WILSON JAMES
            transactionAmount:
              type: number
              format: double
              description: Amount transacted.
              example: 300
            fee:
              type: number
              format: double
              description: Transaction fee.
              example: 10
            sessionId:
              type: string
              description: Session ID from the provider.
              example: '999999240902170916631388211854'
            transactionStatus:
              type: string
              description: Status of the transaction (e.g., NIP_SUCCESS).
              example: NIP_SUCCESS
            narration:
              type: string
              description: Transaction narration.
              example: Remittance
            transactionType:
              type: string
              description: Type of transaction (e.g., DEBIT).
              example: DEBIT
            responseMessage:
              type: string
              description: Detailed response message.
              example: Approved or Completely Successful
            responseCode:
              type: string
              description: Response code (00 indicates success).
              example: '00'
            currency:
              type: string
              description: Transaction currency.
              example: NGN
            balanceBefore:
              type: number
              format: double
              description: Balance before transaction.
              example: 431.1
            balanceAfter:
              type: number
              format: double
              description: Balance after transaction.
              example: 121.1
            duration:
              type: object
              description: Duration details (if any).
  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” '

````