openapi: 3.1.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 Account Numbers 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: schemas: 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. 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' 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: 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' required: - total_healthcare - total_cumulative - surcharge - transit - vision - clinic - dental - prescription - original - unknown title: Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s amount: description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default card_payment_id: description: The ID of the Card Payment this transaction belongs to. type: string x-documentation-priority: default x-id-reference-to: Card Payments currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) declined_transaction_id: description: The identifier of the declined transaction created for this Card Decline. type: string x-documentation-priority: default x-id-reference-to: Declined Transactions digital_wallet_token_id: anyOf: - description: If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used. type: string x-documentation-priority: default x-id-reference-to: Digital Wallet Tokens - type: 'null' direction: description: The direction describes the direction the funds will move, either from the cardholder to the merchant or from the merchant to the cardholder. enum: - settlement - refund type: string x-documentation-priority: default x-enum-descriptions: - A regular card authorization where funds are debited from the cardholder. - A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. id: description: The Card Decline identifier. type: string x-documentation-priority: default x-id-reference-to: Card Declines incremented_card_authorization_id: anyOf: - description: The identifier of the card authorization this request attempted to incrementally authorize. type: string x-documentation-priority: default x-id-reference-to: Card Authorizations - type: 'null' merchant_acceptor_id: description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_category_code: description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_city: anyOf: - description: The city the merchant resides in. type: string x-documentation-priority: default - type: 'null' merchant_country: description: The country the merchant resides in. type: string x-documentation-priority: default merchant_descriptor: description: The merchant descriptor of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_postal_code: anyOf: - description: The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash. type: string x-documentation-priority: default - type: 'null' merchant_state: anyOf: - description: The state the merchant resides in. type: string x-documentation-priority: default - type: 'null' network_details: additionalProperties: false description: Fields specific to the `network`. properties: category: description: The payment network used to process this card authorization. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa - Pulse pulse: anyOf: - additionalProperties: false description: Fields specific to the `pulse` network. properties: {} title: Declined Transaction Declined Transaction Source Card Decline NetworkDetails Pulse type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Pulses - type: 'null' visa: anyOf: - additionalProperties: false description: Fields specific to the `visa` network. properties: electronic_commerce_indicator: anyOf: - description: For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order. enum: - mail_phone_order - recurring - installment - unknown_mail_phone_order - secure_electronic_commerce - non_authenticated_security_transaction_at_3ds_capable_merchant - non_authenticated_security_transaction - non_secure_transaction type: string x-documentation-priority: default x-enum-descriptions: - 'Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.' - 'Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.' - 'Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.' - 'Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.' - 'Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure' - 'Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.' - 'Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however, cardholder authentication is not performed using 3-D Secure.' - 'Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection.' - type: 'null' point_of_service_entry_mode: anyOf: - description: The method used to enter the cardholder's primary account number and card expiration date. enum: - unknown - manual - magnetic_stripe_no_cvv - optical_code - integrated_circuit_card - contactless - credential_on_file - magnetic_stripe - contactless_magnetic_stripe - integrated_circuit_card_no_cvv type: string x-documentation-priority: default x-enum-descriptions: - Unknown - Manual key entry - Magnetic stripe read, without card verification value - Optical code - Contact chip card - Contactless read of chip card - Transaction initiated using a credential that has previously been stored on file - Magnetic stripe read - Contactless read of magnetic stripe data - Contact chip card, without card verification value - type: 'null' stand_in_processing_reason: anyOf: - description: 'Only present when `actioner: network`. Describes why a card authorization was approved or declined by Visa through stand-in processing.' enum: - issuer_error - invalid_physical_card - invalid_cryptogram - invalid_cardholder_authentication_verification_value - internal_visa_error - merchant_transaction_advisory_service_authentication_required - payment_fraud_disruption_acquirer_block - other type: string x-documentation-priority: default x-enum-descriptions: - Increase failed to process the authorization in a timely manner. - The physical card read had an invalid CVV or dCVV. - The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase. - The 3DS cardholder authentication verification value was invalid. - An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays. - The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier. - The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing. - An unspecific reason for stand-in processing. - type: 'null' terminal_entry_capability: anyOf: - description: The capability of the terminal being used to read the card. Shows whether a terminal can e.g., accept chip cards or if it only supports magnetic stripe reads. This reflects the highest capability of the terminal — for example, a terminal that supports both chip and magnetic stripe will be identified as chip-capable. enum: - unknown - terminal_not_used - magnetic_stripe - barcode - optical_character_recognition - chip_or_contactless - contactless_only - no_capability type: string x-documentation-priority: default x-enum-descriptions: - Unknown - No terminal was used for this transaction. - The terminal can only read magnetic stripes and does not have chip or contactless reading capability. - The terminal can only read barcodes. - The terminal can only read cards via Optical Character Recognition. - The terminal supports contact chip cards and can also read the magnetic stripe. If contact chip is supported, this value is used regardless of whether contactless is also supported. - The terminal supports contactless reads but does not support contact chip. Only used when the terminal lacks contact chip capability. - The terminal has no card reading capability. - type: 'null' required: - electronic_commerce_indicator - point_of_service_entry_mode - stand_in_processing_reason - terminal_entry_capability title: Declined Transaction Declined Transaction Source Card Decline NetworkDetails Visa type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Visas - type: 'null' required: - category - visa - pulse title: Declined Transaction Declined Transaction Source Card Decline NetworkDetails type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s 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: Declined Transaction Declined Transaction Source Card Decline 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. For Pulse the score is from 0 to 999, where 999 is the riskiest. type: integer x-documentation-priority: default - type: 'null' physical_card_id: anyOf: - description: If the authorization was made in-person with a physical card, the Physical Card that was used. type: string x-documentation-priority: default x-id-reference-to: Physical Cards - type: 'null' presentment_amount: description: The declined amount 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 processing_category: description: The processing category describes the intent behind the authorization, such as whether it was used for bill payments or an automatic fuel dispenser. enum: - account_funding - automatic_fuel_dispenser - bill_payment - original_credit - purchase - quasi_cash - refund - cash_disbursement - balance_inquiry - unknown type: string x-documentation-priority: default x-enum-descriptions: - Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts. - Automatic fuel dispenser authorizations occur when a card is used at a gas pump, prior to the actual transaction amount being known. They are followed by an advice message that updates the amount of the pending transaction. - A transaction used to pay a bill. - Original credit transactions are used to send money to a cardholder. - A regular purchase. - Quasi-cash transactions represent purchases of items which may be convertible to cash. - A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. - Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale. - A balance inquiry transaction is used to check the balance of an account associated with a card. - The processing category is unknown. real_time_decision_id: anyOf: - description: The identifier of the Real-Time Decision sent to approve or decline this transaction. type: string x-documentation-priority: default x-id-reference-to: Real-Time Decisions - type: 'null' real_time_decision_reason: anyOf: - description: This is present if a specific decline reason was given in the real-time decision. enum: - insufficient_funds - transaction_never_allowed - exceeds_approval_limit - card_temporarily_disabled - suspected_fraud - other type: string x-documentation-priority: default x-enum-descriptions: - The cardholder does not have sufficient funds to cover the transaction. The merchant may attempt to process the transaction again. - This type of transaction is not allowed for this card. This transaction should not be retried. - The transaction amount exceeds the cardholder's approval limit. The merchant may attempt to process the transaction again. - The card has been temporarily disabled or not yet activated. The merchant may attempt to process the transaction again. - The transaction is suspected to be fraudulent. The merchant may attempt to process the transaction again. - The transaction was declined for another reason. The merchant may attempt to process the transaction again. This should be used sparingly. - type: 'null' reason: description: Why the transaction was declined. enum: - account_closed - card_not_active - card_canceled - physical_card_not_active - entity_not_active - group_locked - insufficient_funds - cvv2_mismatch - pin_mismatch - card_expiration_mismatch - transaction_not_allowed - breaches_limit - webhook_declined - webhook_timed_out - declined_by_stand_in_processing - invalid_physical_card - missing_original_authorization - invalid_cryptogram - failed_3ds_authentication - suspected_card_testing - suspected_fraud type: string x-documentation-priority: default x-enum-descriptions: - The account has been closed. - The Card was not active. - The Card has been canceled. - The Physical Card was not active. - The account's entity was not active. - The account was inactive. - The Card's Account did not have a sufficient available balance. - The given CVV2 did not match the card's value. - The given PIN did not match the card's value. - The given expiration date did not match the card's value. Only applies when a CVV2 is present. - The attempted card transaction is not allowed per Increase's terms. - The transaction was blocked by a Limit. - Your application declined the transaction via webhook. - Your application webhook did not respond without the required timeout. - Declined by stand-in processing. - The card read had an invalid CVV or dCVV. - The original card authorization for this incremental authorization does not exist. - The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase. - The transaction was declined because the 3DS authentication failed. - The transaction was suspected to be used by a card tester to test for valid card numbers. - The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information. scheme_fees: description: The scheme fees associated with this card decline. 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 - fixed_component title: Declined Transaction Declined Transaction Source Card Decline Card Scheme Fee type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Scheme Fees type: array x-documentation-priority: default terminal_id: anyOf: - description: The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with. type: string x-documentation-priority: default - type: 'null' verification: additionalProperties: false description: Fields related to verification of cardholder-provided values. properties: card_verification_code: additionalProperties: false description: Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. properties: result: description: The result of verifying the Card Verification Code. enum: - not_checked - match - no_match type: string x-documentation-priority: default x-enum-descriptions: - No card verification code was provided in the authorization request. - The card verification code matched the one on file. - The card verification code did not match the one on file. required: - result title: Declined Transaction Declined Transaction Source Card Decline Verification CardVerificationCode type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardVerificationCodes cardholder_address: additionalProperties: false description: Cardholder address provided in the authorization request and the address on file we verified it against. properties: actual_line1: anyOf: - description: Line 1 of the address on file for the cardholder. type: string x-documentation-priority: default - type: 'null' actual_postal_code: anyOf: - description: The postal code of the address on file for the cardholder. type: string x-documentation-priority: default - type: 'null' provided_line1: anyOf: - description: The cardholder address line 1 provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_postal_code: anyOf: - description: The postal code provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' result: description: The address verification result returned to the card network. enum: - not_checked - postal_code_match_address_no_match - postal_code_no_match_address_match - match - no_match - postal_code_match_address_not_checked type: string x-documentation-priority: default x-enum-descriptions: - No address information was provided in the authorization request. - Postal code matches, but the street address does not match or was not provided. - Postal code does not match, but the street address matches or was not provided. - Postal code and street address match. - Postal code and street address do not match. - Postal code matches, but the street address was not verified. (deprecated) required: - provided_postal_code - provided_line1 - actual_postal_code - actual_line1 - result title: Declined Transaction Declined Transaction Source Card Decline Verification CardholderAddress type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardholderAddresses cardholder_name: anyOf: - additionalProperties: false description: Cardholder name provided in the authorization request. properties: provided_first_name: anyOf: - description: The first name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_last_name: anyOf: - description: The last name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_middle_name: anyOf: - description: The middle name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' required: - provided_first_name - provided_middle_name - provided_last_name title: Declined Transaction Declined Transaction Source Card Decline Verification CardholderName type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardholderNames - type: 'null' required: - cardholder_address - cardholder_name - card_verification_code title: Declined Transaction Declined Transaction Source Card Decline Verification type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s required: - merchant_acceptor_id - merchant_descriptor - merchant_category_code - terminal_id - merchant_city - merchant_state - merchant_postal_code - merchant_country - digital_wallet_token_id - physical_card_id - verification - additional_amounts - network_identifiers - network_risk_score - network_details - id - card_payment_id - amount - presentment_amount - presentment_currency - currency - processing_category - reason - real_time_decision_reason - incremented_card_authorization_id - actioner - direction - real_time_decision_id - scheme_fees - declined_transaction_id title: Declined Transaction Declined Transaction Source Card Decline type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Declines - type: 'null' category: description: The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully. 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-documentation-priority: default 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. check_decline: anyOf: - additionalProperties: true description: A Check Decline object. This field will be present in the JSON response if and only if `category` is equal to `check_decline`. example: amount: -1000 auxiliary_on_us: '99999' back_image_file_id: null check_transfer_id: check_transfer_30b43acfu9vw8fyc4f5 front_image_file_id: null inbound_check_deposit_id: inbound_check_deposit_zoshvqybq0cjjm31mra reason: insufficient_funds properties: amount: description: The declined amount in USD cents. type: integer x-documentation-priority: default auxiliary_on_us: anyOf: - description: A computer-readable number printed on the MICR line of business checks, usually the check number. This is useful for positive pay checks, but can be unreliably transmitted by the bank of first deposit. type: string x-documentation-priority: default - type: 'null' back_image_file_id: anyOf: - description: The identifier of the API File object containing an image of the back of the declined check. type: string x-documentation-priority: default x-id-reference-to: Files - type: 'null' check_transfer_id: anyOf: - description: The identifier of the Check Transfer object associated with this decline. type: string x-documentation-priority: default x-id-reference-to: Check Transfers - type: 'null' front_image_file_id: anyOf: - description: The identifier of the API File object containing an image of the front of the declined check. type: string x-documentation-priority: default x-id-reference-to: Files - type: 'null' inbound_check_deposit_id: anyOf: - description: The identifier of the Inbound Check Deposit object associated with this decline. type: string x-documentation-priority: default x-id-reference-to: Inbound Check Deposits - type: 'null' reason: description: Why the check was declined. enum: - ach_route_disabled - ach_route_canceled - altered_or_fictitious - breaches_limit - endorsement_irregular - entity_not_active - group_locked - insufficient_funds - stop_payment_requested - duplicate_presentment - not_authorized - amount_mismatch - not_our_item - no_account_number_found - refer_to_image - unable_to_process - unusable_image - user_initiated type: string x-documentation-priority: default x-enum-descriptions: - The account number is disabled. - The account number is canceled. - The deposited check was altered or fictitious. - The transaction would cause a limit to be exceeded. - The check was not endorsed by the payee. - The account's entity is not active. - Your account is inactive. - Your account contains insufficient funds. - Stop payment requested for this check. - The check was a duplicate deposit. - The check was not authorized. - The amount the receiving bank is attempting to deposit does not match the amount on the check. - The check attempting to be deposited does not belong to Increase. - The account number on the check does not exist at Increase. - The check is not readable. Please refer to the image. - 'The check cannot be processed. This is rare: please contact support.' - The check image is unusable. - Your integration declined this check via the API. required: - amount - auxiliary_on_us - reason - front_image_file_id - back_image_file_id - inbound_check_deposit_id - check_transfer_id title: Declined Transaction Declined Transaction Source Check Decline type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Check Declines - type: 'null' check_deposit_rejection: anyOf: - additionalProperties: true description: A Check Deposit Rejection object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_rejection`. example: amount: 1750 check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1 currency: USD declined_transaction_id: declined_transaction_17jbn0yyhvkt4v4ooym8 reason: incomplete_image rejected_at: '2020-01-31T23:59:59Z' properties: amount: description: The rejected amount in the minor unit of check's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default check_deposit_id: description: The identifier of the Check Deposit that was rejected. type: string x-documentation-priority: default x-id-reference-to: Check Deposits currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) declined_transaction_id: description: The identifier of the associated declined transaction. type: string x-documentation-priority: default x-id-reference-to: Declined Transactions reason: description: Why the check deposit was rejected. enum: - incomplete_image - duplicate - poor_image_quality - incorrect_amount - incorrect_recipient - not_eligible_for_mobile_deposit - missing_required_data_elements - suspected_fraud - deposit_window_expired - requested_by_user - international - unknown type: string x-documentation-priority: default x-enum-descriptions: - The check's image is incomplete. - This is a duplicate check submission. - This check has poor image quality. - The check was deposited with the incorrect amount. - The check is made out to someone other than the account holder. - This check was not eligible for mobile deposit. - This check is missing at least one required field. - This check is suspected to be fraudulent. - This check's deposit window has expired. - The check was rejected at the user's request. - The check is not a U.S. domestic check and cannot be processed. - The check was rejected for an unknown reason. rejected_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was rejected. format: date-time type: string x-documentation-priority: default required: - check_deposit_id - declined_transaction_id - amount - currency - reason - rejected_at title: Declined Transaction Declined Transaction Source Check Deposit Rejection type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Check Deposit Rejections - type: 'null' inbound_fednow_transfer_decline: anyOf: - additionalProperties: true description: An Inbound FedNow Transfer Decline object. This field will be present in the JSON response if and only if `category` is equal to `inbound_fednow_transfer_decline`. example: reason: account_number_disabled transfer_id: inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20 properties: reason: description: Why the transfer was declined. enum: - account_number_canceled - account_number_disabled - account_restricted - group_locked - entity_not_active - fednow_not_enabled type: string x-documentation-priority: default x-enum-descriptions: - The account number is canceled. - The account number is disabled. - Your account is restricted. - Your account is inactive. - The account's entity is not active. - Your account is not enabled to receive FedNow transfers. transfer_id: description: The identifier of the FedNow Transfer that led to this declined transaction. type: string x-documentation-priority: default x-id-reference-to: Inbound FedNow Transfers required: - reason - transfer_id title: Declined Transaction Declined Transaction Source Inbound FedNow Transfer Decline type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound FedNow Transfer Declines - type: 'null' inbound_real_time_payments_transfer_decline: anyOf: - additionalProperties: true description: An Inbound Real-Time Payments Transfer Decline object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_decline`. example: amount: 100 creditor_name: Ian Crease currency: USD debtor_account_number: '987654321' debtor_name: National Phonograph Company debtor_routing_number: '101050001' reason: account_number_disabled transaction_identification: 20220501234567891T1BSLZO01745013025 transfer_id: inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr unstructured_remittance_information: Invoice 29582 properties: amount: description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default creditor_name: description: The name the sender of the transfer specified as the recipient of the transfer. type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined transfer's currency. This will always be "USD" for a Real-Time Payments transfer. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) debtor_account_number: description: The account number of the account that sent the transfer. type: string x-documentation-priority: default debtor_name: description: The name provided by the sender of the transfer. type: string x-documentation-priority: default debtor_routing_number: description: The routing number of the account that sent the transfer. type: string x-documentation-priority: default reason: description: Why the transfer was declined. enum: - account_number_canceled - account_number_disabled - account_restricted - group_locked - entity_not_active - real_time_payments_not_enabled type: string x-documentation-priority: default x-enum-descriptions: - The account number is canceled. - The account number is disabled. - Your account is restricted. - Your account is inactive. - The account's entity is not active. - Your account is not enabled to receive Real-Time Payments transfers. transaction_identification: description: The Real-Time Payments network identification of the declined transfer. type: string x-documentation-priority: default transfer_id: description: The identifier of the Real-Time Payments Transfer that led to this Transaction. type: string x-documentation-priority: default x-id-reference-to: Inbound Real-Time Payments Transfers unstructured_remittance_information: anyOf: - description: Additional information included with the transfer. type: string x-documentation-priority: default - type: 'null' required: - amount - currency - reason - creditor_name - debtor_name - debtor_account_number - debtor_routing_number - transaction_identification - unstructured_remittance_information - transfer_id title: Declined Transaction Declined Transaction Source Inbound Real-Time Payments Transfer Decline type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound Real-Time Payments Transfer Declines - type: 'null' other: anyOf: - additionalProperties: false description: If the category of this Transaction source is equal to `other`, this field will contain an empty object, otherwise it will contain null. properties: {} title: Declined Transaction Declined Transaction Source Other type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Others - type: 'null' wire_decline: anyOf: - additionalProperties: true description: A Wire Decline object. This field will be present in the JSON response if and only if `category` is equal to `wire_decline`. example: inbound_wire_transfer_id: inbound_wire_transfer_f228m6bmhtcxjco9pwp0 reason: account_number_disabled properties: inbound_wire_transfer_id: description: The identifier of the Inbound Wire Transfer that was declined. type: string x-documentation-priority: default x-id-reference-to: Inbound Wire Transfers reason: description: Why the wire transfer was declined. enum: - account_number_canceled - account_number_disabled - entity_not_active - group_locked - no_account_number - transaction_not_allowed type: string x-documentation-priority: default x-enum-descriptions: - The account number is canceled. - The account number is disabled. - The account's entity is not active. - Your account is inactive. - The beneficiary account number does not exist. - The transaction is not allowed per Increase's terms. required: - reason - inbound_wire_transfer_id title: Declined Transaction Declined Transaction Source Wire Decline type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Wire Declines - type: 'null' required: - category title: Declined Transaction Declined Transaction Source type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Declined Transaction Sources type: description: A constant representing the object's type. For this resource it will always be `declined_transaction`. enum: - declined_transaction type: string x-documentation-priority: default required: - type - account_id - amount - currency - created_at - description - id - route_id - route_type - source title: Declined Transaction type: object x-event-categories: - declined_transaction.created x-stainless-empty-object: false x-tag: Declined Transactions x-title-plural: Declined Transactions error: anyOf: - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 404 type: integer title: type: string type: enum: - api_method_not_found_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 403 type: integer title: type: string type: enum: - environment_mismatch_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' resource_id: description: '' type: string x-documentation-priority: default status: enum: - 409 type: integer title: type: string type: enum: - idempotency_key_already_used_error type: string required: - type - title - detail - status - resource_id type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 403 type: integer title: type: string type: enum: - insufficient_permissions_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 500 type: integer title: type: string type: enum: - internal_server_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' reason: description: '' enum: - deleted_credential - expired_credential - ip_not_allowed - no_credential - no_header - no_api_access - wrong_environment type: string x-documentation-priority: default x-enum-descriptions: - deleted_credential - expired_credential - ip_not_allowed - no_credential - no_header - no_api_access - wrong_environment status: enum: - 401 type: integer title: type: string type: enum: - invalid_api_key_error type: string required: - type - title - detail - status - reason type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 409 type: integer title: type: string type: enum: - invalid_operation_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' errors: description: All errors related to parsing the request parameters. items: additionalProperties: true properties: {} title: ErrorsElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: ErrorsElements type: array x-documentation-priority: default status: enum: - 400 type: integer title: type: string type: enum: - invalid_parameters_error type: string required: - type - title - detail - status - errors type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 400 type: integer title: type: string type: enum: - malformed_request_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 404 type: integer title: type: string type: enum: - object_not_found_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' status: enum: - 403 type: integer title: type: string type: enum: - private_feature_error type: string required: - type - title - detail - status type: object x-event-categories: [] - properties: detail: anyOf: - type: string - type: 'null' retry_after: anyOf: - description: '' type: integer x-documentation-priority: default - type: 'null' status: enum: - 429 type: integer title: type: string type: enum: - rate_limited_error type: string required: - type - title - detail - status type: object x-event-categories: [] 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_list: additionalProperties: true description: A list of Declined Transaction objects. example: data: - 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 next_cursor: v57w5d properties: data: description: The contents of the list. items: $ref: '#/components/schemas/declined_transaction' type: array x-documentation-priority: default next_cursor: anyOf: - description: A pointer to a place in the list. Pass this as the `cursor` parameter to retrieve the next page of results. If there are no more results, the value will be `null`. type: string x-documentation-priority: default - type: 'null' required: - data - next_cursor title: Declined Transaction List type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Declined Transaction Lists responses: errorResponse: content: application/json: schema: allOf: - $ref: '#/components/schemas/error' description: Error securitySchemes: bearerAuth: scheme: bearer type: http x-tagGroups: - name: Accounts tags: - Accounts - Account Numbers - Account Transfers - name: Transactions tags: - Transactions - Pending Transactions - Declined Transactions - name: Ach Transfers tags: - ACH Transfers - Inbound ACH Transfers - ACH Prenotifications - name: Check Transfers tags: - Check Transfers - Inbound Check Deposits - name: Real Time Payments Transfers tags: - Real-Time Payments Transfers - Inbound Real-Time Payments Transfers - name: Fednow Transfers tags: - FedNow Transfers - Inbound FedNow Transfers - name: Swift Transfers tags: - Swift Transfers - name: Wire Transfers tags: - Wire Transfers - Inbound Wire Transfers - Wire Drawdown Requests - Inbound Wire Drawdown Requests - name: Card Transfers tags: - Card Tokens - Card Push Transfers - Card Validations - name: Check Deposits tags: - Check Deposits - Lockbox Addresses - Lockbox Recipients - Inbound Mail Items - name: Cards tags: - Cards - Card Payments - Card Purchase Supplements - Card Disputes - Physical Cards - Digital Card Profiles - Physical Card Profiles - Digital Wallet Tokens - name: Compliance tags: - Entities - Beneficial Owners - Supplemental Documents - Entity Onboarding Sessions - Programs - name: Events and Webhooks tags: - Events - Event Subscriptions - Real-Time Decisions - name: External Accounts tags: - Routing Numbers - External Accounts - name: Files and Exports tags: - Account Statements - Files - File Links - Exports - name: OAuth tags: - Groups - OAuth Applications - OAuth Connections - OAuth Tokens - name: Intrafi tags: - IntraFi Account Enrollments - IntraFi Balances - IntraFi Exclusions