Credorax Customers API

openapi: 3.2.0
info:
  title: Credorax Customers API
  version: '2026-10-11'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-11: 9 operation(s) read from 7 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Credorax has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 5
    documentation: 4
    pages-with-code: 7
    pages-read: 7
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-11'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://dev.shift4.com/docs/api
  - https://dev.shift4.com/docs/api/shift4-gateway
  - https://dev.shift4.com/docs/api/shift4-gateway/cards
  - https://dev.shift4.com/docs/api/shift4-gateway/plans
  - https://dev.shift4.com/docs/api/shift4-gateway/events
  - https://dev.shift4.com/docs/api/shift4-gateway/tokens
  - https://dev.shift4.com/docs/api/shift4-gateway/charges
servers:
- url: https://api.shift4.com
security:
- basic: []
tags:
- name: Customers
paths:
  /customers/{customerid}/cards:
    get:
      operationId: get_customers_customerid_cards
      tags:
      - Customers
      summary: List cards for a customer
      description: Retrieves a list of cards stored on the specified customer.
      x-source: https://dev.shift4.com/docs/api/shift4-gateway/cards
      parameters:
      - name: customerid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetCustomersCustomeridCardsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_customers_customerid_cards
      tags:
      - Customers
      summary: Create a card
      description: Adds a new card to an existing customer. Supports card token, charge ID, or full card details.
      x-source: https://dev.shift4.com/docs/api/shift4-gateway/cards
      parameters:
      - name: customerid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostCustomersCustomeridCardsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostCustomersCustomeridCardsResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostCustomersCustomeridCardsResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the card
        created:
          type: integer
          description: Unix timestamp
        objectType:
          type: string
          description: 'Value: "card"'
        first6:
          type: string
          description: First six digits of the card number
        last4:
          type: string
          description: Last four digits of the card number
        fingerprint:
          type: string
          description: Unique fingerprint for this card number
        expMonth:
          type: string
          description: Two-digit expiration month
        expYear:
          type: string
          description: Four-digit expiration year
        cardholderName:
          type: string
          description: Name of the cardholder
        brand:
          type: string
          description: Card brand
        type:
          type: string
          description: Card type
        country:
          type: string
          description: Two-letter ISO 3166-1 country code of the card's issuing country
        issuer:
          type: string
          description: Name of the bank that issued the card
        customerId:
          type: string
          description: ID of the customer this card belongs to
        fraudCheckData:
          type: object
          description: Fraud‑protection data captured when the card was created
        merchantAccountId:
          type: string
          description: Identifier of the merchant account used to create this card
        addressLine1:
          type: string
          description: First line of the billing address associated with the card
        addressLine2:
          type: string
          description: Second line of the billing address associated with the card
        addressCity:
          type: string
          description: City of the billing address associated with the card
        addressState:
          type: string
          description: State of the billing address associated with the card
        addressZip:
          type: string
          description: ZIP or postal code of the billing address associated with the card
        addressCountry:
          type: string
          description: Country of the billing address associated with the card, represented as a three‑letter ISO country code
        fastCredit:
          type: object
          description: Fast credit (fast payout) support status for this card
    GetCustomersCustomeridCardsResponse:
      type: object
      properties:
        cards:
          type: array
          description: Array of card objects as defined in the Create a card response.
    PostCustomersCustomeridCardsRequest:
      type: object
      properties:
        id:
          type: string
          description: A card token (for example obtained from Components), or the identifier of a successful charge whose card should be saved to this customer.
      required:
      - id
  securitySchemes:
    basic:
      type: http
      scheme: basic
      x-source: https://dev.shift4.com/docs/api/shift4-gateway/section/authentication