Increase Declined Transactions 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 Declined Transactions API
  version: 0.0.1
servers:
- url: https://api.increase.com
- url: https://sandbox.increase.com
security:
- bearerAuth: []
tags:
- description: Declined Transactions are refused additions and removals of money from your bank account. For example, Declined Transactions are caused when your Account has an insufficient balance or your Limits are triggered.
  name: Declined Transactions
paths:
  /declined_transactions:
    get:
      operationId: list_declined_transactions
      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
      - in: query
        name: account_id
        required: false
        schema:
          description: Filter Declined Transactions to ones belonging to the specified Account.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Accounts
      - 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
      - in: query
        name: route_id
        required: false
        schema:
          description: Filter Declined Transactions to those belonging to the specified route.
          type: string
          x-documentation-priority: default
      - in: query
        name: category.in
        required: false
        schema:
          description: Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.
          items:
            enum:
            - ach_decline
            - card_decline
            - check_decline
            - inbound_real_time_payments_transfer_decline
            - inbound_fednow_transfer_decline
            - wire_decline
            - check_deposit_rejection
            - other
            type: string
            x-enum-descriptions:
            - 'ACH Decline: details will be under the `ach_decline` object.'
            - 'Card Decline: details will be under the `card_decline` object.'
            - 'Check Decline: details will be under the `check_decline` object.'
            - 'Inbound Real-Time Payments Transfer Decline: details will be under the `inbound_real_time_payments_transfer_decline` object.'
            - 'Inbound FedNow Transfer Decline: details will be under the `inbound_fednow_transfer_decline` object.'
            - 'Wire Decline: details will be under the `wire_decline` object.'
            - 'Check Deposit Rejection: details will be under the `check_deposit_rejection` object.'
            - The Declined Transaction was made for an undocumented or deprecated reason.
          type: array
          x-documentation-priority: default
        explode: false
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/declined_transaction_list'
          description: Declined Transaction List
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: List Declined Transactions
      x-sandbox-only: false
      x-tag: Declined Transactions
      tags:
      - Declined Transactions
  /declined_transactions/{declined_transaction_id}:
    get:
      operationId: retrieve_a_declined_transaction
      parameters:
      - example: declined_transaction_17jbn0yyhvkt4v4ooym8
        in: path
        name: declined_transaction_id
        required: true
        schema:
          description: The identifier of the Declined Transaction.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Declined Transactions
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/declined_transaction'
          description: Declined Transaction
        4XX:
          $ref: '#/components/responses/errorResponse'
        5XX:
          $ref: '#/components/responses/errorResponse'
      summary: Retrieve a Declined Transaction
      x-sandbox-only: false
      x-tag: Declined Transactions
      tags:
      - Declined Transactions
