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 Transactions API version: 0.0.1 servers: - url: https://api.increase.com - url: https://sandbox.increase.com security: - bearerAuth: [] tags: - description: Transactions are the immutable additions and removals of money from your bank account. They're the equivalent of line items on your bank statement. To learn more, see [Transactions and Transfers](/documentation/transactions-transfers). name: Transactions paths: /transactions: get: operationId: list_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 Transactions for those 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: 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: - account_transfer_intention - ach_transfer_intention - ach_transfer_rejection - ach_transfer_return - cashback_payment - card_dispute_acceptance - card_dispute_financial - card_dispute_loss - card_refund - card_settlement - card_financial - card_revenue_payment - check_deposit_acceptance - check_deposit_return - fednow_transfer_acknowledgement - check_transfer_deposit - fee_payment - inbound_ach_transfer - inbound_ach_transfer_return_intention - inbound_check_deposit_return_intention - inbound_check_adjustment - inbound_fednow_transfer_confirmation - inbound_real_time_payments_transfer_confirmation - inbound_wire_reversal - inbound_wire_transfer - inbound_wire_transfer_reversal - interest_payment - internal_source - real_time_payments_transfer_acknowledgement - sample_funds - wire_transfer_intention - swift_transfer_intention - swift_transfer_return - card_push_transfer_acceptance - account_revenue_payment - blockchain_onramp_transfer_intention - blockchain_offramp_transfer_settlement - other type: string x-enum-descriptions: - 'Account Transfer Intention: details will be under the `account_transfer_intention` object.' - 'ACH Transfer Intention: details will be under the `ach_transfer_intention` object.' - 'ACH Transfer Rejection: details will be under the `ach_transfer_rejection` object.' - 'ACH Transfer Return: details will be under the `ach_transfer_return` object.' - 'Cashback Payment: details will be under the `cashback_payment` object.' - 'Legacy Card Dispute Acceptance: details will be under the `card_dispute_acceptance` object.' - 'Card Dispute Financial: details will be under the `card_dispute_financial` object.' - 'Legacy Card Dispute Loss: details will be under the `card_dispute_loss` object.' - 'Card Refund: details will be under the `card_refund` object.' - 'Card Settlement: details will be under the `card_settlement` object.' - 'Card Financial: details will be under the `card_financial` object.' - 'Card Revenue Payment: details will be under the `card_revenue_payment` object.' - 'Check Deposit Acceptance: details will be under the `check_deposit_acceptance` object.' - 'Check Deposit Return: details will be under the `check_deposit_return` object.' - 'FedNow Transfer Acknowledgement: details will be under the `fednow_transfer_acknowledgement` object.' - 'Check Transfer Deposit: details will be under the `check_transfer_deposit` object.' - 'Fee Payment: details will be under the `fee_payment` object.' - 'Inbound ACH Transfer Intention: details will be under the `inbound_ach_transfer` object.' - 'Inbound ACH Transfer Return Intention: details will be under the `inbound_ach_transfer_return_intention` object.' - 'Inbound Check Deposit Return Intention: details will be under the `inbound_check_deposit_return_intention` object.' - 'Inbound Check Adjustment: details will be under the `inbound_check_adjustment` object.' - 'Inbound FedNow Transfer Confirmation: details will be under the `inbound_fednow_transfer_confirmation` object.' - 'Inbound Real-Time Payments Transfer Confirmation: details will be under the `inbound_real_time_payments_transfer_confirmation` object.' - 'Inbound Wire Reversal: details will be under the `inbound_wire_reversal` object.' - 'Inbound Wire Transfer Intention: details will be under the `inbound_wire_transfer` object.' - 'Inbound Wire Transfer Reversal Intention: details will be under the `inbound_wire_transfer_reversal` object.' - 'Interest Payment: details will be under the `interest_payment` object.' - 'Internal Source: details will be under the `internal_source` object.' - 'Real-Time Payments Transfer Acknowledgement: details will be under the `real_time_payments_transfer_acknowledgement` object.' - 'Sample Funds: details will be under the `sample_funds` object.' - 'Wire Transfer Intention: details will be under the `wire_transfer_intention` object.' - 'Swift Transfer Intention: details will be under the `swift_transfer_intention` object.' - 'Swift Transfer Return: details will be under the `swift_transfer_return` object.' - 'Card Push Transfer Acceptance: details will be under the `card_push_transfer_acceptance` object.' - 'Account Revenue Payment: details will be under the `account_revenue_payment` object.' - 'Blockchain On-Ramp Transfer Intention: details will be under the `blockchain_onramp_transfer_intention` object.' - 'Blockchain Off-Ramp Transfer Settlement: details will be under the `blockchain_offramp_transfer_settlement` object.' - The Transaction was made for an undocumented or deprecated reason. type: array x-documentation-priority: default explode: false - in: query name: route_id required: false schema: description: Filter Transactions for those belonging to the specified route. This could be a Card ID or an Account Number ID. type: string x-documentation-priority: default responses: '200': content: application/json: schema: $ref: '#/components/schemas/transaction_list' description: Transaction List 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: List Transactions x-sandbox-only: false x-tag: Transactions tags: - Transactions /transactions/{transaction_id}: get: operationId: retrieve_a_transaction parameters: - example: transaction_uyrp7fld2ium70oa7oi in: path name: transaction_id required: true schema: description: The identifier of the Transaction to retrieve. type: string x-documentation-priority: default x-id-reference-to: Transactions responses: '200': content: application/json: schema: $ref: '#/components/schemas/transaction' description: Transaction 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: Retrieve a Transaction x-sandbox-only: false x-tag: Transactions tags: - Transactions components: schemas: inbound_check_adjustment: additionalProperties: true description: An Inbound Check Adjustment is created when Increase receives an adjustment for a check or return deposited through Check21. example: adjusted_transaction_id: transaction_uyrp7fld2ium70oa7oi amount: 1750 reason: late_return properties: adjusted_transaction_id: description: The ID of the transaction that was adjusted. type: string x-documentation-priority: default x-id-reference-to: Transactions amount: description: The amount of the check adjustment. type: integer x-documentation-priority: default reason: description: The reason for the adjustment. enum: - late_return - wrong_payee_credit - adjusted_amount - non_conforming_item - paid type: string x-documentation-priority: default x-enum-descriptions: - The return was initiated too late and the receiving institution has responded with a Late Return Claim. - The check was deposited to the wrong payee and the depositing institution has reimbursed the funds with a Wrong Payee Credit. - The check was deposited with a different amount than what was written on the check. - The recipient was not able to process the check. This usually happens for e.g., low quality images. - The check has already been deposited elsewhere and so this is a duplicate. required: - adjusted_transaction_id - amount - reason title: Inbound Check Adjustment type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound Check Adjustments 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: [] transaction_list: additionalProperties: true description: A list of Transaction objects. example: data: - account_id: account_in71c4amph0vgo2qllky amount: 100 created_at: '2020-01-31T23:59:59Z' currency: USD description: INVOICE 2468 id: transaction_uyrp7fld2ium70oa7oi route_id: account_number_v18nkfqm6afpsrvy82b2 route_type: account_number source: category: inbound_ach_transfer inbound_ach_transfer: addenda: null amount: 100 originator_company_descriptive_date: null originator_company_discretionary_data: null originator_company_entry_description: RESERVE originator_company_id: 0987654321 originator_company_name: BIG BANK receiver_id_number: '12345678900' receiver_name: IAN CREASE trace_number: 021000038461022 transfer_id: inbound_ach_transfer_tdrwqr3fq9gnnq49odev type: transaction next_cursor: v57w5d properties: data: description: The contents of the list. items: $ref: '#/components/schemas/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: Transaction List type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Transaction Lists inbound_check_deposit_return_intention: additionalProperties: true description: An Inbound Check Deposit Return Intention is created when Increase receives an Inbound Check and the User requests that it be returned. example: inbound_check_deposit_id: inbound_check_deposit_zoshvqybq0cjjm31mra transfer_id: check_transfer_30b43acfu9vw8fyc4f5 properties: inbound_check_deposit_id: description: The ID of the Inbound Check Deposit that is being returned. type: string x-documentation-priority: default x-id-reference-to: Inbound Check Deposits transfer_id: anyOf: - description: The identifier of the Check Transfer object that was deposited. type: string x-documentation-priority: default x-id-reference-to: Check Transfers - type: 'null' required: - inbound_check_deposit_id - transfer_id title: Inbound Check Deposit Return Intention type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound Check Deposit Return Intentions card_refund: additionalProperties: true description: Card Refunds move money back to the cardholder. While they are usually connected to a Card Settlement, an acquirer can also refund money directly to a card without relation to a transaction. example: amount: 100 card_payment_id: card_payment_nd3k2kacrqjli8482ave cashback: null currency: USD id: card_refund_imgc2xwplh6t4r3gn16e interchange: amount: '0.137465' code: '271' currency: USD merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_name: AMAZON.COM merchant_postal_code: '10045' merchant_state: NY network_identifiers: acquirer_business_id: '69650702' acquirer_reference_number: '83163715445437604865089' authorization_identification_response: ABC123 transaction_id: '627199945183184' presentment_amount: 100 presentment_currency: USD purchase_details: car_rental: null customer_reference_identifier: '51201' local_tax_amount: null local_tax_currency: usd lodging: check_in_date: '2023-07-20' daily_room_rate_amount: 1000 daily_room_rate_currency: usd extra_charges: restaurant folio_cash_advances_amount: 0 folio_cash_advances_currency: usd food_beverage_charges_amount: 0 food_beverage_charges_currency: usd no_show_indicator: no_show prepaid_expenses_amount: 0 prepaid_expenses_currency: usd room_nights: 1 total_room_tax_amount: 100 total_room_tax_currency: usd total_tax_amount: 100 total_tax_currency: usd national_tax_amount: null national_tax_currency: usd purchase_identifier: '10203' purchase_identifier_format: order_number travel: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' transaction_id: transaction_uyrp7fld2ium70oa7oi type: card_refund properties: amount: description: The amount in the minor unit of the transaction's settlement 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 cashback: anyOf: - additionalProperties: false description: Cashback debited for this transaction, if eligible. Cashback is paid out in aggregate, monthly. example: amount: '0.137465' currency: USD properties: amount: description: The cashback amount given as a string containing a decimal number. The amount is a positive number if it will be credited to you (e.g., settlements) and a negative number if it will be debited (e.g., refunds). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) required: - amount - currency title: Card Refund Cashback type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cashbacks - type: 'null' currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) id: description: The Card Refund identifier. type: string x-documentation-priority: default x-id-reference-to: Card Refunds interchange: anyOf: - additionalProperties: false description: Interchange assessed as a part of this transaction. example: amount: '0.137465' code: '271' currency: USD properties: amount: description: The interchange amount given as a string containing a decimal number in major units (so e.g., "3.14" for $3.14). The amount is a positive number if it is credited to Increase (e.g., settlements) and a negative number if it is debited (e.g., refunds). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default code: anyOf: - description: The card network specific interchange code. type: string x-documentation-priority: default - type: 'null' currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange reimbursement. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) required: - amount - currency - code title: Card Refund Card Interchange type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Interchanges - 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 4-digit MCC describing the merchant's business. type: string x-documentation-priority: default merchant_city: description: The city the merchant resides in. type: string x-documentation-priority: default merchant_country: description: The country the merchant resides in. type: string x-documentation-priority: default merchant_name: description: The name of the merchant. type: string x-documentation-priority: default merchant_postal_code: anyOf: - description: The merchant's postal code. For US merchants this is always a 5-digit ZIP code. 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_identifiers: additionalProperties: false description: Network-specific identifiers for this refund. properties: acquirer_business_id: description: A network assigned business ID that identifies the acquirer that processed this transaction. type: string x-documentation-priority: default acquirer_reference_number: description: A globally unique identifier for this settlement. type: string x-documentation-priority: default 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' 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 - acquirer_reference_number - acquirer_business_id - authorization_identification_response title: Card Refund NetworkIdentifiers type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: NetworkIdentifiers presentment_amount: description: The 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 purchase_details: anyOf: - additionalProperties: false description: Additional details about the card purchase, such as tax and industry-specific fields. example: car_rental: null customer_reference_identifier: '51201' local_tax_amount: null local_tax_currency: usd lodging: check_in_date: '2023-07-20' daily_room_rate_amount: 1000 daily_room_rate_currency: usd extra_charges: restaurant folio_cash_advances_amount: 0 folio_cash_advances_currency: usd food_beverage_charges_amount: 0 food_beverage_charges_currency: usd no_show_indicator: no_show prepaid_expenses_amount: 0 prepaid_expenses_currency: usd room_nights: 1 total_room_tax_amount: 100 total_room_tax_currency: usd total_tax_amount: 100 total_tax_currency: usd national_tax_amount: null national_tax_currency: usd purchase_identifier: '10203' purchase_identifier_format: order_number travel: null properties: car_rental: anyOf: - additionalProperties: false description: Fields specific to car rentals. properties: car_class_code: anyOf: - description: Code indicating the vehicle's class. type: string x-documentation-priority: default - type: 'null' checkout_date: anyOf: - description: Date the customer picked up the car or, in the case of a no-show or pre-pay transaction, the scheduled pick up date. format: date type: string x-documentation-priority: default - type: 'null' daily_rental_rate_amount: anyOf: - description: Daily rate being charged for the vehicle. type: integer x-documentation-priority: default - type: 'null' daily_rental_rate_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental rate. type: string x-documentation-priority: default - type: 'null' days_rented: anyOf: - description: Number of days the vehicle was rented. type: integer x-documentation-priority: default - type: 'null' extra_charges: anyOf: - description: Additional charges (gas, late fee, etc.) being billed. enum: - no_extra_charge - gas - extra_mileage - late_return - one_way_service_fee - parking_violation type: string x-documentation-priority: default x-enum-descriptions: - No extra charge - Gas - Extra mileage - Late return - One way service fee - Parking violation - type: 'null' fuel_charges_amount: anyOf: - description: Fuel charges for the vehicle. type: integer x-documentation-priority: default - type: 'null' fuel_charges_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges assessed. type: string x-documentation-priority: default - type: 'null' insurance_charges_amount: anyOf: - description: Any insurance being charged for the vehicle. type: integer x-documentation-priority: default - type: 'null' insurance_charges_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance charges assessed. type: string x-documentation-priority: default - type: 'null' no_show_indicator: anyOf: - description: An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a "no-show" charge). enum: - not_applicable - no_show_for_specialized_vehicle type: string x-documentation-priority: default x-enum-descriptions: - Not applicable - No show for specialized vehicle - type: 'null' one_way_drop_off_charges_amount: anyOf: - description: Charges for returning the vehicle at a different location than where it was picked up. type: integer x-documentation-priority: default - type: 'null' one_way_drop_off_charges_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way drop-off charges assessed. type: string x-documentation-priority: default - type: 'null' renter_name: anyOf: - description: Name of the person renting the vehicle. type: string x-documentation-priority: default - type: 'null' weekly_rental_rate_amount: anyOf: - description: Weekly rate being charged for the vehicle. type: integer x-documentation-priority: default - type: 'null' weekly_rental_rate_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly rental rate. type: string x-documentation-priority: default - type: 'null' required: - extra_charges - days_rented - no_show_indicator - checkout_date - daily_rental_rate_amount - daily_rental_rate_currency - weekly_rental_rate_amount - weekly_rental_rate_currency - insurance_charges_amount - insurance_charges_currency - fuel_charges_amount - fuel_charges_currency - one_way_drop_off_charges_amount - one_way_drop_off_charges_currency - car_class_code - renter_name title: Card Refund Card Purchase Details CarRental type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CarRentals - type: 'null' customer_reference_identifier: anyOf: - description: An identifier from the merchant for the customer or consumer. type: string x-documentation-priority: default - type: 'null' local_tax_amount: anyOf: - description: The state or provincial tax amount in minor units. type: integer x-documentation-priority: default - type: 'null' local_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax assessed. type: string x-documentation-priority: default - type: 'null' lodging: anyOf: - additionalProperties: false description: Fields specific to lodging. properties: check_in_date: anyOf: - description: Date the customer checked in. format: date type: string x-documentation-priority: default - type: 'null' daily_room_rate_amount: anyOf: - description: Daily rate being charged for the room. type: integer x-documentation-priority: default - type: 'null' daily_room_rate_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room rate. type: string x-documentation-priority: default - type: 'null' extra_charges: anyOf: - description: Additional charges (phone, late check-out, etc.) being billed. enum: - no_extra_charge - restaurant - gift_shop - mini_bar - telephone - other - laundry type: string x-documentation-priority: default x-enum-descriptions: - No extra charge - Restaurant - Gift shop - Mini bar - Telephone - Other - Laundry - type: 'null' folio_cash_advances_amount: anyOf: - description: Folio cash advances for the room. type: integer x-documentation-priority: default - type: 'null' folio_cash_advances_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash advances. type: string x-documentation-priority: default - type: 'null' food_beverage_charges_amount: anyOf: - description: Food and beverage charges for the room. type: integer x-documentation-priority: default - type: 'null' food_beverage_charges_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and beverage charges. type: string x-documentation-priority: default - type: 'null' no_show_indicator: anyOf: - description: Indicator that the cardholder is being billed for a reserved room that was not actually used. enum: - not_applicable - no_show type: string x-documentation-priority: default x-enum-descriptions: - Not applicable - No show - type: 'null' prepaid_expenses_amount: anyOf: - description: Prepaid expenses being charged for the room. type: integer x-documentation-priority: default - type: 'null' prepaid_expenses_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid expenses. type: string x-documentation-priority: default - type: 'null' room_nights: anyOf: - description: Number of nights the room was rented. type: integer x-documentation-priority: default - type: 'null' total_room_tax_amount: anyOf: - description: Total room tax being charged. type: integer x-documentation-priority: default - type: 'null' total_room_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room tax. type: string x-documentation-priority: default - type: 'null' total_tax_amount: anyOf: - description: Total tax being charged for the room. type: integer x-documentation-priority: default - type: 'null' total_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax assessed. type: string x-documentation-priority: default - type: 'null' required: - no_show_indicator - extra_charges - check_in_date - daily_room_rate_amount - daily_room_rate_currency - total_tax_amount - total_tax_currency - prepaid_expenses_amount - prepaid_expenses_currency - food_beverage_charges_amount - food_beverage_charges_currency - folio_cash_advances_amount - folio_cash_advances_currency - room_nights - total_room_tax_amount - total_room_tax_currency title: Card Refund Card Purchase Details Lodging type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Lodgings - type: 'null' national_tax_amount: anyOf: - description: The national tax amount in minor units. type: integer x-documentation-priority: default - type: 'null' national_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax assessed. type: string x-documentation-priority: default - type: 'null' purchase_identifier: anyOf: - description: An identifier from the merchant for the purchase to the issuer and cardholder. type: string x-documentation-priority: default - type: 'null' purchase_identifier_format: anyOf: - description: The format of the purchase identifier. enum: - free_text - order_number - rental_agreement_number - hotel_folio_number - invoice_number type: string x-documentation-priority: default x-enum-descriptions: - Free text - Order number - Rental agreement number - Hotel folio number - Invoice number - type: 'null' travel: anyOf: - additionalProperties: false description: Fields specific to travel. properties: ancillary: anyOf: - additionalProperties: false description: Ancillary purchases in addition to the airfare. properties: connected_ticket_document_number: anyOf: - description: If this purchase has a connection or relationship to another purchase, such as a baggage fee for a passenger transport ticket, this field should contain the ticket document number for the other purchase. type: string x-documentation-priority: default - type: 'null' credit_reason_indicator: anyOf: - description: Indicates the reason for a credit to the cardholder. enum: - no_credit - passenger_transport_ancillary_purchase_cancellation - airline_ticket_and_passenger_transport_ancillary_purchase_cancellation - other type: string x-documentation-priority: default x-enum-descriptions: - No credit - Passenger transport ancillary purchase cancellation - Airline ticket and passenger transport ancillary purchase cancellation - Other - type: 'null' passenger_name_or_description: anyOf: - description: Name of the passenger or description of the ancillary purchase. type: string x-documentation-priority: default - type: 'null' services: description: Additional travel charges, such as baggage fees. items: additionalProperties: false properties: category: anyOf: - description: Category of the ancillary service. enum: - none - bundled_service - baggage_fee - change_fee - cargo - carbon_offset - frequent_flyer - gift_card - ground_transport - in_flight_entertainment - lounge - medical - meal_beverage - other - passenger_assist_fee - pets - seat_fees - standby - service_fee - store - travel_service - unaccompanied_travel - upgrades - wifi type: string x-documentation-priority: default x-enum-descriptions: - None - Bundled service - Baggage fee - Change fee - Cargo - Carbon offset - Frequent flyer - Gift card - Ground transport - In-flight entertainment - Lounge - Medical - Meal beverage - Other - Passenger assist fee - Pets - Seat fees - Standby - Service fee - Store - Travel service - Unaccompanied travel - Upgrades - Wi-fi - type: 'null' sub_category: anyOf: - description: Sub-category of the ancillary service, free-form. type: string x-documentation-priority: default - type: 'null' required: - category - sub_category title: Card Refund Card Purchase Details Travel Ancillary ServicesElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: ServicesElements type: array x-documentation-priority: default ticket_document_number: anyOf: - description: Ticket document number. type: string x-documentation-priority: default - type: 'null' required: - ticket_document_number - passenger_name_or_description - connected_ticket_document_number - credit_reason_indicator - services title: Card Refund Card Purchase Details Travel Ancillary type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Ancillaries - type: 'null' computerized_reservation_system: anyOf: - description: Indicates the computerized reservation system used to book the ticket. type: string x-documentation-priority: default - type: 'null' credit_reason_indicator: anyOf: - description: Indicates the reason for a credit to the cardholder. enum: - no_credit - passenger_transport_ancillary_purchase_cancellation - airline_ticket_and_passenger_transport_ancillary_purchase_cancellation - airline_ticket_cancellation - other - partial_refund_of_airline_ticket type: string x-documentation-priority: default x-enum-descriptions: - No credit - Passenger transport ancillary purchase cancellation - Airline ticket and passenger transport ancillary purchase cancellation - Airline ticket cancellation - Other - Partial refund of airline ticket - type: 'null' departure_date: anyOf: - description: Date of departure. format: date type: string x-documentation-priority: default - type: 'null' origination_city_airport_code: anyOf: - description: Code for the originating city or airport. type: string x-documentation-priority: default - type: 'null' passenger_name: anyOf: - description: Name of the passenger. type: string x-documentation-priority: default - type: 'null' restricted_ticket_indicator: anyOf: - description: Indicates whether this ticket is non-refundable. enum: - no_restrictions - restricted_non_refundable_ticket type: string x-documentation-priority: default x-enum-descriptions: - No restrictions - Restricted non-refundable ticket - type: 'null' ticket_change_indicator: anyOf: - description: Indicates why a ticket was changed. enum: - none - change_to_existing_ticket - new_ticket type: string x-documentation-priority: default x-enum-descriptions: - None - Change to existing ticket - New ticket - type: 'null' ticket_number: anyOf: - description: Ticket number. type: string x-documentation-priority: default - type: 'null' travel_agency_code: anyOf: - description: Code for the travel agency if the ticket was issued by a travel agency. type: string x-documentation-priority: default - type: 'null' travel_agency_name: anyOf: - description: Name of the travel agency if the ticket was issued by a travel agency. type: string x-documentation-priority: default - type: 'null' trip_legs: anyOf: - description: Fields specific to each leg of the journey. items: additionalProperties: false properties: carrier_code: anyOf: - description: Carrier code (e.g., United Airlines, Jet Blue, etc.). type: string x-documentation-priority: default - type: 'null' destination_city_airport_code: anyOf: - description: Code for the destination city or airport. type: string x-documentation-priority: default - type: 'null' fare_basis_code: anyOf: - description: Fare basis code. type: string x-documentation-priority: default - type: 'null' flight_number: anyOf: - description: Flight number. type: string x-documentation-priority: default - type: 'null' service_class: anyOf: - description: Service class (e.g., first class, business class, etc.). type: string x-documentation-priority: default - type: 'null' stop_over_code: anyOf: - description: Indicates whether a stopover is allowed on this ticket. enum: - none - stop_over_allowed - stop_over_not_allowed type: string x-documentation-priority: default x-enum-descriptions: - None - Stop over allowed - Stop over not allowed - type: 'null' required: - flight_number - carrier_code - fare_basis_code - service_class - stop_over_code - destination_city_airport_code title: Card Refund Card Purchase Details Travel TripLegsElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: TripLegsElements type: array x-documentation-priority: default - type: 'null' required: - ticket_number - passenger_name - departure_date - origination_city_airport_code - travel_agency_code - travel_agency_name - restricted_ticket_indicator - computerized_reservation_system - credit_reason_indicator - ticket_change_indicator - trip_legs - ancillary title: Card Refund Card Purchase Details Travel type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Travels - type: 'null' required: - purchase_identifier - purchase_identifier_format - customer_reference_identifier - local_tax_amount - local_tax_currency - national_tax_amount - national_tax_currency - car_rental - lodging - travel title: Card Refund Card Purchase Details type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Purchase Details - type: 'null' scheme_fees: description: The scheme fees associated with this card refund. 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: Card Refund 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 transaction_id: description: The identifier of the Transaction associated with this Transaction. type: string x-documentation-priority: default x-id-reference-to: Transactions type: description: A constant representing the object's type. For this resource it will always be `card_refund`. enum: - card_refund type: string x-documentation-priority: default required: - type - id - card_payment_id - amount - currency - presentment_amount - presentment_currency - merchant_acceptor_id - merchant_city - merchant_state - merchant_postal_code - merchant_country - merchant_name - merchant_category_code - interchange - cashback - purchase_details - scheme_fees - transaction_id - network_identifiers title: Card Refund type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Refunds transaction: additionalProperties: true description: Transactions are the immutable additions and removals of money from your bank account. They're the equivalent of line items on your bank statement. To learn more, see [Transactions and Transfers](/documentation/transactions-transfers). example: account_id: account_in71c4amph0vgo2qllky amount: 100 created_at: '2020-01-31T23:59:59Z' currency: USD description: INVOICE 2468 id: transaction_uyrp7fld2ium70oa7oi route_id: account_number_v18nkfqm6afpsrvy82b2 route_type: account_number source: category: inbound_ach_transfer inbound_ach_transfer: addenda: null amount: 100 originator_company_descriptive_date: null originator_company_discretionary_data: null originator_company_entry_description: RESERVE originator_company_id: 0987654321 originator_company_name: BIG BANK receiver_id_number: '12345678900' receiver_name: IAN CREASE trace_number: 021000038461022 transfer_id: inbound_ach_transfer_tdrwqr3fq9gnnq49odev type: transaction properties: account_id: description: The identifier for the Account the Transaction belongs to. type: string x-documentation-priority: default x-id-reference-to: Accounts amount: description: The 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 Transaction's currency. This will match the currency on the Transaction's Account. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) description: description: An informational message describing this transaction. Use the fields in `source` to get more detailed information. This field appears as the line-item on the statement. type: string x-documentation-priority: default id: description: The Transaction identifier. type: string x-documentation-priority: default x-id-reference-to: Transactions route_id: anyOf: - description: The identifier for the route this 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 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 Transaction. 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: category: inbound_ach_transfer inbound_ach_transfer: addenda: null amount: 100 originator_company_descriptive_date: null originator_company_discretionary_data: null originator_company_entry_description: RESERVE originator_company_id: 0987654321 originator_company_name: BIG BANK receiver_id_number: '12345678900' receiver_name: IAN CREASE trace_number: 021000038461022 transfer_id: inbound_ach_transfer_tdrwqr3fq9gnnq49odev properties: account_revenue_payment: anyOf: - additionalProperties: true description: An Account Revenue Payment object. This field will be present in the JSON response if and only if `category` is equal to `account_revenue_payment`. An Account Revenue Payment represents a payment made to an account from the bank. Account revenue is a type of non-interest income. example: accrued_on_account_id: account_in71c4amph0vgo2qllky period_end: '2025-06-30T23:59:59+00:00' period_start: '2025-06-01T00:00:00+00:00' properties: accrued_on_account_id: description: The account on which the account revenue was accrued. type: string x-documentation-priority: default x-id-reference-to: Accounts period_end: description: The end of the period for which this transaction paid account revenue. format: date-time type: string x-documentation-priority: default period_start: description: The start of the period for which this transaction paid account revenue. format: date-time type: string x-documentation-priority: default required: - period_start - period_end - accrued_on_account_id title: Transaction Transaction Source Account Revenue Payment type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Account Revenue Payments - type: 'null' account_transfer_intention: anyOf: - additionalProperties: true description: An Account Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_intention`. Two Account Transfer Intentions are created from each Account Transfer. One decrements the source account, and the other increments the destination account. example: amount: 100 currency: USD description: INVOICE 2468 destination_account_id: account_uf16sut2ct5bevmq3eh source_account_id: account_in71c4amph0vgo2qllky transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n properties: amount: description: The pending amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default 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) description: description: The description you chose to give the transfer. type: string x-documentation-priority: default destination_account_id: description: The identifier of the Account to where the Account Transfer was sent. type: string x-documentation-priority: default x-id-reference-to: Accounts source_account_id: description: The identifier of the Account from where the Account Transfer was sent. type: string x-documentation-priority: default x-id-reference-to: Accounts transfer_id: description: The identifier of the Account Transfer that led to this Pending Transaction. type: string x-documentation-priority: default x-id-reference-to: Account Transfers required: - amount - currency - description - destination_account_id - source_account_id - transfer_id title: Transaction Transaction Source Account Transfer Intention type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Account Transfer Intentions - type: 'null' ach_transfer_intention: anyOf: - additionalProperties: true description: An ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_intention`. An ACH Transfer Intention is created from an ACH Transfer. It reflects the intention to move money into or out of an Increase account via the ACH network. example: account_number: '987654321' amount: 100 routing_number: '101050001' statement_descriptor: INVOICE 2468 transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n properties: account_number: description: The account number for the destination account. type: string x-documentation-priority: default amount: description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default routing_number: description: The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account. type: string x-documentation-priority: default statement_descriptor: description: A description set when the ACH Transfer was created. type: string x-documentation-priority: default transfer_id: description: The identifier of the ACH Transfer that led to this Transaction. type: string x-documentation-priority: default x-id-reference-to: ACH Transfers required: - amount - account_number - routing_number - statement_descriptor - transfer_id title: Transaction Transaction Source ACH Transfer Intention type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: ACH Transfer Intentions - type: 'null' ach_transfer_rejection: anyOf: - additionalProperties: true description: An ACH Transfer Rejection object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_rejection`. An ACH Transfer Rejection is created when an ACH Transfer is rejected by Increase. It offsets the ACH Transfer Intention. These rejections are rare. example: transfer_id: account_transfer_7k9qe1ysdgqztnt63l7n properties: transfer_id: description: The identifier of the ACH Transfer that led to this Transaction. type: string x-documentation-priority: default x-id-reference-to: ACH Transfers required: - transfer_id title: Transaction Transaction Source ACH Transfer Rejection type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: ACH Transfer Rejections - type: 'null' ach_transfer_return: anyOf: - additionalProperties: true description: An ACH Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_return`. An ACH Transfer Return is created when an ACH Transfer is returned by the receiving bank. It offsets the ACH Transfer Intention. ACH Transfer Returns usually occur within the first two business days after the transfer is initiated, but can occur much later. example: created_at: '2020-01-31T23:59:59Z' raw_return_reason_code: R01 return_reason_code: insufficient_fund trace_number: '111122223292834' transaction_id: transaction_uyrp7fld2ium70oa7oi transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q properties: created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created. format: date-time type: string x-documentation-priority: default raw_return_reason_code: description: The three character ACH return code, in the range R01 to R85. type: string x-documentation-priority: default return_reason_code: description: Why the ACH Transfer was returned. This reason code is sent by the receiving bank back to Increase. enum: - insufficient_fund - no_account - account_closed - invalid_account_number_structure - account_frozen_entry_returned_per_ofac_instruction - credit_entry_refused_by_receiver - unauthorized_debit_to_consumer_account_using_corporate_sec_code - corporate_customer_advised_not_authorized - payment_stopped - non_transaction_account - uncollected_funds - routing_number_check_digit_error - customer_advised_unauthorized_improper_ineligible_or_incomplete - amount_field_error - authorization_revoked_by_customer - invalid_ach_routing_number - file_record_edit_criteria - enr_invalid_individual_name - returned_per_odfi_request - limited_participation_dfi - incorrectly_coded_outbound_international_payment - account_sold_to_another_dfi - addenda_error - beneficiary_or_account_holder_deceased - customer_advised_not_within_authorization_terms - corrected_return - duplicate_entry - duplicate_return - enr_duplicate_enrollment - enr_invalid_dfi_account_number - enr_invalid_individual_id_number - enr_invalid_representative_payee_indicator - enr_invalid_transaction_code - enr_return_of_enr_entry - enr_routing_number_check_digit_error - entry_not_processed_by_gateway - field_error - foreign_receiving_dfi_unable_to_settle - iat_entry_coding_error - improper_effective_entry_date - improper_source_document_source_document_presented - invalid_company_id - invalid_foreign_receiving_dfi_identification - invalid_individual_id_number - item_and_rck_entry_presented_for_payment - item_related_to_rck_entry_is_ineligible - mandatory_field_error - misrouted_dishonored_return - misrouted_return - no_errors_found - non_acceptance_of_r62_dishonored_return - non_participant_in_iat_program - permissible_return_entry - permissible_return_entry_not_accepted - rdfi_non_settlement - rdfi_participant_in_check_truncation_program - representative_payee_deceased_or_unable_to_continue_in_that_capacity - return_not_a_duplicate - return_of_erroneous_or_reversing_debit - return_of_improper_credit_entry - return_of_improper_debit_entry - return_of_xck_entry - source_document_presented_for_payment - state_law_affecting_rck_acceptance - stop_payment_on_item_related_to_rck_entry - stop_payment_on_source_document - timely_original_return - trace_number_error - untimely_dishonored_return - untimely_return type: string x-documentation-priority: default x-enum-descriptions: - Code R01. Insufficient funds in the receiving account. Sometimes abbreviated to "NSF." - Code R03. The account does not exist or the receiving bank was unable to locate it. - Code R02. The account is closed at the receiving bank. - Code R04. The account number is invalid at the receiving bank. - Code R16. This return code has two separate meanings. (1) The receiving bank froze the account or (2) the Office of Foreign Assets Control (OFAC) instructed the receiving bank to return the entry. - Code R23. The receiving bank refused the credit transfer. - Code R05. The receiving bank rejected because of an incorrect Standard Entry Class code. Consumer accounts cannot be debited as `corporate_credit_or_debit` or `corporate_trade_exchange`. - Code R29. The corporate customer at the receiving bank reversed the transfer. - Code R08. The receiving bank stopped payment on this transfer. - Code R20. The account is not eligible for ACH, such as a savings account with transaction limits. - Code R09. The receiving bank account does not have enough available balance for the transfer. - Code R28. The routing number is incorrect. - Code R10. The customer at the receiving bank reversed the transfer. - Code R19. The amount field is incorrect or too large. - Code R07. The customer revoked their authorization for a previously authorized transfer. - Code R13. The routing number is invalid. - Code R17. The receiving bank is unable to process a field in the transfer. - Code R45. A rare return reason. The individual name field was invalid. - Code R06. The originating financial institution asked for this transfer to be returned. The receiving bank is complying with the request. - Code R34. The receiving bank's regulatory supervisor has limited their participation in the ACH network. - Code R85. The outbound international ACH transfer was incorrect. - Code R12. A rare return reason. The account was sold to another bank. - Code R25. The addenda record is incorrect or missing. - Code R15. A rare return reason. The account holder is deceased. - Code R11. A rare return reason. The customer authorized some payment to the sender, but this payment was not in error. - Code R74. A rare return reason. Sent in response to a return that was returned with code `field_error`. The latest return should include the corrected field(s). - Code R24. A rare return reason. The receiving bank received an exact duplicate entry with the same trace number and amount. - Code R67. A rare return reason. The return this message refers to was a duplicate. - Code R47. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages. - Code R43. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages. - Code R44. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages. - Code R46. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages. - Code R41. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages. - Code R40. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages. - Code R42. A rare return reason. Only used for US Government agency non-monetary automatic enrollment messages. - Code R84. A rare return reason. The International ACH Transfer cannot be processed by the gateway. - Code R69. A rare return reason. One or more of the fields in the ACH were malformed. - Code R83. A rare return reason. The Foreign receiving bank was unable to settle this ACH transfer. - Code R80. A rare return reason. The International ACH Transfer is malformed. - Code R18. A rare return reason. The ACH has an improper effective entry date field. - Code R39. A rare return reason. The source document related to this ACH, usually an ACH check conversion, was presented to the bank. - Code R21. A rare return reason. The Company ID field of the ACH was invalid. - Code R82. A rare return reason. The foreign receiving bank identifier for an International ACH Transfer was invalid. - Code R22. A rare return reason. The Individual ID number field of the ACH was invalid. - Code R53. A rare return reason. Both the Represented Check ("RCK") entry and the original check were presented to the bank. - Code R51. A rare return reason. The Represented Check ("RCK") entry is ineligible. - Code R26. A rare return reason. The ACH is missing a required field. - Code R71. A rare return reason. The receiving bank does not recognize the routing number in a dishonored return entry. - Code R61. A rare return reason. The receiving bank does not recognize the routing number in a return entry. - Code R76. A rare return reason. Sent in response to a return, the bank does not find the errors alleged by the returning bank. - Code R77. A rare return reason. The receiving bank does not accept the return of the erroneous debit. The funds are not available at the receiving bank. - Code R81. A rare return reason. The receiving bank does not accept International ACH Transfers. - Code R31. A rare return reason. A return that has been agreed to be accepted by the receiving bank, despite falling outside of the usual return timeframe. - Code R70. A rare return reason. The receiving bank had not approved this return. - Code R32. A rare return reason. The receiving bank could not settle this transaction. - Code R30. A rare return reason. The receiving bank does not accept Check Truncation ACH transfers. - Code R14. A rare return reason. The payee is deceased. - Code R75. A rare return reason. The originating bank disputes that an earlier `duplicate_entry` return was actually a duplicate. - Code R62. A rare return reason. The originating financial institution made a mistake and this return corrects it. - Code R36. A rare return reason. Return of a malformed credit entry. - Code R35. A rare return reason. Return of a malformed debit entry. - Code R33. A rare return reason. Return of a destroyed check ("XCK") entry. - Code R37. A rare return reason. The source document related to this ACH, usually an ACH check conversion, was presented to the bank. - Code R50. A rare return reason. State law prevents the bank from accepting the Represented Check ("RCK") entry. - Code R52. A rare return reason. A stop payment was issued on a Represented Check ("RCK") entry. - Code R38. A rare return reason. The source attached to the ACH, usually an ACH check conversion, includes a stop payment. - Code R73. A rare return reason. The bank receiving an `untimely_return` believes it was on time. - Code R27. A rare return reason. An ACH return's trace number does not match an originated ACH. - Code R72. A rare return reason. The dishonored return was sent too late. - Code R68. A rare return reason. The return was sent too late. trace_number: description: A 15 digit number that was generated by the bank that initiated the return. The trace number of the return is different than that of the original transfer. ACH trace numbers are not unique, but along with the amount and date this number can be used to identify the ACH return at the bank that initiated it. type: string x-documentation-priority: default transaction_id: description: The identifier of the Transaction associated with this return. type: string x-documentation-priority: default x-id-reference-to: Transactions transfer_id: description: The identifier of the ACH Transfer associated with this return. type: string x-documentation-priority: default x-id-reference-to: ACH Transfers required: - created_at - trace_number - return_reason_code - raw_return_reason_code - transfer_id - transaction_id title: Transaction Transaction Source ACH Transfer Return type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: ACH Transfer Returns - type: 'null' blockchain_offramp_transfer_settlement: anyOf: - additionalProperties: true description: A Blockchain Off-Ramp Transfer Settlement object. This field will be present in the JSON response if and only if `category` is equal to `blockchain_offramp_transfer_settlement`. example: source_blockchain_address_id: blockchain_address_tijjpqp9t5d358ehydqi transfer_id: blockchain_offramp_transfer_sqd2x3ti6u2sy91v696m properties: source_blockchain_address_id: description: The identifier of the Blockchain Address the funds were received at. type: string x-documentation-priority: default x-id-reference-to: Blockchain Addresses transfer_id: description: The identifier of the Blockchain Off-Ramp Transfer that led to this Transaction. type: string x-documentation-priority: default x-id-reference-to: Blockchain Off-Ramp Transfers required: - transfer_id - source_blockchain_address_id title: Transaction Transaction Source Blockchain Off-Ramp Transfer Settlement type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Blockchain Off-Ramp Transfer Settlements - type: 'null' blockchain_onramp_transfer_intention: anyOf: - additionalProperties: true description: A Blockchain On-Ramp Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `blockchain_onramp_transfer_intention`. example: destination_blockchain_address: '0xaabbccdd' transfer_id: blockchain_onramp_transfer_sg8nzy569rk0dnfk28bv properties: destination_blockchain_address: description: The blockchain address the funds were sent to. type: string x-documentation-priority: default transfer_id: description: The identifier of the Blockchain On-Ramp Transfer that led to this Transaction. type: string x-documentation-priority: default x-id-reference-to: Blockchain On-Ramp Transfers required: - transfer_id - destination_blockchain_address title: Transaction Transaction Source Blockchain On-Ramp Transfer Intention type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Blockchain On-Ramp Transfer Intentions - type: 'null' card_dispute_acceptance: anyOf: - additionalProperties: true description: A Legacy Card Dispute Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_acceptance`. Contains the details of a successful Card Dispute. example: accepted_at: '2020-01-31T23:59:59Z' transaction_id: transaction_uyrp7fld2ium70oa7oi properties: accepted_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was accepted. format: date-time type: string x-documentation-priority: default transaction_id: description: The identifier of the Transaction that was created to return the disputed funds to your account. type: string x-documentation-priority: default x-id-reference-to: Transactions required: - accepted_at - transaction_id title: Transaction Transaction Source Legacy Card Dispute Acceptance type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Legacy Card Dispute Acceptances - type: 'null' card_dispute_financial: anyOf: - additionalProperties: true description: A Card Dispute Financial object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_financial`. Financial event related to a Card Dispute. example: amount: 1000 network: visa transaction_id: transaction_uyrp7fld2ium70oa7oi visa: event_type: chargeback_submitted properties: amount: description: The amount of the financial event. type: integer x-documentation-priority: default network: description: The network that the Card Dispute is associated with. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - 'Visa: details will be under the `visa` object.' - 'Pulse: details will be under the `pulse` object.' transaction_id: description: The identifier of the Transaction that was created to credit or debit the disputed funds to or from your account. type: string x-documentation-priority: default x-id-reference-to: Card Dispute Financials visa: anyOf: - $ref: '#/components/schemas/card_dispute_financial_visa' description: Information for events related to card dispute for card payments processed over Visa's network. This field will be present in the JSON response if and only if `network` is equal to `visa`. x-documentation-priority: default - type: 'null' required: - amount - network - transaction_id - visa title: Transaction Transaction Source Card Dispute Financial type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Dispute Financials - type: 'null' card_dispute_loss: anyOf: - additionalProperties: true description: A Legacy Card Dispute Loss object. This field will be present in the JSON response if and only if `category` is equal to `card_dispute_loss`. Contains the details of a lost Card Dispute. example: explanation: The card dispute was lost. lost_at: '2020-01-31T23:59:59Z' transaction_id: transaction_uyrp7fld2ium70oa7oi properties: explanation: description: Why the Card Dispute was lost. type: string x-documentation-priority: default lost_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was lost. format: date-time type: string x-documentation-priority: default transaction_id: description: The identifier of the Transaction that was created to debit the disputed funds from your account. type: string x-documentation-priority: default x-id-reference-to: Transactions required: - lost_at - transaction_id - explanation title: Transaction Transaction Source Legacy Card Dispute Loss type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Legacy Card Dispute Losses - type: 'null' card_financial: anyOf: - $ref: '#/components/schemas/card_financial' description: A Card Financial object. This field will be present in the JSON response if and only if `category` is equal to `card_financial`. Card Financials are temporary holds placed on a customer's funds with the intent to later clear a transaction. x-documentation-priority: default - type: 'null' card_push_transfer_acceptance: anyOf: - additionalProperties: true description: A Card Push Transfer Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `card_push_transfer_acceptance`. A Card Push Transfer Acceptance is created when an Outbound Card Push Transfer sent from Increase is accepted by the receiving bank. example: settlement_amount: 100 transfer_id: outbound_card_push_transfer_e0z9rdpamraczh4tvwye properties: settlement_amount: description: The transfer amount in USD cents. type: integer x-documentation-priority: default transfer_id: description: The identifier of the Card Push Transfer that led to this Transaction. type: string x-documentation-priority: default x-id-reference-to: Card Push Transfers required: - settlement_amount - transfer_id title: Transaction Transaction Source Card Push Transfer Acceptance type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Push Transfer Acceptances - type: 'null' card_refund: anyOf: - $ref: '#/components/schemas/card_refund' description: A Card Refund object. This field will be present in the JSON response if and only if `category` is equal to `card_refund`. Card Refunds move money back to the cardholder. While they are usually connected to a Card Settlement, an acquirer can also refund money directly to a card without relation to a transaction. x-documentation-priority: default - type: 'null' card_revenue_payment: anyOf: - additionalProperties: true description: A Card Revenue Payment object. This field will be present in the JSON response if and only if `category` is equal to `card_revenue_payment`. Card Revenue Payments reflect earnings from fees on card transactions. example: amount: 100 currency: USD period_end: '2025-06-30T23:59:59+00:00' period_start: '2025-06-01T00:00:00+00:00' transacted_on_account_id: account_in71c4amph0vgo2qllky properties: amount: description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) period_end: description: The end of the period for which this transaction paid interest. format: date-time type: string x-documentation-priority: default period_start: description: The start of the period for which this transaction paid interest. format: date-time type: string x-documentation-priority: default transacted_on_account_id: anyOf: - description: The account the card belonged to. type: string x-documentation-priority: default x-id-reference-to: Accounts - type: 'null' required: - amount - currency - period_start - period_end - transacted_on_account_id title: Transaction Transaction Source Card Revenue Payment type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Revenue Payments - type: 'null' card_settlement: anyOf: - $ref: '#/components/schemas/card_settlement' description: A Card Settlement object. This field will be present in the JSON response if and only if `category` is equal to `card_settlement`. Card Settlements are card transactions that have cleared and settled. While a settlement is usually preceded by an authorization, an acquirer can also directly clear a transaction without first authorizing it. x-documentation-priority: default - type: 'null' cashback_payment: anyOf: - additionalProperties: true description: A Cashback Payment object. This field will be present in the JSON response if and only if `category` is equal to `cashback_payment`. A Cashback Payment represents the cashback paid to a cardholder for a given period. Cashback is usually paid monthly for the prior month's transactions. example: accrued_on_card_id: card_oubs0hwk5rn6knuecxg2 amount: 100 currency: USD period_end: '2025-06-30T23:59:59+00:00' period_start: '2025-06-01T00:00:00+00:00' properties: accrued_on_card_id: anyOf: - description: The card on which the cashback was accrued. type: string x-documentation-priority: default x-id-reference-to: Cards - type: 'null' amount: description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) period_end: description: The end of the period for which this transaction paid cashback. format: date-time type: string x-documentation-priority: default period_start: description: The start of the period for which this transaction paid cashback. format: date-time type: string x-documentation-priority: default required: - amount - currency - period_start - period_end - accrued_on_card_id title: Transaction Transaction Source Cashback Payment type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cashback Payments - 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: - account_transfer_intention - ach_transfer_intention - ach_transfer_rejection - ach_transfer_return - cashback_payment - card_dispute_acceptance - card_dispute_financial - card_dispute_loss - card_refund - card_settlement - card_financial - card_revenue_payment - check_deposit_acceptance - check_deposit_return - fednow_transfer_acknowledgement - check_transfer_deposit - fee_payment - inbound_ach_transfer - inbound_ach_transfer_return_intention - inbound_check_deposit_return_intention - inbound_check_adjustment - inbound_fednow_transfer_confirmation - inbound_real_time_payments_transfer_confirmation - inbound_wire_reversal - inbound_wire_transfer - inbound_wire_transfer_reversal - interest_payment - internal_source - real_time_payments_transfer_acknowledgement - sample_funds - wire_transfer_intention - swift_transfer_intention - swift_transfer_return - card_push_transfer_acceptance - account_revenue_payment - blockchain_onramp_transfer_intention - blockchain_offramp_transfer_settlement - other type: string x-documentation-priority: default x-enum-descriptions: - 'Account Transfer Intention: details will be under the `account_transfer_intention` object.' - 'ACH Transfer Intention: details will be under the `ach_transfer_intention` object.' - 'ACH Transfer Rejection: details will be under the `ach_transfer_rejection` object.' - 'ACH Transfer Return: details will be under the `ach_transfer_return` object.' - 'Cashback Payment: details will be under the `cashback_payment` object.' - 'Legacy Card Dispute Acceptance: details will be under the `card_dispute_acceptance` object.' - 'Card Dispute Financial: details will be under the `card_dispute_financial` object.' - 'Legacy Card Dispute Loss: details will be under the `card_dispute_loss` object.' - 'Card Refund: details will be under the `card_refund` object.' - 'Card Settlement: details will be under the `card_settlement` object.' - 'Card Financial: details will be under the `card_financial` object.' - 'Card Revenue Payment: details will be under the `card_revenue_payment` object.' - 'Check Deposit Acceptance: details will be under the `check_deposit_acceptance` object.' - 'Check Deposit Return: details will be under the `check_deposit_return` object.' - 'FedNow Transfer Acknowledgement: details will be under the `fednow_transfer_acknowledgement` object.' - 'Check Transfer Deposit: details will be under the `check_transfer_deposit` object.' - 'Fee Payment: details will be under the `fee_payment` object.' - 'Inbound ACH Transfer Intention: details will be under the `inbound_ach_transfer` object.' - 'Inbound ACH Transfer Return Intention: details will be under the `inbound_ach_transfer_return_intention` object.' - 'Inbound Check Deposit Return Intention: details will be under the `inbound_check_deposit_return_intention` object.' - 'Inbound Check Adjustment: details will be under the `inbound_check_adjustment` object.' - 'Inbound FedNow Transfer Confirmation: details will be under the `inbound_fednow_transfer_confirmation` object.' - 'Inbound Real-Time Payments Transfer Confirmation: details will be under the `inbound_real_time_payments_transfer_confirmation` object.' - 'Inbound Wire Reversal: details will be under the `inbound_wire_reversal` object.' - 'Inbound Wire Transfer Intention: details will be under the `inbound_wire_transfer` object.' - 'Inbound Wire Transfer Reversal Intention: details will be under the `inbound_wire_transfer_reversal` object.' - 'Interest Payment: details will be under the `interest_payment` object.' - 'Internal Source: details will be under the `internal_source` object.' - 'Real-Time Payments Transfer Acknowledgement: details will be under the `real_time_payments_transfer_acknowledgement` object.' - 'Sample Funds: details will be under the `sample_funds` object.' - 'Wire Transfer Intention: details will be under the `wire_transfer_intention` object.' - 'Swift Transfer Intention: details will be under the `swift_transfer_intention` object.' - 'Swift Transfer Return: details will be under the `swift_transfer_return` object.' - 'Card Push Transfer Acceptance: details will be under the `card_push_transfer_acceptance` object.' - 'Account Revenue Payment: details will be under the `account_revenue_payment` object.' - 'Blockchain On-Ramp Transfer Intention: details will be under the `blockchain_onramp_transfer_intention` object.' - 'Blockchain Off-Ramp Transfer Settlement: details will be under the `blockchain_offramp_transfer_settlement` object.' - The Transaction was made for an undocumented or deprecated reason. check_deposit_acceptance: anyOf: - additionalProperties: true description: A Check Deposit Acceptance object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_acceptance`. A Check Deposit Acceptance is created when a Check Deposit is processed and its details confirmed. Check Deposits may be returned by the receiving bank, which will appear as a Check Deposit Return. example: account_number: '987654321' amount: 1000 auxiliary_on_us: '101' check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1 currency: USD routing_number: '101050001' serial_number: null properties: account_number: description: The account number printed on the check. This is an account at the bank that issued the check. type: string x-documentation-priority: default amount: description: The amount to be deposited in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default auxiliary_on_us: anyOf: - description: An additional line of metadata printed on the check. This typically includes the check number for business checks. type: string x-documentation-priority: default - type: 'null' check_deposit_id: description: The ID of the Check Deposit that was accepted. 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 transaction's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) routing_number: description: The routing number printed on the check. This is a routing number for the bank that issued the check. type: string x-documentation-priority: default serial_number: anyOf: - description: The check serial number, if present, for consumer checks. For business checks, the serial number is usually in the `auxiliary_on_us` field. type: string x-documentation-priority: default - type: 'null' required: - amount - currency - account_number - routing_number - auxiliary_on_us - serial_number - check_deposit_id title: Transaction Transaction Source Check Deposit Acceptance type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Check Deposit Acceptances - type: 'null' check_deposit_return: anyOf: - additionalProperties: true description: A Check Deposit Return object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_return`. A Check Deposit Return is created when a Check Deposit is returned by the bank holding the account it was drawn against. Check Deposits may be returned for a variety of reasons, including insufficient funds or a mismatched account number. Usually, checks are returned within the first 7 days after the deposit is made. example: amount: 100 check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1 currency: USD return_reason: insufficient_funds returned_at: '2020-01-31T23:59:59Z' transaction_id: transaction_uyrp7fld2ium70oa7oi properties: amount: description: The returned amount in USD cents. type: integer x-documentation-priority: default check_deposit_id: description: The identifier of the Check Deposit that was returned. 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 transaction's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) return_reason: description: Why this check was returned by the bank holding the account it was drawn against. enum: - ach_conversion_not_supported - closed_account - duplicate_submission - insufficient_funds - no_account - not_authorized - stale_dated - stop_payment - unknown_reason - unmatched_details - unreadable_image - endorsement_irregular - altered_or_fictitious_item - frozen_or_blocked_account - post_dated - endorsement_missing - signature_missing - stop_payment_suspect - unusable_image - image_fails_security_check - cannot_determine_amount - signature_irregular - non_cash_item - unable_to_process - item_exceeds_dollar_limit - branch_or_account_sold type: string x-documentation-priority: default x-enum-descriptions: - The check doesn't allow ACH conversion. - The account is closed. (Check21 return code `D`) - The check has already been deposited. (Check21 return code `Y`) - Insufficient funds (Check21 return code `A`) - No account was found matching the check details. (Check21 return code `E`) - The check was not authorized. (Check21 return code `Q`) - The check is too old. (Check21 return code `G`) - The payment has been stopped by the account holder. (Check21 return code `C`) - The reason for the return is unknown. - The image doesn't match the details submitted. - The image could not be read. (Check21 return code `U`) - The check endorsement was irregular. (Check21 return code `J`) - The check present was either altered or fake. (Check21 return code `N`) - The account this check is drawn on is frozen. (Check21 return code `F`) - The check is post dated. (Check21 return code `H`) - The endorsement was missing. (Check21 return code `I`) - The check signature was missing. (Check21 return code `K`) - The bank suspects a stop payment will be placed. (Check21 return code `T`) - The bank cannot read the image. (Check21 return code `U`) - The check image fails the bank's security check. (Check21 return code `V`) - The bank cannot determine the amount. (Check21 return code `W`) - The signature is inconsistent with prior signatures. (Check21 return code `L`) - The check is a non-cash item and cannot be drawn against the account. (Check21 return code `M`) - The bank is unable to process this check. (Check21 return code `O`) - The check exceeds the bank or customer's limit. (Check21 return code `P`) - The bank sold this account and no longer services this customer. (Check21 return code `R`) returned_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was returned. format: date-time type: string x-documentation-priority: default transaction_id: description: The identifier of the transaction that reversed the original check deposit transaction. type: string x-documentation-priority: default x-id-reference-to: Transactions required: - amount - returned_at - currency - check_deposit_id - transaction_id - return_reason title: Transaction Transaction Source Check Deposit Return type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Check Deposit Returns - type: 'null' check_transfer_deposit: anyOf: - $ref: '#/components/schemas/check_transfer_deposit' description: A Check Transfer Deposit object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_deposit`. An Inbound Check is a check drawn on an Increase account that has been deposited by an external bank account. These types of checks are not pre-registered. x-documentation-priority: default - type: 'null' fednow_transfer_acknowledgement: anyOf: - additionalProperties: true description: A FedNow Transfer Acknowledgement object. This field will be present in the JSON response if and only if `category` is equal to `fednow_transfer_acknowledgement`. A FedNow Transfer Acknowledgement is created when a FedNow Transfer sent from Increase is acknowledged by the receiving bank. example: transfer_id: fednow_transfer_4i0mptrdu1mueg1196bg properties: transfer_id: description: The identifier of the FedNow Transfer that led to this Transaction. type: string x-documentation-priority: default x-id-reference-to: FedNow Transfers required: - transfer_id title: Transaction Transaction Source FedNow Transfer Acknowledgement type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: FedNow Transfer Acknowledgements - type: 'null' fee_payment: anyOf: - additionalProperties: true description: A Fee Payment object. This field will be present in the JSON response if and only if `category` is equal to `fee_payment`. A Fee Payment represents a payment made to Increase. example: amount: 100 currency: USD fee_period_start: '2023-05-01' fee_statement_id: fee_statement_lz33v0d7pnxwkptrdwq4 program_id: program_i2v2os4mwza1oetokh9i properties: amount: description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) fee_period_start: description: The start of this payment's fee period, usually the first day of a month. format: date type: string x-documentation-priority: default program_id: anyOf: - description: The Program for which this fee was incurred. type: string x-documentation-priority: default x-id-reference-to: Programs - type: 'null' required: - amount - currency - fee_period_start - program_id title: Transaction Transaction Source Fee Payment type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Fee Payments - type: 'null' inbound_ach_transfer: anyOf: - additionalProperties: true description: An Inbound ACH Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `inbound_ach_transfer`. An Inbound ACH Transfer Intention is created when an ACH transfer is initiated at another bank and received by Increase. example: addenda: null amount: 100 originator_company_descriptive_date: null originator_company_discretionary_data: null originator_company_entry_description: RESERVE originator_company_id: 0987654321 originator_company_name: BIG BANK receiver_id_number: '12345678900' receiver_name: IAN CREASE trace_number: 021000038461022 transfer_id: inbound_ach_transfer_tdrwqr3fq9gnnq49odev properties: addenda: anyOf: - additionalProperties: false description: Additional information sent from the originator. properties: category: description: The type of addendum. enum: - freeform type: string x-documentation-priority: default x-enum-descriptions: - Unstructured addendum. freeform: anyOf: - additionalProperties: false description: Unstructured `payment_related_information` passed through by the originator. properties: entries: description: Each entry represents an addendum received from the originator. items: additionalProperties: false properties: payment_related_information: description: The payment related information passed in the addendum. type: string x-documentation-priority: default required: - payment_related_information title: Transaction Transaction Source Inbound ACH Transfer Intention Addenda Freeform EntriesElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: EntriesElements type: array x-documentation-priority: default required: - entries title: Transaction Transaction Source Inbound ACH Transfer Intention Addenda Freeform type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Freeforms - type: 'null' required: - category - freeform title: Transaction Transaction Source Inbound ACH Transfer Intention Addenda type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Addendas - type: 'null' amount: description: The transfer amount in USD cents. type: integer x-documentation-priority: default originator_company_descriptive_date: anyOf: - description: The description of the date of the transfer, usually in the format `YYMMDD`. type: string x-documentation-priority: default - type: 'null' originator_company_discretionary_data: anyOf: - description: Data set by the originator. type: string x-documentation-priority: default - type: 'null' originator_company_entry_description: description: An informational description of the transfer. type: string x-documentation-priority: default originator_company_id: description: An identifier for the originating company. This is generally, but not always, a stable identifier across multiple transfers. type: string x-documentation-priority: default originator_company_name: description: A name set by the originator to identify themselves. type: string x-documentation-priority: default receiver_id_number: anyOf: - description: The originator's identifier for the transfer recipient. type: string x-documentation-priority: default - type: 'null' receiver_name: anyOf: - description: The name of the transfer recipient. This value is informational and not verified by Increase. type: string x-documentation-priority: default - type: 'null' trace_number: description: A 15 digit number recorded in the Nacha file and available to both the originating and receiving bank. Along with the amount, date, and originating routing number, this can be used to identify the ACH transfer at either bank. ACH trace numbers are not unique, but are [used to correlate returns](https://increase.com/documentation/ach-returns#ach-returns). type: string x-documentation-priority: default transfer_id: description: The Inbound ACH Transfer's identifier. type: string x-documentation-priority: default x-id-reference-to: Inbound ACH Transfers required: - amount - originator_company_name - originator_company_descriptive_date - originator_company_discretionary_data - originator_company_entry_description - originator_company_id - receiver_id_number - receiver_name - trace_number - transfer_id - addenda title: Transaction Transaction Source Inbound ACH Transfer Intention type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound ACH Transfer Intentions - type: 'null' inbound_ach_transfer_return_intention: anyOf: - $ref: '#/components/schemas/inbound_ach_transfer_return_intention' description: An Inbound ACH Transfer Return Intention object. This field will be present in the JSON response if and only if `category` is equal to `inbound_ach_transfer_return_intention`. An Inbound ACH Transfer Return Intention is created when an ACH transfer is initiated at another bank and returned by Increase. x-documentation-priority: default - type: 'null' inbound_check_adjustment: anyOf: - $ref: '#/components/schemas/inbound_check_adjustment' description: An Inbound Check Adjustment object. This field will be present in the JSON response if and only if `category` is equal to `inbound_check_adjustment`. An Inbound Check Adjustment is created when Increase receives an adjustment for a check or return deposited through Check21. x-documentation-priority: default - type: 'null' inbound_check_deposit_return_intention: anyOf: - $ref: '#/components/schemas/inbound_check_deposit_return_intention' description: An Inbound Check Deposit Return Intention object. This field will be present in the JSON response if and only if `category` is equal to `inbound_check_deposit_return_intention`. An Inbound Check Deposit Return Intention is created when Increase receives an Inbound Check and the User requests that it be returned. x-documentation-priority: default - type: 'null' inbound_fednow_transfer_confirmation: anyOf: - additionalProperties: true description: An Inbound FedNow Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `inbound_fednow_transfer_confirmation`. An Inbound FedNow Transfer Confirmation is created when a FedNow transfer is initiated at another bank and received by Increase. example: transfer_id: inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20 properties: transfer_id: description: The identifier of the FedNow Transfer that led to this Transaction. type: string x-documentation-priority: default x-id-reference-to: Inbound FedNow Transfers required: - transfer_id title: Transaction Transaction Source Inbound FedNow Transfer Confirmation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound FedNow Transfer Confirmations - type: 'null' inbound_real_time_payments_transfer_confirmation: anyOf: - additionalProperties: true description: An Inbound Real-Time Payments Transfer Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_confirmation`. An Inbound Real-Time Payments Transfer Confirmation is created when a Real-Time Payments transfer is initiated at another bank and received by Increase. example: amount: 100 creditor_name: Ian Crease currency: USD debtor_account_number: '987654321' debtor_name: National Phonograph Company debtor_routing_number: '101050001' transaction_identification: 20220501234567891T1BSLZO01745013025 transfer_id: inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr unstructured_remittance_information: Invoice 29582 properties: amount: description: The amount in the minor unit of the transfer's 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 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 transaction_identification: description: The Real-Time Payments network identification of the 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 - creditor_name - debtor_name - debtor_account_number - debtor_routing_number - transaction_identification - unstructured_remittance_information - transfer_id title: Transaction Transaction Source Inbound Real-Time Payments Transfer Confirmation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound Real-Time Payments Transfer Confirmations - type: 'null' inbound_wire_reversal: anyOf: - additionalProperties: true description: An Inbound Wire Reversal object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_reversal`. An Inbound Wire Reversal represents a reversal of a wire transfer that was initiated via Increase. The other bank is sending the money back. This most often happens when the original destination account details were incorrect. example: amount: 12345 created_at: '2020-01-31T23:59:59Z' debtor_routing_number: '101050001' description: Inbound wire reversal 2022021100335128 input_cycle_date: '2022-02-11' input_message_accountability_data: 20220211B6B7HU2R011023 input_sequence_number: '11023' input_source: B6B7HU2R instruction_identification: null return_reason_additional_information: null return_reason_code: null return_reason_code_description: null transaction_id: transaction_uyrp7fld2ium70oa7oi wire_transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u properties: amount: description: The amount that was reversed in USD cents. type: integer x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the reversal was created. format: date-time type: string x-documentation-priority: default debtor_routing_number: anyOf: - description: The debtor's routing number. type: string x-documentation-priority: default - type: 'null' description: description: The description on the reversal message from Fedwire, set by the reversing bank. type: string x-documentation-priority: default input_cycle_date: description: The Fedwire cycle date for the wire reversal. The "Fedwire day" begins at 9:00 PM Eastern Time on the evening before the `cycle date`. format: date type: string x-documentation-priority: default input_message_accountability_data: description: The Fedwire transaction identifier. type: string x-documentation-priority: default input_sequence_number: description: The Fedwire sequence number. type: string x-documentation-priority: default input_source: description: The Fedwire input source identifier. type: string x-documentation-priority: default instruction_identification: anyOf: - description: The sending bank's identifier for the reversal. type: string x-documentation-priority: default - type: 'null' return_reason_additional_information: anyOf: - description: Additional information about the reason for the reversal. type: string x-documentation-priority: default - type: 'null' return_reason_code: anyOf: - description: A code provided by the sending bank giving a reason for the reversal. The common return reason codes are [documented here](/documentation/wire-reversals#reversal-reason-codes). type: string x-documentation-priority: default - type: 'null' return_reason_code_description: anyOf: - description: An Increase-generated description of the `return_reason_code`. type: string x-documentation-priority: default - type: 'null' transaction_id: description: The ID for the Transaction associated with the transfer reversal. type: string x-documentation-priority: default x-id-reference-to: Transactions wire_transfer_id: description: The ID for the Wire Transfer that is being reversed. type: string x-documentation-priority: default x-id-reference-to: Wire Transfers required: - amount - created_at - description - input_cycle_date - input_sequence_number - input_source - input_message_accountability_data - transaction_id - wire_transfer_id - instruction_identification - debtor_routing_number - return_reason_code - return_reason_code_description - return_reason_additional_information title: Transaction Transaction Source Inbound Wire Reversal type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound Wire Reversals - type: 'null' inbound_wire_transfer: anyOf: - additionalProperties: true description: An Inbound Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer`. An Inbound Wire Transfer Intention is created when a wire transfer is initiated at another bank and received by Increase. example: amount: 100 creditor_address_line1: null creditor_address_line2: null creditor_address_line3: null creditor_name: null debtor_address_line1: null debtor_address_line2: null debtor_address_line3: null debtor_name: null description: Inbound wire transfer end_to_end_identification: null input_message_accountability_data: null instructing_agent_routing_number: null instruction_identification: null transfer_id: inbound_wire_transfer_f228m6bmhtcxjco9pwp0 unique_end_to_end_transaction_reference: null unstructured_remittance_information: null properties: amount: description: The amount in USD cents. type: integer x-documentation-priority: default creditor_address_line1: anyOf: - description: A free-form address field set by the sender. type: string x-documentation-priority: default - type: 'null' creditor_address_line2: anyOf: - description: A free-form address field set by the sender. type: string x-documentation-priority: default - type: 'null' creditor_address_line3: anyOf: - description: A free-form address field set by the sender. type: string x-documentation-priority: default - type: 'null' creditor_name: anyOf: - description: A name set by the sender. type: string x-documentation-priority: default - type: 'null' debtor_address_line1: anyOf: - description: A free-form address field set by the sender. type: string x-documentation-priority: default - type: 'null' debtor_address_line2: anyOf: - description: A free-form address field set by the sender. type: string x-documentation-priority: default - type: 'null' debtor_address_line3: anyOf: - description: A free-form address field set by the sender. type: string x-documentation-priority: default - type: 'null' debtor_name: anyOf: - description: A name set by the sender. type: string x-documentation-priority: default - type: 'null' description: description: An Increase-constructed description of the transfer. type: string x-documentation-priority: default end_to_end_identification: anyOf: - description: A free-form reference string set by the sender, to help identify the transfer. type: string x-documentation-priority: default - type: 'null' input_message_accountability_data: anyOf: - description: A unique identifier available to the originating and receiving banks, commonly abbreviated as IMAD. It is created when the wire is submitted to the Fedwire service and is helpful when debugging wires with the originating bank. type: string x-documentation-priority: default - type: 'null' instructing_agent_routing_number: anyOf: - description: The American Banking Association (ABA) routing number of the bank that sent the wire. type: string x-documentation-priority: default - type: 'null' instruction_identification: anyOf: - description: The sending bank's identifier for the wire transfer. type: string x-documentation-priority: default - type: 'null' transfer_id: description: The ID of the Inbound Wire Transfer object that resulted in this Transaction. type: string x-documentation-priority: default x-id-reference-to: Inbound Wire Transfers unique_end_to_end_transaction_reference: anyOf: - description: The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) of the transfer. type: string x-documentation-priority: default - type: 'null' unstructured_remittance_information: anyOf: - description: A free-form message set by the sender. type: string x-documentation-priority: default - type: 'null' required: - amount - description - input_message_accountability_data - transfer_id - creditor_address_line1 - creditor_address_line2 - creditor_address_line3 - creditor_name - end_to_end_identification - debtor_address_line1 - debtor_address_line2 - debtor_address_line3 - debtor_name - instructing_agent_routing_number - unstructured_remittance_information - instruction_identification - unique_end_to_end_transaction_reference title: Transaction Transaction Source Inbound Wire Transfer Intention type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound Wire Transfer Intentions - type: 'null' inbound_wire_transfer_reversal: anyOf: - $ref: '#/components/schemas/inbound_wire_transfer_reversal' description: An Inbound Wire Transfer Reversal Intention object. This field will be present in the JSON response if and only if `category` is equal to `inbound_wire_transfer_reversal`. An Inbound Wire Transfer Reversal Intention is created when Increase has received a wire and the User requests that it be reversed. x-documentation-priority: default - type: 'null' interest_payment: anyOf: - additionalProperties: true description: An Interest Payment object. This field will be present in the JSON response if and only if `category` is equal to `interest_payment`. An Interest Payment represents a payment of interest on an account. Interest is usually paid monthly. example: accrued_on_account_id: account_in71c4amph0vgo2qllky amount: 100 currency: USD period_end: '2025-06-30T23:59:59+00:00' period_start: '2025-06-01T00:00:00+00:00' properties: accrued_on_account_id: description: The account on which the interest was accrued. type: string x-documentation-priority: default x-id-reference-to: Accounts amount: description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) period_end: description: The end of the period for which this transaction paid interest. format: date-time type: string x-documentation-priority: default period_start: description: The start of the period for which this transaction paid interest. format: date-time type: string x-documentation-priority: default required: - amount - currency - period_start - period_end - accrued_on_account_id title: Transaction Transaction Source Interest Payment type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Interest Payments - type: 'null' internal_source: anyOf: - additionalProperties: true description: An Internal Source object. This field will be present in the JSON response if and only if `category` is equal to `internal_source`. A transaction between the user and Increase. See the `reason` attribute for more information. example: amount: 100 currency: USD reason: sample_funds properties: amount: description: The amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) reason: description: An Internal Source is a transaction between you and Increase. This describes the reason for the transaction. enum: - account_closure - account_revenue_payment_distribution - bank_drawn_check - bank_drawn_check_credit - bank_migration - check_adjustment - collection_payment - collection_receivable - dishonored_ach_return - empyreal_adjustment - error - error_correction - fees - general_ledger_transfer - interest - negative_balance_forgiveness - sample_funds - sample_funds_return type: string x-documentation-priority: default x-enum-descriptions: - Account closure - Account revenue payment distribution - Bank-drawn check - Bank-drawn check credit - Bank migration - Check adjustment - Collection payment - Collection receivable - Dishonored ACH return - Empyreal adjustment - Error - Error correction - Fees - General ledger transfer - Interest - Negative balance forgiveness - Sample funds - Sample funds return required: - amount - currency - reason title: Transaction Transaction Source Internal Source type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Internal Sources - 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: Transaction Transaction Source Other type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Others - type: 'null' real_time_payments_transfer_acknowledgement: anyOf: - additionalProperties: true description: A Real-Time Payments Transfer Acknowledgement object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_acknowledgement`. A Real-Time Payments Transfer Acknowledgement is created when a Real-Time Payments Transfer sent from Increase is acknowledged by the receiving bank. example: account_number: '987654321' amount: 100 routing_number: '101050001' transfer_id: real_time_payments_transfer_iyuhl5kdn7ssmup83mvq unstructured_remittance_information: Invoice 29582 properties: account_number: description: The destination account number. type: string x-documentation-priority: default amount: description: The transfer amount in USD cents. type: integer x-documentation-priority: default routing_number: description: The American Bankers' Association (ABA) Routing Transit Number (RTN). 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: Real-Time Payments Transfers unstructured_remittance_information: description: Unstructured information that will show on the recipient's bank statement. type: string x-documentation-priority: default required: - amount - account_number - routing_number - unstructured_remittance_information - transfer_id title: Transaction Transaction Source Real-Time Payments Transfer Acknowledgement type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Real-Time Payments Transfer Acknowledgements - type: 'null' sample_funds: anyOf: - additionalProperties: true description: A Sample Funds object. This field will be present in the JSON response if and only if `category` is equal to `sample_funds`. Sample funds for testing purposes. example: originator: dashboard properties: originator: description: Where the sample funds came from. type: string x-documentation-priority: default required: - originator title: Transaction Transaction Source Sample Funds type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Sample Funds - type: 'null' swift_transfer_intention: anyOf: - additionalProperties: true description: A Swift Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `swift_transfer_intention`. A Swift Transfer initiated via Increase. example: transfer_id: swift_transfer_29h21xkng03788zwd3fh properties: transfer_id: description: The identifier of the Swift Transfer that led to this Transaction. type: string x-documentation-priority: default x-id-reference-to: Swift Transfers required: - transfer_id title: Transaction Transaction Source Swift Transfer Intention type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Swift Transfer Intentions - type: 'null' swift_transfer_return: anyOf: - additionalProperties: true description: A Swift Transfer Return object. This field will be present in the JSON response if and only if `category` is equal to `swift_transfer_return`. A Swift Transfer Return is created when a Swift Transfer is returned by the receiving bank. example: transfer_id: swift_transfer_29h21xkng03788zwd3fh properties: transfer_id: description: The identifier of the Swift Transfer that led to this Transaction. type: string x-documentation-priority: default x-id-reference-to: Swift Transfers required: - transfer_id title: Transaction Transaction Source Swift Transfer Return type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Swift Transfer Returns - type: 'null' wire_transfer_intention: anyOf: - additionalProperties: true description: A Wire Transfer Intention object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_intention`. A Wire Transfer initiated via Increase and sent to a different bank. example: account_number: '987654321' amount: 100 message_to_recipient: HELLO routing_number: '101050001' transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u properties: account_number: description: The destination account number. type: string x-documentation-priority: default amount: description: The transfer amount in USD cents. type: integer x-documentation-priority: default message_to_recipient: description: The message that will show on the recipient's bank statement. type: string x-documentation-priority: default routing_number: description: The American Bankers' Association (ABA) Routing Transit Number (RTN). type: string x-documentation-priority: default transfer_id: description: The identifier of the Wire Transfer that led to this Transaction. type: string x-documentation-priority: default x-id-reference-to: Wire Transfers required: - amount - account_number - routing_number - message_to_recipient - transfer_id title: Transaction Transaction Source Wire Transfer Intention type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Wire Transfer Intentions - type: 'null' required: - category title: Transaction Transaction Source type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Transaction Sources type: description: A constant representing the object's type. For this resource it will always be `transaction`. enum: - transaction type: string x-documentation-priority: default required: - type - account_id - amount - currency - created_at - description - id - route_id - route_type - source title: Transaction type: object x-event-categories: - transaction.created x-stainless-empty-object: false x-tag: Transactions x-title-plural: Transactions card_settlement: additionalProperties: true description: Card Settlements are card transactions that have cleared and settled. While a settlement is usually preceded by an authorization, an acquirer can also directly clear a transaction without first authorizing it. example: amount: 100 card_authorization: null card_payment_id: card_payment_nd3k2kacrqjli8482ave cashback: null currency: USD id: card_settlement_khv5kfeu0vndj291omg6 interchange: amount: '0.137465' code: '271' currency: USD merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_name: AMAZON.COM merchant_postal_code: '10045' merchant_state: NY network: visa network_identifiers: acquirer_business_id: '69650702' acquirer_reference_number: '83163715445437604865089' authorization_identification_response: ABC123 transaction_id: '627199945183184' pending_transaction_id: null presentment_amount: 100 presentment_currency: USD purchase_details: car_rental: null customer_reference_identifier: '51201' local_tax_amount: null local_tax_currency: usd lodging: check_in_date: '2023-07-20' daily_room_rate_amount: 1000 daily_room_rate_currency: usd extra_charges: restaurant folio_cash_advances_amount: 0 folio_cash_advances_currency: usd food_beverage_charges_amount: 0 food_beverage_charges_currency: usd no_show_indicator: no_show prepaid_expenses_amount: 0 prepaid_expenses_currency: usd room_nights: 1 total_room_tax_amount: 100 total_room_tax_currency: usd total_tax_amount: 100 total_tax_currency: usd national_tax_amount: null national_tax_currency: usd purchase_identifier: '10203' purchase_identifier_format: order_number travel: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' surcharge: null transaction_id: transaction_uyrp7fld2ium70oa7oi type: card_settlement properties: amount: description: The amount in the minor unit of the transaction's settlement currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default card_authorization: anyOf: - description: The Card Authorization that was created prior to this Card Settlement, if one exists. type: string x-documentation-priority: default - type: 'null' 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 cashback: anyOf: - additionalProperties: false description: Cashback earned on this transaction, if eligible. Cashback is paid out in aggregate, monthly. example: amount: '0.137465' currency: USD properties: amount: description: The cashback amount given as a string containing a decimal number. The amount is a positive number if it will be credited to you (e.g., settlements) and a negative number if it will be debited (e.g., refunds). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the cashback. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) required: - amount - currency title: Card Settlement Cashback type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cashbacks - type: 'null' currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's settlement currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) id: description: The Card Settlement identifier. type: string x-documentation-priority: default x-id-reference-to: Card Settlements interchange: anyOf: - additionalProperties: false description: Interchange assessed as a part of this transaction. example: amount: '0.137465' code: '271' currency: USD properties: amount: description: The interchange amount given as a string containing a decimal number in major units (so e.g., "3.14" for $3.14). The amount is a positive number if it is credited to Increase (e.g., settlements) and a negative number if it is debited (e.g., refunds). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default code: anyOf: - description: The card network specific interchange code. type: string x-documentation-priority: default - type: 'null' currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the interchange reimbursement. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) required: - amount - currency - code title: Card Settlement Card Interchange type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Interchanges - 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 4-digit MCC describing the merchant's business. type: string x-documentation-priority: default merchant_city: description: The city the merchant resides in. type: string x-documentation-priority: default merchant_country: description: The country the merchant resides in. type: string x-documentation-priority: default merchant_name: description: The name of the merchant. type: string x-documentation-priority: default merchant_postal_code: anyOf: - description: The merchant's postal code. For US merchants this is always a 5-digit ZIP code. 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: description: The card network on which this transaction was processed. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa - Pulse network_identifiers: additionalProperties: false description: Network-specific identifiers for this refund. properties: acquirer_business_id: description: A network assigned business ID that identifies the acquirer that processed this transaction. type: string x-documentation-priority: default acquirer_reference_number: description: A globally unique identifier for this settlement. type: string x-documentation-priority: default 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' 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 - acquirer_reference_number - acquirer_business_id - authorization_identification_response title: Card Settlement NetworkIdentifiers type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: NetworkIdentifiers pending_transaction_id: anyOf: - description: The identifier of the Pending Transaction associated with this Transaction. type: string x-documentation-priority: default x-id-reference-to: Pending Transactions - type: 'null' presentment_amount: description: The 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 purchase_details: anyOf: - additionalProperties: false description: Additional details about the card purchase, such as tax and industry-specific fields. example: car_rental: null customer_reference_identifier: '51201' local_tax_amount: null local_tax_currency: usd lodging: check_in_date: '2023-07-20' daily_room_rate_amount: 1000 daily_room_rate_currency: usd extra_charges: restaurant folio_cash_advances_amount: 0 folio_cash_advances_currency: usd food_beverage_charges_amount: 0 food_beverage_charges_currency: usd no_show_indicator: no_show prepaid_expenses_amount: 0 prepaid_expenses_currency: usd room_nights: 1 total_room_tax_amount: 100 total_room_tax_currency: usd total_tax_amount: 100 total_tax_currency: usd national_tax_amount: null national_tax_currency: usd purchase_identifier: '10203' purchase_identifier_format: order_number travel: null properties: car_rental: anyOf: - additionalProperties: false description: Fields specific to car rentals. properties: car_class_code: anyOf: - description: Code indicating the vehicle's class. type: string x-documentation-priority: default - type: 'null' checkout_date: anyOf: - description: Date the customer picked up the car or, in the case of a no-show or pre-pay transaction, the scheduled pick up date. format: date type: string x-documentation-priority: default - type: 'null' daily_rental_rate_amount: anyOf: - description: Daily rate being charged for the vehicle. type: integer x-documentation-priority: default - type: 'null' daily_rental_rate_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily rental rate. type: string x-documentation-priority: default - type: 'null' days_rented: anyOf: - description: Number of days the vehicle was rented. type: integer x-documentation-priority: default - type: 'null' extra_charges: anyOf: - description: Additional charges (gas, late fee, etc.) being billed. enum: - no_extra_charge - gas - extra_mileage - late_return - one_way_service_fee - parking_violation type: string x-documentation-priority: default x-enum-descriptions: - No extra charge - Gas - Extra mileage - Late return - One way service fee - Parking violation - type: 'null' fuel_charges_amount: anyOf: - description: Fuel charges for the vehicle. type: integer x-documentation-priority: default - type: 'null' fuel_charges_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fuel charges assessed. type: string x-documentation-priority: default - type: 'null' insurance_charges_amount: anyOf: - description: Any insurance being charged for the vehicle. type: integer x-documentation-priority: default - type: 'null' insurance_charges_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the insurance charges assessed. type: string x-documentation-priority: default - type: 'null' no_show_indicator: anyOf: - description: An indicator that the cardholder is being billed for a reserved vehicle that was not actually rented (that is, a "no-show" charge). enum: - not_applicable - no_show_for_specialized_vehicle type: string x-documentation-priority: default x-enum-descriptions: - Not applicable - No show for specialized vehicle - type: 'null' one_way_drop_off_charges_amount: anyOf: - description: Charges for returning the vehicle at a different location than where it was picked up. type: integer x-documentation-priority: default - type: 'null' one_way_drop_off_charges_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the one-way drop-off charges assessed. type: string x-documentation-priority: default - type: 'null' renter_name: anyOf: - description: Name of the person renting the vehicle. type: string x-documentation-priority: default - type: 'null' weekly_rental_rate_amount: anyOf: - description: Weekly rate being charged for the vehicle. type: integer x-documentation-priority: default - type: 'null' weekly_rental_rate_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the weekly rental rate. type: string x-documentation-priority: default - type: 'null' required: - extra_charges - days_rented - no_show_indicator - checkout_date - daily_rental_rate_amount - daily_rental_rate_currency - weekly_rental_rate_amount - weekly_rental_rate_currency - insurance_charges_amount - insurance_charges_currency - fuel_charges_amount - fuel_charges_currency - one_way_drop_off_charges_amount - one_way_drop_off_charges_currency - car_class_code - renter_name title: Card Settlement Card Purchase Details CarRental type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CarRentals - type: 'null' customer_reference_identifier: anyOf: - description: An identifier from the merchant for the customer or consumer. type: string x-documentation-priority: default - type: 'null' local_tax_amount: anyOf: - description: The state or provincial tax amount in minor units. type: integer x-documentation-priority: default - type: 'null' local_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax assessed. type: string x-documentation-priority: default - type: 'null' lodging: anyOf: - additionalProperties: false description: Fields specific to lodging. properties: check_in_date: anyOf: - description: Date the customer checked in. format: date type: string x-documentation-priority: default - type: 'null' daily_room_rate_amount: anyOf: - description: Daily rate being charged for the room. type: integer x-documentation-priority: default - type: 'null' daily_room_rate_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the daily room rate. type: string x-documentation-priority: default - type: 'null' extra_charges: anyOf: - description: Additional charges (phone, late check-out, etc.) being billed. enum: - no_extra_charge - restaurant - gift_shop - mini_bar - telephone - other - laundry type: string x-documentation-priority: default x-enum-descriptions: - No extra charge - Restaurant - Gift shop - Mini bar - Telephone - Other - Laundry - type: 'null' folio_cash_advances_amount: anyOf: - description: Folio cash advances for the room. type: integer x-documentation-priority: default - type: 'null' folio_cash_advances_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the folio cash advances. type: string x-documentation-priority: default - type: 'null' food_beverage_charges_amount: anyOf: - description: Food and beverage charges for the room. type: integer x-documentation-priority: default - type: 'null' food_beverage_charges_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the food and beverage charges. type: string x-documentation-priority: default - type: 'null' no_show_indicator: anyOf: - description: Indicator that the cardholder is being billed for a reserved room that was not actually used. enum: - not_applicable - no_show type: string x-documentation-priority: default x-enum-descriptions: - Not applicable - No show - type: 'null' prepaid_expenses_amount: anyOf: - description: Prepaid expenses being charged for the room. type: integer x-documentation-priority: default - type: 'null' prepaid_expenses_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the prepaid expenses. type: string x-documentation-priority: default - type: 'null' room_nights: anyOf: - description: Number of nights the room was rented. type: integer x-documentation-priority: default - type: 'null' total_room_tax_amount: anyOf: - description: Total room tax being charged. type: integer x-documentation-priority: default - type: 'null' total_room_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total room tax. type: string x-documentation-priority: default - type: 'null' total_tax_amount: anyOf: - description: Total tax being charged for the room. type: integer x-documentation-priority: default - type: 'null' total_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total tax assessed. type: string x-documentation-priority: default - type: 'null' required: - no_show_indicator - extra_charges - check_in_date - daily_room_rate_amount - daily_room_rate_currency - total_tax_amount - total_tax_currency - prepaid_expenses_amount - prepaid_expenses_currency - food_beverage_charges_amount - food_beverage_charges_currency - folio_cash_advances_amount - folio_cash_advances_currency - room_nights - total_room_tax_amount - total_room_tax_currency title: Card Settlement Card Purchase Details Lodging type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Lodgings - type: 'null' national_tax_amount: anyOf: - description: The national tax amount in minor units. type: integer x-documentation-priority: default - type: 'null' national_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the local tax assessed. type: string x-documentation-priority: default - type: 'null' purchase_identifier: anyOf: - description: An identifier from the merchant for the purchase to the issuer and cardholder. type: string x-documentation-priority: default - type: 'null' purchase_identifier_format: anyOf: - description: The format of the purchase identifier. enum: - free_text - order_number - rental_agreement_number - hotel_folio_number - invoice_number type: string x-documentation-priority: default x-enum-descriptions: - Free text - Order number - Rental agreement number - Hotel folio number - Invoice number - type: 'null' travel: anyOf: - additionalProperties: false description: Fields specific to travel. properties: ancillary: anyOf: - additionalProperties: false description: Ancillary purchases in addition to the airfare. properties: connected_ticket_document_number: anyOf: - description: If this purchase has a connection or relationship to another purchase, such as a baggage fee for a passenger transport ticket, this field should contain the ticket document number for the other purchase. type: string x-documentation-priority: default - type: 'null' credit_reason_indicator: anyOf: - description: Indicates the reason for a credit to the cardholder. enum: - no_credit - passenger_transport_ancillary_purchase_cancellation - airline_ticket_and_passenger_transport_ancillary_purchase_cancellation - other type: string x-documentation-priority: default x-enum-descriptions: - No credit - Passenger transport ancillary purchase cancellation - Airline ticket and passenger transport ancillary purchase cancellation - Other - type: 'null' passenger_name_or_description: anyOf: - description: Name of the passenger or description of the ancillary purchase. type: string x-documentation-priority: default - type: 'null' services: description: Additional travel charges, such as baggage fees. items: additionalProperties: false properties: category: anyOf: - description: Category of the ancillary service. enum: - none - bundled_service - baggage_fee - change_fee - cargo - carbon_offset - frequent_flyer - gift_card - ground_transport - in_flight_entertainment - lounge - medical - meal_beverage - other - passenger_assist_fee - pets - seat_fees - standby - service_fee - store - travel_service - unaccompanied_travel - upgrades - wifi type: string x-documentation-priority: default x-enum-descriptions: - None - Bundled service - Baggage fee - Change fee - Cargo - Carbon offset - Frequent flyer - Gift card - Ground transport - In-flight entertainment - Lounge - Medical - Meal beverage - Other - Passenger assist fee - Pets - Seat fees - Standby - Service fee - Store - Travel service - Unaccompanied travel - Upgrades - Wi-fi - type: 'null' sub_category: anyOf: - description: Sub-category of the ancillary service, free-form. type: string x-documentation-priority: default - type: 'null' required: - category - sub_category title: Card Settlement Card Purchase Details Travel Ancillary ServicesElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: ServicesElements type: array x-documentation-priority: default ticket_document_number: anyOf: - description: Ticket document number. type: string x-documentation-priority: default - type: 'null' required: - ticket_document_number - passenger_name_or_description - connected_ticket_document_number - credit_reason_indicator - services title: Card Settlement Card Purchase Details Travel Ancillary type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Ancillaries - type: 'null' computerized_reservation_system: anyOf: - description: Indicates the computerized reservation system used to book the ticket. type: string x-documentation-priority: default - type: 'null' credit_reason_indicator: anyOf: - description: Indicates the reason for a credit to the cardholder. enum: - no_credit - passenger_transport_ancillary_purchase_cancellation - airline_ticket_and_passenger_transport_ancillary_purchase_cancellation - airline_ticket_cancellation - other - partial_refund_of_airline_ticket type: string x-documentation-priority: default x-enum-descriptions: - No credit - Passenger transport ancillary purchase cancellation - Airline ticket and passenger transport ancillary purchase cancellation - Airline ticket cancellation - Other - Partial refund of airline ticket - type: 'null' departure_date: anyOf: - description: Date of departure. format: date type: string x-documentation-priority: default - type: 'null' origination_city_airport_code: anyOf: - description: Code for the originating city or airport. type: string x-documentation-priority: default - type: 'null' passenger_name: anyOf: - description: Name of the passenger. type: string x-documentation-priority: default - type: 'null' restricted_ticket_indicator: anyOf: - description: Indicates whether this ticket is non-refundable. enum: - no_restrictions - restricted_non_refundable_ticket type: string x-documentation-priority: default x-enum-descriptions: - No restrictions - Restricted non-refundable ticket - type: 'null' ticket_change_indicator: anyOf: - description: Indicates why a ticket was changed. enum: - none - change_to_existing_ticket - new_ticket type: string x-documentation-priority: default x-enum-descriptions: - None - Change to existing ticket - New ticket - type: 'null' ticket_number: anyOf: - description: Ticket number. type: string x-documentation-priority: default - type: 'null' travel_agency_code: anyOf: - description: Code for the travel agency if the ticket was issued by a travel agency. type: string x-documentation-priority: default - type: 'null' travel_agency_name: anyOf: - description: Name of the travel agency if the ticket was issued by a travel agency. type: string x-documentation-priority: default - type: 'null' trip_legs: anyOf: - description: Fields specific to each leg of the journey. items: additionalProperties: false properties: carrier_code: anyOf: - description: Carrier code (e.g., United Airlines, Jet Blue, etc.). type: string x-documentation-priority: default - type: 'null' destination_city_airport_code: anyOf: - description: Code for the destination city or airport. type: string x-documentation-priority: default - type: 'null' fare_basis_code: anyOf: - description: Fare basis code. type: string x-documentation-priority: default - type: 'null' flight_number: anyOf: - description: Flight number. type: string x-documentation-priority: default - type: 'null' service_class: anyOf: - description: Service class (e.g., first class, business class, etc.). type: string x-documentation-priority: default - type: 'null' stop_over_code: anyOf: - description: Indicates whether a stopover is allowed on this ticket. enum: - none - stop_over_allowed - stop_over_not_allowed type: string x-documentation-priority: default x-enum-descriptions: - None - Stop over allowed - Stop over not allowed - type: 'null' required: - flight_number - carrier_code - fare_basis_code - service_class - stop_over_code - destination_city_airport_code title: Card Settlement Card Purchase Details Travel TripLegsElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: TripLegsElements type: array x-documentation-priority: default - type: 'null' required: - ticket_number - passenger_name - departure_date - origination_city_airport_code - travel_agency_code - travel_agency_name - restricted_ticket_indicator - computerized_reservation_system - credit_reason_indicator - ticket_change_indicator - trip_legs - ancillary title: Card Settlement Card Purchase Details Travel type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Travels - type: 'null' required: - purchase_identifier - purchase_identifier_format - customer_reference_identifier - local_tax_amount - local_tax_currency - national_tax_amount - national_tax_currency - car_rental - lodging - travel title: Card Settlement Card Purchase Details type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Purchase Details - type: 'null' scheme_fees: description: The scheme fees associated with this card settlement. 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: Card Settlement 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 surcharge: anyOf: - additionalProperties: false description: Surcharge amount details, if applicable. The amount is positive if the surcharge is added to the overall transaction amount (surcharge), and negative if the surcharge is deducted from the overall transaction amount (discount). properties: amount: description: The surcharge amount in the minor unit of the transaction's settlement currency. type: integer x-documentation-priority: default presentment_amount: description: The surcharge amount in the minor unit of the transaction's presentment currency. type: integer x-documentation-priority: default required: - amount - presentment_amount title: Card Settlement Surcharge type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Surcharges - type: 'null' transaction_id: description: The identifier of the Transaction associated with this Transaction. type: string x-documentation-priority: default x-id-reference-to: Transactions type: description: A constant representing the object's type. For this resource it will always be `card_settlement`. enum: - card_settlement type: string x-documentation-priority: default required: - type - id - card_payment_id - card_authorization - amount - currency - presentment_amount - presentment_currency - merchant_acceptor_id - merchant_city - merchant_state - merchant_country - merchant_name - merchant_postal_code - merchant_category_code - transaction_id - pending_transaction_id - interchange - cashback - purchase_details - surcharge - scheme_fees - network - network_identifiers title: Card Settlement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Settlements card_financial: additionalProperties: true description: Card Financials are temporary holds placed on a customer's funds with the intent to later clear a transaction. 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: 100 card_payment_id: card_payment_nd3k2kacrqjli8482ave currency: USD digital_wallet_token_id: null direction: settlement id: card_financial_di5b98i72ppomo268zfk 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: NY 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: 100 presentment_currency: USD processing_category: purchase real_time_decision_id: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' terminal_id: RCN5VNXS transaction_id: transaction_uyrp7fld2ium70oa7oi type: card_financial 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 financial was approved by Increase, the card network through stand-in processing, or the user through a real-time decision. enum: - user - increase - network type: string x-documentation-priority: default x-enum-descriptions: - This object was actioned by the user through a real-time decision. - This object was actioned by Increase without user intervention. - This object was actioned by the network, through stand-in processing. additional_amounts: additionalProperties: false description: Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction. properties: clinic: anyOf: - additionalProperties: false description: The part of this transaction amount that was for clinic-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' dental: anyOf: - additionalProperties: false description: The part of this transaction amount that was for dental-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' original: anyOf: - additionalProperties: false description: The original pre-authorized amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' prescription: anyOf: - additionalProperties: false description: The part of this transaction amount that was for healthcare prescriptions. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' surcharge: anyOf: - additionalProperties: false description: The surcharge amount charged for this transaction by the merchant. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_cumulative: anyOf: - additionalProperties: false description: The total amount of a series of incremental authorizations, optionally provided. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_healthcare: anyOf: - additionalProperties: false description: The total amount of healthcare-related additional amounts. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' transit: anyOf: - additionalProperties: false description: The part of this transaction amount that was for transit-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' unknown: anyOf: - additionalProperties: false description: An unknown additional amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' vision: anyOf: - additionalProperties: false description: The part of this transaction amount that was for vision-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Financial AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' required: - total_healthcare - total_cumulative - surcharge - transit - vision - clinic - dental - prescription - original - unknown title: Card Financial AdditionalAmounts type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s amount: description: The pending amount in the minor unit of the transaction's 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 transaction's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) 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 Financial identifier. type: string x-documentation-priority: default x-id-reference-to: Card Financials 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: Card Financial 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: Card Financial 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: Card Financial 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: Card Financial 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 pending 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 financial, 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' scheme_fees: description: The scheme fees associated with this card financial. 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: Card Financial 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' transaction_id: description: The identifier of the Transaction associated with this Transaction. type: string x-documentation-priority: default x-id-reference-to: Transactions type: description: A constant representing the object's type. For this resource it will always be `card_financial`. enum: - card_financial type: string x-documentation-priority: default 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: Card Financial 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: Card Financial 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: Card Financial 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: Card Financial Verification type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s required: - type - id - card_payment_id - 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 - amount - presentment_amount - presentment_currency - currency - direction - actioner - processing_category - real_time_decision_id - transaction_id - scheme_fees title: Card Financial type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Financials check_transfer_deposit: additionalProperties: true description: An Inbound Check is a check drawn on an Increase account that has been deposited by an external bank account. These types of checks are not pre-registered. example: back_image_file_id: file_makxrc67oh9l6sg7w9yc bank_of_first_deposit_routing_number: null deposited_at: '2020-01-31T23:59:59Z' front_image_file_id: file_makxrc67oh9l6sg7w9yc inbound_check_deposit_id: inbound_check_deposit_zoshvqybq0cjjm31mra transaction_id: transaction_uyrp7fld2ium70oa7oi transfer_id: check_transfer_30b43acfu9vw8fyc4f5 type: check_transfer_deposit properties: back_image_file_id: anyOf: - description: The identifier of the API File object containing an image of the back of the deposited check. type: string x-documentation-priority: default x-id-reference-to: Files - type: 'null' bank_of_first_deposit_routing_number: anyOf: - description: The American Bankers' Association (ABA) Routing Transit Number (RTN) for the bank depositing this check. In some rare cases, this is not transmitted via Check21 and the value will be null. type: string x-documentation-priority: default - type: 'null' deposited_at: description: When the check was deposited. format: date-time type: string x-documentation-priority: default front_image_file_id: anyOf: - description: The identifier of the API File object containing an image of the front of the deposited 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 transaction. type: string x-documentation-priority: default x-id-reference-to: Inbound Check Deposits - type: 'null' transaction_id: anyOf: - description: The identifier of the Transaction object created when the check was deposited. type: string x-documentation-priority: default x-id-reference-to: Transactions - type: 'null' transfer_id: anyOf: - description: The identifier of the Check Transfer object that was deposited. type: string x-documentation-priority: default x-id-reference-to: Check Transfers - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `check_transfer_deposit`. enum: - check_transfer_deposit type: string x-documentation-priority: default required: - type - deposited_at - transaction_id - front_image_file_id - back_image_file_id - bank_of_first_deposit_routing_number - inbound_check_deposit_id - transfer_id title: Check Transfer Deposit type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Check Transfer Deposits inbound_wire_transfer_reversal: additionalProperties: true description: An Inbound Wire Transfer Reversal Intention is created when Increase has received a wire and the User requests that it be reversed. example: inbound_wire_transfer_id: inbound_wire_transfer_f228m6bmhtcxjco9pwp0 properties: inbound_wire_transfer_id: description: The ID of the Inbound Wire Transfer that is being reversed. type: string x-documentation-priority: default x-id-reference-to: Inbound Wire Transfers required: - inbound_wire_transfer_id title: Inbound Wire Transfer Reversal Intention type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound Wire Transfer Reversal Intentions inbound_ach_transfer_return_intention: additionalProperties: true description: An Inbound ACH Transfer Return Intention is created when an ACH transfer is initiated at another bank and returned by Increase. example: inbound_ach_transfer_id: inbound_ach_transfer_tdrwqr3fq9gnnq49odev properties: inbound_ach_transfer_id: description: The ID of the Inbound ACH Transfer that is being returned. type: string x-documentation-priority: default x-id-reference-to: Inbound ACH Transfers required: - inbound_ach_transfer_id title: Inbound ACH Transfer Return Intention type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound ACH Transfer Return Intentions card_dispute_financial_visa: additionalProperties: false example: event_type: chargeback_submitted properties: event_type: description: The type of card dispute financial event. enum: - chargeback_submitted - merchant_prearbitration_decline_submitted - merchant_prearbitration_received - represented - user_prearbitration_decline_received - user_prearbitration_submitted - user_withdrawal_submitted type: string x-documentation-priority: default x-enum-descriptions: - The user's chargeback was submitted. - The user declined the merchant's pre-arbitration submission. - The merchant's pre-arbitration submission was received. - The transaction was re-presented by the merchant. - The user's pre-arbitration was declined by the merchant. - The user's pre-arbitration was submitted. - The user withdrew from the dispute. required: - event_type title: Card Dispute Financial Visa-specific details type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Dispute Financial Visa-specific details 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