Increase Card Payments API

openapi: 3.2.0
info:
  description: Anything that you can achieve with PDFs, presence, and persistence in a bank branch you can do with our API. We've always wanted a fully programmatic bank so we built one. Our API faithfully exposes the data and capabilities of the Federal Reserve, Visa, The Clearing House, depository networks, and accounting tools. It's lovingly boring and exceptionally powerful. If you have any questions or want to get started, don't hesitate to ping us at sales@increase.com. We can't wait to see what you build!
  title: Increase Card Payments API
  version: 0.0.1
servers:
- url: https://api.increase.com
- url: https://sandbox.increase.com
security:
- bearerAuth: []
tags:
- description: Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement.
  name: Card Payments
paths:
  /card_payments:
    get:
      operationId: list_card_payments
      parameters:
      - in: query
        name: cursor
        required: false
        schema:
          description: Return the page of entries after this one.
          type: string
          x-documentation-priority: low
      - in: query
        name: limit
        required: false
        schema:
          description: Limit the size of the list that is returned. The default (and maximum) is 100 objects.
          minimum: 1
          type: integer
          x-documentation-priority: low
      - example: account_in71c4amph0vgo2qllky
        in: query
        name: account_id
        required: false
        schema:
          description: Filter Card Payments to ones belonging to the specified Account.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Accounts
      - in: query
        name: card_id
        required: false
        schema:
          description: Filter Card Payments to ones belonging to the specified Card.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Cards
      - in: query
        name: created_at.after
        required: false
        schema:
          description: Return results after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
          format: date-time
          type: string
          x-documentation-priority: low
      - in: query
        name: created_at.before
        required: false
        schema:
          description: Return results before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
          format: date-time
          type: string
          x-documentation-priority: low
      - in: query
        name: created_at.on_or_after
        required: false
        schema:
          description: Return results on or after this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
          format: date-time
          type: string
          x-documentation-priority: low
      - in: query
        name: created_at.on_or_before
        required: false
        schema:
          description: Return results on or before this [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) timestamp.
          format: date-time
          type: string
          x-documentation-priority: low
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/card_payment_list'
          description: Card Payment List
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: List Card Payments
      x-sandbox-only: false
      x-tag: Card Payments
      tags:
      - Card Payments
  /card_payments/{card_payment_id}:
    get:
      operationId: retrieve_a_card_payment
      parameters:
      - example: card_payment_nd3k2kacrqjli8482ave
        in: path
        name: card_payment_id
        required: true
        schema:
          description: The identifier of the Card Payment.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Card Payments
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/card_payment'
          description: Card Payment
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: Retrieve a Card Payment
      x-sandbox-only: false
      x-tag: Card Payments
      tags:
      - Card Payments
