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

# Check the status of one of your payment requests by id. Documented fallback for missed webhooks.

> Check the status of one of your payment requests by id. Documented fallback for missed webhooks.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/payment-requests/{paymentRequestId}/status
openapi: 3.1.0
info:
  title: Quidkey API
  version: 1.0.0
  description: API documentation for Quidkey Core Services
servers:
  - url: https://core.quidkey.com
    description: Production
security: []
paths:
  /api/v1/payment-requests/{paymentRequestId}/status:
    get:
      tags:
        - Payments
      summary: >-
        Check the status of one of your payment requests by id. Documented
        fallback for missed webhooks.
      description: >-
        Check the status of one of your payment requests by id. Documented
        fallback for missed webhooks.
      parameters:
        - name: paymentRequestId
          in: path
          required: true
          schema:
            format: uuid
            type: string
          description: The paymentRequestId parameter
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/paymentStatus_MerchantResponse'
              example:
                success: true
                data:
                  status: pending
                  amount: '1000'
                  currency: GBP
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shared_Error400'
              example:
                success: false
                error:
                  message: Invalid input provided
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shared_Error401'
              example:
                success: false
                error:
                  message: Invalid input provided
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/shared_Error404'
              example:
                success: false
                error:
                  message: Invalid input provided
      security:
        - bearerAuth: []
components:
  schemas:
    paymentStatus_MerchantResponse:
      type: object
      required:
        - success
        - data
      properties:
        success:
          description: Indicates if the request was successful
          examples:
            - true
          type: boolean
        data:
          title: Merchant Payment Status
          description: Tenant-scoped payment status view
          additionalProperties: false
          type: object
          required:
            - payment_request_id
            - status
            - amount
            - currency
          properties:
            payment_request_id:
              format: uuid
              description: Internal payment request identifier
              type: string
            status:
              description: Current payment status
              examples:
                - pending
                - completed
              type: string
            status_reason:
              description: Human-readable reason for the current status, when available
              anyOf:
                - type: string
                - type: 'null'
            amount:
              description: Payment amount in minor units
              examples:
                - '1000'
              type: string
            currency:
              pattern: ^[A-Za-z]{3}$
              minLength: 3
              maxLength: 3
              description: The currency of the payment
              examples:
                - GBP
                - USD
                - EUR
                - JPY
              type: string
            order_id:
              description: The merchant's order identifier, if one was provided
              anyOf:
                - type: string
                - type: 'null'
            transaction_number:
              description: Transaction number once a transaction has been created
              anyOf:
                - type: string
                - type: 'null'
    shared_Error400:
      title: Bad Request Error
      description: 400 Bad Request Error Response
      type: object
      required:
        - success
        - error
      properties:
        success:
          description: Always false for error responses
          examples:
            - false
          const: false
          type: boolean
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              allOf:
                - description: Error code for the specific error type
                  examples:
                    - INVALID_INPUT
                  type: string
                - description: Error code for the specific error type
                  examples:
                    - VALIDATION_ERROR
                  type: string
            message:
              description: Human-readable error message
              examples:
                - Invalid input provided
              type: string
            metadata:
              additionalProperties: true
              description: >-
                Additional error context. For VALIDATION_ERROR, includes a
                per-field `errors` array.
              type: object
              properties:
                errors:
                  type: array
                  items:
                    type: object
                    required:
                      - field
                      - message
                    properties:
                      field:
                        type: string
                      message:
                        type: string
    shared_Error401:
      title: Unauthorized Error
      description: 401 Unauthorized Error Response
      type: object
      required:
        - success
        - error
      properties:
        success:
          description: Always false for error responses
          examples:
            - false
          const: false
          type: boolean
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              allOf:
                - description: Error code for the specific error type
                  examples:
                    - INVALID_INPUT
                  type: string
                - const: UNAUTHORIZED
                  type: string
            message:
              description: Human-readable error message
              examples:
                - Invalid input provided
              type: string
    shared_Error404:
      title: Not Found Error
      description: 404 Not Found Error Response
      type: object
      required:
        - success
        - error
      properties:
        success:
          description: Always false for error responses
          examples:
            - false
          const: false
          type: boolean
        error:
          type: object
          required:
            - code
            - message
          properties:
            code:
              allOf:
                - description: Error code for the specific error type
                  examples:
                    - INVALID_INPUT
                  type: string
                - description: Error code for resource not found
                  examples:
                    - MERCHANT_NOT_FOUND
                    - BANK_NOT_FOUND
                  type: string
            message:
              description: Human-readable error message
              examples:
                - Invalid input provided
              type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````