Fiserv Inquire API

openapi: 3.2.0
info:
  title: Fiserv CardPointe Gateway Inquire API
  description: The CardPointe Gateway API provides a RESTful interface for integrating secure tokenization, payment processing, and reporting features into applications and websites. The API supports authorization, capture, void, refund, and inquiry operations, as well as customer profile management for storing payment credentials securely.
  version: 1.0.0
  contact:
    name: Fiserv Developer Support
    url: https://developer.fiserv.com/product/CardPointe
  termsOfService: https://www.fiserv.com/en/legal.html
servers:
- url: https://{site}-uat.cardconnect.com/cardconnect/rest
  description: UAT Environment
  variables:
    site:
      default: fts
      description: The site name provided during onboarding.
- url: https://{site}.cardconnect.com/cardconnect/rest
  description: Production Environment
  variables:
    site:
      default: fts
      description: The site name provided during onboarding.
security:
- basicAuth: []
tags:
- name: Inquire
  description: Inquire about the status of transactions and merchant information.
paths:
  /inquire/{retref}/{merchid}:
    get:
      operationId: inquireTransaction
      summary: Fiserv Inquire about a transaction
      description: Retrieves the current status and details of a previously processed transaction using its retrieval reference number.
      tags:
      - Inquire
      parameters:
      - $ref: '#/components/parameters/Retref'
      - $ref: '#/components/parameters/MerchantId'
      responses:
        '200':
          description: Transaction details returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InquireResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Transaction not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
  /inquireByOrderid/{orderid}/{merchid}:
    get:
      operationId: inquireTransactionByOrderId
      summary: Fiserv Inquire about a transaction by order ID
      description: Retrieves the current status and details of a previously processed transaction using the merchant-assigned order identifier.
      tags:
      - Inquire
      parameters:
      - name: orderid
        in: path
        required: true
        schema:
          type: string
        description: The merchant-assigned order identifier.
      - $ref: '#/components/parameters/MerchantId'
      responses:
        '200':
          description: Transaction details returned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InquireResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Transaction not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    InquireResponse:
      type: object
      description: Transaction inquiry response payload.
      properties:
        merchid:
          type: string
          description: The merchant identifier.
        retref:
          type: string
          description: The retrieval reference number.
        respstat:
          type: string
          description: The response status.
        account:
          type: string
          description: The masked account number.
        amount:
          type: string
          description: The transaction amount.
        currency:
          type: string
          description: The currency code.
        setlstat:
          type: string
          description: The settlement status.
        respcode:
          type: string
          description: The response code.
        resptext:
          type: string
          description: The response text.
        authcode:
          type: string
          description: The authorization code.
        captureStatus:
          type: string
          description: The capture status of the transaction.
        voidable:
          type: string
          description: Whether the transaction can be voided.
        refundable:
          type: string
          description: Whether the transaction can be refunded.
    ErrorResponse:
      type: object
      description: Error response payload.
      properties:
        respstat:
          type: string
          description: The response status (C for declined/error).
        respcode:
          type: string
          description: The error response code.
        resptext:
          type: string
          description: A human-readable error message.
  parameters:
    MerchantId:
      name: merchid
      in: path
      required: true
      schema:
        type: string
      description: The CardPointe merchant identifier.
    Retref:
      name: retref
      in: path
      required: true
      schema:
        type: string
      description: The retrieval reference number from the original transaction.
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using the CardPointe Gateway credentials.
externalDocs:
  description: CardPointe Gateway API Documentation
  url: https://developer.fiserv.com/product/CardPointe/docs/?path=docs%2FAPIs%2FCardPointeGatewayAPI.md