components:
  schemas:
    card_increment:
      additionalProperties: true
      description: Card Increments increase the pending amount of an authorized transaction.
      example:
        actioner: increase
        additional_amounts:
          clinic: null
          dental: null
          original: null
          prescription: null
          surcharge: null
          total_cumulative: null
          total_healthcare: null
          transit: null
          unknown: null
          vision: null
        amount: 20
        card_authorization_id: card_authorization_6iqxap6ivd0fo5eu3i8x
        currency: USD
        id: card_increment_6ztayc58j1od0rpebp3e
        network: visa
        network_identifiers:
          authorization_identification_response: null
          retrieval_reference_number: '785867080153'
          trace_number: '487941'
          transaction_id: '627199945183184'
        network_risk_score: 10
        pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4
        presentment_amount: 20
        presentment_currency: USD
        real_time_decision_id: null
        scheme_fees:
        - amount: '0.137465'
          created_at: '2020-01-31T23:59:59Z'
          currency: USD
          fee_type: visa_corporate_acceptance_fee
          fixed_component: null
          variable_rate: '0.0002'
        type: card_increment
        updated_authorization_amount: 120
      properties:
        actioner:
          description: Whether this authorization was approved by Increase, the card network through stand-in processing, or the user through a real-time decision.
          enum:
          - user
          - increase
          - network
          type: string
          x-documentation-priority: default
          x-enum-descriptions:
          - This object was actioned by the user through a real-time decision.
          - This object was actioned by Increase without user intervention.
          - This object was actioned by the network, through stand-in processing.
        additional_amounts:
          additionalProperties: false
          description: Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction.
          properties:
            clinic:
              anyOf:
              - additionalProperties: false
                description: The part of this transaction amount that was for clinic-related services.
                properties:
                  amount:
                    description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
                    type: integer
                    x-documentation-priority: default
                  currency:
                    description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
                    type: string
                    x-documentation-priority: default
                required:
                - amount
                - currency
                title: Card Increment AdditionalAmounts AdditionalAmount
                type: object
                x-documentation-priority: default
                x-event-categories: []
                x-stainless-empty-object: false
                x-title-plural: s
              - type: 'null'
            dental:
              anyOf:
              - additionalProperties: false
                description: The part of this transaction amount that was for dental-related services.
                properties:
                  amount:
                    description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
                    type: integer
                    x-documentation-priority: default
                  currency:
                    description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
                    type: string
                    x-documentation-priority: default
                required:
                - amount
                - currency
                title: Card Increment AdditionalAmounts AdditionalAmount
                type: object
                x-documentation-priority: default
                x-event-categories: []
                x-stainless-empty-object: false
                x-title-plural: s
              - type: 'null'
            original:
              anyOf:
              - additionalProperties: false
                description: The original pre-authorized amount.
                properties:
                  amount:
                    description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
                    type: integer
                    x-documentation-priority: default
                  currency:
                    description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
                    type: string
                    x-documentation-priority: default
                required:
                - amount
                - currency
                title: Card Increment AdditionalAmounts AdditionalAmount
                type: object
                x-documentation-priority: default
                x-event-categories: []
                x-stainless-empty-object: false
                x-title-plural: s
              - type: 'null'
            prescription:
              anyOf:
              - additionalProperties: false
                description: The part of this transaction amount that was for healthcare prescriptions.
                properties:
                  amount:
                    description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
                    type: integer
                    x-documentation-priority: default
                  currency:
                    description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
                    type: string
                    x-documentation-priority: default
                required:
                - amount
                - currency
                title: Card Increment AdditionalAmounts AdditionalAmount
                type: object
                x-documentation-priority: default
                x-event-categories: []
                x-stainless-empty-object: false
                x-title-plural: s
              - type: 'null'
            surcharge:
              anyOf:
              - additionalProperties: false
                description: The surcharge amount charged for this transaction by the merchant.
                properties:
                  amount:
                    description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
                    type: integer
                    x-documentation-priority: default
                  currency:
                    description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
                    type: string
                    x-documentation-priority: default
                required:
                - amount
                - currency
                title: Card Increment AdditionalAmounts AdditionalAmount
                type: object
                x-documentation-priority: default
                x-event-categories: []
                x-stainless-empty-object: false
                x-title-plural: s
              - type: 'null'
            total_cumulative:
              anyOf:
              - additionalProperties: false
                description: The total amount of a series of incremental authorizations, optionally provided.
                properties:
                  amount:
                    description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
                    type: integer
                    x-documentation-priority: default
                  currency:
                    description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
                    type: string
                    x-documentation-priority: default
                required:
                - amount
                - currency
                title: Card Increment AdditionalAmounts AdditionalAmount
                type: object
                x-documentation-priority: default
                x-event-categories: []
                x-stainless-empty-object: false
                x-title-plural: s
              - type: 'null'
            total_healthcare:
              anyOf:
              - additionalProperties: false
                description: The total amount of healthcare-related additional amounts.
                properties:
                  amount:
                    description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
                    type: integer
                    x-documentation-priority: default
                  currency:
                    description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
                    type: string
                    x-documentation-priority: default
                required:
                - amount
                - currency
                title: Card Increment AdditionalAmounts AdditionalAmount
                type: object
                x-documentation-priority: default
                x-event-categories: []
                x-stainless-empty-object: false
                x-title-plural: s
              - type: 'null'
            transit:
              anyOf:
              - additionalProperties: false
                description: The part of this transaction amount that was for transit-related services.
                properties:
                  amount:
                    description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
                    type: integer
                    x-documentation-priority: default
                  currency:
                    description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
                    type: string
                    x-documentation-priority: default
                required:
                - amount
                - currency
                title: Card Increment AdditionalAmounts AdditionalAmount
                type: object
                x-documentation-priority: default
                x-event-categories: []
                x-stainless-empty-object: false
                x-title-plural: s
              - type: 'null'
            unknown:
              anyOf:
              - additionalProperties: false
                description: An unknown additional amount.
                properties:
                  amount:
                    description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
                    type: integer
                    x-documentation-priority: default
                  currency:
                    description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
                    type: string
                    x-documentation-priority: default
                required:
                - amount
                - currency
                title: Card Increment AdditionalAmounts AdditionalAmount
                type: object
                x-documentation-priority: default
                x-event-categories: []
                x-stainless-empty-object: false
                x-title-plural: s
              - type: 'null'
            vision:
              anyOf:
              - additionalProperties: false
                description: The part of this transaction amount that was for vision-related services.
                properties:
                  amount:
                    description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount).
                    type: integer
                    x-documentation-priority: default
                  currency:
                    description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency.
                    type: string
                    x-documentation-priority: default
                required:
                - amount
                - currency
                title: Card Increment AdditionalAmounts AdditionalAmount
                type: object
                x-documentation-priority: default
                x-event-categories: []
                x-stainless-empty-object: false
                x-title-plural: s
              - type: 'null'
          required:
          - total_healthcare
          - total_cumulative
          - surcharge
          - transit
          - vision
          - clinic
          - dental
          - prescription
          - original
          - unknown
          title: Card Increment AdditionalAmounts
          type: object
          x-documentation-priority: default
          x-event-categories: []
          x-stainless-empty-object: false
          x-title-plural: s
        amount:
          description: The amount of this increment in the minor unit of the transaction's currency. For dollars, for example, this is cents.
          type: integer
          x-documentation-priority: default
        card_authorization_id:
          description: The identifier for the Card Authorization this increments.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Card Authorizations
        currency:
          description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's currency.
          enum:
          - USD
          type: string
          x-documentation-priority: default
          x-enum-descriptions:
          - US Dollar (USD)
        id:
          description: The Card Increment identifier.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Card Increments
        network:
          description: The card network used to process this card authorization.
          enum:
          - visa
          - pulse
          type: string
          x-documentation-priority: default
          x-enum-descriptions:
          - Visa
          - Pulse
        network_identifiers:
          additionalProperties: false
          description: Network-specific identifiers for a specific request or transaction.
          example:
            authorization_identification_response: null
            retrieval_reference_number: '785867080153'
            trace_number: '487941'
            transaction_id: '627199945183184'
          properties:
            authorization_identification_response:
              anyOf:
              - description: The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response.
                type: string
                x-documentation-priority: default
              - type: 'null'
            retrieval_reference_number:
              anyOf:
              - description: A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter.
                type: string
                x-documentation-priority: default
              - type: 'null'
            trace_number:
              anyOf:
              - description: A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time.
                type: string
                x-documentation-priority: default
              - type: 'null'
            transaction_id:
              anyOf:
              - description: A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests.
                type: string
                x-documentation-priority: default
              - type: 'null'
          required:
          - transaction_id
          - trace_number
          - retrieval_reference_number
          - authorization_identification_response
          title: Card Increment NetworkIdentifiers
          type: object
          x-documentation-priority: default
          x-event-categories: []
          x-stainless-empty-object: false
          x-title-plural: s
        network_risk_score:
          anyOf:
          - description: The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest.
            type: integer
            x-documentation-priority: default
          - type: 'null'
        pending_transaction_id:
          anyOf:
          - description: The identifier of the Pending Transaction associated with this Card Increment.
            type: string
            x-documentation-priority: default
            x-id-reference-to: Pending Transactions
          - type: 'null'
        presentment_amount:
          description: The amount of this increment in the minor unit of the transaction's presentment currency.
          type: integer
          x-documentation-priority: default
        presentment_currency:
          description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency.
          type: string
          x-documentation-priority: default
        real_time_decision_id:
          anyOf:
          - description: The identifier of the Real-Time Decision sent to approve or decline this incremental authorization.
            type: string
            x-documentation-priority: default
            x-id-reference-to: Real-Time Decisions
          - type: 'null'
        scheme_fees:
          description: The scheme fees associated with this card increment.
          items:
            additionalProperties: false
            example:
              amount: '0.137465'
              created_at: '2020-01-31T23:59:59Z'
              currency: USD
              fee_type: visa_corporate_acceptance_fee
              fixed_component: null
              variable_rate: '0.0002'
            properties:
              amount:
                description: The fee amount given as a string containing a decimal number.
                pattern: ^-?\d+(\.\d+)?$
                type: string
                x-documentation-priority: default
              created_at:
                description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created.
                format: date-time
                type: string
                x-documentation-priority: default
              currency:
                description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement.
                enum:
                - USD
                type: string
                x-documentation-priority: default
                x-enum-descriptions:
                - US Dollar (USD)
              fee_type:
                description: The type of fee being assessed.
                enum:
                - visa_international_service_assessment_single_currency
                - visa_international_service_assessment_cross_currency
                - visa_authorization_domestic_point_of_sale
                - visa_authorization_international_point_of_sale
                - visa_authorization_canada_point_of_sale
                - visa_authorization_reversal_point_of_sale
                - visa_authorization_reversal_international_point_of_sale
                - visa_authorization_address_verification_service
                - visa_advanced_authorization
                - visa_message_transmission
                - visa_account_verification_domestic
                - visa_account_verification_international
                - visa_account_verification_canada
                - visa_corporate_acceptance_fee
                - visa_consumer_debit_acceptance_fee
                - visa_business_debit_acceptance_fee
                - visa_purchasing_acceptance_fee
                - visa_purchase_domestic
                - visa_purchase_international
                - visa_credit_purchase_token
                - visa_debit_purchase_token
                - visa_clearing_transmission
                - visa_direct_authorization
                - visa_direct_transaction_domestic
                - visa_service_commercial_credit
                - visa_advertising_service_commercial_credit
                - visa_community_growth_acceleration_program
                - visa_processing_guarantee_commercial_credit
                - pulse_switch_fee
                type: string
                x-documentation-priority: default
                x-enum-descriptions:
                - International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency.
                - International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies.
                - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.
                - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer.
                - Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified.
                - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.
                - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request.
                - A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes.
                - Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions).
                - Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point.
                - Activity, per inquiry, related to the domestic Issuer for Account Number Verification.
                - Activity, per inquiry, related to the international Issuer for Account Number Verification.
                - Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification.
                - The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.
                - The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation.
                - The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions.
                - The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions.
                - Activity and fees for the processing of a sales draft original for a purchase transaction.
                - Activity and fees for the processing of an international sales draft original for a purchase transaction.
                - Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.
                - Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions.
                - A per transaction fee assessed for Base II financial draft - Issuer.
                - Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions.
                - Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions.
                - Issuer card service fee for Commercial Credit cards.
                - Issuer Advertising Service Fee for Commercial Credit cards.
                - Issuer Community Growth Acceleration Program Fee.
                - Issuer Processing Guarantee for Commercial Credit cards.
                - Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network.
              fixed_component:
                anyOf:
                - description: The fixed component of the fee, if applicable, given in major units of the fee amount.
                  pattern: ^-?\d+(\.\d+)?$
                  type: string
                  x-documentation-priority: default
                - type: 'null'
              variable_rate:
                anyOf:
                - description: The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%).
                  pattern: ^-?\d+(\.\d+)?$
                  type: string
                  x-documentation-priority: default
                - type: 'null'
            required:
            - created_at
            - amount
            - currency
            - fee_type
            - variable_rate
     

# --- truncated at 32 KB (505 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/increase/refs/heads/main/openapi/increase-card-payments-api-openapi.yml