Credorax Charges API

openapi: 3.2.0
info:
  title: Credorax Charges 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: Charges
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
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.
  securitySchemes:
    basic:
      type: http
      scheme: basic
      x-source: https://dev.shift4.com/docs/api/shift4-gateway/section/authentication