Fiserv Authorization API

openapi: 3.2.0
info:
  title: Fiserv CardPointe Gateway Authorization 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: Authorization
  description: Authorize payment transactions against a cardholder account.
paths:
  /auth:
    put:
      operationId: authorizeTransaction
      summary: Fiserv Authorize a payment transaction
      description: Submits an authorization request to process a payment. The authorization verifies the cardholder account and places a hold on funds. The response includes a retref (retrieval reference number) used for subsequent capture, void, or refund operations.
      tags:
      - Authorization
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AuthRequest'
      responses:
        '200':
          description: Authorization processed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    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.
    AuthRequest:
      type: object
      description: Authorization request payload.
      required:
      - merchid
      - account
      - amount
      properties:
        merchid:
          type: string
          description: The CardPointe merchant ID.
        account:
          type: string
          description: The card number or CardSecure token.
        expiry:
          type: string
          pattern: ^\d{4}$
          description: Card expiration date in MMYY format.
        amount:
          type: string
          description: The transaction amount in the smallest currency unit.
        currency:
          type: string
          pattern: ^[A-Z]{3}$
          description: The ISO 4217 currency code.
        cvv2:
          type: string
          description: The card verification value.
        orderid:
          type: string
          maxLength: 19
          description: The merchant-assigned order identifier.
        name:
          type: string
          description: The cardholder name.
        address:
          type: string
          description: The cardholder billing street address.
        city:
          type: string
          description: The cardholder billing city.
        region:
          type: string
          description: The cardholder billing state or province.
        country:
          type: string
          description: The cardholder billing country.
        postal:
          type: string
          description: The cardholder billing postal code.
        capture:
          type: string
          enum:
          - Y
          - N
          description: Set to Y to capture the transaction immediately (sale).
        profile:
          type: string
          enum:
          - Y
          - N
          description: Set to Y to create a stored profile for the account.
    AuthResponse:
      type: object
      description: Authorization response payload.
      properties:
        respstat:
          type: string
          enum:
          - A
          - B
          - C
          description: 'Response status: A=Approved, B=Retry, C=Declined.'
        retref:
          type: string
          description: The retrieval reference number for the transaction.
        account:
          type: string
          description: The masked account number or token.
        token:
          type: string
          description: The CardSecure token for the account.
        amount:
          type: string
          description: The authorized amount.
        merchid:
          type: string
          description: The merchant identifier.
        respcode:
          type: string
          description: The processor response code.
        resptext:
          type: string
          description: The human-readable response text.
        authcode:
          type: string
          description: The authorization code from the issuer.
        avsresp:
          type: string
          description: The AVS response code.
        cvvresp:
          type: string
          description: The CVV response code.
        profileid:
          type: string
          description: The stored profile ID if profile creation was requested.
  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