Credorax API

openapi: 3.1.0
info:
  title: Credorax 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
paths:
  /charges:
    get:
      operationId: get_charges
      tags:
      - Charges
      summary: GET /charges
      x-source: https://dev.shift4.com/docs/api
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetChargesResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl https://api.shift4.com/charges -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: The key above belongs to a shared demo account, so
          the examples throughout these docs are runnable as written. Substitute your own key to work against your data. The demo account predates
          the current prefixes, so its keys read pr_test_ and pu_test_ where yours will read sk_test_ and pk_test_ . Note the trailing colon (
          : ) af'
    post:
      operationId: post_charges
      tags:
      - Charges
      summary: Create a charge
      x-source: https://dev.shift4.com/docs/api/shift4-gateway/charges
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostChargesRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostChargesResponse'
      x-evidence:
        kind: documentation
  /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
  /events:
    get:
      operationId: get_events
      tags:
      - Events
      summary: GET /events
      x-source: https://dev.shift4.com/docs/api/shift4-gateway/events
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl curl \"https://api.shift4.com/events?limit=3\"  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa: Try it Responses 200 List of events\
          \ Body application/json list Array of objects (Event) + Show 6 array properties hasMore boolean Whether more results exist beyond this\
          \ page Example : true Response 200 application/json { \n \"list\" : [ \n { … } \n ] ,\n \"hasMore\" : true \n } Was this helpful? Shift4.com\
          \ Dashboard Sta"
  /plans:
    get:
      operationId: get_plans
      tags:
      - Plans
      summary: GET /plans
      x-source: https://dev.shift4.com/docs/api/shift4-gateway/plans
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetPlansResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl curl https://api.shift4.com/plans  -u pr_test_tXHm9qV9qV9bjIRHcQr9PLPa:  -d "amount=499"  -d "currency=USD"  -d "interval=day"  -d
          "intervalCount=10"  -d "name=Example plan" Try it Responses 200 400 Plan created Body application/json id string Unique identifier for
          the plan Example : "plan_bLu3vzO8yhAFhbxFEadm6HUV" created integer Unix timestamp when the plan was created Example : 1711929600 '
    post:
      operationId: post_plans
      tags:
      - Plans
      summary: Create a plan
      x-source: https://dev.shift4.com/docs/api/shift4-gateway/plans
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostPlansRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostPlansResponse'
      x-evidence:
        kind: documentation
  /tokens:
    get:
      operationId: get_tokens
      tags:
      - Tokens
      summary: GET /tokens
      x-source: https://dev.shift4.com/docs/api/shift4-gateway/tokens
      responses:
        '200':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetTokensResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl curl https://api.shift4.com/tokens  -u pu_test_WVMFC9GFuvm54b0uorifKkCh:  -d "number=4242424242424242"  -d "expMonth=12"  -d
          "expYear=2030"  -d "cvc=123"  -d "cardholderName=John Doe" Try it Responses 200 400 402 Token created Body application/json id string
          Unique identifier for the token Example : "tok_NGsyDoJQXop5Pqqi6HizbJTe" created integer Unix timestamp Example : 1701432000 objectType '
    post:
      operationId: post_tokens
      tags:
      - Tokens
      summary: Create a token
      description: Creates a new token object. This method can be called with either your API public key or your API secret key.
      x-source: https://dev.shift4.com/docs/api/shift4-gateway/tokens
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostTokensRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostTokensResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    GetChargesResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            type:
              type: string
            code:
              type: string
            message:
              type: string
    PostChargesRequest:
      type: object
      properties:
        amount:
          type: integer
          description: Charge amount in the minor units of the given currency.
        currency:
          type: string
          description: Charge currency as a three-letter ISO 4217 code.
        type:
          type: string
          description: Stored-credential indicator describing how the charge is initiated.
        description:
          type: string
          description: Optional description shown on the charge.
        customerId:
          type: string
          description: Identifier of the customer to associate with this charge.
        card:
          type: string
          description: Card token or ID, or CardCreate object.
        paymentMethod:
          type: string
          description: Payment method ID or Payment Method object.
        flow:
          type: object
          description: Payment-process details specific to the payment method.
        captured:
          type: boolean
          description: Whether to immediately capture the charge.
        options:
          type: object
          description: Authorization options.
        billing:
          type: object
          description: Billing details.
        shipping:
          type: object
          description: Shipping details for the order.
        threeDSecure:
          type: object
          description: 3D Secure options.
        splits:
          type: array
          description: Split part of the charge amount to other merchants.
        recipient:
          type: object
          description: Recipient details, required for account-funding / top-up transactions.
        sender:
          type: object
          description: Sender details, required for top-up transactions when the sender differs from the recipient.
        merchantAccountId:
          type: string
          description: Identifier of the merchant account to use to process this charge.
        external:
          type: object
          description: External references to attach to the charge.
        collectionMode:
          type: string
          description: Indicates how the order was collected for this charge.
        metadata:
          type: object
          description: Set of key-value pairs for storing additional information.
      required:
      - amount
      - currency
    PostChargesResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the charge.
        created:
          type: integer
          description: Unix timestamp (seconds) when the charge was created.
        objectType:
          type: string
          description: Object type identifier.
        amount:
          type: integer
          description: Charge amount in the smallest currency unit.
        amountRefunded:
          type: integer
          description: Amount refunded so far, in the smallest currency unit.
        currency:
          type: string
          description: Three-letter ISO 4217 currency code.
        description:
          type: string
          description: Optional description of the charge.
        type:
          type: string
          description: Stored-credential indicator sent to the card network.
        status:
          type: string
          description: Current status of the charge.
        captured:
          type: boolean
          description: Whether the charge has been captured.
        refunded:
          type: boolean
          description: Whether the charge has been fully refunded.
        refunds:
          type: array
          description: List of refunds issued against this charge.
        disputed:
          type: boolean
          description: Whether the charge is currently disputed.
        dispute:
          type: object
          description: The dispute object, present when the charge has been disputed.
        flow:
          type: object
          description: Details of the payment process for payment methods that require additional customer action.
        customerId:
          type: string
          description: ID of the customer associated with this charge.
        subscriptionId:
          type: string
          description: ID of the subscription that generated this charge, if any.
        clientObjectId:
          type: string
          description: Client-facing identifier that can be used with shift4.js to check the charge status from the browser.
        options:
          type: object
          description: Authorization options for the charge.
        metadata:
          type: object
          description: Set of key-value pairs for storing additional information.
        fraudDetails:
          type: object
          description: Fraud detection details.
        arn:
          type: string
          description: Acquirer Reference Number assigned to the settled transaction.
        schemeTransactionId:
          type: string
          description: Identifier of the transaction in the card scheme's network.
        paymentAccountReference:
          type: string
          description: Payment Account Reference (PAR).
        aft:
          type: object
          description: Account Funding Transaction details.
        authCode:
          type: string
          description: Authorization code returned by the issuer.
        threeDSecureInfo:
          type: object
          description: 3D Secure verification details.
        avsCheck:
          type: object
          description: Address Verification Service result.
        aniCheck:
          type: object
          description: Account Name Inquiry result (Visa).
        cvvCheck:
          type: object
          description: CVV/CVC verification result.
        failureCode:
          type: string
          description: Error code describing why the charge failed.
        failureMessage:
          type: string
          description: Human-readable message describing why the charge failed.
        failureIssuerDeclineCode:
          type: string
          description: Decline code supplied by the card issuer.
        adviceCode:
          type: string
          description: Advice on how to proceed with a declined charge.
        networkAdviceCode:
          type: string
          description: Raw advice code received from the issuer or card network.
        collectionMode:
          type: string
          description: How the order was collected for this charge.
        billing:
          type: object
          description: Billing details for the payer.
        shipping:
          type: object
          description: Shipping details for the order.
        external:
          type: object
          description: External references attached to the charge.
        multibanco:
          type: object
          description: Additional information for Multibanco payments.
        splits:
          type: array
          description: List of charge splits.
        merchantAccountId:
          type: string
          description: Identifier of the merchant account used to process this charge.
        card:
          type: object
          description: The card used for this charge.
    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
    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
    GetPlansResponse:
      type: object
      properties:
        id:
          type: string
        created:
          type: integer
        objectType:
          type: string
        amount:
          type: integer
        currency:
          type: string
        interval:
          type: string
        intervalCount:
          type: integer
        billingCycles:
          type:
          - string
          - 'null'
        name:
          type: string
        trialPeriodDays:
          type: integer
        recursTo:
          type:
          - string
          - 'null'
        metadata:
          type: object
    PostPlansRequest:
      type: object
      properties:
        amount:
          type: integer
          description: Subscription charge amount in minor units of the given currency.
        currency:
          type: string
          description: Subscription charge currency represented as a three-letter ISO currency code.
        interval:
          type: string
          description: Frequency of the subscription charges.
        intervalCount:
          type: integer
          description: Number of intervals between the subscription charges.
        name:
          type: string
          description: Display name of this plan.
        billingCycles:
          type: integer
          description: Number of charges after which the subscription will be automatically canceled.
        trialPeriodDays:
          type: integer
          description: Number of days between the creation of the subscription and the first charge.
        recursTo:
          type: string
          description: When the subscription is automatically canceled, it will move to the plan defined by this attribute.
        splits:
          type: array
          description: Array of objects (ChargeSplitCreate) Allows to transfer part of a charge amount to the given merchant.
        metadata:
          type: object
          description: A set of key-value pairs attached to the plan.
      required:
      - amount
      - currency
      - interval
      - name
    PostPlansResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the plan
        created:
          type: integer
          description: Unix timestamp when the plan was created
        objectType:
          type: string
          description: Object type identifier
        amount:
          type: integer
          description: Subscription charge amount in minor units of the given currency.
        currency:
          type: string
          description: Subscription charge currency represented as a three-letter ISO currency code.
        interval:
          type: string
          description: Frequency of subscription charges.
        intervalCount:
          type: integer
          description: Number of intervals between subscription charges.
        billingCycles:
          type: integer
          description: Number of charges after which the subscription will be automatically canceled.
        name:
          type: string
          description: Display name of this plan
        trialPeriodDays:
          type: integer
          description: Number of days between the creation of the subscription and the first charge.
        recursTo:
          type: string
          description: When the subscription is automatically canceled, it will move to the plan defined by this attribute.
        splits:
          type: array
          description: Information about split requests defined when creating the plan.
        metadata:
          type: object
          description: Set of key-value pairs
    GetTokensResponse:
      type: object
      properties:
        id:
          type: string
        created:
          type: integer
        objectType:
          type: string
        first6:
          type: string
        last4:
          type: string
        fingerprint:
          type: string
        expMonth:
          type: string
        expYear:
          type: string
        cardholderName:
          type: string
        brand:
          type: string
        type:
          type: string
        country:
          type: string
        used:
          type: boolean
    PostTokensRequest:
      type: object
      properties:
        number:
          type: string
          description: Card number without any separators.
        expMonth:
          type: string
          description: Card expiration month.
        expYear:
          type: string
          description: Card expiration year.
        cvc:
          type: string
          description: Card security code.
        cardholderName:
          type: string
          description: Name of the cardholder.
        addressLine1:
          type: string
          description: First line of the billing address.
        addressLine2:
          type: string
          description: Second line of the billing address.
        addressCity:
          type: string
          description: City of the billing address.
        addressState:
          type: string
          description: State of the billing address.
        addressZip:
          type: string
          description: ZIP or postal code of the billing address.
        addressCountry:
          type: string
          description: Country represented as a three‑letter ISO country code.
        fraudCheckData:
          type: object
          description: Additional data used for fraud protection (secret‑key only).
        merchantAccountId:
          type: string
          description: Identifier of the merchant account that this token should be associated with.
      required:
      - number
      - expMonth
      - expYear
      - cvc
      - cardholderName
    PostTokensResponse:
      type: object
      properties:
        id:
          type: string
          description: Unique identifier for the token.
        created:
          type: integer
          description: Unix timestamp when the token was created.
        objectType:
          type: string
          description: 'Value: "token".'
        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 identifier of the card number.
        expMonth:
          type: string
          description: Two‑digit expiration month.
        expYear:
          type: string
          description: Four‑digit expiration year.
        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.
        cardholderName:
          type: string
          description: Name of the cardholder.
        addressLine1:
          type: string
          description: First line of the billing address.
        addressLine2:
          type: string
          description: Second line of the billing address.
        addressCity:
          type: string
          description: City of the billing address.
        addressState:
          type: string
          description: State of the billing address.
        addressZip:
          type: string
          description: ZIP or postal code of the billing address.
        addressCountry:
          type: string
          description: Country of the billing address (three‑letter ISO code).
        used:
          type: boolean
          description: Whether this token has already been used.
        card:
          type: object
          description: Card object created from this token.
        fraudCheckData:
          type: object
          description: Additional data used for fraud protection.
        threeDSecureInfo:
          type: object
          description: Data present if the card was verified with 3D Secure.
  securitySchemes:
    basic:
      type: http
      scheme: basic
      x-source: https://dev.shift4.com/docs/api/shift4-gateway/section/authentication
tags:
- name: Charges
- name: Customers
- name: Events
- name: Plans
- name: Tokens
security:
- basic: []