components:
  responses:
    errorResponse:
      content:
        application/json:
          schema:
            allOf:
            - $ref: '#/components/schemas/error'
      description: Error
  schemas:
    ach_decline:
      additionalProperties: true
      example:
        amount: 1750
        id: ach_decline_72v1mcwxudctq56efipa
        inbound_ach_transfer_id: inbound_ach_transfer_tdrwqr3fq9gnnq49odev
        originator_company_descriptive_date: null
        originator_company_discretionary_data: null
        originator_company_id: 0987654321
        originator_company_name: BIG BANK
        reason: insufficient_funds
        receiver_id_number: '12345678900'
        receiver_name: IAN CREASE
        trace_number: 021000038461022
        type: ach_decline
      properties:
        amount:
          description: The declined amount in USD cents.
          type: integer
          x-documentation-priority: default
        id:
          description: The ACH Decline's identifier.
          type: string
          x-documentation-priority: default
          x-id-reference-to: ACH Declines
        inbound_ach_transfer_id:
          description: The identifier of the Inbound ACH Transfer object associated with this decline.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Inbound ACH Transfers
        originator_company_descriptive_date:
          anyOf:
          - description: The descriptive date of the transfer.
            type: string
            x-documentation-priority: default
          - type: 'null'
        originator_company_discretionary_data:
          anyOf:
          - description: The additional information included with the transfer.
            type: string
            x-documentation-priority: default
          - type: 'null'
        originator_company_id:
          description: The identifier of the company that initiated the transfer.
          type: string
          x-documentation-priority: default
        originator_company_name:
          description: The name of the company that initiated the transfer.
          type: string
          x-documentation-priority: default
        reason:
          description: Why the ACH transfer was declined.
          enum:
          - ach_route_canceled
          - ach_route_disabled
          - breaches_limit
          - entity_not_active
          - group_locked
          - transaction_not_allowed
          - returned_per_odfi_request
          - user_initiated
          - insufficient_funds
          - authorization_revoked_by_customer
          - payment_stopped
          - customer_advised_unauthorized_improper_ineligible_or_incomplete
          - representative_payee_deceased_or_unable_to_continue_in_that_capacity
          - beneficiary_or_account_holder_deceased
          - credit_entry_refused_by_receiver
          - duplicate_entry
          - corporate_customer_advised_not_authorized
          type: string
          x-documentation-priority: default
          x-enum-descriptions:
          - The account number is canceled.
          - The account number is disabled.
          - The transaction would cause an Increase limit to be exceeded.
          - The account's entity is not active.
          - Your account is inactive.
          - The transaction is not allowed per Increase's terms.
          - The originating financial institution asked for this transfer to be returned. The receiving bank is complying with the request.
          - Your integration declined this transfer via the API.
          - Your account contains insufficient funds.
          - The customer no longer authorizes this transaction.
          - The customer asked for the payment to be stopped.
          - The customer advises that the debit was unauthorized.
          - The payee is deceased.
          - The account holder is deceased.
          - The customer refused a credit entry.
          - The account holder identified this transaction as a duplicate.
          - The corporate customer no longer authorizes this transaction.
        receiver_id_number:
          anyOf:
          - description: The id of the receiver of the transfer.
            type: string
            x-documentation-priority: default
          - type: 'null'
        receiver_name:
          anyOf:
          - description: The name of the receiver of the transfer.
            type: string
            x-documentation-priority: default
          - type: 'null'
        trace_number:
          description: The trace number of the transfer.
          type: string
          x-documentation-priority: default
        type:
          description: A constant representing the object's type. For this resource it will always be `ach_decline`.
          enum:
          - ach_decline
          type: string
          x-documentation-priority: default
      required:
      - type
      - id
      - amount
      - originator_company_name
      - originator_company_descriptive_date
      - originator_company_discretionary_data
      - originator_company_id
      - reason
      - receiver_id_number
      - receiver_name
      - trace_number
      - inbound_ach_transfer_id
      title: ACH Decline
      type: object
      x-event-categories: []
      x-stainless-empty-object: false
      x-title-plural: ACH Declines
    declined_transaction:
      additionalProperties: true
      description: Declined Transactions are refused additions and removals of money from your bank account. For example, Declined Transactions are caused when your Account has an insufficient balance or your Limits are triggered.
      example:
        account_id: account_in71c4amph0vgo2qllky
        amount: 1750
        created_at: '2020-01-31T23:59:59Z'
        currency: USD
        description: INVOICE 2468
        id: declined_transaction_17jbn0yyhvkt4v4ooym8
        route_id: account_number_v18nkfqm6afpsrvy82b2
        route_type: account_number
        source:
          ach_decline:
            amount: 1750
            id: ach_decline_72v1mcwxudctq56efipa
            inbound_ach_transfer_id: inbound_ach_transfer_tdrwqr3fq9gnnq49odev
            originator_company_descriptive_date: null
            originator_company_discretionary_data: null
            originator_company_id: 0987654321
            originator_company_name: BIG BANK
            reason: insufficient_funds
            receiver_id_number: '12345678900'
            receiver_name: IAN CREASE
            trace_number: 021000038461022
            type: ach_decline
          category: ach_decline
        type: declined_transaction
      properties:
        account_id:
          description: The identifier for the Account the Declined Transaction belongs to.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Accounts
        amount:
          description: The Declined Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.
          type: integer
          x-documentation-priority: default
        created_at:
          description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transaction occurred.
          format: date-time
          type: string
          x-documentation-priority: default
        currency:
          description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined Transaction's currency. This will match the currency on the Declined Transaction's Account.
          enum:
          - USD
          type: string
          x-documentation-priority: default
          x-enum-descriptions:
          - US Dollar (USD)
        description:
          description: This is the description the vendor provides.
          type: string
          x-documentation-priority: default
        id:
          description: The Declined Transaction identifier.
          type: string
          x-documentation-priority: default
          x-id-reference-to: Declined Transactions
        route_id:
          anyOf:
          - description: The identifier for the route this Declined Transaction came through. Routes are things like cards and ACH details.
            type: string
            x-documentation-priority: default
          - type: 'null'
        route_type:
          anyOf:
          - description: The type of the route this Declined Transaction came through.
            enum:
            - account_number
            - card
            - lockbox
            type: string
            x-documentation-priority: default
            x-enum-descriptions:
            - An Account Number.
            - A Card.
            - A Lockbox.
          - type: 'null'
        source:
          additionalProperties: true
          description: This is an object giving more details on the network-level event that caused the Declined Transaction. For example, for a card transaction this lists the merchant's industry and location. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.
          example:
            ach_decline:
              amount: 1750
              id: ach_decline_72v1mcwxudctq56efipa
              inbound_ach_transfer_id: inbound_ach_transfer_tdrwqr3fq9gnnq49odev
              originator_company_descriptive_date: null
              originator_company_discretionary_data: null
              originator_company_id: 0987654321
              originator_company_name: BIG BANK
              reason: insufficient_funds
              receiver_id_number: '12345678900'
              receiver_name: IAN CREASE
              trace_number: 021000038461022
              type: ach_decline
            category: ach_decline
          properties:
            ach_decline:
              anyOf:
              - $ref: '#/components/schemas/ach_decline'
                description: An ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `ach_decline`.
                x-documentation-priority: default
              - type: 'null'
            card_decline:
              anyOf:
              - additionalProperties: true
                description: A Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_decline`.
                example:
                  actioner: increase
                  additional_amounts:
                    clinic: null
                    dental: null
                    original: null
                    prescription: null
                    surcharge:
                      amount: 10
                      currency: USD
                    total_cumulative: null
                    total_healthcare: null
                    transit: null
                    unknown: null
                    vision: null
                  amount: -1000
                  card_payment_id: card_payment_nd3k2kacrqjli8482ave
                  currency: USD
                  declined_transaction_id: declined_transaction_17jbn0yyhvkt4v4ooym8
                  digital_wallet_token_id: null
                  direction: settlement
                  id: card_decline_bx3o8zd7glq8yvtwg25v
                  incremented_card_authorization_id: null
                  merchant_acceptor_id: '5665270011000168'
                  merchant_category_code: '5734'
                  merchant_city: New York
                  merchant_country: US
                  merchant_descriptor: AMAZON.COM
                  merchant_postal_code: '10045'
                  merchant_state: null
                  network_details:
                    category: visa
                    pulse: null
                    visa:
                      electronic_commerce_indicator: secure_electronic_commerce
                      point_of_service_entry_mode: manual
                      stand_in_processing_reason: null
                      terminal_entry_capability: magnetic_stripe
                  network_identifiers:
                    authorization_identification_response: null
                    retrieval_reference_number: '785867080153'
                    trace_number: '487941'
                    transaction_id: '627199945183184'
                  network_risk_score: 10
                  physical_card_id: null
                  presentment_amount: -1000
                  presentment_currency: USD
                  processing_category: purchase
                  real_time_decision_id: null
                  real_time_decision_reason: null
                  reason: insufficient_funds
                  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'
                  terminal_id: RCN5VNXS
                  verification:
                    card_verification_code:
                      result: match
                    cardholder_address:
                      actual_line1: 33 Liberty Street
                      actual_postal_code: '94131'
                      provided_line1: 33 Liberty Street
                      provided_postal_code: '94132'
                      result: postal_code_no_match_address_match
                    cardholder_name: null
                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: Declined Transaction Declined Transaction Source Card Decline 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: Declined Transaction Declined Transaction Source Card Decline 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: Declined Transaction Declined Transaction Source Card Decline 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: Declined Transaction Declined Transaction Source Card Decline 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: Declined Transaction Declined Transaction Source Card Decline 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: Declined Transaction Declined Transaction Source Card Decline 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: Declined Transaction Declined Transaction Source Card Decline 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: Declined Transaction Declined Transaction Source Card Decline 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.
     

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