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

# Transaction Status API

> The Transaction Status API is used to retrieve the current status of a specific transaction, including pre-authorization, capture, refund, or void transactions.

### Key Points

<Info>
  * The transactionId is required to query the status of the specific transaction.

  * The API will return detailed information about the transaction, including its current status and any relevant error codes or messages.

  * This API is essential for tracking and managing transaction lifecycles, ensuring that transactions are completed successfully or identifying any issues that require attention.
</Info>

## Api Parameters


## OpenAPI

````yaml api-reference/en/open-api-config/server-to-server/transaction-status.json GET /api/v1/server-to-server-interface/transaction/status/{transactionId}
openapi: 3.0.1
info:
  title: Payment Options API
  description: API for generating Hosted Payment Page (HPP) links and processing payments.
  version: 1.0.0
servers:
  - url: https://api-dev.paymentoptions.com
security:
  - apiKeyAuth: []
    xApiKeyAuth: []
paths:
  /api/v1/server-to-server-interface/transaction/status/{transactionId}:
    get:
      summary: Get Transaction Status
      description: >-
        This endpoint allows merchants to retrieve the status of a specific
        transaction using its transaction ID.
      operationId: getTransactionStatus
      parameters:
        - name: transactionId
          in: path
          required: true
          schema:
            type: string
            maxLength: 36
          description: >-
            The original transaction ID of the Pre-Auth, Capture, Refund, or
            Void transaction.
      responses:
        '200':
          description: Transaction status retrieved successfully
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    description: True on successful transaction, false on failure.
                    example: true
                  status_code:
                    type: integer
                    description: The status code of the transaction.
                    example: 200
                  is_live:
                    type: boolean
                    description: True if live transaction, false if test transaction.
                    example: false
                  transaction_type:
                    type: string
                    description: The transaction type (e.g., PRE_AUTH, CAPTURE).
                    example: CAPTURE
                  gateway_response:
                    type: object
                    description: A JSON object containing the response from the gateway.
                    properties:
                      version:
                        type: string
                        description: The version of the gateway.
                        example: '1'
                      type:
                        type: string
                        description: Type of response, INFO for informative.
                        example: INFO
                      message:
                        type: string
                        description: The message response from the gateway.
                        example: Payment Successful.
                      code:
                        type: string
                        description: Message code of the response.
                        example: INFO0000
                  merchant_details:
                    type: object
                    description: A JSON object containing the details of the merchant.
                    properties:
                      legal_name:
                        type: string
                        description: The merchant’s legal name.
                        example: Tink15 Factory
                      mid:
                        type: string
                        description: The merchant ID (DASMID).
                        example: < Merchant ID >
                      merchant_txn_ref:
                        type: string
                        description: The merchant transaction reference.
                        example: qwe
                  payment_details:
                    type: object
                    description: >-
                      A JSON object containing the payment details of the
                      transaction.
                    properties:
                      amount:
                        type: number
                        description: The amount value of the transaction.
                        example: 1000
                      response_code:
                        type: integer
                        description: The acquirer response code.
                        example: 0
                      responseDescription:
                        type: string
                        description: The acquirer response description.
                        example: The transaction was completed successfully.
                      auth_code:
                        type: string
                        description: The acquirer authorization code.
                        example: '268004'
                      currency:
                        type: string
                        description: The currency of the transaction.
                        example: JPY
                      payment_method:
                        type: string
                        description: >-
                          The payment card type (e.g., Credit Card or Debit
                          Card).
                        example: ECMC-SSL
                      scheme:
                        type: string
                        description: The card brand scheme (e.g., MASTERCARD).
                        example: MASTERCARD
                      card:
                        type: object
                        description: A JSON object containing details of the card.
                        properties:
                          name:
                            type: string
                            description: The cardholder’s name on the card.
                            example: John Doe
                          number:
                            type: string
                            description: The card number (masked).
                            example: '5200000000001005'
                          exp_month:
                            type: string
                            description: The expiry month of the card.
                            example: '12'
                          exp_year:
                            type: string
                            description: The expiry year of the card.
                            example: '29'
                      additional_data:
                        type: object
                        description: A JSON object containing additional data.
                        properties:
                          payment_data_source:
                            type: object
                            description: A JSON object containing the payment data source.
                            properties:
                              type:
                                type: string
                                description: >-
                                  The type of payment data source (e.g., Card,
                                  GooglePay, ApplePay).
                                example: card
                  transaction_details:
                    type: object
                    description: A JSON object containing details of the transaction.
                    properties:
                      id:
                        type: string
                        description: The Transaction ID of the transaction.
                        example: fc565b43-26f5-4906-92ae-d849edc3c3a1
                      ref:
                        type: integer
                        description: The authorization code of the transaction.
                        example: 74811
                      timestamp:
                        type: string
                        description: Date and time of the transaction.
                        example: '2024-11-25T08:24:36.000Z'
                      billing_details:
                        type: object
                        description: A JSON object containing the billing details.
                        properties:
                          billing_address:
                            type: object
                            description: A JSON object containing the billing address.
                            properties:
                              country:
                                type: string
                                description: The cardholder’s billing country code.
                                example: JP
                              email:
                                type: string
                                description: The cardholder’s billing email address.
                                example: billing@testemail.com
                              address1:
                                type: string
                                description: The cardholder’s billing address line.
                                example: 1-2-3 Shinjuku
                              phone_number:
                                type: string
                                description: The cardholder’s billing phone number.
                                example: N/A
                              city:
                                type: string
                                description: The cardholder’s billing city.
                                example: Shinjuku-ku
                              state:
                                type: string
                                description: The cardholder’s billing state.
                                example: Tokyo
                              postal_code:
                                type: string
                                description: The cardholder’s postal code.
                                example: '1600022'
                          shipping_address:
                            type: object
                            description: A JSON object containing the shipping address.
                            properties:
                              country:
                                type: string
                                description: The cardholder’s shipping country code.
                                example: JP
                              email:
                                type: string
                                description: The cardholder’s shipping email address.
                                example: shipping@testemail.com
                              address1:
                                type: string
                                description: The cardholder’s shipping address line.
                                example: 1-2-3 Shinjuku
                              phone_number:
                                type: string
                                description: The cardholder’s shipping phone number.
                                example: N/A
                              city:
                                type: string
                                description: The cardholder’s shipping city.
                                example: Shinjuku-ku
                              state:
                                type: string
                                description: The cardholder’s shipping state.
                                example: Tokyo
                              postal_code:
                                type: string
                                description: The cardholder’s shipping postal code.
                                example: '1600022'
                  risk_details:
                    type: object
                    description: A JSON object containing details of risk.
                    properties:
                      risk_score:
                        type: string
                        description: The risk score (if applicable).
                        example: null
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      name: Authorization
      in: header
      description: 'API Key for Authorization. Format: ''Basic YOUR_API_KEY_HERE'''
    xApiKeyAuth:
      type: apiKey
      name: x-api-key
      in: header
      description: API Key specific to x-api-key.

````