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 Simulations API version: 0.0.1 servers: - url: https://api.increase.com - url: https://sandbox.increase.com security: - bearerAuth: [] tags: - name: Simulations paths: /simulations/account_revenue_payments: post: description: Simulates an account revenue payment to your account. In production, this happens automatically on the first of each month. operationId: sandbox_create_an_account_revenue_payment parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_an_account_revenue_payment_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/transaction' description: Transaction 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create an account revenue payment' x-returns-example: account_id: account_in71c4amph0vgo2qllky amount: 100 created_at: '2020-01-31T23:59:59Z' currency: USD description: Revenue Payment for My first account! in 2025-06 id: transaction_uyrp7fld2ium70oa7oi route_id: null route_type: null source: account_revenue_payment: accrued_on_account_id: account_in71c4amph0vgo2qllky period_end: '2025-06-30T23:59:59+00:00' period_start: '2025-06-01T00:00:00+00:00' category: account_revenue_payment type: transaction x-sandbox-only: true x-tag: Accounts tags: - Simulations /simulations/account_statements: post: description: Simulates an [Account Statement](#account-statements) being created for an account. In production, Account Statements are generated once per month. operationId: sandbox_create_an_account_statement parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_an_account_statement_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/account_statement' description: Account Statement 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create an Account Statement' x-sandbox-only: true x-tag: Account Statements tags: - Simulations /simulations/ach_transfers/{ach_transfer_id}/acknowledge: post: description: Simulates the acknowledgement of an [ACH Transfer](#ach-transfers) by the Federal Reserve. This transfer must first have a `status` of `submitted`. In production, the Federal Reserve generally acknowledges submitted ACH files within 30 minutes. Since sandbox ACH Transfers are not submitted to the Federal Reserve, this endpoint allows you to skip that delay and add the acknowledgement subresource to the ACH Transfer. operationId: sandbox_acknowledge_an_ach_transfer parameters: - example: ach_transfer_uoxatyh3lt5evrsdvo7q in: path name: ach_transfer_id required: true schema: description: The identifier of the ACH Transfer you wish to become acknowledged. type: string x-documentation-priority: default x-id-reference-to: ACH Transfers responses: '200': content: application/json: schema: $ref: '#/components/schemas/ach_transfer' description: ACH Transfer 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Acknowledge an ACH Transfer' x-sandbox-only: true x-tag: ACH Transfers tags: - Simulations /simulations/ach_transfers/{ach_transfer_id}/create_notification_of_change: post: description: Simulates receiving a Notification of Change for an [ACH Transfer](#ach-transfers). operationId: sandbox_create_a_notification_of_change_for_an_ach_transfer parameters: - example: ach_transfer_uoxatyh3lt5evrsdvo7q in: path name: ach_transfer_id required: true schema: description: The identifier of the ACH Transfer you wish to create a notification of change for. type: string x-documentation-priority: default x-id-reference-to: ACH Transfers requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_a_notification_of_change_for_an_ach_transfer_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ach_transfer' description: ACH Transfer 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create a Notification of Change for an ACH Transfer' x-sandbox-only: true x-tag: ACH Transfers tags: - Simulations /simulations/ach_transfers/{ach_transfer_id}/return: post: description: Simulates the return of an [ACH Transfer](#ach-transfers) by the Federal Reserve due to an error condition. This will also create a Transaction to account for the returned funds. This transfer must first have a `status` of `submitted`. operationId: sandbox_return_an_ach_transfer parameters: - example: ach_transfer_uoxatyh3lt5evrsdvo7q in: path name: ach_transfer_id required: true schema: description: The identifier of the ACH Transfer you wish to return. type: string x-documentation-priority: default x-id-reference-to: ACH Transfers requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_return_an_ach_transfer_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ach_transfer' description: ACH Transfer 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Return an ACH Transfer' x-sandbox-only: true x-tag: ACH Transfers tags: - Simulations /simulations/ach_transfers/{ach_transfer_id}/settle: post: description: 'Simulates the settlement of an [ACH Transfer](#ach-transfers) by the Federal Reserve. This transfer must first have a `status` of `pending_submission` or `submitted`. For convenience, if the transfer is in `status`: `pending_submission`, the simulation will also submit the transfer. Without this simulation the transfer will eventually settle on its own following the same Federal Reserve timeline as in production. Additionally, you can specify the behavior of the inbound funds hold that is created when the ACH Transfer is settled. If no behavior is specified, the inbound funds hold will be released immediately in order for the funds to be available for use.' operationId: sandbox_settle_an_ach_transfer parameters: - example: ach_transfer_uoxatyh3lt5evrsdvo7q in: path name: ach_transfer_id required: true schema: description: The identifier of the ACH Transfer you wish to become settled. type: string x-documentation-priority: default x-id-reference-to: ACH Transfers requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_settle_an_ach_transfer_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ach_transfer' description: ACH Transfer 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Settle an ACH Transfer' x-sandbox-only: true x-tag: ACH Transfers tags: - Simulations /simulations/ach_transfers/{ach_transfer_id}/submit: post: description: Simulates the submission of an [ACH Transfer](#ach-transfers) to the Federal Reserve. This transfer must first have a `status` of `pending_approval` or `pending_submission`. In production, Increase submits ACH Transfers to the Federal Reserve three times per day on weekdays. Since sandbox ACH Transfers are not submitted to the Federal Reserve, this endpoint allows you to skip that delay and transition the ACH Transfer to a status of `submitted`. operationId: sandbox_submit_an_ach_transfer parameters: - example: ach_transfer_uoxatyh3lt5evrsdvo7q in: path name: ach_transfer_id required: true schema: description: The identifier of the ACH Transfer you wish to submit. type: string x-documentation-priority: default x-id-reference-to: ACH Transfers responses: '200': content: application/json: schema: $ref: '#/components/schemas/ach_transfer' description: ACH Transfer 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Submit an ACH Transfer' x-sandbox-only: true x-tag: ACH Transfers tags: - Simulations /simulations/card_authentications: post: description: Simulates a Card Authentication attempt on a [Card](#cards). The attempt always results in a [Card Payment](#card_payments) being created, either with a status that allows further action or a terminal failed status. operationId: sandbox_create_a_card_authentication_attempt parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_a_card_authentication_attempt_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_payment' description: Card Payment 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create a Card Authentication attempt' x-sandbox-only: true x-tag: Card Payments tags: - Simulations /simulations/card_authentications/{card_payment_id}/challenge_attempts: post: description: Simulates an attempt at a Card Authentication Challenge. This updates the `card_authentications` object under the [Card Payment](#card_payments). You can also attempt the challenge by navigating to https://dashboard.increase.com/card_authentication_simulation/:card_payment_id. operationId: sandbox_create_a_card_authentication_challenge_attempt parameters: - example: card_payment_nd3k2kacrqjli8482ave in: path name: card_payment_id required: true schema: description: The identifier of the Card Payment to be challenged. type: string x-documentation-priority: default x-id-reference-to: Card Payments requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_a_card_authentication_challenge_attempt_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_payment' description: Card Payment 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create a Card Authentication Challenge attempt' x-sandbox-only: true x-tag: Card Payments tags: - Simulations /simulations/card_authentications/{card_payment_id}/challenges: post: description: Simulates starting a Card Authentication Challenge for an existing Card Authentication. This updates the `card_authentications` object under the [Card Payment](#card_payments). To attempt the challenge, use the `/simulations/card_authentications/:card_payment_id/challenge_attempts` endpoint or navigate to https://dashboard.increase.com/card_authentication_simulation/:card_payment_id. operationId: sandbox_create_an_initial_card_authentication_challenge parameters: - example: card_payment_nd3k2kacrqjli8482ave in: path name: card_payment_id required: true schema: description: The identifier of the Card Payment to be challenged. type: string x-documentation-priority: default x-id-reference-to: Card Payments responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_payment' description: Card Payment 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create an initial Card Authentication Challenge' x-sandbox-only: true x-tag: Card Payments tags: - Simulations /simulations/card_authorization_expirations: post: description: Simulates expiring a Card Authorization immediately. operationId: sandbox_expire_a_card_authorization parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_expire_a_card_authorization_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_payment' description: Card Payment 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Expire a Card Authorization' x-sandbox-only: true x-tag: Card Payments tags: - Simulations /simulations/card_authorizations: post: description: Simulates a purchase authorization on a [Card](#cards). Depending on the balance available to the card and the `amount` submitted, the authorization activity will result in a [Pending Transaction](#pending-transactions) of type `card_authorization` or a [Declined Transaction](#declined-transactions) of type `card_decline`. You can pass either a Card id or a [Digital Wallet Token](#digital-wallet-tokens) id to simulate the two different ways purchases can be made. operationId: sandbox_create_a_card_authorization parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_a_card_authorization_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/inbound_card_authorization_simulation_result' description: Inbound Card Authorization Simulation Result 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create a Card Authorization' x-sandbox-only: true x-tag: Card Payments tags: - Simulations /simulations/card_balance_inquiries: post: description: Simulates a balance inquiry on a [Card](#cards). operationId: sandbox_create_a_card_balance_inquiry parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_a_card_balance_inquiry_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_payment' description: Card Payment 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create a Card Balance Inquiry' x-sandbox-only: true x-tag: Card Payments tags: - Simulations /simulations/card_disputes/{card_dispute_id}/action: post: description: After a [Card Dispute](#card-disputes) is created in production, the dispute will initially be in a `pending_user_submission_reviewing` state. Since no review or further action happens in sandbox, this endpoint simulates moving a Card Dispute through its various states. operationId: sandbox_advance_the_state_of_a_card_dispute parameters: - example: card_dispute_h9sc95nbl1cgltpp7men in: path name: card_dispute_id required: true schema: description: The dispute you would like to action. type: string x-documentation-priority: default x-id-reference-to: Card Disputes requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_advance_the_state_of_a_card_dispute_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_dispute' description: Card Dispute 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Advance the state of a Card Dispute' x-sandbox-only: true x-tag: Card Disputes tags: - Simulations /simulations/card_fuel_confirmations: post: description: Simulates the fuel confirmation of an authorization by a card acquirer. This happens asynchronously right after a fuel pump transaction is completed. A fuel confirmation can only happen once per authorization. operationId: sandbox_confirm_the_fuel_pump_amount_for_a_card_authorization parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_confirm_the_fuel_pump_amount_for_a_card_authorization_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_payment' description: Card Payment 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Confirm the fuel pump amount for a Card Authorization' x-sandbox-only: true x-tag: Card Payments tags: - Simulations /simulations/card_increments: post: description: Simulates the increment of an authorization by a card acquirer. An authorization can be incremented multiple times. operationId: sandbox_increment_a_card_authorization parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_increment_a_card_authorization_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_payment' description: Card Payment 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Increment a Card Authorization' x-sandbox-only: true x-tag: Card Payments tags: - Simulations /simulations/card_purchase_supplements: post: description: Simulates the creation of a Card Purchase Supplement (Level 3 data) for a card settlement. This happens asynchronously in production when Visa sends enhanced transaction data about a purchase. operationId: sandbox_create_a_card_purchase_supplement parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_a_card_purchase_supplement_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_purchase_supplement' description: Card Purchase Supplement 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create a Card Purchase Supplement' x-sandbox-only: true x-tag: Card Purchase Supplements tags: - Simulations /simulations/card_refunds: post: description: Simulates refunding a card transaction. The full value of the original sandbox transaction is refunded. operationId: sandbox_refund_a_card_transaction parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_refund_a_card_transaction_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/transaction' description: Transaction 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Refund a card transaction' x-sandbox-only: true x-tag: Card Payments tags: - Simulations /simulations/card_reversals: post: description: Simulates the reversal of an authorization by a card acquirer. An authorization can be partially reversed multiple times, up until the total authorized amount. Marks the pending transaction as complete if the authorization is fully reversed. operationId: sandbox_reverse_a_card_authorization parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_reverse_a_card_authorization_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_payment' description: Card Payment 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Reverse a Card Authorization' x-sandbox-only: true x-tag: Card Payments tags: - Simulations /simulations/card_settlements: post: description: Simulates the settlement of an authorization by a card acquirer. After a card authorization is created, the merchant will eventually send a settlement. This simulates that event, which may occur many days after the purchase in production. The amount settled can be different from the amount originally authorized, for example, when adding a tip to a restaurant bill. operationId: sandbox_settle_a_card_authorization parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_settle_a_card_authorization_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/transaction' description: Transaction 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Settle a Card Authorization' x-sandbox-only: true x-tag: Card Payments tags: - Simulations /simulations/card_tokens: post: description: Simulates tokenizing a card in the sandbox environment. operationId: sandbox_create_a_card_token parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_a_card_token_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/card_token' description: Card Token 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create a Card Token' x-sandbox-only: true x-tag: Card Tokens tags: - Simulations /simulations/check_deposits/{check_deposit_id}/adjustment: post: description: Simulates the creation of a [Check Deposit Adjustment](#check-deposit-adjustments) on a [Check Deposit](#check-deposits). This Check Deposit must first have a `status` of `submitted`. operationId: sandbox_adjust_a_check_deposit parameters: - example: check_deposit_f06n9gpg7sxn8t19lfc1 in: path name: check_deposit_id required: true schema: description: The identifier of the Check Deposit you wish to adjust. type: string x-documentation-priority: default x-id-reference-to: Check Deposits requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_adjust_a_check_deposit_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/check_deposit' description: Check Deposit 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Adjust a Check Deposit' x-sandbox-only: true x-tag: Check Deposits tags: - Simulations /simulations/check_deposits/{check_deposit_id}/reject: post: description: Simulates the rejection of a [Check Deposit](#check-deposits) by Increase due to factors like poor image quality. This Check Deposit must first have a `status` of `pending`. operationId: sandbox_reject_a_check_deposit parameters: - example: check_deposit_f06n9gpg7sxn8t19lfc1 in: path name: check_deposit_id required: true schema: description: The identifier of the Check Deposit you wish to reject. type: string x-documentation-priority: default x-id-reference-to: Check Deposits responses: '200': content: application/json: schema: $ref: '#/components/schemas/check_deposit' description: Check Deposit 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Reject a Check Deposit' x-sandbox-only: true x-tag: Check Deposits tags: - Simulations /simulations/check_deposits/{check_deposit_id}/return: post: description: Simulates the return of a [Check Deposit](#check-deposits). This Check Deposit must first have a `status` of `submitted`. operationId: sandbox_return_a_check_deposit parameters: - example: check_deposit_f06n9gpg7sxn8t19lfc1 in: path name: check_deposit_id required: true schema: description: The identifier of the Check Deposit you wish to return. type: string x-documentation-priority: default x-id-reference-to: Check Deposits responses: '200': content: application/json: schema: $ref: '#/components/schemas/check_deposit' description: Check Deposit 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Return a Check Deposit' x-sandbox-only: true x-tag: Check Deposits tags: - Simulations /simulations/check_deposits/{check_deposit_id}/submit: post: description: Simulates the submission of a [Check Deposit](#check-deposits) to the Federal Reserve. This Check Deposit must first have a `status` of `pending`. operationId: sandbox_submit_a_check_deposit parameters: - example: check_deposit_f06n9gpg7sxn8t19lfc1 in: path name: check_deposit_id required: true schema: description: The identifier of the Check Deposit you wish to submit. type: string x-documentation-priority: default x-id-reference-to: Check Deposits requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_submit_a_check_deposit_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/check_deposit' description: Check Deposit 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Submit a Check Deposit' x-sandbox-only: true x-tag: Check Deposits tags: - Simulations /simulations/check_transfers/{check_transfer_id}/mail: post: description: Simulates the mailing of a [Check Transfer](#check-transfers), which happens periodically throughout the day in production but can be sped up in sandbox. This transfer must first have a `status` of `pending_approval` or `pending_submission`. operationId: sandbox_mail_a_check_transfer parameters: - example: check_transfer_30b43acfu9vw8fyc4f5 in: path name: check_transfer_id required: true schema: description: The identifier of the Check Transfer you wish to mail. type: string x-documentation-priority: default x-id-reference-to: Check Transfers responses: '200': content: application/json: schema: $ref: '#/components/schemas/check_transfer' description: Check Transfer 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Mail a Check Transfer' x-sandbox-only: true x-tag: Check Transfers tags: - Simulations /simulations/digital_wallet_token_requests: post: description: Simulates a user attempting to add a [Card](#cards) to a digital wallet such as Apple Pay. operationId: sandbox_create_a_digital_wallet_token_request parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_a_digital_wallet_token_request_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/inbound_digital_wallet_token_request_simulation_result' description: Inbound Digital Wallet Token Request Simulation Result 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create a digital wallet token request' x-sandbox-only: true x-tag: Digital Wallet Tokens tags: - Simulations /simulations/entities/{entity_id}/update_validation: post: description: Simulate updates to an [Entity's validation](/documentation/api/entities#entity-object.validation). In production, Know Your Customer validations [run automatically](/documentation/entity-validation#entity-validation) for eligible programs. While developing, use this API to simulate issues with information submissions. operationId: sandbox_simulate_validation_of_an_entity parameters: - example: entity_n8y8tnk2p9339ti393yi in: path name: entity_id required: true schema: description: The identifier of the Entity whose validation status to update. type: string x-documentation-priority: default x-id-reference-to: Entities requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_simulate_validation_of_an_entity_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/entity' description: Entity 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Simulate validation of an Entity' x-sandbox-only: true x-tag: Entities tags: - Simulations /simulations/entity_onboarding_sessions/{entity_onboarding_session_id}/submit: post: description: Simulates the submission of an [Entity Onboarding Session](#entity-onboarding-sessions). This session must have a `status` of `active`. After submission, the session will transition to `expired` and a new Entity will be created. operationId: sandbox_submit_an_entity_onboarding_session parameters: - example: entity_onboarding_session_wid2ug11fsmvh3k9hymd in: path name: entity_onboarding_session_id required: true schema: description: The identifier of the Entity Onboarding Session you wish to submit. type: string x-documentation-priority: default x-id-reference-to: Entity Onboarding Sessions responses: '200': content: application/json: schema: $ref: '#/components/schemas/entity_onboarding_session' description: Entity Onboarding Session 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Submit an Entity Onboarding Session' x-sandbox-only: true x-tag: Entity Onboarding Sessions tags: - Simulations /simulations/exports: post: description: Many exports are created by you via POST /exports or in the Dashboard. Some exports are created automatically by Increase. For example, tax documents are published once a year. In sandbox, you can trigger the arrival of an export that would normally only be created automatically via this simulation. operationId: sandbox_generate_a_tax_form_export parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_generate_a_tax_form_export_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/export' description: Export 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Generate a Tax Form Export' x-sandbox-only: true x-tag: Exports tags: - Simulations /simulations/inbound_ach_transfers: post: description: Simulates an inbound ACH transfer to your account. This imitates initiating a transfer to an Increase account from a different financial institution. The transfer may be either a credit or a debit depending on if the `amount` is positive or negative. The result of calling this API will contain the created transfer. You can pass a `resolve_at` parameter to allow for a window to [action on the Inbound ACH Transfer](https://increase.com/documentation/receiving-ach-transfers). Alternatively, if you don't pass the `resolve_at` parameter the result will contain either a [Transaction](#transactions) or a [Declined Transaction](#declined-transactions) depending on whether or not the transfer is allowed. operationId: sandbox_create_an_inbound_ach_transfer parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_an_inbound_ach_transfer_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/inbound_ach_transfer' description: Inbound ACH Transfer 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create an Inbound ACH Transfer' x-sandbox-only: true x-tag: Inbound ACH Transfers tags: - Simulations /simulations/inbound_check_deposits: post: description: Simulates an Inbound Check Deposit against your account. This imitates someone depositing a check at their bank that was issued from your account. It may or may not be associated with a Check Transfer. Increase will evaluate the Inbound Check Deposit as we would in production and either create a Transaction or a Declined Transaction as a result. You can inspect the resulting Inbound Check Deposit object to see the result. operationId: sandbox_create_an_inbound_check_deposit parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_an_inbound_check_deposit_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/inbound_check_deposit' description: Inbound Check Deposit 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create an Inbound Check Deposit' x-sandbox-only: true x-tag: Inbound Check Deposits tags: - Simulations /simulations/inbound_check_deposits/{inbound_check_deposit_id}/adjustment: post: description: Simulates an adjustment on an Inbound Check Deposit. The Inbound Check Deposit must have a `status` of `accepted`. operationId: sandbox_create_an_inbound_check_deposit_adjustment parameters: - example: inbound_check_deposit_zoshvqybq0cjjm31mra in: path name: inbound_check_deposit_id required: true schema: description: The identifier of the Inbound Check Deposit to adjust. type: string x-documentation-priority: default x-id-reference-to: Inbound Check Deposits requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_an_inbound_check_deposit_adjustment_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/inbound_check_deposit' description: Inbound Check Deposit 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create an Inbound Check Deposit Adjustment' x-sandbox-only: true x-tag: Inbound Check Deposits tags: - Simulations /simulations/inbound_fednow_transfers: post: description: Simulates an [Inbound FedNow Transfer](#inbound-fednow-transfers) to your account. operationId: sandbox_create_an_inbound_fednow_transfer parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_an_inbound_fednow_transfer_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/inbound_fednow_transfer' description: Inbound FedNow Transfer 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create an Inbound FedNow Transfer' x-sandbox-only: true x-tag: Inbound FedNow Transfers tags: - Simulations /simulations/inbound_mail_items: post: description: Simulates an Inbound Mail Item to one of your Lockbox Addresses or Lockbox Recipients, as if someone had mailed a physical check. operationId: sandbox_create_an_inbound_mail_item parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_an_inbound_mail_item_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/inbound_mail_item' description: Inbound Mail Item 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create an Inbound Mail Item' x-sandbox-only: true x-tag: Inbound Mail Items tags: - Simulations /simulations/inbound_real_time_payments_transfers: post: description: Simulates an [Inbound Real-Time Payments Transfer](#inbound-real-time-payments-transfers) to your account. Real-Time Payments are a beta feature. operationId: sandbox_create_an_inbound_real_time_payments_transfer parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_an_inbound_real_time_payments_transfer_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/inbound_real_time_payments_transfer' description: Inbound Real-Time Payments Transfer 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create an Inbound Real-Time Payments Transfer' x-sandbox-only: true x-tag: Inbound Real-Time Payments Transfers tags: - Simulations /simulations/inbound_wire_drawdown_requests: post: description: Simulates receiving an [Inbound Wire Drawdown Request](#inbound-wire-drawdown-requests). operationId: sandbox_create_an_inbound_wire_drawdown_request parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_an_inbound_wire_drawdown_request_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/inbound_wire_drawdown_request' description: Inbound Wire Drawdown Request 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create an Inbound Wire Drawdown request' x-sandbox-only: true x-tag: Inbound Wire Drawdown Requests tags: - Simulations /simulations/inbound_wire_transfers: post: description: Simulates an [Inbound Wire Transfer](#inbound-wire-transfers) to your account. operationId: sandbox_create_an_inbound_wire_transfer parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_an_inbound_wire_transfer_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/inbound_wire_transfer' description: Inbound Wire Transfer 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create an Inbound Wire Transfer' x-sandbox-only: true x-tag: Inbound Wire Transfers tags: - Simulations /simulations/interest_payments: post: description: Simulates an interest payment to your account. In production, this happens automatically on the first of each month. operationId: sandbox_create_an_interest_payment parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_an_interest_payment_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/transaction' description: Transaction 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create an interest payment' x-returns-example: account_id: account_in71c4amph0vgo2qllky amount: 100 created_at: '2020-01-31T23:59:59Z' currency: USD description: Interest payment for 2025-06 id: transaction_uyrp7fld2ium70oa7oi route_id: null route_type: null source: category: interest_payment interest_payment: 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' type: transaction x-sandbox-only: true x-tag: Accounts tags: - Simulations /simulations/pending_transactions/{pending_transaction_id}/release_inbound_funds_hold: post: description: This endpoint simulates immediately releasing an Inbound Funds Hold, which might be created as a result of, for example, an ACH debit. operationId: sandbox_release_an_inbound_funds_hold parameters: - example: pending_transaction_k1sfetcau2qbvjbzgju4 in: path name: pending_transaction_id required: true schema: description: The pending transaction to release. The pending transaction must have a `inbound_funds_hold` source. type: string x-documentation-priority: default x-id-reference-to: Pending Transactions responses: '200': content: application/json: schema: $ref: '#/components/schemas/pending_transaction' description: Pending Transaction 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Release an Inbound Funds Hold' x-sandbox-only: true x-tag: Pending Transactions tags: - Simulations /simulations/physical_cards/{physical_card_id}/advance_shipment: post: description: This endpoint allows you to simulate advancing the shipment status of a Physical Card, to simulate e.g., that a physical card was attempted shipped but then failed delivery. operationId: sandbox_advance_the_shipment_status_of_a_physical_card parameters: - example: physical_card_ode8duyq5v2ynhjoharl in: path name: physical_card_id required: true schema: description: The Physical Card you would like to action. type: string x-documentation-priority: default x-id-reference-to: Physical Cards requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_advance_the_shipment_status_of_a_physical_card_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/physical_card' description: Physical Card 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Advance the shipment status of a Physical Card' x-sandbox-only: true x-tag: Physical Cards tags: - Simulations /simulations/physical_cards/{physical_card_id}/tracking_updates: post: description: This endpoint allows you to simulate receiving a tracking update for a Physical Card, to simulate the progress of a shipment. operationId: sandbox_create_a_physical_card_shipment_tracking_update parameters: - example: physical_card_ode8duyq5v2ynhjoharl in: path name: physical_card_id required: true schema: description: The Physical Card you would like to action. type: string x-documentation-priority: default x-id-reference-to: Physical Cards requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_a_physical_card_shipment_tracking_update_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/physical_card' description: Physical Card 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create a Physical Card Shipment Tracking Update' x-sandbox-only: true x-tag: Physical Cards tags: - Simulations /simulations/programs: post: description: Simulates a [Program](#programs) being created in your group. By default, your group has one program called Commercial Banking. Note that when your group operates more than one program, `program_id` is a required field when creating accounts. operationId: sandbox_create_a_program parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_create_a_program_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/program' description: Program 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Create a Program' x-sandbox-only: true x-tag: Programs tags: - Simulations /simulations/real_time_payments_transfers/{real_time_payments_transfer_id}/complete: post: description: Simulates submission of a [Real-Time Payments Transfer](#real-time-payments-transfers) and handling the response from the destination financial institution. This transfer must first have a `status` of `pending_submission`. operationId: sandbox_complete_a_real_time_payments_transfer parameters: - example: real_time_payments_transfer_iyuhl5kdn7ssmup83mvq in: path name: real_time_payments_transfer_id required: true schema: description: The identifier of the Real-Time Payments Transfer you wish to complete. type: string x-documentation-priority: default x-id-reference-to: Real-Time Payments Transfers requestBody: content: application/json: schema: $ref: '#/components/schemas/sandbox_complete_a_real_time_payments_transfer_parameters' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/real_time_payments_transfer' description: Real-Time Payments Transfer 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Complete a Real-Time Payments Transfer' x-sandbox-only: true x-tag: Real-Time Payments Transfers tags: - Simulations /simulations/wire_drawdown_requests/{wire_drawdown_request_id}/refuse: post: description: Simulates a Wire Drawdown Request being refused by the debtor. operationId: sandbox_refuse_a_wire_drawdown_request parameters: - example: wire_drawdown_request_q6lmocus3glo0lr2bfv3 in: path name: wire_drawdown_request_id required: true schema: description: The identifier of the Wire Drawdown Request you wish to refuse. type: string x-documentation-priority: default x-id-reference-to: Wire Drawdown Requests responses: '200': content: application/json: schema: $ref: '#/components/schemas/wire_drawdown_request' description: Wire Drawdown Request 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Refuse a Wire Drawdown Request' x-sandbox-only: true x-tag: Wire Drawdown Requests tags: - Simulations /simulations/wire_drawdown_requests/{wire_drawdown_request_id}/submit: post: description: Simulates a Wire Drawdown Request being submitted to Fedwire. operationId: sandbox_submit_a_wire_drawdown_request parameters: - example: wire_drawdown_request_q6lmocus3glo0lr2bfv3 in: path name: wire_drawdown_request_id required: true schema: description: The identifier of the Wire Drawdown Request you wish to submit. type: string x-documentation-priority: default x-id-reference-to: Wire Drawdown Requests responses: '200': content: application/json: schema: $ref: '#/components/schemas/wire_drawdown_request' description: Wire Drawdown Request 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Submit a Wire Drawdown Request' x-sandbox-only: true x-tag: Wire Drawdown Requests tags: - Simulations /simulations/wire_transfers/{wire_transfer_id}/reverse: post: description: Simulates the reversal of a [Wire Transfer](#wire-transfers) by the Federal Reserve due to error conditions. This will also create a [Transaction](#transaction) to account for the returned funds. This Wire Transfer must first have a `status` of `complete`. operationId: sandbox_reverse_a_wire_transfer parameters: - example: wire_transfer_5akynk7dqsq25qwk9q2u in: path name: wire_transfer_id required: true schema: description: The identifier of the Wire Transfer you wish to reverse. type: string x-documentation-priority: default x-id-reference-to: Wire Transfers responses: '200': content: application/json: schema: $ref: '#/components/schemas/wire_transfer' description: Wire Transfer 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Reverse a Wire Transfer' x-sandbox-only: true x-tag: Wire Transfers tags: - Simulations /simulations/wire_transfers/{wire_transfer_id}/submit: post: description: Simulates the submission of a [Wire Transfer](#wire-transfers) to the Federal Reserve. This transfer must first have a `status` of `pending_approval` or `pending_creating`. operationId: sandbox_submit_a_wire_transfer parameters: - example: wire_transfer_5akynk7dqsq25qwk9q2u in: path name: wire_transfer_id required: true schema: description: The identifier of the Wire Transfer you wish to submit. type: string x-documentation-priority: default x-id-reference-to: Wire Transfers responses: '200': content: application/json: schema: $ref: '#/components/schemas/wire_transfer' description: Wire Transfer 4XX: $ref: '#/components/responses/errorResponse' 5XX: $ref: '#/components/responses/errorResponse' summary: 'Sandbox: Submit a Wire Transfer' x-sandbox-only: true x-tag: Wire Transfers tags: - Simulations components: schemas: check_deposit: additionalProperties: true description: Check Deposits allow you to deposit images of paper checks into your account. example: account_id: account_in71c4amph0vgo2qllky amount: 1000 back_image_file_id: file_26khfk98mzfz90a11oqx created_at: '2020-01-31T23:59:59Z' deposit_acceptance: account_number: '987654321' amount: 1000 auxiliary_on_us: '101' check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1 currency: USD routing_number: '101050001' serial_number: null deposit_adjustments: [] deposit_rejection: null deposit_return: null deposit_submission: back_file_id: file_frhw4s443nh7noss55kq front_file_id: file_j7ed9mrve741m6yui9ju submitted_at: '2020-02-01T00:59:59+00:00' description: null front_image_file_id: file_makxrc67oh9l6sg7w9yc id: check_deposit_f06n9gpg7sxn8t19lfc1 idempotency_key: null inbound_funds_hold: null inbound_mail_item_id: null lockbox_recipient_id: null status: submitted transaction_id: transaction_uyrp7fld2ium70oa7oi type: check_deposit properties: account_id: description: The Account the check was deposited into. type: string x-documentation-priority: default x-id-reference-to: Accounts amount: description: The deposited amount in USD cents. type: integer x-documentation-priority: default back_image_file_id: anyOf: - description: The ID for the File containing the image of the back of the check. type: string x-documentation-priority: default x-id-reference-to: Files - type: 'null' 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 deposit_acceptance: anyOf: - additionalProperties: true description: Once your deposit is successfully parsed and accepted by Increase, this will contain details of the parsed check. 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: Check Deposit 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' deposit_adjustments: description: If the deposit or the return was adjusted by the receiving institution, this will contain details of the adjustments. items: additionalProperties: false example: adjusted_at: '2020-01-31T23:59:59Z' amount: 1750 reason: late_return transaction_id: transaction_uyrp7fld2ium70oa7oi properties: adjusted_at: description: The time at which the adjustment was received. format: date-time type: string x-documentation-priority: default amount: description: The amount of the adjustment. type: integer x-documentation-priority: default reason: description: The reason for the adjustment. enum: - adjusted_amount - non_conforming_item - paid type: string x-documentation-priority: default x-enum-descriptions: - 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. transaction_id: description: The id of the transaction for the adjustment. type: string x-documentation-priority: default x-id-reference-to: Transactions required: - adjusted_at - transaction_id - reason - amount title: Check Deposit Check Deposit Adjustment type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Check Deposit Adjustments type: array x-documentation-priority: default deposit_rejection: anyOf: - additionalProperties: true description: If your deposit is rejected by Increase, this will contain details as to why it was rejected. example: amount: 1750 check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1 currency: USD declined_transaction_id: declined_transaction_17jbn0yyhvkt4v4ooym8 reason: incomplete_image rejected_at: '2020-01-31T23:59:59Z' properties: amount: description: The rejected amount in the minor unit of check's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default check_deposit_id: description: The identifier of the Check Deposit that was rejected. type: string x-documentation-priority: default x-id-reference-to: Check Deposits currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) declined_transaction_id: description: The identifier of the associated declined transaction. type: string x-documentation-priority: default x-id-reference-to: Declined Transactions reason: description: Why the check deposit was rejected. enum: - incomplete_image - duplicate - poor_image_quality - incorrect_amount - incorrect_recipient - not_eligible_for_mobile_deposit - missing_required_data_elements - suspected_fraud - deposit_window_expired - requested_by_user - international - unknown type: string x-documentation-priority: default x-enum-descriptions: - The check's image is incomplete. - This is a duplicate check submission. - This check has poor image quality. - The check was deposited with the incorrect amount. - The check is made out to someone other than the account holder. - This check was not eligible for mobile deposit. - This check is missing at least one required field. - This check is suspected to be fraudulent. - This check's deposit window has expired. - The check was rejected at the user's request. - The check is not a U.S. domestic check and cannot be processed. - The check was rejected for an unknown reason. rejected_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was rejected. format: date-time type: string x-documentation-priority: default required: - check_deposit_id - declined_transaction_id - amount - currency - reason - rejected_at title: Check Deposit Check Deposit Rejection type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Check Deposit Rejections - type: 'null' deposit_return: anyOf: - additionalProperties: true description: If your deposit is returned, this will contain details as to why it was returned. 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: Check Deposit 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' deposit_submission: anyOf: - additionalProperties: false description: After the check is parsed, it is submitted to the Check21 network for processing. This will contain details of the submission. example: back_file_id: file_frhw4s443nh7noss55kq front_file_id: file_j7ed9mrve741m6yui9ju submitted_at: '2020-02-01T00:59:59+00:00' properties: back_file_id: description: The ID for the File containing the check back image that was submitted to the Check21 network. type: string x-documentation-priority: default x-id-reference-to: Files front_file_id: description: The ID for the File containing the check front image that was submitted to the Check21 network. type: string x-documentation-priority: default x-id-reference-to: Files submitted_at: description: When the check deposit was submitted to the Check21 network for processing. During business days, this happens within a few hours of the check being accepted by Increase. format: date-time type: string x-documentation-priority: default required: - submitted_at - front_file_id - back_file_id title: Check Deposit Check Deposit Submission type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Check Deposit Submissions - type: 'null' description: anyOf: - description: The description of the Check Deposit, for display purposes only. type: string x-documentation-priority: default - type: 'null' front_image_file_id: description: The ID for the File containing the image of the front of the check. type: string x-documentation-priority: default x-id-reference-to: Files id: description: The deposit's identifier. type: string x-documentation-priority: default x-id-reference-to: Check Deposits idempotency_key: anyOf: - description: The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys). type: string x-documentation-priority: default - type: 'null' inbound_funds_hold: anyOf: - $ref: '#/components/schemas/inbound_funds_hold' description: Increase will sometimes hold the funds for Check Deposits. If funds are held, this sub-object will contain details of the hold. x-documentation-priority: default - type: 'null' inbound_mail_item_id: anyOf: - description: If the Check Deposit was the result of an Inbound Mail Item, this will contain the identifier of the Inbound Mail Item. type: string x-documentation-priority: default x-id-reference-to: Inbound Mail Items - type: 'null' lockbox_recipient_id: anyOf: - description: If the Check Deposit was the result of an Inbound Mail Item routed to a Lockbox Recipient, this will contain the identifier of the Lockbox Recipient that received it. type: string x-documentation-priority: default x-id-reference-to: Lockbox Recipients - type: 'null' status: description: The status of the Check Deposit. enum: - pending - submitted - rejected - returned type: string x-documentation-priority: default x-enum-descriptions: - The Check Deposit is pending review. - The Check Deposit has been deposited. - The Check Deposit has been rejected. - The Check Deposit has been returned. transaction_id: anyOf: - description: The ID for the Transaction created by the deposit. type: string x-documentation-priority: default x-id-reference-to: Transactions - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `check_deposit`. enum: - check_deposit type: string x-documentation-priority: default required: - type - id - amount - description - created_at - status - account_id - front_image_file_id - back_image_file_id - transaction_id - deposit_acceptance - deposit_submission - deposit_rejection - deposit_return - inbound_funds_hold - inbound_mail_item_id - lockbox_recipient_id - deposit_adjustments - idempotency_key title: Check Deposit type: object x-event-categories: - check_deposit.created - check_deposit.updated x-stainless-empty-object: false x-tag: Check Deposits x-title-plural: Check Deposits card_token: additionalProperties: false description: Card Tokens represent a tokenized card number that can be used for Card Push Transfers and Card Validations. example: created_at: '2020-01-31T23:59:59Z' expiration_date: '2020-01-31' id: outbound_card_token_zlt0ml6youq3q7vcdlg0 last4: '1234' length: 16 prefix: '46637100' type: card_token properties: created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the card token was created. format: date-time type: string x-documentation-priority: default expiration_date: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date when the card expires. format: date type: string x-documentation-priority: default id: description: The Card Token's identifier. type: string x-documentation-priority: default x-id-reference-to: Card Tokens last4: description: The last 4 digits of the card number. type: string x-documentation-priority: default length: description: The length of the card number. type: integer x-documentation-priority: default prefix: description: The prefix of the card number, usually 8 digits. type: string x-documentation-priority: default type: description: A constant representing the object's type. For this resource it will always be `card_token`. enum: - card_token type: string x-documentation-priority: default required: - type - id - created_at - prefix - last4 - length - expiration_date title: Card Token type: object x-event-categories: [] x-stainless-empty-object: false x-tag: Card Tokens x-title-plural: Card Tokens inbound_card_validation: additionalProperties: true description: Inbound Card Validations are requests from a merchant to verify that a card number and optionally its address and/or Card Verification Value are valid. 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 card_payment_id: card_payment_nd3k2kacrqjli8482ave currency: USD digital_wallet_token_id: null id: card_validation_yi4e59jiaz6n9hx8tczv 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 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 type: inbound_card_validation verification: card_verification_code: result: match cardholder_address: actual_line1: 33 Liberty Street actual_postal_code: '94131' provided_line1: 33 Liberty Street provided_postal_code: '94132' result: postal_code_no_match_address_match cardholder_name: null properties: actioner: description: Whether this authorization was approved by Increase, the card network through stand-in processing, or the user through a real-time decision. enum: - user - increase - network type: string x-documentation-priority: default x-enum-descriptions: - This object was actioned by the user through a real-time decision. - This object was actioned by Increase without user intervention. - This object was actioned by the network, through stand-in processing. additional_amounts: additionalProperties: false description: Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction. properties: clinic: anyOf: - additionalProperties: false description: The part of this transaction amount that was for clinic-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Inbound Card Validation 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: Inbound Card Validation 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: Inbound Card Validation 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: Inbound Card Validation 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: Inbound Card Validation 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: Inbound Card Validation 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: Inbound Card Validation 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: Inbound Card Validation 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: Inbound Card Validation 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: Inbound Card Validation 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: Inbound Card Validation AdditionalAmounts type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s 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' id: description: The Card Validation identifier. type: string x-documentation-priority: default x-id-reference-to: Inbound Card Validations 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: Inbound Card Validation 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: Inbound Card Validation 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: Inbound Card Validation 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: Inbound Card Validation 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' 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 validation. 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: Inbound Card Validation 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' type: description: A constant representing the object's type. For this resource it will always be `inbound_card_validation`. enum: - inbound_card_validation 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: Inbound Card Validation 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: Inbound Card Validation 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: Inbound Card Validation 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: Inbound Card Validation 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 - currency - real_time_decision_id - actioner - scheme_fees title: Inbound Card Validation type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound Card Validations card_dispute_file_attachment: additionalProperties: false properties: file_id: description: The ID of the file attached to the Card Dispute. type: string x-documentation-priority: default x-id-reference-to: Files required: - file_id title: Card Dispute File Attachment type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Dispute File Attachments export: additionalProperties: true description: Exports are generated files. Some exports can contain a lot of data, like a CSV of your transactions. Others can be a single document, like a tax form. Since they can take a while, they are generated asynchronously. We send a webhook when they are ready. For more information, please read our [Exports documentation](https://increase.com/documentation/exports). example: account_statement_bai2: null account_statement_ofx: null account_verification_letter: null balance_csv: null bookkeeping_account_balance_csv: null category: transaction_csv created_at: '2020-01-31T23:59:59Z' daily_account_balance_csv: null dashboard_table_csv: null entity_csv: null fee_csv: null form_1099_int: null form_1099_misc: null funding_instructions: null id: export_8s4m48qz3bclzje0zwh9 idempotency_key: null result: file_id: file_makxrc67oh9l6sg7w9yc status: complete transaction_csv: account_id: account_in71c4amph0vgo2qllky created_at: null type: export vendor_csv: null voided_check: null properties: account_statement_bai2: anyOf: - additionalProperties: false description: Details of the account statement BAI2 export. This field will be present when the `category` is equal to `account_statement_bai2`. properties: account_id: anyOf: - description: Filter results by Account. type: string x-documentation-priority: default x-id-reference-to: Accounts - type: 'null' effective_date: anyOf: - description: The date for which to retrieve the balance. format: date type: string x-documentation-priority: default - type: 'null' program_id: anyOf: - description: Filter results by Program. type: string x-documentation-priority: default x-id-reference-to: Programs - type: 'null' required: - account_id - program_id - effective_date title: Export AccountStatementBAI2 type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' account_statement_ofx: anyOf: - additionalProperties: false description: Details of the account statement OFX export. This field will be present when the `category` is equal to `account_statement_ofx`. properties: account_id: description: The Account to create a statement for. type: string x-documentation-priority: default x-id-reference-to: Accounts created_at: anyOf: - additionalProperties: false description: Filter transactions by their created date. properties: before: anyOf: - description: Filter results to transactions created before this time. format: date-time type: string x-documentation-priority: default - type: 'null' on_or_after: anyOf: - description: Filter results to transactions created on or after this time. format: date-time type: string x-documentation-priority: default - type: 'null' required: - before - on_or_after title: Export AccountStatementOFX CreatedAt type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CreatedAts - type: 'null' required: - account_id - created_at title: Export AccountStatementOFX type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' account_verification_letter: anyOf: - additionalProperties: false description: Details of the account verification letter export. This field will be present when the `category` is equal to `account_verification_letter`. properties: account_number_id: description: The Account Number to create a letter for. type: string x-documentation-priority: default x-id-reference-to: Account Numbers balance_date: anyOf: - description: The date of the balance to include in the letter. format: date type: string x-documentation-priority: default - type: 'null' required: - account_number_id - balance_date title: Export AccountVerificationLetter type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' balance_csv: anyOf: - additionalProperties: false description: Details of the balance CSV export. This field will be present when the `category` is equal to `balance_csv`. properties: account_id: anyOf: - description: Filter results by Account. type: string x-documentation-priority: default x-id-reference-to: Accounts - type: 'null' created_at: anyOf: - additionalProperties: false description: Filter balances by their created date. properties: after: anyOf: - description: Filter balances created after this time. format: date-time type: string x-documentation-priority: default - type: 'null' before: anyOf: - description: Filter balances created before this time. format: date-time type: string x-documentation-priority: default - type: 'null' required: - after - before title: Export BalanceCSV CreatedAt type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CreatedAts - type: 'null' required: - account_id - created_at title: Export BalanceCSV type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' bookkeeping_account_balance_csv: anyOf: - additionalProperties: false description: Details of the bookkeeping account balance CSV export. This field will be present when the `category` is equal to `bookkeeping_account_balance_csv`. properties: bookkeeping_account_id: anyOf: - description: Filter results by Bookkeeping Account. type: string x-documentation-priority: default - type: 'null' on_or_after_date: anyOf: - description: Filter balances to those on or after this date. format: date type: string x-documentation-priority: default - type: 'null' on_or_before_date: anyOf: - description: Filter balances to those on or before this date. format: date type: string x-documentation-priority: default - type: 'null' required: - bookkeeping_account_id - on_or_before_date - on_or_after_date title: Export BookkeepingAccountBalanceCSV type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' category: description: The category of the Export. We may add additional possible values for this enum over time; your application should be able to handle that gracefully. enum: - account_statement_ofx - account_statement_bai2 - transaction_csv - balance_csv - bookkeeping_account_balance_csv - entity_csv - vendor_csv - dashboard_table_csv - account_verification_letter - funding_instructions - form_1099_int - form_1099_misc - fee_csv - voided_check - daily_account_balance_csv type: string x-documentation-priority: default x-enum-descriptions: - Export an Open Financial Exchange (OFX) file of transactions and balances for a given time range and Account. - Export a BAI2 file of transactions and balances for a given date and optional Account. - Export a CSV of all transactions for a given time range. - Export a CSV of account balances for the dates in a given range. (deprecated, use `daily_account_balance_csv` instead) - Export a CSV of bookkeeping account balances for the dates in a given range. - Export a CSV of entities with a given status. - Export a CSV of vendors added to the third-party risk management dashboard. - Certain dashboard tables are available as CSV exports. This export cannot be created via the API. - A PDF of an account verification letter. - A PDF of funding instructions. - A PDF of an Internal Revenue Service Form 1099-INT. - A PDF of an Internal Revenue Service Form 1099-MISC. - Export a CSV of fees. The time range must not include any fees that are part of an open fee statement. - A PDF of a voided check. - Export a CSV of daily account balances with starting and ending balances for a given date range. created_at: description: The time the Export was created. format: date-time type: string x-documentation-priority: default daily_account_balance_csv: anyOf: - additionalProperties: false description: Details of the daily account balance CSV export. This field will be present when the `category` is equal to `daily_account_balance_csv`. properties: account_id: anyOf: - description: Filter results by Account. type: string x-documentation-priority: default x-id-reference-to: Accounts - type: 'null' on_or_after_date: anyOf: - description: Filter balances on or after this date. format: date type: string x-documentation-priority: default - type: 'null' on_or_before_date: anyOf: - description: Filter balances on or before this date. format: date type: string x-documentation-priority: default - type: 'null' required: - account_id - on_or_after_date - on_or_before_date title: Export DailyAccountBalanceCSV type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' dashboard_table_csv: anyOf: - additionalProperties: false description: Details of the dashboard table CSV export. This field will be present when the `category` is equal to `dashboard_table_csv`. properties: {} title: Export DashboardTableCSV type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: s - type: 'null' entity_csv: anyOf: - additionalProperties: false description: Details of the entity CSV export. This field will be present when the `category` is equal to `entity_csv`. properties: {} title: Export EntityCSV type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: s - type: 'null' fee_csv: anyOf: - additionalProperties: false description: Details of the fee CSV export. This field will be present when the `category` is equal to `fee_csv`. properties: created_at: anyOf: - additionalProperties: false description: Filter fees by their created date. The time range must not include any fees that are part of an open fee statement. properties: after: anyOf: - description: Filter fees created after this time. format: date-time type: string x-documentation-priority: default - type: 'null' before: anyOf: - description: Filter fees created before this time. format: date-time type: string x-documentation-priority: default - type: 'null' required: - after - before title: Export FeeCSV CreatedAt type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CreatedAts - type: 'null' required: - created_at title: Export FeeCSV type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' form_1099_int: anyOf: - additionalProperties: false description: Details of the Form 1099-INT export. This field will be present when the `category` is equal to `form_1099_int`. properties: account_id: description: The Account the tax form is for. type: string x-documentation-priority: default x-id-reference-to: Accounts corrected: description: Whether the tax form is a corrected form. type: boolean x-documentation-priority: default description: description: A description of the tax form. type: string x-documentation-priority: default year: description: The tax year for the tax form. type: integer x-documentation-priority: default required: - account_id - description - year - corrected title: Export Form1099INT type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' form_1099_misc: anyOf: - additionalProperties: false description: Details of the Form 1099-MISC export. This field will be present when the `category` is equal to `form_1099_misc`. properties: account_id: description: The Account the tax form is for. type: string x-documentation-priority: default x-id-reference-to: Accounts corrected: description: Whether the tax form is a corrected form. type: boolean x-documentation-priority: default year: description: The tax year for the tax form. type: integer x-documentation-priority: default required: - account_id - year - corrected title: Export Form1099Misc type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' funding_instructions: anyOf: - additionalProperties: false description: Details of the funding instructions export. This field will be present when the `category` is equal to `funding_instructions`. properties: account_number_id: description: The Account Number to create funding instructions for. type: string x-documentation-priority: default x-id-reference-to: Account Numbers required: - account_number_id title: Export FundingInstructions type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' id: description: The Export identifier. type: string x-documentation-priority: default x-id-reference-to: Exports idempotency_key: anyOf: - description: The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys). type: string x-documentation-priority: default - type: 'null' result: anyOf: - additionalProperties: false description: The result of the Export. This will be present when the Export's status transitions to `complete`. properties: file_id: description: The File containing the contents of the Export. type: string x-documentation-priority: default x-id-reference-to: Files required: - file_id title: Export Result type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Results - type: 'null' status: description: The status of the Export. enum: - pending - complete - failed type: string x-documentation-priority: default x-enum-descriptions: - Increase is generating the export. - The export has been successfully generated. - The export failed to generate. Increase will reach out to you to resolve the issue. transaction_csv: anyOf: - additionalProperties: false description: Details of the transaction CSV export. This field will be present when the `category` is equal to `transaction_csv`. properties: account_id: anyOf: - description: Filter results by Account. type: string x-documentation-priority: default x-id-reference-to: Accounts - type: 'null' created_at: anyOf: - additionalProperties: false description: Filter transactions by their created date. properties: after: anyOf: - description: Filter transactions created after this time. format: date-time type: string x-documentation-priority: default - type: 'null' before: anyOf: - description: Filter transactions created before this time. format: date-time type: string x-documentation-priority: default - type: 'null' required: - after - before title: Export TransactionCSV CreatedAt type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CreatedAts - type: 'null' required: - account_id - created_at title: Export TransactionCSV type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `export`. enum: - export type: string x-documentation-priority: default vendor_csv: anyOf: - additionalProperties: false description: Details of the vendor CSV export. This field will be present when the `category` is equal to `vendor_csv`. properties: {} title: Export VendorCSV type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: s - type: 'null' voided_check: anyOf: - additionalProperties: false description: Details of the voided check export. This field will be present when the `category` is equal to `voided_check`. properties: account_number_id: description: The Account Number for the voided check. type: string x-documentation-priority: default x-id-reference-to: Account Numbers payer: description: The payer information printed on the check. items: additionalProperties: false properties: line: description: The contents of the line. type: string x-documentation-priority: default required: - line title: Export VoidedCheck PayerElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: PayerElements type: array x-documentation-priority: default required: - account_number_id - payer title: Export VoidedCheck type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' required: - type - id - created_at - category - status - result - account_statement_ofx - account_statement_bai2 - dashboard_table_csv - transaction_csv - balance_csv - bookkeeping_account_balance_csv - entity_csv - vendor_csv - account_verification_letter - funding_instructions - form_1099_int - form_1099_misc - fee_csv - voided_check - daily_account_balance_csv - idempotency_key title: Export type: object x-event-categories: - export.created - export.updated x-stainless-empty-object: false x-tag: Exports x-title-plural: Exports sandbox_reverse_a_card_authorization_parameters: additionalProperties: false example: card_payment_id: card_payment_nd3k2kacrqjli8482ave properties: amount: description: The amount of the reversal in minor units in the card authorization's currency. This defaults to the authorization amount. maximum: 1000000000 minimum: 1 type: integer x-documentation-priority: default card_payment_id: description: The identifier of the Card Payment to create a reversal on. type: string x-documentation-priority: default x-id-reference-to: Card Payments required: - card_payment_id type: object x-event-categories: [] x-stainless-empty-object: false inbound_real_time_payments_transfer: additionalProperties: true description: An Inbound Real-Time Payments Transfer is a Real-Time Payments transfer initiated outside of Increase to your account. example: account_id: account_in71c4amph0vgo2qllky account_number_id: account_number_v18nkfqm6afpsrvy82b2 amount: 100 confirmation: confirmed_at: '2020-01-31T23:59:59Z' transaction_id: transaction_uyrp7fld2ium70oa7oi created_at: '2020-01-31T23:59:59Z' creditor_name: Ian Crease currency: USD debtor_account_number: '987654321' debtor_name: National Phonograph Company debtor_routing_number: '101050001' decline: null id: inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr status: confirmed transaction_identification: 20220501234567891T1BSLZO01745013025 type: inbound_real_time_payments_transfer unstructured_remittance_information: Invoice 29582 properties: account_id: description: The Account to which the transfer was sent. type: string x-documentation-priority: default x-id-reference-to: Accounts account_number_id: description: The identifier of the Account Number to which this transfer was sent. type: string x-documentation-priority: default x-id-reference-to: Account Numbers amount: description: The amount in USD cents. type: integer x-documentation-priority: default confirmation: anyOf: - additionalProperties: false description: If your transfer is confirmed, this will contain details of the confirmation. properties: confirmed_at: description: The time at which the transfer was confirmed. format: date-time type: string x-documentation-priority: default transaction_id: description: The id of the transaction for the confirmed transfer. type: string x-documentation-priority: default x-id-reference-to: Transactions required: - confirmed_at - transaction_id title: Inbound Real-Time Payments Transfer Confirmation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Confirmations - type: 'null' 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 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 decline: anyOf: - additionalProperties: false description: If your transfer is declined, this will contain details of the decline. properties: declined_at: description: The time at which the transfer was declined. format: date-time type: string x-documentation-priority: default declined_transaction_id: description: The id of the transaction for the declined transfer. type: string x-documentation-priority: default x-id-reference-to: Declined Transactions reason: description: The reason for the transfer decline. enum: - account_number_canceled - account_number_disabled - account_restricted - group_locked - entity_not_active - real_time_payments_not_enabled type: string x-documentation-priority: default x-enum-descriptions: - The account number is canceled. - The account number is disabled. - Your account is restricted. - Your account is inactive. - The account's entity is not active. - Your account is not enabled to receive Real-Time Payments transfers. required: - reason - declined_at - declined_transaction_id title: Inbound Real-Time Payments Transfer Decline type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Declines - type: 'null' id: description: The inbound Real-Time Payments transfer's identifier. type: string x-documentation-priority: default x-id-reference-to: Inbound Real-Time Payments Transfers status: description: The lifecycle status of the transfer. enum: - pending_confirming - timed_out - confirmed - declined type: string x-documentation-priority: default x-enum-descriptions: - The transfer is pending confirmation. - The transfer was not responded to in time. - The transfer has been received successfully and is confirmed. - The transfer has been declined. transaction_identification: description: The Real-Time Payments network identification of the transfer. type: string x-documentation-priority: default type: description: A constant representing the object's type. For this resource it will always be `inbound_real_time_payments_transfer`. enum: - inbound_real_time_payments_transfer type: string x-documentation-priority: default unstructured_remittance_information: anyOf: - description: Additional information included with the transfer. type: string x-documentation-priority: default - type: 'null' required: - type - id - amount - currency - creditor_name - debtor_name - debtor_account_number - debtor_routing_number - transaction_identification - unstructured_remittance_information - status - account_id - account_number_id - created_at - confirmation - decline title: Inbound Real-Time Payments Transfer type: object x-event-categories: - inbound_real_time_payments_transfer.created - inbound_real_time_payments_transfer.updated x-stainless-empty-object: false x-tag: Inbound Real-Time Payments Transfers x-title-plural: Inbound Real-Time Payments Transfers sandbox_create_an_inbound_ach_transfer_parameters: additionalProperties: false example: account_number_id: account_number_v18nkfqm6afpsrvy82b2 amount: 1000 properties: account_number_id: description: The identifier of the Account Number the inbound ACH Transfer is for. type: string x-documentation-priority: default x-id-reference-to: Account Numbers addenda: additionalProperties: false description: Additional information to include in the transfer. properties: category: description: The type of addenda to simulate being sent with the transfer. enum: - freeform type: string x-documentation-priority: default x-enum-descriptions: - Unstructured `payment_related_information` passed through with the transfer. freeform: additionalProperties: false description: Unstructured `payment_related_information` passed through with the transfer. properties: entries: description: Each entry represents an addendum sent with the transfer. items: additionalProperties: false properties: payment_related_information: description: The payment related information passed in the addendum. maxLength: 80 minLength: 1 pattern: ^[ -~]*$ type: string x-documentation-priority: default required: - payment_related_information type: object x-event-categories: [] x-stainless-empty-object: false type: array x-documentation-priority: default required: - entries type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - category type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false amount: description: The transfer amount in cents. A positive amount originates a credit transfer pushing funds to the receiving account. A negative amount originates a debit transfer pulling funds from the receiving account. type: integer x-documentation-priority: default company_descriptive_date: description: The description of the date of the transfer. maxLength: 6 minLength: 1 pattern: ^[ -~]*$ type: string x-documentation-priority: default company_discretionary_data: description: Data associated with the transfer set by the sender. maxLength: 20 minLength: 1 pattern: ^[ -~]*$ type: string x-documentation-priority: default company_entry_description: description: The description of the transfer set by the sender. maxLength: 10 minLength: 1 pattern: ^[ -~]*$ type: string x-documentation-priority: default company_id: description: The sender's company ID. maxLength: 15 minLength: 1 pattern: ^[ -~]*$ type: string x-documentation-priority: default company_name: description: The name of the sender. maxLength: 16 minLength: 1 pattern: ^[ -~]*$ type: string x-documentation-priority: default receiver_id_number: description: The ID of the receiver of the transfer. maxLength: 200 minLength: 1 type: string x-documentation-priority: default receiver_name: description: The name of the receiver of the transfer. maxLength: 200 minLength: 1 type: string x-documentation-priority: default resolve_at: description: The time at which the transfer should be resolved. If not provided will resolve immediately. format: date-time type: string x-documentation-priority: default standard_entry_class_code: description: The standard entry class code for the transfer. enum: - corporate_credit_or_debit - corporate_trade_exchange - prearranged_payments_and_deposit - internet_initiated - point_of_sale - telephone_initiated - customer_initiated - accounts_receivable - machine_transfer - shared_network_transaction - represented_check - back_office_conversion - point_of_purchase - check_truncation - destroyed_check - international_ach_transaction type: string x-documentation-priority: default x-enum-descriptions: - Corporate Credit and Debit (CCD). - Corporate Trade Exchange (CTX). - Prearranged Payments and Deposits (PPD). - Internet Initiated (WEB). - Point of Sale (POS). - Telephone Initiated (TEL). - Customer Initiated (CIE). - Accounts Receivable (ARC). - Machine Transfer (MTE). - Shared Network Transaction (SHR). - Represented Check (RCK). - Back Office Conversion (BOC). - Point of Purchase (POP). - Check Truncation (TRC). - Destroyed Check (XCK). - International ACH Transaction (IAT). required: - account_number_id - amount type: object x-event-categories: [] x-stainless-empty-object: false card_balance_inquiry: additionalProperties: true description: Card Balance Inquiries are transactions that allow merchants to check the available balance on a card without placing a hold on funds, commonly used when a customer requests their balance at an ATM. example: 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 balance: 100 card_payment_id: card_payment_nd3k2kacrqjli8482ave currency: USD digital_wallet_token_id: null id: card_balance_inquiry_pt06vq4e7qzvv01je0yt 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 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 type: card_balance_inquiry 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: 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 Balance Inquiry 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 Balance Inquiry 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 Balance Inquiry 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 Balance Inquiry 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 Balance Inquiry 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 Balance Inquiry 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 Balance Inquiry 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 Balance Inquiry 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 Balance Inquiry 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 Balance Inquiry 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 Balance Inquiry AdditionalAmounts type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s balance: description: The balance amount in the minor unit of the account'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 account'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' id: description: The Card Balance Inquiry identifier. type: string x-documentation-priority: default x-id-reference-to: Card Balance Inquiries 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 Balance Inquiry 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 Balance Inquiry 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 Balance Inquiry 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 Balance Inquiry 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' 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 balance inquiry. 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 Balance Inquiry 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' type: description: A constant representing the object's type. For this resource it will always be `card_balance_inquiry`. enum: - card_balance_inquiry 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 Balance Inquiry 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 Balance Inquiry 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 Balance Inquiry 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 Balance Inquiry 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 - balance - currency - real_time_decision_id - scheme_fees title: Card Balance Inquiry type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Balance Inquiries sandbox_create_an_inbound_wire_drawdown_request_parameters: additionalProperties: false example: amount: 10000 creditor_account_number: '987654321' creditor_address_line1: 33 Liberty Street creditor_address_line2: New York, NY, 10045 creditor_name: Ian Crease creditor_routing_number: '101050001' currency: USD debtor_account_number: '987654321' debtor_address_line1: 33 Liberty Street debtor_address_line2: New York, NY, 10045 debtor_name: Ian Crease debtor_routing_number: '101050001' instruction_identification: null recipient_account_number_id: account_number_v18nkfqm6afpsrvy82b2 properties: amount: description: The amount being requested in cents. minimum: 0 type: integer x-documentation-priority: default creditor_account_number: description: The creditor's account number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default creditor_address_line1: description: A free-form address field set by the sender representing the first line of the creditor's address. maxLength: 200 minLength: 1 type: string x-documentation-priority: default creditor_address_line2: description: A free-form address field set by the sender representing the second line of the creditor's address. maxLength: 200 minLength: 1 type: string x-documentation-priority: default creditor_address_line3: description: A free-form address field set by the sender representing the third line of the creditor's address. maxLength: 200 minLength: 1 type: string x-documentation-priority: default creditor_name: description: A free-form name field set by the sender representing the creditor's name. maxLength: 200 minLength: 1 type: string x-documentation-priority: default creditor_routing_number: description: The creditor's routing number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being requested. Will always be "USD". maxLength: 200 minLength: 1 type: string x-documentation-priority: default debtor_account_number: description: The debtor's account number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default debtor_address_line1: description: A free-form address field set by the sender representing the first line of the debtor's address. maxLength: 200 minLength: 1 type: string x-documentation-priority: default debtor_address_line2: description: A free-form address field set by the sender representing the second line of the debtor's address. maxLength: 200 minLength: 1 type: string x-documentation-priority: default debtor_address_line3: description: A free-form address field set by the sender. maxLength: 200 minLength: 1 type: string x-documentation-priority: default debtor_name: description: A free-form name field set by the sender representing the debtor's name. maxLength: 200 minLength: 1 type: string x-documentation-priority: default debtor_routing_number: description: The debtor's routing number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default end_to_end_identification: description: A free-form reference string set by the sender, to help identify the transfer. maxLength: 200 minLength: 1 type: string x-documentation-priority: default instruction_identification: description: The sending bank's identifier for the wire transfer. maxLength: 200 minLength: 1 type: string x-documentation-priority: default recipient_account_number_id: description: The Account Number to which the recipient of this request is being requested to send funds from. type: string x-documentation-priority: default x-id-reference-to: Account Numbers unique_end_to_end_transaction_reference: description: The Unique End-to-end Transaction Reference ([UETR](https://www.swift.com/payments/what-unique-end-end-transaction-reference-uetr)) of the transfer. maxLength: 200 minLength: 1 type: string x-documentation-priority: default unstructured_remittance_information: description: A free-form message set by the sender. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - recipient_account_number_id - amount - currency - creditor_routing_number - creditor_account_number type: object x-event-categories: [] x-stainless-empty-object: false inbound_ach_transfer: additionalProperties: true description: An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your account. example: acceptance: accepted_at: '2020-01-31T23:59:59Z' transaction_id: transaction_uyrp7fld2ium70oa7oi account_id: account_in71c4amph0vgo2qllky account_number_id: account_number_v18nkfqm6afpsrvy82b2 addenda: null amount: 100 automatically_resolves_at: '2020-01-31T23:59:59Z' created_at: '2020-01-31T23:59:59Z' decline: null direction: credit effective_date: '2023-04-02' id: inbound_ach_transfer_tdrwqr3fq9gnnq49odev international_addenda: null notification_of_change: null originator_company_descriptive_date: '230401' originator_company_discretionary_data: WEB AUTOPAY originator_company_entry_description: INVOICE 2468 originator_company_id: 0987654321 originator_company_name: PAYROLL COMPANY originator_routing_number: '101050001' receiver_id_number: null receiver_name: Ian Crease settlement: settled_at: '2020-01-31T23:59:59Z' settlement_schedule: same_day standard_entry_class_code: internet_initiated status: accepted trace_number: 021000038461022 transfer_return: null type: inbound_ach_transfer properties: acceptance: anyOf: - additionalProperties: false description: If your transfer is accepted, this will contain details of the acceptance. properties: accepted_at: description: The time at which the transfer was accepted. format: date-time type: string x-documentation-priority: default transaction_id: description: The id of the transaction for the accepted transfer. type: string x-documentation-priority: default x-id-reference-to: Transactions required: - accepted_at - transaction_id title: Inbound ACH Transfer Acceptance type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Acceptances - type: 'null' account_id: description: The Account to which the transfer belongs. type: string x-documentation-priority: default x-id-reference-to: Accounts account_number_id: description: The identifier of the Account Number to which this transfer was sent. type: string x-documentation-priority: default x-id-reference-to: Account Numbers 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: Inbound ACH Transfer 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: Inbound ACH Transfer 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: Inbound ACH Transfer 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 automatically_resolves_at: description: The time at which the transfer will be automatically resolved. format: date-time type: string x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the inbound ACH transfer was created. format: date-time type: string x-documentation-priority: default decline: anyOf: - additionalProperties: false description: If your transfer is declined, this will contain details of the decline. properties: declined_at: description: The time at which the transfer was declined. format: date-time type: string x-documentation-priority: default declined_transaction_id: description: The id of the transaction for the declined transfer. type: string x-documentation-priority: default x-id-reference-to: Declined Transactions reason: description: The reason for the transfer decline. enum: - ach_route_canceled - ach_route_disabled - breaches_limit - entity_not_active - group_locked - transaction_not_allowed - returned_per_odfi_request - user_initiated - insufficient_funds - authorization_revoked_by_customer - payment_stopped - customer_advised_unauthorized_improper_ineligible_or_incomplete - representative_payee_deceased_or_unable_to_continue_in_that_capacity - beneficiary_or_account_holder_deceased - credit_entry_refused_by_receiver - duplicate_entry - corporate_customer_advised_not_authorized type: string x-documentation-priority: default x-enum-descriptions: - The account number is canceled. - The account number is disabled. - The transaction would cause an Increase limit to be exceeded. - The account's entity is not active. - Your account is inactive. - The transaction is not allowed per Increase's terms. - The originating financial institution asked for this transfer to be returned. The receiving bank is complying with the request. - Your integration declined this transfer via the API. - Your account contains insufficient funds. - The customer no longer authorizes this transaction. - The customer asked for the payment to be stopped. - The customer advises that the debit was unauthorized. - The payee is deceased. - The account holder is deceased. - The customer refused a credit entry. - The account holder identified this transaction as a duplicate. - The corporate customer no longer authorizes this transaction. required: - reason - declined_at - declined_transaction_id title: Inbound ACH Transfer Decline type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Declines - type: 'null' direction: description: The direction of the transfer. enum: - credit - debit type: string x-documentation-priority: default x-enum-descriptions: - Credit - Debit effective_date: description: The effective date of the transfer. This is sent by the sending bank and is a factor in determining funds availability. format: date type: string x-documentation-priority: default id: description: The inbound ACH transfer's identifier. type: string x-documentation-priority: default x-id-reference-to: Inbound ACH Transfers international_addenda: anyOf: - additionalProperties: false description: If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will contain fields pertaining to the International ACH Transaction. example: destination_country_code: US destination_currency_code: USD foreign_exchange_indicator: fixed_to_fixed foreign_exchange_reference: null foreign_exchange_reference_indicator: blank foreign_payment_amount: 199 foreign_trace_number: null international_transaction_type_code: internet_initiated originating_currency_code: USD originating_depository_financial_institution_branch_country: US originating_depository_financial_institution_id: 091000019 originating_depository_financial_institution_id_qualifier: national_clearing_system_number originating_depository_financial_institution_name: WELLS FARGO BANK originator_city: BERLIN originator_country: DE originator_identification: 770510487A originator_name: BERGHAIN originator_postal_code: '50825' originator_state_or_province: null originator_street_address: Ruedersdorferstr. 7 payment_related_information: null payment_related_information2: null receiver_city: BEVERLY HILLS receiver_country: US receiver_identification_number: '1018790279274' receiver_postal_code: '90210' receiver_state_or_province: CA receiver_street_address: 123 FAKE ST receiving_company_or_individual_name: IAN CREASE receiving_depository_financial_institution_country: US receiving_depository_financial_institution_id: '101050001' receiving_depository_financial_institution_id_qualifier: national_clearing_system_number receiving_depository_financial_institution_name: BLUE RIDGE BANK, NATIONAL ASSOCIATI properties: destination_country_code: description: The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the destination country. type: string x-documentation-priority: default destination_currency_code: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the destination bank account. type: string x-documentation-priority: default foreign_exchange_indicator: description: A description of how the foreign exchange rate was calculated. enum: - fixed_to_variable - variable_to_fixed - fixed_to_fixed type: string x-documentation-priority: default x-enum-descriptions: - The originator chose an amount in their own currency. The settled amount in USD was converted using the exchange rate. - The originator chose an amount to settle in USD. The originator's amount was variable; known only after the foreign exchange conversion. - The amount was originated and settled as a fixed amount in USD. There is no foreign exchange conversion. foreign_exchange_reference: anyOf: - description: Depending on the `foreign_exchange_reference_indicator`, an exchange rate or a reference to a well-known rate. type: string x-documentation-priority: default - type: 'null' foreign_exchange_reference_indicator: description: An instruction of how to interpret the `foreign_exchange_reference` field for this Transaction. enum: - foreign_exchange_rate - foreign_exchange_reference_number - blank type: string x-documentation-priority: default x-enum-descriptions: - The ACH file contains a foreign exchange rate. - The ACH file contains a reference to a well-known foreign exchange rate. - There is no foreign exchange for this transfer, so the `foreign_exchange_reference` field is blank. foreign_payment_amount: description: The amount in the minor unit of the foreign payment currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default foreign_trace_number: anyOf: - description: A reference number in the foreign banking infrastructure. type: string x-documentation-priority: default - type: 'null' international_transaction_type_code: description: The type of transfer. Set by the originator. enum: - annuity - business_or_commercial - deposit - loan - miscellaneous - mortgage - pension - remittance - rent_or_lease - salary_or_payroll - tax - accounts_receivable - back_office_conversion - machine_transfer - point_of_purchase - point_of_sale - represented_check - shared_network_transaction - telphone_initiated - internet_initiated type: string x-documentation-priority: default x-enum-descriptions: - Sent as `ANN` in the Nacha file. - Sent as `BUS` in the Nacha file. - Sent as `DEP` in the Nacha file. - Sent as `LOA` in the Nacha file. - Sent as `MIS` in the Nacha file. - Sent as `MOR` in the Nacha file. - Sent as `PEN` in the Nacha file. - Sent as `REM` in the Nacha file. - Sent as `RLS` in the Nacha file. - Sent as `SAL` in the Nacha file. - Sent as `TAX` in the Nacha file. - Sent as `ARC` in the Nacha file. - Sent as `BOC` in the Nacha file. - Sent as `MTE` in the Nacha file. - Sent as `POP` in the Nacha file. - Sent as `POS` in the Nacha file. - Sent as `RCK` in the Nacha file. - Sent as `SHR` in the Nacha file. - Sent as `TEL` in the Nacha file. - Sent as `WEB` in the Nacha file. originating_currency_code: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code for the originating bank account. type: string x-documentation-priority: default originating_depository_financial_institution_branch_country: description: The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the originating branch country. type: string x-documentation-priority: default originating_depository_financial_institution_id: description: An identifier for the originating bank. One of an International Bank Account Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a domestic identifier like a US Routing Number. type: string x-documentation-priority: default originating_depository_financial_institution_id_qualifier: description: An instruction of how to interpret the `originating_depository_financial_institution_id` field for this Transaction. enum: - national_clearing_system_number - bic_code - iban type: string x-documentation-priority: default x-enum-descriptions: - A domestic clearing system number. In the US, for example, this is the American Banking Association (ABA) routing number. - The SWIFT Bank Identifier Code (BIC) of the bank. - An International Bank Account Number. originating_depository_financial_institution_name: description: The name of the originating bank. Sometimes this will refer to an American bank and obscure the correspondent foreign bank. type: string x-documentation-priority: default originator_city: description: A portion of the originator address. This may be incomplete. type: string x-documentation-priority: default originator_country: description: A portion of the originator address. The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the originator country. type: string x-documentation-priority: default originator_identification: description: An identifier for the originating company. This is generally stable across multiple ACH transfers. type: string x-documentation-priority: default originator_name: description: Either the name of the originator or an intermediary money transmitter. type: string x-documentation-priority: default originator_postal_code: anyOf: - description: A portion of the originator address. This may be incomplete. type: string x-documentation-priority: default - type: 'null' originator_state_or_province: anyOf: - description: A portion of the originator address. This may be incomplete. type: string x-documentation-priority: default - type: 'null' originator_street_address: description: A portion of the originator address. This may be incomplete. type: string x-documentation-priority: default payment_related_information: anyOf: - description: A description field set by the originator. type: string x-documentation-priority: default - type: 'null' payment_related_information2: anyOf: - description: A description field set by the originator. type: string x-documentation-priority: default - type: 'null' receiver_city: description: A portion of the receiver address. This may be incomplete. type: string x-documentation-priority: default receiver_country: description: A portion of the receiver address. The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the receiver country. type: string x-documentation-priority: default receiver_identification_number: anyOf: - description: An identification number the originator uses for the receiver. type: string x-documentation-priority: default - type: 'null' receiver_postal_code: anyOf: - description: A portion of the receiver address. This may be incomplete. type: string x-documentation-priority: default - type: 'null' receiver_state_or_province: anyOf: - description: A portion of the receiver address. This may be incomplete. type: string x-documentation-priority: default - type: 'null' receiver_street_address: description: A portion of the receiver address. This may be incomplete. type: string x-documentation-priority: default receiving_company_or_individual_name: description: The name of the receiver of the transfer. This is not verified by Increase. type: string x-documentation-priority: default receiving_depository_financial_institution_country: description: The [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), Alpha-2 country code of the receiving bank country. type: string x-documentation-priority: default receiving_depository_financial_institution_id: description: An identifier for the receiving bank. One of an International Bank Account Number (IBAN) bank identifier, SWIFT Bank Identification Code (BIC), or a domestic identifier like a US Routing Number. type: string x-documentation-priority: default receiving_depository_financial_institution_id_qualifier: description: An instruction of how to interpret the `receiving_depository_financial_institution_id` field for this Transaction. enum: - national_clearing_system_number - bic_code - iban type: string x-documentation-priority: default x-enum-descriptions: - A domestic clearing system number. In the US, for example, this is the American Banking Association (ABA) routing number. - The SWIFT Bank Identifier Code (BIC) of the bank. - An International Bank Account Number. receiving_depository_financial_institution_name: description: The name of the receiving bank, as set by the sending financial institution. type: string x-documentation-priority: default required: - foreign_exchange_indicator - foreign_exchange_reference_indicator - foreign_exchange_reference - destination_country_code - destination_currency_code - foreign_payment_amount - foreign_trace_number - international_transaction_type_code - originating_currency_code - originating_depository_financial_institution_name - originating_depository_financial_institution_id_qualifier - originating_depository_financial_institution_id - originating_depository_financial_institution_branch_country - originator_name - originator_street_address - originator_city - originator_state_or_province - originator_postal_code - originator_country - originator_identification - payment_related_information - payment_related_information2 - receiver_identification_number - receiver_street_address - receiver_city - receiver_state_or_province - receiver_country - receiver_postal_code - receiving_company_or_individual_name - receiving_depository_financial_institution_name - receiving_depository_financial_institution_id_qualifier - receiving_depository_financial_institution_id - receiving_depository_financial_institution_country title: Inbound ACH Transfer Inbound ACH Transfer International Addendum type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound ACH Transfer International Addendums - type: 'null' notification_of_change: anyOf: - additionalProperties: false description: If you initiate a notification of change in response to the transfer, this will contain its details. properties: updated_account_number: anyOf: - description: The new account number provided in the notification of change. type: string x-documentation-priority: default - type: 'null' updated_routing_number: anyOf: - description: The new routing number provided in the notification of change. type: string x-documentation-priority: default - type: 'null' required: - updated_account_number - updated_routing_number title: Inbound ACH Transfer NotificationOfChange type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: NotificationOfChanges - type: 'null' originator_company_descriptive_date: anyOf: - description: The descriptive date of the transfer. type: string x-documentation-priority: default - type: 'null' originator_company_discretionary_data: anyOf: - description: The additional information included with the transfer. type: string x-documentation-priority: default - type: 'null' originator_company_entry_description: description: The description of the transfer. type: string x-documentation-priority: default originator_company_id: description: The id of the company that initiated the transfer. type: string x-documentation-priority: default originator_company_name: description: The name of the company that initiated the transfer. type: string x-documentation-priority: default originator_routing_number: description: The American Banking Association (ABA) routing number of the bank originating the transfer. type: string x-documentation-priority: default receiver_id_number: anyOf: - description: The id of the receiver of the transfer. type: string x-documentation-priority: default - type: 'null' receiver_name: anyOf: - description: The name of the receiver of the transfer. type: string x-documentation-priority: default - type: 'null' settlement: additionalProperties: false description: A subhash containing information about when and how the transfer settled at the Federal Reserve. properties: settled_at: description: When the funds for this transfer settle at the recipient bank at the Federal Reserve. format: date-time type: string x-documentation-priority: default settlement_schedule: description: The settlement schedule this transfer follows. enum: - same_day - future_dated type: string x-documentation-priority: default x-enum-descriptions: - The transfer is expected to settle same-day. - The transfer is expected to settle on a future date. required: - settled_at - settlement_schedule title: Inbound ACH Transfer Settlement type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Settlements standard_entry_class_code: description: The Standard Entry Class (SEC) code of the transfer. enum: - corporate_credit_or_debit - corporate_trade_exchange - prearranged_payments_and_deposit - internet_initiated - point_of_sale - telephone_initiated - customer_initiated - accounts_receivable - machine_transfer - shared_network_transaction - represented_check - back_office_conversion - point_of_purchase - check_truncation - destroyed_check - international_ach_transaction type: string x-documentation-priority: default x-enum-descriptions: - Corporate Credit and Debit (CCD). - Corporate Trade Exchange (CTX). - Prearranged Payments and Deposits (PPD). - Internet Initiated (WEB). - Point of Sale (POS). - Telephone Initiated (TEL). - Customer Initiated (CIE). - Accounts Receivable (ARC). - Machine Transfer (MTE). - Shared Network Transaction (SHR). - Represented Check (RCK). - Back Office Conversion (BOC). - Point of Purchase (POP). - Check Truncation (TRC). - Destroyed Check (XCK). - International ACH Transaction (IAT). status: description: The status of the transfer. enum: - pending - declined - accepted - returned type: string x-documentation-priority: default x-enum-descriptions: - The Inbound ACH Transfer is awaiting action, will transition automatically if no action is taken. - The Inbound ACH Transfer has been declined. - The Inbound ACH Transfer is accepted. - The Inbound ACH Transfer has been returned. trace_number: description: A 15 digit number set by the sending bank and transmitted to the receiving bank. Along with the amount, date, and originating routing number, this can be used to identify the ACH transfer. 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_return: anyOf: - additionalProperties: false description: If your transfer is returned, this will contain details of the return. properties: reason: description: The reason for the transfer return. enum: - insufficient_funds - returned_per_odfi_request - authorization_revoked_by_customer - payment_stopped - customer_advised_unauthorized_improper_ineligible_or_incomplete - representative_payee_deceased_or_unable_to_continue_in_that_capacity - beneficiary_or_account_holder_deceased - credit_entry_refused_by_receiver - duplicate_entry - corporate_customer_advised_not_authorized type: string x-documentation-priority: default x-enum-descriptions: - The customer's account has insufficient funds. This reason is only allowed for debits. The Nacha return code is R01. - The originating financial institution asked for this transfer to be returned. The receiving bank is complying with the request. The Nacha return code is R06. - The customer no longer authorizes this transaction. The Nacha return code is R07. - The customer asked for the payment to be stopped. This reason is only allowed for debits. The Nacha return code is R08. - The customer advises that the debit was unauthorized. The Nacha return code is R10. - The payee is deceased. The Nacha return code is R14. - The account holder is deceased. The Nacha return code is R15. - The customer refused a credit entry. This reason is only allowed for credits. The Nacha return code is R23. - The account holder identified this transaction as a duplicate. The Nacha return code is R24. - The corporate customer no longer authorizes this transaction. The Nacha return code is R29. returned_at: description: The time at which the transfer was returned. format: date-time type: string x-documentation-priority: default transaction_id: description: The id of the transaction for the returned transfer. type: string x-documentation-priority: default x-id-reference-to: Transactions required: - reason - returned_at - transaction_id title: Inbound ACH Transfer TransferReturn type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: TransferReturns - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `inbound_ach_transfer`. enum: - inbound_ach_transfer type: string x-documentation-priority: default required: - type - id - amount - account_id - account_number_id - direction - status - created_at - originator_company_name - originator_company_descriptive_date - originator_company_discretionary_data - originator_company_entry_description - originator_company_id - originator_routing_number - receiver_id_number - receiver_name - trace_number - effective_date - standard_entry_class_code - settlement - automatically_resolves_at - addenda - acceptance - decline - transfer_return - notification_of_change - international_addenda title: Inbound ACH Transfer type: object x-event-categories: - inbound_ach_transfer.created - inbound_ach_transfer.updated x-stainless-empty-object: false x-tag: Inbound ACH Transfers x-title-plural: Inbound ACH Transfers 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 sandbox_create_an_inbound_fednow_transfer_parameters: additionalProperties: false example: account_number_id: account_number_v18nkfqm6afpsrvy82b2 amount: 1000 properties: account_number_id: description: The identifier of the Account Number the inbound FedNow Transfer is for. type: string x-documentation-priority: default x-id-reference-to: Account Numbers amount: description: The transfer amount in USD cents. Must be positive. minimum: 1 type: integer x-documentation-priority: default debtor_account_number: description: The account number of the account that sent the transfer. maxLength: 200 minLength: 1 type: string x-documentation-priority: default debtor_name: description: The name provided by the sender of the transfer. maxLength: 200 minLength: 1 type: string x-documentation-priority: default debtor_routing_number: description: The routing number of the account that sent the transfer. maxLength: 9 minLength: 9 type: string x-documentation-priority: default unstructured_remittance_information: description: Additional information included with the transfer. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - account_number_id - amount type: object x-event-categories: [] x-stainless-empty-object: false check_transfer: additionalProperties: true description: Check Transfers move funds from your Increase account by mailing a physical check. example: account_id: account_in71c4amph0vgo2qllky account_number: '987654321' amount: 1000 approval: null approved_inbound_check_deposit_id: inbound_check_deposit_zoshvqybq0cjjm31mra balance_check: null cancellation: null check_number: '123' created_at: '2020-01-31T23:59:59Z' created_by: category: user user: email: user@example.com currency: USD fulfillment_method: physical_check id: check_transfer_30b43acfu9vw8fyc4f5 idempotency_key: null mailing: mailed_at: '2020-01-31T23:59:59Z' pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4 physical_check: attachment_file_id: null check_voucher_image_file_id: null mailing_address: city: New York line1: 33 Liberty Street line2: null name: Ian Crease phone: '+16505046304' postal_code: '10045' state: NY memo: Invoice 29582 note: null payer: - contents: Ian Crease - contents: 33 Liberty Street - contents: New York, NY 10045 recipient_name: Ian Crease return_address: city: New York line1: 33 Liberty Street line2: null name: Ian Crease phone: '+16505046304' postal_code: '10045' state: NY shipping_method: null signature: image_file_id: null text: Ian Crease tracking_updates: [] routing_number: '101050001' source_account_number_id: account_number_v18nkfqm6afpsrvy82b2 status: mailed stop_payment_request: null submission: preview_file_id: null submitted_address: city: NEW YORK line1: 33 LIBERTY STREET line2: null recipient_name: IAN CREASE state: NY zip: '10045' submitted_at: '2020-01-31T23:59:59Z' tracking_number: null third_party: null type: check_transfer valid_until_date: null properties: account_id: description: The identifier of the Account from which funds will be transferred. type: string x-documentation-priority: default x-id-reference-to: Accounts account_number: description: The account number printed on the check. type: string x-documentation-priority: default amount: description: The transfer amount in USD cents. type: integer x-documentation-priority: default approval: anyOf: - additionalProperties: false description: If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval. example: approved_at: '2020-01-31T23:59:59Z' approved_by: null properties: approved_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved. format: date-time type: string x-documentation-priority: default approved_by: anyOf: - description: If the Transfer was approved by a user in the dashboard, the email address of that user. type: string x-documentation-priority: default - type: 'null' required: - approved_at - approved_by title: Check Transfer Transfer Approval type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Transfer Approvals - type: 'null' approved_inbound_check_deposit_id: anyOf: - description: If the Check Transfer was successfully deposited, this will contain the identifier of the Inbound Check Deposit object with details of the deposit. type: string x-documentation-priority: default x-id-reference-to: Inbound Check Deposits - type: 'null' balance_check: anyOf: - description: How the account's available balance should be checked. enum: - full - none type: string x-documentation-priority: default x-enum-descriptions: - The available balance of the account must be at least the amount of the check, and a Pending Transaction will be created for the full amount. This is the default behavior if `balance_check` is omitted. - No balance check will performed when the check transfer is initiated. A zero-dollar Pending Transaction will be created. The balance will still be checked when the Inbound Check Deposit is created. - type: 'null' cancellation: anyOf: - additionalProperties: false description: If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation. example: canceled_at: '2020-01-31T23:59:59Z' canceled_by: null properties: canceled_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled. format: date-time type: string x-documentation-priority: default canceled_by: anyOf: - description: If the Transfer was canceled by a user in the dashboard, the email address of that user. type: string x-documentation-priority: default - type: 'null' required: - canceled_at - canceled_by title: Check Transfer Transfer Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Transfer Cancellations - type: 'null' check_number: description: The check number printed on the check. type: string x-documentation-priority: default 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 created_by: anyOf: - additionalProperties: false description: What object created the transfer, either via the API or the dashboard. example: category: user user: email: user@example.com properties: api_key: anyOf: - additionalProperties: false description: If present, details about the API key that created the transfer. properties: description: anyOf: - description: The description set for the API key when it was created. type: string x-documentation-priority: default - type: 'null' required: - description title: Check Transfer Transfer Creator ApiKey type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: ApiKeys - type: 'null' category: description: The type of object that created this transfer. enum: - api_key - oauth_application - user type: string x-documentation-priority: default x-enum-descriptions: - An API key. Details will be under the `api_key` object. - An OAuth application you connected to Increase. Details will be under the `oauth_application` object. - A User in the Increase dashboard. Details will be under the `user` object. oauth_application: anyOf: - additionalProperties: false description: If present, details about the OAuth Application that created the transfer. properties: name: description: The name of the OAuth Application. type: string x-documentation-priority: default required: - name title: Check Transfer Transfer Creator OAuthApplication type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: OAuthApplications - type: 'null' user: anyOf: - additionalProperties: false description: If present, details about the User that created the transfer. properties: email: description: The email address of the User. type: string x-documentation-priority: default required: - email title: Check Transfer Transfer Creator User type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Users - type: 'null' required: - category title: Check Transfer Transfer Creator type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Transfer Creators - type: 'null' currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) fulfillment_method: description: Whether Increase will print and mail the check or if you will do it yourself. enum: - physical_check - third_party type: string x-documentation-priority: default x-enum-descriptions: - Increase will print and mail a physical check. - Increase will not print a check; you are responsible for printing and mailing a check with the provided account number, routing number, check number, and amount. id: description: The Check transfer's identifier. type: string x-documentation-priority: default x-id-reference-to: Check Transfers idempotency_key: anyOf: - description: The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys). type: string x-documentation-priority: default - type: 'null' mailing: anyOf: - additionalProperties: true description: If the check has been mailed by Increase, this will contain details of the shipment. properties: mailed_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check was mailed. format: date-time type: string x-documentation-priority: default required: - mailed_at title: Check Transfer Mailing type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Mailings - type: 'null' pending_transaction_id: anyOf: - description: The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) by someone else in your organization. type: string x-documentation-priority: default x-id-reference-to: Pending Transactions - type: 'null' physical_check: anyOf: - additionalProperties: true description: Details relating to the physical check that Increase will print and mail. Will be present if and only if `fulfillment_method` is equal to `physical_check`. properties: attachment_file_id: anyOf: - description: The ID of the file for the check attachment. type: string x-documentation-priority: default x-id-reference-to: Files - type: 'null' check_voucher_image_file_id: anyOf: - description: The ID of the file for the check voucher image. type: string x-documentation-priority: default x-id-reference-to: Files - type: 'null' mailing_address: additionalProperties: false description: Details for where Increase will mail the check. properties: city: anyOf: - description: The city of the check's destination. type: string x-documentation-priority: default - type: 'null' line1: anyOf: - description: The street address of the check's destination. type: string x-documentation-priority: default - type: 'null' line2: anyOf: - description: The second line of the address of the check's destination. type: string x-documentation-priority: default - type: 'null' name: anyOf: - description: The name component of the check's mailing address. type: string x-documentation-priority: default - type: 'null' phone: anyOf: - description: The phone number to be used in case of delivery issues at the check's mailing address. Only used for FedEx overnight shipping. type: string x-documentation-priority: default - type: 'null' postal_code: anyOf: - description: The postal code of the check's destination. type: string x-documentation-priority: default - type: 'null' state: anyOf: - description: The state of the check's destination. type: string x-documentation-priority: default - type: 'null' required: - name - line1 - line2 - city - state - postal_code - phone title: Check Transfer PhysicalCheck MailingAddress type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: MailingAddresses memo: anyOf: - description: The descriptor that will be printed on the memo field on the check. type: string x-documentation-priority: default - type: 'null' note: anyOf: - description: The descriptor that will be printed on the letter included with the check. type: string x-documentation-priority: default - type: 'null' payer: description: The payer of the check. This will be printed on the top-left portion of the check and defaults to the return address if unspecified. items: additionalProperties: false properties: contents: description: The contents of the line. type: string x-documentation-priority: default required: - contents title: Check Transfer PhysicalCheck PayerElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: PayerElements type: array x-documentation-priority: default recipient_name: description: The name that will be printed on the check. type: string x-documentation-priority: default return_address: anyOf: - additionalProperties: false description: The return address to be printed on the check. properties: city: anyOf: - description: The city of the check's destination. type: string x-documentation-priority: default - type: 'null' line1: anyOf: - description: The street address of the check's destination. type: string x-documentation-priority: default - type: 'null' line2: anyOf: - description: The second line of the address of the check's destination. type: string x-documentation-priority: default - type: 'null' name: anyOf: - description: The name component of the check's return address. type: string x-documentation-priority: default - type: 'null' phone: anyOf: - description: The shipper's phone number to be used in case of delivery issues. Only used for FedEx overnight shipping. type: string x-documentation-priority: default - type: 'null' postal_code: anyOf: - description: The postal code of the check's destination. type: string x-documentation-priority: default - type: 'null' state: anyOf: - description: The state of the check's destination. type: string x-documentation-priority: default - type: 'null' required: - name - line1 - line2 - city - state - postal_code - phone title: Check Transfer PhysicalCheck ReturnAddress type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: ReturnAddresses - type: 'null' shipping_method: anyOf: - description: The shipping method for the check. enum: - usps_first_class - fedex_overnight type: string x-documentation-priority: default x-enum-descriptions: - USPS First Class - FedEx Overnight - type: 'null' signature: additionalProperties: false description: The signature that will appear on the check. properties: image_file_id: anyOf: - description: The ID of a File containing a PNG of the signature. type: string x-documentation-priority: default x-id-reference-to: Files - type: 'null' text: anyOf: - description: The text that will appear as the signature on the check in cursive font. type: string x-documentation-priority: default - type: 'null' required: - text - image_file_id title: Check Transfer PhysicalCheck Signature type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Signatures tracking_updates: description: Tracking updates relating to the physical check's delivery. items: additionalProperties: false properties: category: description: The type of tracking event. enum: - in_transit - processed_for_delivery - delivered - delivery_issue - returned_to_sender type: string x-documentation-priority: default x-enum-descriptions: - The check is in transit. - The check has been processed for delivery. - The check has been delivered. - There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the check will be returned to sender. - Delivery failed and the check was returned to sender. country: description: The ISO 3166-1 alpha-2 country code for the country where the event took place. type: string x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the tracking event took place. format: date-time type: string x-documentation-priority: default postal_code: description: The postal code where the event took place. type: string x-documentation-priority: default required: - category - created_at - postal_code - country title: Check Transfer PhysicalCheck TrackingUpdatesElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: TrackingUpdatesElements type: array x-documentation-priority: default required: - memo - note - recipient_name - signature - shipping_method - attachment_file_id - check_voucher_image_file_id - mailing_address - return_address - payer - tracking_updates title: Check Transfer PhysicalCheck type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: PhysicalChecks - type: 'null' routing_number: description: The routing number printed on the check. type: string x-documentation-priority: default source_account_number_id: anyOf: - description: The identifier of the Account Number from which to send the transfer and print on the check. type: string x-documentation-priority: default x-id-reference-to: Account Numbers - type: 'null' status: description: The lifecycle status of the transfer. enum: - pending_approval - canceled - pending_submission - requires_attention - rejected - pending_mailing - mailed - deposited - stopped - returned type: string x-documentation-priority: default x-enum-descriptions: - The transfer is awaiting approval. - The transfer has been canceled. - The transfer is pending submission. - The transfer requires attention from an Increase operator. - The transfer has been rejected. - The check is queued for mailing. - The check has been mailed. - The check has been deposited. - A stop-payment was requested for this check. - The transfer has been returned. stop_payment_request: anyOf: - $ref: '#/components/schemas/check_transfer_stop_payment_request' description: After a stop-payment is requested on the check, this will contain supplemental details. x-documentation-priority: default - type: 'null' submission: anyOf: - additionalProperties: true description: After the transfer is submitted, this will contain supplemental details. example: preview_file_id: null submitted_address: city: NEW YORK line1: 33 LIBERTY STREET line2: null recipient_name: IAN CREASE state: NY zip: '10045' submitted_at: '2020-01-31T23:59:59Z' tracking_number: null properties: preview_file_id: anyOf: - description: The ID of the file corresponding to an image of the check that was mailed, if available. type: string x-documentation-priority: default x-id-reference-to: Files - type: 'null' submitted_address: additionalProperties: false description: The address we submitted to the printer. This is what is physically printed on the check. properties: city: description: The submitted address city. type: string x-documentation-priority: default line1: description: The submitted address line 1. type: string x-documentation-priority: default line2: anyOf: - description: The submitted address line 2. type: string x-documentation-priority: default - type: 'null' recipient_name: description: The submitted recipient name. type: string x-documentation-priority: default state: description: The submitted address state. type: string x-documentation-priority: default zip: description: The submitted address zip. type: string x-documentation-priority: default required: - recipient_name - line1 - line2 - city - state - zip title: Check Transfer Physical Check Submission SubmittedAddress type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: SubmittedAddresses submitted_at: description: When this check was submitted to our check printer. format: date-time type: string x-documentation-priority: default tracking_number: anyOf: - description: The tracking number for the check shipment. type: string x-documentation-priority: default - type: 'null' required: - submitted_at - tracking_number - preview_file_id - submitted_address title: Check Transfer Physical Check Submission type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Physical Check Submissions - type: 'null' third_party: anyOf: - additionalProperties: true description: Details relating to the custom fulfillment you will perform. Will be present if and only if `fulfillment_method` is equal to `third_party`. properties: recipient_name: anyOf: - description: The name that you will print on the check. type: string x-documentation-priority: default - type: 'null' required: - recipient_name title: Check Transfer ThirdParty type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: ThirdParties - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `check_transfer`. enum: - check_transfer type: string x-documentation-priority: default valid_until_date: anyOf: - description: If set, the check will be valid on or before this date. After this date, the check transfer will be automatically stopped and deposits will not be accepted. For checks printed by Increase, this date is included on the check as its expiry. format: date type: string x-documentation-priority: default - type: 'null' required: - type - account_id - source_account_number_id - account_number - routing_number - check_number - valid_until_date - balance_check - fulfillment_method - physical_check - third_party - amount - created_at - currency - approval - cancellation - id - mailing - pending_transaction_id - status - submission - stop_payment_request - approved_inbound_check_deposit_id - created_by - idempotency_key title: Check Transfer type: object x-event-categories: - check_transfer.created - check_transfer.updated x-stainless-empty-object: false x-tag: Check Transfers x-title-plural: Check Transfers physical_card: additionalProperties: false description: Custom physical Visa cards that are shipped to your customers. The artwork is configurable by a connected [Card Profile](/documentation/api#card-profiles). The same Card can be used for multiple Physical Cards. Printing cards incurs a fee. Please contact [support@increase.com](mailto:support@increase.com) for pricing! example: card_id: card_oubs0hwk5rn6knuecxg2 cardholder: first_name: Ian last_name: Crease created_at: '2020-01-31T23:59:59Z' id: physical_card_ode8duyq5v2ynhjoharl idempotency_key: null physical_card_profile_id: physical_card_profile_m534d5rn9qyy9ufqxoec shipment: address: city: New York country: US line1: 33 Liberty Street line2: Unit 2 line3: null name: Ian Crease postal_code: '10045' state: NY method: usps schedule: next_day status: shipped tracking: number: '9400110200881234567890' return_number: null return_reason: null shipped_at: '2020-01-31T23:59:59Z' updates: - carrier_estimated_delivery_at: null category: delivered city: null created_at: '2020-01-31T23:59:59Z' postal_code: '10001' state: null status: active type: physical_card properties: card_id: description: The identifier for the Card this Physical Card represents. type: string x-documentation-priority: default x-id-reference-to: Cards cardholder: additionalProperties: false description: Details about the cardholder, as it appears on the printed card. properties: first_name: description: The cardholder's first name. type: string x-documentation-priority: default last_name: description: The cardholder's last name. type: string x-documentation-priority: default required: - first_name - last_name title: Physical Card Cardholder type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholders created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Physical Card was created. format: date-time type: string x-documentation-priority: default id: description: The physical card identifier. type: string x-documentation-priority: default x-id-reference-to: Physical Cards idempotency_key: anyOf: - description: The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys). type: string x-documentation-priority: default - type: 'null' physical_card_profile_id: anyOf: - description: The Physical Card Profile used for this Physical Card. type: string x-documentation-priority: default x-id-reference-to: Physical Card Profiles - type: 'null' shipment: additionalProperties: false description: The details used to ship this physical card. properties: address: additionalProperties: false description: The location to where the card's packing label is addressed. properties: city: description: The city of the shipping address. type: string x-documentation-priority: default country: description: The country of the shipping address. type: string x-documentation-priority: default line1: description: The first line of the shipping address. type: string x-documentation-priority: default line2: anyOf: - description: The second line of the shipping address. type: string x-documentation-priority: default - type: 'null' line3: anyOf: - description: The third line of the shipping address. type: string x-documentation-priority: default - type: 'null' name: description: The name of the recipient. type: string x-documentation-priority: default postal_code: description: The postal code of the shipping address. type: string x-documentation-priority: default state: description: The state of the shipping address. type: string x-documentation-priority: default required: - name - line1 - line2 - line3 - city - state - postal_code - country title: Physical Card Shipment Address type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Addresses method: description: The shipping method. enum: - usps - fedex_priority_overnight - fedex_2_day - dhl_worldwide_express type: string x-documentation-priority: default x-enum-descriptions: - USPS Post. - FedEx Priority Overnight, no signature. - FedEx 2-day. - DHL Worldwide Express, international shipping only. schedule: description: When this physical card should be produced by the card printer. The default timeline is the day after the card printer receives the order, except for `FEDEX_PRIORITY_OVERNIGHT` cards, which default to `SAME_DAY`. To use faster production methods, please reach out to [support@increase.com](mailto:support@increase.com). enum: - next_day - same_day type: string x-documentation-priority: default x-enum-descriptions: - The physical card will be shipped one business day after the order is received by the card printer. A card that is submitted to Increase on a Monday evening (Pacific Time) will ship out on Wednesday. - The physical card will be shipped on the same business day that the order is received by the card printer. A card that is submitted to Increase on a Monday evening (Pacific Time) will ship out on Tuesday. status: description: The status of this shipment. enum: - pending - canceled - submitted - acknowledged - rejected - shipped - returned - requires_attention type: string x-documentation-priority: default x-enum-descriptions: - The physical card has not yet been shipped. - The physical card shipment was canceled prior to submission. - The physical card shipment has been submitted to the card fulfillment provider. - The physical card shipment has been acknowledged by the card fulfillment provider and will be processed in their next batch. - The physical card shipment was rejected by the card printer due to an error. - The physical card has been shipped. - The physical card shipment was returned to the sender and destroyed by the production facility. - The physical card shipment requires attention from Increase before progressing. tracking: anyOf: - additionalProperties: false description: Tracking details for the shipment. properties: number: anyOf: - description: The tracking number. Not available for USPS shipments. type: string x-documentation-priority: default - type: 'null' return_number: anyOf: - description: For returned shipments, the tracking number of the return shipment. type: string x-documentation-priority: default - type: 'null' return_reason: anyOf: - description: For returned shipments, this describes why the package was returned. type: string x-documentation-priority: default - type: 'null' shipped_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the fulfillment provider marked the card as ready for pick-up by the shipment carrier. format: date-time type: string x-documentation-priority: default updates: description: Tracking updates relating to the physical card's delivery. items: additionalProperties: false properties: carrier_estimated_delivery_at: anyOf: - description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the carrier expects the card to be delivered. format: date-time type: string x-documentation-priority: default - type: 'null' category: description: The type of tracking event. enum: - in_transit - processed_for_delivery - delivered - delivery_issue - returned_to_sender type: string x-documentation-priority: default x-enum-descriptions: - The physical card is in transit. - The physical card has been processed for delivery. - The physical card has been delivered. - There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the physical card will be returned to sender. - Delivery failed and the physical card was returned to sender. city: anyOf: - description: The city where the event took place. type: string x-documentation-priority: default - type: 'null' created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the tracking event took place. format: date-time type: string x-documentation-priority: default postal_code: anyOf: - description: The postal code where the event took place. type: string x-documentation-priority: default - type: 'null' state: anyOf: - description: The state where the event took place. type: string x-documentation-priority: default - type: 'null' required: - category - created_at - carrier_estimated_delivery_at - postal_code - city - state title: Physical Card Shipment Tracking UpdatesElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: UpdatesElements type: array x-documentation-priority: default required: - number - shipped_at - return_reason - return_number - updates title: Physical Card Shipment Tracking type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Trackings - type: 'null' required: - method - schedule - status - tracking - address title: Physical Card Shipment type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Shipments status: description: The status of the Physical Card. enum: - active - disabled - canceled type: string x-documentation-priority: default x-enum-descriptions: - The physical card is active. - The physical card is temporarily disabled. - The physical card is permanently canceled. type: description: A constant representing the object's type. For this resource it will always be `physical_card`. enum: - physical_card type: string x-documentation-priority: default required: - type - id - card_id - physical_card_profile_id - created_at - status - cardholder - shipment - idempotency_key title: Physical Card type: object x-event-categories: - physical_card.created - physical_card.updated x-stainless-empty-object: false x-tag: Physical Cards x-title-plural: Physical Cards sandbox_advance_the_shipment_status_of_a_physical_card_parameters: additionalProperties: false example: shipment_status: shipped properties: shipment_status: description: The shipment status to move the Physical Card to. enum: - pending - canceled - submitted - acknowledged - rejected - shipped - returned - requires_attention type: string x-documentation-priority: default x-enum-descriptions: - The physical card has not yet been shipped. - The physical card shipment was canceled prior to submission. - The physical card shipment has been submitted to the card fulfillment provider. - The physical card shipment has been acknowledged by the card fulfillment provider and will be processed in their next batch. - The physical card shipment was rejected by the card printer due to an error. - The physical card has been shipped. - The physical card shipment was returned to the sender and destroyed by the production facility. - The physical card shipment requires attention from Increase before progressing. required: - shipment_status type: object x-event-categories: [] x-stainless-empty-object: false sandbox_create_an_inbound_check_deposit_parameters: additionalProperties: false example: account_number_id: account_number_v18nkfqm6afpsrvy82b2 amount: 1000 check_number: '1234567890' properties: account_number_id: description: The identifier of the Account Number the Inbound Check Deposit will be against. type: string x-documentation-priority: default x-id-reference-to: Account Numbers amount: description: The check amount in cents. minimum: 0 type: integer x-documentation-priority: default check_number: description: The check number on the check to be deposited. maxLength: 10 minLength: 1 pattern: ^[0-9]*$ type: string x-documentation-priority: default payee_name_analysis: description: Simulate the outcome of [payee name checking](https://increase.com/documentation/positive-pay#payee-name-mismatches). Defaults to `not_evaluated`. enum: - name_matches - does_not_match - not_evaluated type: string x-documentation-priority: default x-enum-descriptions: - The details on the check match the recipient name of the check transfer. - The details on the check do not match the recipient name of the check transfer. - The payee name analysis was not evaluated. required: - account_number_id - amount - check_number type: object x-event-categories: [] x-stainless-empty-object: false 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 account_statement: additionalProperties: false description: Account Statements are generated monthly for every active Account. You can access the statement's data via the API or retrieve a PDF with its details via its associated File. example: account_id: account_in71c4amph0vgo2qllky created_at: '2020-01-31T23:59:59Z' ending_balance: 100 file_id: file_makxrc67oh9l6sg7w9yc id: account_statement_lkc03a4skm2k7f38vj15 loan: null starting_balance: 0 statement_period_end: '2020-01-31T23:59:59Z' statement_period_start: '2020-01-31T23:59:59Z' type: account_statement properties: account_id: description: The identifier for the Account this Account Statement belongs to. type: string x-documentation-priority: default x-id-reference-to: Accounts created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account Statement was created. format: date-time type: string x-documentation-priority: default ending_balance: description: The Account's balance at the end of its statement period. type: integer x-documentation-priority: default file_id: description: The identifier of the File containing a PDF of the statement. type: string x-documentation-priority: default x-id-reference-to: Files id: description: The Account Statement identifier. type: string x-documentation-priority: default x-id-reference-to: Account Statements loan: anyOf: - additionalProperties: false description: The loan balances. properties: due_at: anyOf: - description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the loan payment is due. format: date-time type: string x-documentation-priority: default - type: 'null' due_balance: description: The total amount due on the loan. type: integer x-documentation-priority: default past_due_balance: description: The amount past due on the loan. type: integer x-documentation-priority: default required: - due_balance - past_due_balance - due_at title: Account Statement Loan type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Loans - type: 'null' starting_balance: description: The Account's balance at the start of its statement period. type: integer x-documentation-priority: default statement_period_end: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the end of the period the Account Statement covers. format: date-time type: string x-documentation-priority: default statement_period_start: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time representing the start of the period the Account Statement covers. format: date-time type: string x-documentation-priority: default type: description: A constant representing the object's type. For this resource it will always be `account_statement`. enum: - account_statement type: string x-documentation-priority: default required: - type - id - account_id - created_at - file_id - statement_period_start - statement_period_end - starting_balance - ending_balance - loan title: Account Statement type: object x-event-categories: - account_statement.created x-stainless-empty-object: false x-tag: Account Statements x-title-plural: Account Statements sandbox_create_an_inbound_real_time_payments_transfer_parameters: additionalProperties: true example: account_number_id: account_number_v18nkfqm6afpsrvy82b2 amount: 1000 request_for_payment_id: real_time_payments_request_for_payment_28kcliz1oevcnqyn9qp7 properties: account_number_id: description: The identifier of the Account Number the inbound Real-Time Payments Transfer is for. type: string x-documentation-priority: default x-id-reference-to: Account Numbers amount: description: The transfer amount in USD cents. Must be positive. minimum: 1 type: integer x-documentation-priority: default debtor_account_number: description: The account number of the account that sent the transfer. maxLength: 200 minLength: 1 type: string x-documentation-priority: default debtor_name: description: The name provided by the sender of the transfer. maxLength: 200 minLength: 1 type: string x-documentation-priority: default debtor_routing_number: description: The routing number of the account that sent the transfer. maxLength: 9 minLength: 9 type: string x-documentation-priority: default request_for_payment_id: description: The identifier of a pending Request for Payment that this transfer will fulfill. type: string x-documentation-priority: default x-id-reference-to: Real-Time Payments Request for Payments unstructured_remittance_information: description: Additional information included with the transfer. maxLength: 140 minLength: 1 type: string x-documentation-priority: default required: - account_number_id - amount type: object x-event-categories: [] x-stainless-empty-object: false 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 sandbox_create_a_program_parameters: additionalProperties: false example: name: For Benefit Of properties: bank: description: The bank for the program's accounts, defaults to First Internet Bank. enum: - core_bank - first_internet_bank - grasshopper_bank - twin_city_bank type: string x-documentation-priority: default x-enum-descriptions: - Core Bank - First Internet Bank of Indiana - Grasshopper Bank - Twin City Bank lending_maximum_extendable_credit: description: The maximum extendable credit of the program being added. minimum: 0 type: integer x-documentation-priority: default name: description: The name of the program being added. maxLength: 200 minLength: 1 type: string x-documentation-priority: default reserve_account_id: description: The identifier of the Account the Program should be added to is for. type: string x-documentation-priority: default x-id-reference-to: Accounts required: - name type: object x-event-categories: [] x-stainless-empty-object: false sandbox_create_an_account_statement_parameters: additionalProperties: false example: account_id: account_in71c4amph0vgo2qllky properties: account_id: description: The identifier of the Account the statement is for. type: string x-documentation-priority: default x-id-reference-to: Accounts required: - account_id type: object x-event-categories: [] x-stainless-empty-object: false sandbox_create_a_digital_wallet_token_request_parameters: additionalProperties: false example: card_id: card_oubs0hwk5rn6knuecxg2 properties: card_id: description: The identifier of the Card to be authorized. type: string x-documentation-priority: default x-id-reference-to: Cards required: - card_id type: object x-event-categories: [] x-stainless-empty-object: false card_purchase_supplement: additionalProperties: true description: Additional information about a card purchase (e.g., settlement or refund), such as level 3 line item data. example: card_payment_id: card_payment_nd3k2kacrqjli8482ave id: card_purchase_supplement_ijuc45iym4jchnh2sfk3 invoice: discount_amount: 100 discount_currency: USD discount_treatment_code: null duty_tax_amount: 200 duty_tax_currency: USD order_date: '2023-07-20' shipping_amount: 300 shipping_currency: USD shipping_destination_country_code: US shipping_destination_postal_code: '10045' shipping_source_postal_code: '10045' shipping_tax_amount: 400 shipping_tax_currency: USD shipping_tax_rate: '0.2' tax_treatments: null unique_value_added_tax_invoice_reference: '12302' line_items: - detail_indicator: normal discount_amount: null discount_currency: null discount_treatment_code: null id: card_purchase_supplement_invoice_line_item_nf9760lz0apqy5retmqh item_commodity_code: '001' item_descriptor: Coffee item_quantity: '1.0' product_code: '101' sales_tax_amount: null sales_tax_currency: null sales_tax_rate: null total_amount: 500 total_amount_currency: USD unit_cost: '5.0' unit_cost_currency: USD unit_of_measure_code: NMB transaction_id: transaction_uyrp7fld2ium70oa7oi type: card_purchase_supplement properties: card_payment_id: anyOf: - description: The ID of the Card Payment this transaction belongs to. type: string x-documentation-priority: default x-id-reference-to: Card Payments - type: 'null' id: description: The Card Purchase Supplement identifier. type: string x-documentation-priority: default x-id-reference-to: Card Purchase Supplements invoice: anyOf: - additionalProperties: false description: Invoice-level information about the payment. properties: discount_amount: anyOf: - description: Discount given to cardholder. type: integer x-documentation-priority: default - type: 'null' discount_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the discount. type: string x-documentation-priority: default - type: 'null' discount_treatment_code: anyOf: - description: Indicates how the merchant applied the discount. enum: - no_invoice_level_discount_provided - tax_calculated_on_post_discount_invoice_total - tax_calculated_on_pre_discount_invoice_total type: string x-documentation-priority: default x-enum-descriptions: - No invoice level discount provided - Tax calculated on post discount invoice total - Tax calculated on pre discount invoice total - type: 'null' duty_tax_amount: anyOf: - description: Amount of duty taxes. type: integer x-documentation-priority: default - type: 'null' duty_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the duty tax. type: string x-documentation-priority: default - type: 'null' order_date: anyOf: - description: Date the order was taken. format: date type: string x-documentation-priority: default - type: 'null' shipping_amount: anyOf: - description: The shipping cost. type: integer x-documentation-priority: default - type: 'null' shipping_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the shipping cost. type: string x-documentation-priority: default - type: 'null' shipping_destination_country_code: anyOf: - description: Country code of the shipping destination. type: string x-documentation-priority: default - type: 'null' shipping_destination_postal_code: anyOf: - description: Postal code of the shipping destination. type: string x-documentation-priority: default - type: 'null' shipping_source_postal_code: anyOf: - description: Postal code of the location being shipped from. type: string x-documentation-priority: default - type: 'null' shipping_tax_amount: anyOf: - description: Taxes paid for freight and shipping. type: integer x-documentation-priority: default - type: 'null' shipping_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the shipping tax. type: string x-documentation-priority: default - type: 'null' shipping_tax_rate: anyOf: - description: Tax rate for freight and shipping. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' tax_treatments: anyOf: - description: Indicates how the merchant applied taxes. enum: - no_tax_applies - net_price_line_item_level - net_price_invoice_level - gross_price_line_item_level - gross_price_invoice_level type: string x-documentation-priority: default x-enum-descriptions: - No tax applies - Net price line item level - Net price invoice level - Gross price line item level - Gross price invoice level - type: 'null' unique_value_added_tax_invoice_reference: anyOf: - description: Value added tax invoice reference number. type: string x-documentation-priority: default - type: 'null' required: - discount_amount - discount_currency - shipping_amount - shipping_currency - duty_tax_amount - duty_tax_currency - shipping_tax_amount - shipping_tax_currency - shipping_tax_rate - shipping_destination_postal_code - shipping_destination_country_code - shipping_source_postal_code - unique_value_added_tax_invoice_reference - order_date - discount_treatment_code - tax_treatments title: Card Purchase Supplement Invoice type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Invoices - type: 'null' line_items: anyOf: - description: Line item information, such as individual products purchased. items: additionalProperties: false properties: detail_indicator: anyOf: - description: Indicates the type of line item. enum: - normal - credit - payment type: string x-documentation-priority: default x-enum-descriptions: - Normal - Credit - Purchase - type: 'null' discount_amount: anyOf: - description: Discount amount for this specific line item. type: integer x-documentation-priority: default - type: 'null' discount_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the discount. type: string x-documentation-priority: default - type: 'null' discount_treatment_code: anyOf: - description: Indicates how the merchant applied the discount for this specific line item. enum: - no_line_item_level_discount_provided - tax_calculated_on_post_discount_line_item_total - tax_calculated_on_pre_discount_line_item_total type: string x-documentation-priority: default x-enum-descriptions: - No line item level discount provided - Tax calculated on post discount line item total - Tax calculated on pre discount line item total - type: 'null' id: description: The Card Purchase Supplement Line Item identifier. type: string x-documentation-priority: default item_commodity_code: anyOf: - description: Code used to categorize the purchase item. type: string x-documentation-priority: default - type: 'null' item_descriptor: anyOf: - description: Description of the purchase item. type: string x-documentation-priority: default - type: 'null' item_quantity: anyOf: - description: The number of units of the product being purchased. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' product_code: anyOf: - description: Code used to categorize the product being purchased. type: string x-documentation-priority: default - type: 'null' sales_tax_amount: anyOf: - description: Sales tax amount for this line item. type: integer x-documentation-priority: default - type: 'null' sales_tax_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the sales tax assessed. type: string x-documentation-priority: default - type: 'null' sales_tax_rate: anyOf: - description: Sales tax rate for this line item. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' total_amount: anyOf: - description: Total amount of all line items. type: integer x-documentation-priority: default - type: 'null' total_amount_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the total amount. type: string x-documentation-priority: default - type: 'null' unit_cost: anyOf: - description: Cost of line item per unit of measure, in major units. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' unit_cost_currency: anyOf: - description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the unit cost. type: string x-documentation-priority: default - type: 'null' unit_of_measure_code: anyOf: - description: Code indicating unit of measure (gallons, etc.). type: string x-documentation-priority: default - type: 'null' required: - id - item_commodity_code - item_descriptor - product_code - item_quantity - unit_of_measure_code - unit_cost - unit_cost_currency - sales_tax_amount - sales_tax_currency - sales_tax_rate - discount_amount - discount_currency - discount_treatment_code - total_amount - total_amount_currency - detail_indicator title: Card Purchase Supplement LineItemsElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: LineItemsElements type: array x-documentation-priority: default - type: 'null' transaction_id: description: The ID of the 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_purchase_supplement`. enum: - card_purchase_supplement type: string x-documentation-priority: default required: - type - id - transaction_id - card_payment_id - invoice - line_items title: Card Purchase Supplement type: object x-event-categories: - card_purchase_supplement.created x-stainless-empty-object: false x-tag: Card Purchase Supplements x-title-plural: Card Purchase Supplements sandbox_generate_a_tax_form_export_parameters: additionalProperties: false example: category: form_1099_int form_1099_int: account_id: account_in71c4amph0vgo2qllky properties: category: description: The type of Export to create. enum: - form_1099_int type: string x-documentation-priority: default x-enum-descriptions: - A PDF of an Internal Revenue Service Form 1099-INT. form_1099_int: additionalProperties: false description: Options for the created export. Required if `category` is equal to `form_1099_int`. properties: account_id: description: The identifier of the Account the tax document is for. type: string x-documentation-priority: default x-id-reference-to: Accounts required: - account_id type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - category type: object x-event-categories: [] x-stainless-empty-object: false sandbox_submit_a_check_deposit_parameters: additionalProperties: false example: {} properties: scan: additionalProperties: false description: If set, the simulation will use these values for the check's scanned MICR data. properties: account_number: description: The account number to be returned in the check deposit's scan data. maxLength: 200 minLength: 1 type: string x-documentation-priority: default auxiliary_on_us: description: The auxiliary on-us data to be returned in the check deposit's scan data. maxLength: 200 minLength: 1 type: string x-documentation-priority: default routing_number: description: The routing number to be returned in the check deposit's scan data. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - account_number - routing_number type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false type: object x-event-categories: [] x-stainless-empty-object: false 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 sandbox_create_a_card_purchase_supplement_parameters: additionalProperties: false example: invoice: discount_amount: 100 duty_tax_amount: 200 order_date: '2023-07-20' shipping_amount: 300 shipping_destination_country_code: US shipping_destination_postal_code: '10045' shipping_source_postal_code: '10045' shipping_tax_amount: 400 shipping_tax_rate: '0.2' unique_value_added_tax_invoice_reference: '12302' line_items: - item_commodity_code: '001' item_descriptor: Coffee item_quantity: '1' product_code: '101' total_amount: 500 unit_cost: '5' unit_of_measure_code: NMB transaction_id: transaction_uyrp7fld2ium70oa7oi properties: invoice: additionalProperties: false description: Invoice-level information about the payment. properties: discount_amount: description: Discount given to cardholder. minimum: 0 type: integer x-documentation-priority: default duty_tax_amount: description: Amount of duty taxes. minimum: 0 type: integer x-documentation-priority: default order_date: description: Date the order was taken. format: date type: string x-documentation-priority: default shipping_amount: description: The shipping cost. minimum: 0 type: integer x-documentation-priority: default shipping_destination_country_code: description: Country code of the shipping destination. maxLength: 200 minLength: 1 type: string x-documentation-priority: default shipping_destination_postal_code: description: Postal code of the shipping destination. maxLength: 200 minLength: 1 type: string x-documentation-priority: default shipping_source_postal_code: description: Postal code of the location being shipped from. maxLength: 200 minLength: 1 type: string x-documentation-priority: default shipping_tax_amount: description: Taxes paid for freight and shipping. minimum: 0 type: integer x-documentation-priority: default shipping_tax_rate: description: Tax rate for freight and shipping. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default unique_value_added_tax_invoice_reference: description: Value added tax invoice reference number. maxLength: 200 minLength: 1 type: string x-documentation-priority: default type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false line_items: description: Line item information, such as individual products purchased. items: additionalProperties: false properties: discount_amount: description: Discount amount for this specific line item. minimum: 0 type: integer x-documentation-priority: default item_commodity_code: description: Code used to categorize the purchase item. maxLength: 200 minLength: 1 type: string x-documentation-priority: default item_descriptor: description: Description of the purchase item. maxLength: 200 minLength: 1 type: string x-documentation-priority: default item_quantity: description: The number of units of the product being purchased. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default product_code: description: Code used to categorize the product being purchased. maxLength: 200 minLength: 1 type: string x-documentation-priority: default sales_tax_amount: description: Sales tax amount for this line item. minimum: 0 type: integer x-documentation-priority: default sales_tax_rate: description: Sales tax rate for this line item. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default total_amount: description: Total amount of all line items. minimum: 0 type: integer x-documentation-priority: default unit_cost: description: Cost of line item per unit of measure, in major units. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default unit_of_measure_code: description: Code indicating unit of measure (gallons, etc.). maxLength: 200 minLength: 1 type: string x-documentation-priority: default type: object x-event-categories: [] x-stainless-empty-object: false type: array x-documentation-priority: default transaction_id: description: The identifier of the Transaction to create a Card Purchase Supplement for. The Transaction must have a source of type `card_settlement`. type: string x-documentation-priority: default x-id-reference-to: Transactions required: - transaction_id type: object x-event-categories: [] x-stainless-empty-object: false pending_transaction: additionalProperties: true description: Pending Transactions are potential future additions and removals of money from your bank account. They impact your available balance, but not your current balance. To learn more, see [Transactions and Transfers](/documentation/transactions-transfers). example: account_id: account_in71c4amph0vgo2qllky amount: 100 completed_at: null created_at: '2020-01-31T23:59:59Z' currency: USD description: INVOICE 2468 held_amount: 100 id: pending_transaction_k1sfetcau2qbvjbzgju4 route_id: card_oubs0hwk5rn6knuecxg2 route_type: card source: ach_transfer_instruction: amount: 100 transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q category: ach_transfer_instruction status: pending type: pending_transaction properties: account_id: description: The identifier for the account this Pending Transaction belongs to. type: string x-documentation-priority: default x-id-reference-to: Accounts amount: description: The Pending Transaction amount in the minor unit of its currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default completed_at: anyOf: - description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending Transaction was completed. format: date-time type: string x-documentation-priority: default - type: 'null' created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Pending 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 Pending Transaction's currency. This will match the currency on the Pending Transaction's Account. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) description: description: For a Pending Transaction related to a transfer, this is the description you provide. For a Pending Transaction related to a payment, this is the description the vendor provides. type: string x-documentation-priority: default held_amount: description: The amount that this Pending Transaction decrements the available balance of its Account. This is usually the same as `amount`, but will differ if the amount is positive. type: integer x-documentation-priority: default id: description: The Pending Transaction identifier. type: string x-documentation-priority: default x-id-reference-to: Pending Transactions route_id: anyOf: - description: The identifier for the route this Pending 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 Pending 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 Pending Transaction. For example, for a card transaction this lists the merchant's industry and location. example: ach_transfer_instruction: amount: 100 transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q category: ach_transfer_instruction properties: account_transfer_instruction: anyOf: - additionalProperties: true description: An Account Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `account_transfer_instruction`. example: amount: 100 currency: USD 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) 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 - transfer_id title: Pending Transaction Pending Transaction Source Account Transfer Instruction type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Account Transfer Instructions - type: 'null' ach_transfer_instruction: anyOf: - additionalProperties: true description: An ACH Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `ach_transfer_instruction`. example: amount: 100 transfer_id: ach_transfer_uoxatyh3lt5evrsdvo7q properties: amount: description: The pending amount in USD cents. type: integer x-documentation-priority: default transfer_id: description: The identifier of the ACH Transfer that led to this Pending Transaction. type: string x-documentation-priority: default x-id-reference-to: ACH Transfers required: - amount - transfer_id title: Pending Transaction Pending Transaction Source ACH Transfer Instruction type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: ACH Transfer Instructions - type: 'null' blockchain_offramp_transfer_instruction: anyOf: - additionalProperties: true description: A Blockchain Off-Ramp Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `blockchain_offramp_transfer_instruction`. 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: Pending Transaction Pending Transaction Source Blockchain Off-Ramp Transfer Instruction type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Blockchain Off-Ramp Transfer Instructions - type: 'null' blockchain_onramp_transfer_instruction: anyOf: - additionalProperties: false description: A Blockchain On-Ramp Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `blockchain_onramp_transfer_instruction`. example: amount: 10000 destination_blockchain_address: '0x304a554a310C7e546dfe434669C62820b7D83490' transfer_id: blockchain_onramp_transfer_sg8nzy569rk0dnfk28bv properties: amount: description: The transfer amount in USD cents. type: integer x-documentation-priority: default destination_blockchain_address: description: The blockchain address the funds are being sent to. type: string x-documentation-priority: default transfer_id: description: The identifier of the Blockchain On-Ramp Transfer that led to this Pending Transaction. type: string x-documentation-priority: default x-id-reference-to: Blockchain On-Ramp Transfers required: - amount - transfer_id - destination_blockchain_address title: Pending Transaction Pending Transaction Source Blockchain On-Ramp Transfer Instruction type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Blockchain On-Ramp Transfer Instructions - type: 'null' card_authorization: anyOf: - $ref: '#/components/schemas/card_authorization' description: A Card Authorization object. This field will be present in the JSON response if and only if `category` is equal to `card_authorization`. Card Authorizations 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_instruction: anyOf: - additionalProperties: false description: A Card Push Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `card_push_transfer_instruction`. example: amount: 100 transfer_id: outbound_card_push_transfer_e0z9rdpamraczh4tvwye properties: 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 Pending Transaction. type: string x-documentation-priority: default x-id-reference-to: Card Push Transfers required: - amount - transfer_id title: Pending Transaction Pending Transaction Source Card Push Transfer Instruction type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Push Transfer Instructions - 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_instruction - ach_transfer_instruction - card_authorization - check_deposit_instruction - check_transfer_instruction - fednow_transfer_instruction - inbound_funds_hold - user_initiated_hold - real_time_payments_transfer_instruction - wire_transfer_instruction - inbound_wire_transfer_reversal - swift_transfer_instruction - card_push_transfer_instruction - blockchain_onramp_transfer_instruction - blockchain_offramp_transfer_instruction - other type: string x-documentation-priority: default x-enum-descriptions: - 'Account Transfer Instruction: details will be under the `account_transfer_instruction` object.' - 'ACH Transfer Instruction: details will be under the `ach_transfer_instruction` object.' - 'Card Authorization: details will be under the `card_authorization` object.' - 'Check Deposit Instruction: details will be under the `check_deposit_instruction` object.' - 'Check Transfer Instruction: details will be under the `check_transfer_instruction` object.' - 'FedNow Transfer Instruction: details will be under the `fednow_transfer_instruction` object.' - 'Inbound Funds Hold: details will be under the `inbound_funds_hold` object.' - 'User Initiated Hold: details will be under the `user_initiated_hold` object.' - 'Real-Time Payments Transfer Instruction: details will be under the `real_time_payments_transfer_instruction` object.' - 'Wire Transfer Instruction: details will be under the `wire_transfer_instruction` object.' - 'Inbound Wire Transfer Reversal: details will be under the `inbound_wire_transfer_reversal` object.' - 'Swift Transfer Instruction: details will be under the `swift_transfer_instruction` object.' - 'Card Push Transfer Instruction: details will be under the `card_push_transfer_instruction` object.' - 'Blockchain On-Ramp Transfer Instruction: details will be under the `blockchain_onramp_transfer_instruction` object.' - 'Blockchain Off-Ramp Transfer Instruction: details will be under the `blockchain_offramp_transfer_instruction` object.' - The Pending Transaction was made for an undocumented or deprecated reason. check_deposit_instruction: anyOf: - additionalProperties: true description: A Check Deposit Instruction object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_instruction`. example: amount: 100 back_image_file_id: file_26khfk98mzfz90a11oqx check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1 currency: USD front_image_file_id: file_makxrc67oh9l6sg7w9yc properties: amount: description: The pending amount in USD cents. type: integer x-documentation-priority: default back_image_file_id: anyOf: - description: The identifier of the File containing the image of the back of the check that was deposited. type: string x-documentation-priority: default x-id-reference-to: Files - type: 'null' check_deposit_id: anyOf: - description: The identifier of the Check Deposit. type: string x-documentation-priority: default x-id-reference-to: Check Deposits - type: 'null' 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) front_image_file_id: description: The identifier of the File containing the image of the front of the check that was deposited. type: string x-documentation-priority: default x-id-reference-to: Files required: - amount - currency - front_image_file_id - back_image_file_id - check_deposit_id title: Pending Transaction Pending Transaction Source Check Deposit Instruction type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Check Deposit Instructions - type: 'null' check_transfer_instruction: anyOf: - additionalProperties: true description: A Check Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `check_transfer_instruction`. example: amount: 100 currency: USD transfer_id: check_transfer_30b43acfu9vw8fyc4f5 properties: amount: description: The transfer amount in USD cents. type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) transfer_id: description: The identifier of the Check Transfer that led to this Pending Transaction. type: string x-documentation-priority: default x-id-reference-to: Check Transfers required: - amount - currency - transfer_id title: Pending Transaction Pending Transaction Source Check Transfer Instruction type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Check Transfer Instructions - type: 'null' fednow_transfer_instruction: anyOf: - additionalProperties: true description: A FedNow Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `fednow_transfer_instruction`. example: transfer_id: fednow_transfer_4i0mptrdu1mueg1196bg properties: transfer_id: description: The identifier of the FedNow Transfer that led to this Pending Transaction. type: string x-documentation-priority: default x-id-reference-to: FedNow Transfers required: - transfer_id title: Pending Transaction Pending Transaction Source FedNow Transfer Instruction type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: FedNow Transfer Instructions - type: 'null' inbound_funds_hold: anyOf: - $ref: '#/components/schemas/inbound_funds_hold' description: An Inbound Funds Hold object. This field will be present in the JSON response if and only if `category` is equal to `inbound_funds_hold`. We hold funds for certain transaction types to account for return windows where funds might still be clawed back by the sending institution. x-documentation-priority: default - type: 'null' inbound_wire_transfer_reversal: anyOf: - $ref: '#/components/schemas/inbound_wire_transfer_reversal' description: An Inbound Wire Transfer Reversal 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 is created when Increase has received a wire and the User requests that it be reversed. x-documentation-priority: default - 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: Pending Transaction Pending 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_instruction: anyOf: - additionalProperties: false description: A Real-Time Payments Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `real_time_payments_transfer_instruction`. example: amount: 100 transfer_id: real_time_payments_transfer_iyuhl5kdn7ssmup83mvq properties: amount: description: The transfer amount in USD cents. type: integer x-documentation-priority: default transfer_id: description: The identifier of the Real-Time Payments Transfer that led to this Pending Transaction. type: string x-documentation-priority: default x-id-reference-to: Real-Time Payments Transfers required: - amount - transfer_id title: Pending Transaction Pending Transaction Source Real-Time Payments Transfer Instruction type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Real-Time Payments Transfer Instructions - type: 'null' swift_transfer_instruction: anyOf: - additionalProperties: true description: A Swift Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `swift_transfer_instruction`. example: transfer_id: swift_transfer_29h21xkng03788zwd3fh properties: transfer_id: description: The identifier of the Swift Transfer that led to this Pending Transaction. type: string x-documentation-priority: default x-id-reference-to: Swift Transfers required: - transfer_id title: Pending Transaction Pending Transaction Source Swift Transfer Instruction type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Swift Transfer Instructions - type: 'null' user_initiated_hold: anyOf: - additionalProperties: true description: An User Initiated Hold object. This field will be present in the JSON response if and only if `category` is equal to `user_initiated_hold`. Created when a user initiates a hold on funds in their account. properties: {} title: Pending Transaction Pending Transaction Source User Initiated Hold type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: User Initiated Holds - type: 'null' wire_transfer_instruction: anyOf: - additionalProperties: true description: A Wire Transfer Instruction object. This field will be present in the JSON response if and only if `category` is equal to `wire_transfer_instruction`. example: account_number: '987654321' amount: 100 message_to_recipient: HELLO routing_number: '101050001' transfer_id: wire_transfer_5akynk7dqsq25qwk9q2u properties: account_number: description: The account number for the destination account. 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) for the destination account. type: string x-documentation-priority: default transfer_id: description: The identifier of the Wire Transfer that led to this Pending 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: Pending Transaction Pending Transaction Source Wire Transfer Instruction type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Wire Transfer Instructions - type: 'null' required: - category title: Pending Transaction Pending Transaction Source type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Pending Transaction Sources status: description: Whether the Pending Transaction has been confirmed and has an associated Transaction. enum: - pending - complete type: string x-documentation-priority: default x-enum-descriptions: - The Pending Transaction is still awaiting confirmation. - The Pending Transaction is confirmed. An associated Transaction exists for this object. The Pending Transaction will no longer count against your balance and can generally be hidden from UIs, etc. type: description: A constant representing the object's type. For this resource it will always be `pending_transaction`. enum: - pending_transaction type: string x-documentation-priority: default required: - type - account_id - amount - held_amount - currency - completed_at - created_at - description - id - route_id - route_type - source - status title: Pending Transaction type: object x-event-categories: - pending_transaction.created - pending_transaction.updated x-stainless-empty-object: false x-tag: Pending Transactions x-title-plural: Pending Transactions 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 card_dispute: additionalProperties: false description: If unauthorized activity occurs on a card, you can create a Card Dispute and we'll work with the card networks to return the funds if appropriate. example: amount: 1000 card_id: card_oubs0hwk5rn6knuecxg2 created_at: '2020-01-31T23:59:59Z' disputed_transaction_id: transaction_uyrp7fld2ium70oa7oi id: card_dispute_h9sc95nbl1cgltpp7men idempotency_key: null loss: null network: visa status: pending_response type: card_dispute user_submission_required_by: null visa: network_events: [] required_user_submission_category: null user_submissions: - accepted_at: null amount: 1000 attachment_files: [] category: chargeback chargeback: authorization: null category: fraud consumer_canceled_merchandise: null consumer_canceled_recurring_transaction: null consumer_canceled_services: null consumer_counterfeit_merchandise: null consumer_credit_not_processed: null consumer_damaged_or_defective_merchandise: null consumer_merchandise_misrepresentation: null consumer_merchandise_not_as_described: null consumer_merchandise_not_received: null consumer_non_receipt_of_cash: null consumer_original_credit_transaction_not_accepted: null consumer_quality_merchandise: null consumer_quality_services: null consumer_services_misrepresentation: null consumer_services_not_as_described: null consumer_services_not_received: null fraud: fraud_type: lost processing_error: null created_at: '2020-01-31T23:59:59Z' explanation: null further_information_requested_at: null further_information_requested_reason: null status: pending_reviewing updated_at: '2020-01-31T23:59:59Z' win: null withdrawal: null properties: amount: description: The amount of the dispute. type: integer x-documentation-priority: default card_id: description: The Card that the Card Dispute is associated with. type: string x-documentation-priority: default x-id-reference-to: Cards created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was created. format: date-time type: string x-documentation-priority: default disputed_transaction_id: description: The identifier of the Transaction that was disputed. type: string x-documentation-priority: default x-id-reference-to: Transactions id: description: The Card Dispute identifier. type: string x-documentation-priority: default x-id-reference-to: Card Disputes idempotency_key: anyOf: - description: The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys). type: string x-documentation-priority: default - type: 'null' loss: anyOf: - additionalProperties: false description: If the Card Dispute's status is `lost`, this will contain details of the lost dispute. example: lost_at: '2020-01-31T23:59:59Z' reason: user_withdrawn properties: 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 reason: description: The reason the Card Dispute was lost. enum: - user_withdrawn - loss type: string x-documentation-priority: default x-enum-descriptions: - The user withdrew the Card Dispute. - The Card Dispute was lost according to network rules. required: - lost_at - reason title: Card Dispute Card Dispute Loss type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Dispute Losses - type: 'null' 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.' status: description: The status of the Card Dispute. enum: - user_submission_required - pending_user_submission_reviewing - pending_user_submission_submitting - pending_user_withdrawal_submitting - pending_response - lost - won type: string x-documentation-priority: default x-enum-descriptions: - A User Submission is required to continue with the Card Dispute. - The most recent User Submission is being reviewed. - The most recent User Submission is being submitted to the network. - The user's withdrawal of the Card Dispute is being submitted to the network. - The Card Dispute is pending a response from the network. - The Card Dispute has been lost and funds previously credited from the acceptance have been debited. - The Card Dispute has been won and no further action can be taken. type: description: A constant representing the object's type. For this resource it will always be `card_dispute`. enum: - card_dispute type: string x-documentation-priority: default user_submission_required_by: anyOf: - description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the user submission is required by. Present only if status is `user_submission_required` and a user submission is required by a certain time. Otherwise, this will be `nil`. format: date-time type: string x-documentation-priority: default - type: 'null' visa: anyOf: - $ref: '#/components/schemas/card_dispute_visa' description: Card Dispute information 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' win: anyOf: - additionalProperties: false description: If the Card Dispute's status is `won`, this will contain details of the won dispute. example: won_at: '2020-01-31T23:59:59Z' properties: won_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was won. format: date-time type: string x-documentation-priority: default required: - won_at title: Card Dispute Card Dispute Win type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Dispute Wins - type: 'null' withdrawal: anyOf: - additionalProperties: false description: If the Card Dispute has been withdrawn, this will contain details of the withdrawal. example: explanation: The cardholder requested a withdrawal of the dispute. properties: explanation: anyOf: - description: The explanation for the withdrawal of the Card Dispute. type: string x-documentation-priority: default - type: 'null' required: - explanation title: Card Dispute Card Dispute Withdrawal type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Dispute Withdrawals - type: 'null' required: - type - id - amount - user_submission_required_by - status - created_at - disputed_transaction_id - network - loss - win - withdrawal - card_id - visa - idempotency_key title: Card Dispute type: object x-event-categories: - card_dispute.created - card_dispute.updated x-stainless-empty-object: false x-tag: Card Disputes x-title-plural: Card Disputes sandbox_complete_a_real_time_payments_transfer_parameters: additionalProperties: false example: {} properties: rejection: additionalProperties: false description: If set, the simulation will reject the transfer. properties: reject_reason_code: description: The reason code that the simulated rejection will have. enum: - account_closed - account_blocked - invalid_creditor_account_type - invalid_creditor_account_number - invalid_creditor_financial_institution_identifier - end_customer_deceased - narrative - transaction_forbidden - transaction_type_not_supported - unexpected_amount - amount_exceeds_bank_limits - invalid_creditor_address - unknown_end_customer - invalid_debtor_address - timeout - unsupported_message_for_recipient - recipient_connection_not_available - real_time_payments_suspended - instructed_agent_signed_off - processing_error - other type: string x-documentation-priority: default x-enum-descriptions: - The destination account is closed. Corresponds to the Real-Time Payments reason code `AC04`. - The destination account is currently blocked from receiving transactions. Corresponds to the Real-Time Payments reason code `AC06`. - The destination account is ineligible to receive Real-Time Payments transfers. Corresponds to the Real-Time Payments reason code `AC14`. - The destination account does not exist. Corresponds to the Real-Time Payments reason code `AC03`. - The destination routing number is invalid. Corresponds to the Real-Time Payments reason code `RC04`. - The destination account holder is deceased. Corresponds to the Real-Time Payments reason code `MD07`. - The reason is provided as narrative information in the additional information field. - Real-Time Payments transfers are not allowed to the destination account. Corresponds to the Real-Time Payments reason code `AG01`. - Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code `AG03`. - The amount of the transfer is different than expected by the recipient. Corresponds to the Real-Time Payments reason code `AM09`. - The amount is higher than the recipient is authorized to send or receive. Corresponds to the Real-Time Payments reason code `AM14`. - The creditor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code `BE04`. - The specified creditor is unknown. Corresponds to the Real-Time Payments reason code `BE06`. - The debtor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code `BE07`. - There was a timeout processing the transfer. Corresponds to the Real-Time Payments reason code `DS24`. - Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code `NOAT`. - The destination financial institution is currently not connected to Real-Time Payments. Corresponds to the Real-Time Payments reason code `9912`. - Real-Time Payments is currently unavailable. Corresponds to the Real-Time Payments reason code `9948`. - The destination financial institution is currently signed off of Real-Time Payments. Corresponds to the Real-Time Payments reason code `9910`. - The transfer was rejected due to an internal Increase issue. We have been notified. - Some other error or issue has occurred. required: - reject_reason_code type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false type: object x-event-categories: [] x-stainless-empty-object: false program: additionalProperties: false description: Programs determine the compliance and commercial terms of Accounts. By default, you have a Commercial Banking program for managing your own funds. If you are lending or managing funds on behalf of your customers, or otherwise engaged in regulated activity, we will work together to create additional Programs for you. example: bank: first_internet_bank billing_account_id: null created_at: '2020-01-31T23:59:59Z' default_digital_card_profile_id: null id: program_i2v2os4mwza1oetokh9i interest_rate: '0.01' lending: null name: Commercial Banking type: program updated_at: '2020-01-31T23:59:59Z' properties: bank: description: The Bank the Program is with. enum: - core_bank - first_internet_bank - grasshopper_bank type: string x-documentation-priority: default x-enum-descriptions: - Core Bank - First Internet Bank of Indiana - Grasshopper Bank billing_account_id: anyOf: - description: The Program billing account. type: string x-documentation-priority: default x-id-reference-to: Accounts - type: 'null' created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program was created. format: date-time type: string x-documentation-priority: default default_digital_card_profile_id: anyOf: - description: The default configuration for digital cards attached to this Program. type: string x-documentation-priority: default x-id-reference-to: Digital Card Profiles - type: 'null' id: description: The Program identifier. type: string x-documentation-priority: default x-id-reference-to: Programs interest_rate: description: The Interest Rate currently being earned on the accounts in this program, as a string containing a decimal number. For example, a 1% interest rate would be represented as "0.01". pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default lending: anyOf: - additionalProperties: false description: The lending details for the program. properties: maximum_extendable_credit: description: The maximum extendable credit of the program. type: integer x-documentation-priority: default required: - maximum_extendable_credit title: Program Lending type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Lendings - type: 'null' name: description: The name of the Program. type: string x-documentation-priority: default type: description: A constant representing the object's type. For this resource it will always be `program`. enum: - program type: string x-documentation-priority: default updated_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Program was last updated. format: date-time type: string x-documentation-priority: default required: - type - name - created_at - updated_at - id - billing_account_id - default_digital_card_profile_id - interest_rate - bank - lending title: Program type: object x-event-categories: - program.created - program.updated x-stainless-empty-object: false x-tag: Programs x-title-plural: Programs 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 card_dispute_visa_network_event: additionalProperties: false properties: attachment_files: description: The files attached to the Visa Card Dispute User Submission. items: $ref: '#/components/schemas/card_dispute_file_attachment' type: array x-documentation-priority: default category: description: The category of the user submission. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully. enum: - chargeback_accepted - chargeback_submitted - chargeback_timed_out - merchant_prearbitration_decline_submitted - merchant_prearbitration_received - merchant_prearbitration_timed_out - represented - representment_timed_out - user_prearbitration_accepted - user_prearbitration_declined - user_prearbitration_submitted - user_prearbitration_timed_out - user_withdrawal_submitted type: string x-documentation-priority: default x-enum-descriptions: - 'Card Dispute Chargeback Accepted Visa Network Event: details will be under the `chargeback_accepted` object.' - 'Card Dispute Chargeback Submitted Visa Network Event: details will be under the `chargeback_submitted` object.' - 'Card Dispute Chargeback Timed Out Visa Network Event: details will be under the `chargeback_timed_out` object.' - 'Card Dispute Merchant Pre-Arbitration Decline Submitted Visa Network Event: details will be under the `merchant_prearbitration_decline_submitted` object.' - 'Card Dispute Merchant Pre-Arbitration Received Visa Network Event: details will be under the `merchant_prearbitration_received` object.' - 'Card Dispute Merchant Pre-Arbitration Timed Out Visa Network Event: details will be under the `merchant_prearbitration_timed_out` object.' - 'Card Dispute Re-presented Visa Network Event: details will be under the `represented` object.' - 'Card Dispute Re-presentment Timed Out Visa Network Event: details will be under the `representment_timed_out` object.' - 'Card Dispute User Pre-Arbitration Accepted Visa Network Event: details will be under the `user_prearbitration_accepted` object.' - 'Card Dispute User Pre-Arbitration Declined Visa Network Event: details will be under the `user_prearbitration_declined` object.' - 'Card Dispute User Pre-Arbitration Submitted Visa Network Event: details will be under the `user_prearbitration_submitted` object.' - 'Card Dispute User Pre-Arbitration Timed Out Visa Network Event: details will be under the `user_prearbitration_timed_out` object.' - 'Card Dispute User Withdrawal Submitted Visa Network Event: details will be under the `user_withdrawal_submitted` object.' chargeback_accepted: anyOf: - additionalProperties: false description: A Card Dispute Chargeback Accepted Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `chargeback_accepted`. Contains the details specific to a chargeback accepted Visa Card Dispute Network Event, which represents that a chargeback has been accepted by the merchant. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute Chargeback Accepted Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute Chargeback Accepted Visa Network Events - type: 'null' chargeback_submitted: anyOf: - additionalProperties: false description: A Card Dispute Chargeback Submitted Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `chargeback_submitted`. Contains the details specific to a chargeback submitted Visa Card Dispute Network Event, which represents that a chargeback has been submitted to the network. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute Chargeback Submitted Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute Chargeback Submitted Visa Network Events - type: 'null' chargeback_timed_out: anyOf: - additionalProperties: false description: A Card Dispute Chargeback Timed Out Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `chargeback_timed_out`. Contains the details specific to a chargeback timed out Visa Card Dispute Network Event, which represents that the chargeback has timed out in the user's favor. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute Chargeback Timed Out Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute Chargeback Timed Out Visa Network Events - type: 'null' created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Visa Card Dispute Network Event was created. format: date-time type: string x-documentation-priority: default dispute_financial_transaction_id: anyOf: - description: The dispute financial transaction that resulted from the network event, if any. type: string x-documentation-priority: default x-id-reference-to: Transactions - type: 'null' merchant_prearbitration_decline_submitted: anyOf: - additionalProperties: false description: A Card Dispute Merchant Pre-Arbitration Decline Submitted Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `merchant_prearbitration_decline_submitted`. Contains the details specific to a merchant prearbitration decline submitted Visa Card Dispute Network Event, which represents that the user has declined the merchant's request for a prearbitration request decision in their favor. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Decline Submitted Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute Merchant Pre-Arbitration Decline Submitted Visa Network Events - type: 'null' merchant_prearbitration_received: anyOf: - additionalProperties: false description: A Card Dispute Merchant Pre-Arbitration Received Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `merchant_prearbitration_received`. Contains the details specific to a merchant prearbitration received Visa Card Dispute Network Event, which represents that the merchant has issued a prearbitration request in the user's favor. example: cardholder_no_longer_disputes: explanation: See the attached email where the cardholder confirmed that they no longer dispute the transaction. compelling_evidence: null credit_or_reversal_processed: null delayed_charge_transaction: null evidence_of_imprint: null invalid_dispute: null non_fiat_currency_or_non_fungible_token_received: null prior_undisputed_non_fraud_transactions: null reason: cardholder_no_longer_disputes properties: cardholder_no_longer_disputes: anyOf: - additionalProperties: false description: Cardholder no longer disputes details. Present if and only if `reason` is `cardholder_no_longer_disputes`. example: explanation: See the attached email where the cardholder confirmed that they no longer dispute the transaction. properties: explanation: anyOf: - description: Explanation for why the merchant believes the cardholder no longer disputes the transaction. type: string x-documentation-priority: default - type: 'null' required: - explanation title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Cardholder No Longer Disputes type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholder No Longer Disputes - type: 'null' compelling_evidence: anyOf: - additionalProperties: false description: Compelling evidence details. Present if and only if `reason` is `compelling_evidence`. example: category: merchandise_use explanation: null properties: category: description: The category of compelling evidence provided by the merchant. enum: - authorized_signer - delivery - delivery_at_place_of_employment - digital_goods_download - dynamic_currency_conversion_actively_chosen - flight_manifest_and_purchase_itinerary - household_member_signer - legitimate_spend_across_payment_types_for_same_merchandise - merchandise_use - passenger_transport_ticket_use - recurring_transaction_with_binding_contract_or_previous_undisputed_transaction - signed_delivery_or_pickup_form - signed_mail_order_phone_order_form - travel_and_expense_loyalty_transaction - travel_and_expense_subsequent_purchase type: string x-documentation-priority: default x-enum-descriptions: - Authorized signer known by the cardholder. - Proof of delivery. - Proof of delivery to cardholder at place of employment. - Proof of digital goods download. - Dynamic Currency Conversion actively chosen by cardholder. - Flight manifest with corresponding purchase itinerary record. - Signer is member of cardholder's household. - Legitimate spend across multiple payment types for same merchandise. - Documentation to prove the cardholder is in possession of and/or using the merchandise. - 'Passenger transport: proof ticket was received, scanned at gate or other transaction related to original (for example, frequent flyer miles.)' - Recurring transaction with binding contract or previous undisputed recurring transactions and proof the cardholder is using the merchandise or service. - Signed delivery form, or copy of/details of identification from cardholder as proof goods were picked up at merchant location. - Signed Mail Order/Phone Order form. - 'Travel & Expense: loyalty transactions related to purchase.' - 'Travel & Expense: subsequent purchases made throughout service period.' explanation: anyOf: - description: Explanation of the compelling evidence provided by the merchant. type: string x-documentation-priority: default - type: 'null' required: - category - explanation title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Compelling Evidence type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Compelling Evidences - type: 'null' credit_or_reversal_processed: anyOf: - additionalProperties: false description: Credit or reversal processed details. Present if and only if `reason` is `credit_or_reversal_processed`. example: amount: 4900 currency: USD explanation: The user did not provide the required documentation. processed_at: '2020-01-31' properties: amount: description: The amount of the credit or reversal in the minor unit of its 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 credit or reversal's currency. type: string x-documentation-priority: default explanation: anyOf: - description: Explanation for why the merchant believes the credit or reversal was processed. type: string x-documentation-priority: default - type: 'null' processed_at: description: The date the credit or reversal was processed. format: date type: string x-documentation-priority: default required: - explanation - processed_at - amount - currency title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Credit Or Reversal Processed type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Credit Or Reversal Processeds - type: 'null' delayed_charge_transaction: anyOf: - additionalProperties: false description: Delayed charge transaction details. Present if and only if `reason` is `delayed_charge_transaction`. example: explanation: null properties: explanation: anyOf: - description: Additional details about the delayed charge transaction. type: string x-documentation-priority: default - type: 'null' required: - explanation title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Delayed Charge Transaction type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Delayed Charge Transactions - type: 'null' evidence_of_imprint: anyOf: - additionalProperties: false description: Evidence of imprint details. Present if and only if `reason` is `evidence_of_imprint`. example: explanation: null properties: explanation: anyOf: - description: Explanation of the evidence of imprint. type: string x-documentation-priority: default - type: 'null' required: - explanation title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Evidence Of Imprint type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Evidence Of Imprints - type: 'null' invalid_dispute: anyOf: - additionalProperties: false description: Invalid dispute details. Present if and only if `reason` is `invalid_dispute`. example: explanation: The user did not provide the required documentation. reason: other properties: explanation: anyOf: - description: Explanation for why the dispute is considered invalid by the merchant. type: string x-documentation-priority: default - type: 'null' reason: description: The reason a merchant considers the dispute invalid. enum: - other - special_authorization_procedures_followed type: string x-documentation-priority: default x-enum-descriptions: - Other. - Special authorization procedures followed. required: - reason - explanation title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Invalid Dispute type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Invalid Disputes - type: 'null' non_fiat_currency_or_non_fungible_token_received: anyOf: - additionalProperties: false description: Non-fiat currency or non-fungible token received details. Present if and only if `reason` is `non_fiat_currency_or_non_fungible_token_received`. example: blockchain_transaction_hash: '0x1234567890123456789012345678901234567890' destination_wallet_address: '0x1234567890123456789012345678901234567890' prior_approved_transactions: '0x1234567890123456789012345678901234567890' properties: blockchain_transaction_hash: description: Blockchain transaction hash. type: string x-documentation-priority: default destination_wallet_address: description: Destination wallet address. type: string x-documentation-priority: default prior_approved_transactions: anyOf: - description: Prior approved transactions. type: string x-documentation-priority: default - type: 'null' required: - destination_wallet_address - blockchain_transaction_hash - prior_approved_transactions title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Non Fiat Currency Or Non Fungible Token Received type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Non Fiat Currency Or Non Fungible Token Receiveds - type: 'null' prior_undisputed_non_fraud_transactions: anyOf: - additionalProperties: false description: Prior undisputed non-fraud transactions details. Present if and only if `reason` is `prior_undisputed_non_fraud_transactions`. example: explanation: null properties: explanation: anyOf: - description: Explanation of the prior undisputed non-fraud transactions provided by the merchant. type: string x-documentation-priority: default - type: 'null' required: - explanation title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event Prior Undisputed Non Fraud Transactions type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Prior Undisputed Non Fraud Transactions - type: 'null' reason: description: The reason the merchant re-presented the dispute. enum: - cardholder_no_longer_disputes - compelling_evidence - credit_or_reversal_processed - delayed_charge_transaction - evidence_of_imprint - invalid_dispute - non_fiat_currency_or_non_fungible_token_received - prior_undisputed_non_fraud_transactions type: string x-documentation-priority: default x-enum-descriptions: - Cardholder no longer disputes the transaction. - Compelling evidence. - Credit or reversal was processed. - Delayed charge transaction. - Evidence of imprint. - Invalid dispute. - Non-fiat currency or non-fungible token was received by the cardholder. - Prior undisputed non-fraud transactions. required: - reason - cardholder_no_longer_disputes - compelling_evidence - credit_or_reversal_processed - delayed_charge_transaction - evidence_of_imprint - invalid_dispute - non_fiat_currency_or_non_fungible_token_received - prior_undisputed_non_fraud_transactions title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Received Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Dispute Merchant Pre-Arbitration Received Visa Network Events - type: 'null' merchant_prearbitration_timed_out: anyOf: - additionalProperties: false description: A Card Dispute Merchant Pre-Arbitration Timed Out Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `merchant_prearbitration_timed_out`. Contains the details specific to a merchant prearbitration timed out Visa Card Dispute Network Event, which represents that the user has timed out responding to the merchant's prearbitration request. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute Merchant Pre-Arbitration Timed Out Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute Merchant Pre-Arbitration Timed Out Visa Network Events - type: 'null' represented: anyOf: - additionalProperties: false description: A Card Dispute Re-presented Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `represented`. Contains the details specific to a re-presented Visa Card Dispute Network Event, which represents that the merchant has declined the user's chargeback and has re-presented the payment. example: cardholder_no_longer_disputes: null credit_or_reversal_processed: null invalid_dispute: explanation: The user did not provide the required documentation. reason: other non_fiat_currency_or_non_fungible_token_as_described: null non_fiat_currency_or_non_fungible_token_received: null proof_of_cash_disbursement: null reason: invalid_dispute reversal_issued: null properties: cardholder_no_longer_disputes: anyOf: - additionalProperties: false description: Cardholder no longer disputes details. Present if and only if `reason` is `cardholder_no_longer_disputes`. example: explanation: See the attached email where the cardholder confirmed that they no longer dispute the transaction. properties: explanation: anyOf: - description: Explanation for why the merchant believes the cardholder no longer disputes the transaction. type: string x-documentation-priority: default - type: 'null' required: - explanation title: Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Cardholder No Longer Disputes type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholder No Longer Disputes - type: 'null' credit_or_reversal_processed: anyOf: - additionalProperties: false description: Credit or reversal processed details. Present if and only if `reason` is `credit_or_reversal_processed`. example: amount: 4900 currency: USD explanation: The user did not provide the required documentation. processed_at: '2020-01-31' properties: amount: description: The amount of the credit or reversal in the minor unit of its 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 credit or reversal's currency. type: string x-documentation-priority: default explanation: anyOf: - description: Explanation for why the merchant believes the credit or reversal was processed. type: string x-documentation-priority: default - type: 'null' processed_at: description: The date the credit or reversal was processed. format: date type: string x-documentation-priority: default required: - explanation - processed_at - amount - currency title: Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Credit Or Reversal Processed type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Credit Or Reversal Processeds - type: 'null' invalid_dispute: anyOf: - additionalProperties: false description: Invalid dispute details. Present if and only if `reason` is `invalid_dispute`. example: explanation: The user did not provide the required documentation. reason: other properties: explanation: anyOf: - description: Explanation for why the dispute is considered invalid by the merchant. type: string x-documentation-priority: default - type: 'null' reason: description: The reason a merchant considers the dispute invalid. enum: - automatic_teller_machine_transaction_proof_provided - balance_of_partial_prepayment_not_paid - cardholder_canceled_before_expected_merchandise_receipt_date - cardholder_canceled_before_expected_services_receipt_date - cardholder_canceled_different_date - cardholder_did_not_cancel_according_to_policy - cardholder_received_merchandise - country_code_correct - credit_processed_correctly - currency_correct - dispute_is_for_quality - dispute_is_for_visa_cash_back_transaction_portion - disputed_amount_is_value_added_tax - disputed_amount_is_value_added_tax_no_credit_receipt_provided - limited_return_or_cancellation_policy_properly_disclosed - merchandise_held_at_cardholder_customs_agency - merchandise_matches_description - merchandise_not_counterfeit - merchandise_not_damaged - merchandise_not_defective - merchandise_provided_prior_to_cancellation_date - merchandise_quality_matches_description - merchandise_return_not_attempted - merchant_not_notified_of_closed_account - name_on_flight_manifest_matches_purchase - no_credit_receipt_provided - other - processing_error_incorrect - returned_mechandise_held_at_customs_agency_outside_merchant_country - services_match_description - services_provided_prior_to_cancellation_date - services_used_after_cancellation_date - terms_of_service_not_misrepresented - transaction_code_correct type: string x-documentation-priority: default x-enum-descriptions: - Automatic Teller Machine (ATM) transaction proof provided. - Balance of partial prepayment not paid. - Cardholder canceled before expected receipt date of the merchandise. - Cardholder canceled before expected receipt date of the services. - Cardholder canceled on a different date than claimed. - Cardholder received did not cancel according to policy. - Cardholder received the merchandise. - Country code is correct. - Credit was processed correctly. - Currency is correct. - Dispute is for quality. - Dispute is for Visa Cash Back transaction portion. - Disputed amount is Value Added Tax (VAT). - Disputed amount is Value Added Tax (VAT) but no credit receipt was provided by the cardholder. - Limited return or cancellation policy was properly disclosed. - Merchandise held at cardholder customs agency. - Merchandise matches the merchant's description. - Merchandise is not counterfeit. - Merchandise is not damaged. - Merchandise is not defective. - Merchandise was provided prior to the cancellation date. - Merchandise quality matches the merchant's description. - Merchandise was not attempted returned to the merchant. - Merchant was not notified of the closed account. - Name on manifest of departed flight matches name on purchased itinerary. - No credit receipt was provided by the cardholder. - Other. - The claimed processing error did not occur. - Returned merchandise held at customs agency outside the merchant's country. - Services match the merchant's description. - Services were provided prior to the cancellation date. - Services were used after the cancellation date and prior to the dispute submission date. - Terms of service were not misrepresented. - Transaction code is correct. required: - reason - explanation title: Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Invalid Dispute type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Invalid Disputes - type: 'null' non_fiat_currency_or_non_fungible_token_as_described: anyOf: - additionalProperties: false description: Non-fiat currency or non-fungible token as described details. Present if and only if `reason` is `non_fiat_currency_or_non_fungible_token_as_described`. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Non Fiat Currency Or Non Fungible Token As Described type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Non Fiat Currency Or Non Fungible Token As Describeds - type: 'null' non_fiat_currency_or_non_fungible_token_received: anyOf: - additionalProperties: false description: Non-fiat currency or non-fungible token received details. Present if and only if `reason` is `non_fiat_currency_or_non_fungible_token_received`. example: blockchain_transaction_hash: '0x1234567890123456789012345678901234567890' destination_wallet_address: '0x1234567890123456789012345678901234567890' prior_approved_transactions: '0x1234567890123456789012345678901234567890' properties: blockchain_transaction_hash: description: Blockchain transaction hash. type: string x-documentation-priority: default destination_wallet_address: description: Destination wallet address. type: string x-documentation-priority: default prior_approved_transactions: anyOf: - description: Prior approved transactions. type: string x-documentation-priority: default - type: 'null' required: - destination_wallet_address - blockchain_transaction_hash - prior_approved_transactions title: Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Non Fiat Currency Or Non Fungible Token Received type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Non Fiat Currency Or Non Fungible Token Receiveds - type: 'null' proof_of_cash_disbursement: anyOf: - additionalProperties: false description: Proof of cash disbursement details. Present if and only if `reason` is `proof_of_cash_disbursement`. example: explanation: null properties: explanation: anyOf: - description: Explanation for why the merchant believes the evidence provides proof of cash disbursement. type: string x-documentation-priority: default - type: 'null' required: - explanation title: Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Proof Of Cash Disbursement type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Proof Of Cash Disbursements - type: 'null' reason: description: The reason the merchant re-presented the dispute. enum: - cardholder_no_longer_disputes - credit_or_reversal_processed - invalid_dispute - non_fiat_currency_or_non_fungible_token_as_described - non_fiat_currency_or_non_fungible_token_received - proof_of_cash_disbursement - reversal_issued type: string x-documentation-priority: default x-enum-descriptions: - Cardholder no longer disputes the transaction. - Credit or reversal was processed. - Invalid dispute. - Non-fiat currency or non-fungible token is as described by the merchant. - Non-fiat currency or non-fungible token was received by the cardholder. - Proof of cash disbursement provided. - Reversal issued by merchant. reversal_issued: anyOf: - additionalProperties: false description: Reversal issued by merchant details. Present if and only if `reason` is `reversal_issued`. example: explanation: The merchant has issued a reversal for the transaction prior to the dispute being filed. properties: explanation: anyOf: - description: Explanation of the reversal issued by the merchant. type: string x-documentation-priority: default - type: 'null' required: - explanation title: Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event Reversal Issued By Merchant type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Reversal Issued By Merchants - type: 'null' required: - reason - cardholder_no_longer_disputes - credit_or_reversal_processed - invalid_dispute - non_fiat_currency_or_non_fungible_token_as_described - non_fiat_currency_or_non_fungible_token_received - proof_of_cash_disbursement - reversal_issued title: Visa Card Dispute Network Event Card Dispute Re-presented Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Dispute Re-presented Visa Network Events - type: 'null' representment_timed_out: anyOf: - additionalProperties: false description: A Card Dispute Re-presentment Timed Out Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `representment_timed_out`. Contains the details specific to a re-presentment time-out Visa Card Dispute Network Event, which represents that the user did not respond to the re-presentment by the merchant within the time limit. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute Re-presentment Timed Out Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute Re-presentment Timed Out Visa Network Events - type: 'null' user_prearbitration_accepted: anyOf: - additionalProperties: false description: A Card Dispute User Pre-Arbitration Accepted Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `user_prearbitration_accepted`. Contains the details specific to a user prearbitration accepted Visa Card Dispute Network Event, which represents that the merchant has accepted the user's prearbitration request in the user's favor. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute User Pre-Arbitration Accepted Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute User Pre-Arbitration Accepted Visa Network Events - type: 'null' user_prearbitration_declined: anyOf: - additionalProperties: false description: A Card Dispute User Pre-Arbitration Declined Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `user_prearbitration_declined`. Contains the details specific to a user prearbitration declined Visa Card Dispute Network Event, which represents that the merchant has declined the user's prearbitration request. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute User Pre-Arbitration Declined Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute User Pre-Arbitration Declined Visa Network Events - type: 'null' user_prearbitration_submitted: anyOf: - additionalProperties: false description: A Card Dispute User Pre-Arbitration Submitted Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `user_prearbitration_submitted`. Contains the details specific to a user prearbitration submitted Visa Card Dispute Network Event, which represents that the user's request for prearbitration has been submitted to the network. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute User Pre-Arbitration Submitted Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute User Pre-Arbitration Submitted Visa Network Events - type: 'null' user_prearbitration_timed_out: anyOf: - additionalProperties: false description: A Card Dispute User Pre-Arbitration Timed Out Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `user_prearbitration_timed_out`. Contains the details specific to a user prearbitration timed out Visa Card Dispute Network Event, which represents that the merchant has timed out responding to the user's prearbitration request. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute User Pre-Arbitration Timed Out Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute User Pre-Arbitration Timed Out Visa Network Events - type: 'null' user_withdrawal_submitted: anyOf: - additionalProperties: false description: A Card Dispute User Withdrawal Submitted Visa Network Event object. This field will be present in the JSON response if and only if `category` is equal to `user_withdrawal_submitted`. Contains the details specific to a user withdrawal submitted Visa Card Dispute Network Event, which represents that the user's request to withdraw the dispute has been submitted to the network. example: {} properties: {} title: Visa Card Dispute Network Event Card Dispute User Withdrawal Submitted Visa Network Event type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Card Dispute User Withdrawal Submitted Visa Network Events - type: 'null' required: - created_at - attachment_files - dispute_financial_transaction_id - category title: Visa Card Dispute Network Event type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Visa Card Dispute Network Events sandbox_confirm_the_fuel_pump_amount_for_a_card_authorization_parameters: additionalProperties: false example: amount: 5000 card_payment_id: card_payment_nd3k2kacrqjli8482ave properties: amount: description: The amount of the fuel_confirmation in minor units in the card authorization's currency. maximum: 1000000000 minimum: 1 type: integer x-documentation-priority: default card_payment_id: description: The identifier of the Card Payment to create a fuel_confirmation on. type: string x-documentation-priority: default x-id-reference-to: Card Payments required: - card_payment_id - amount type: object x-event-categories: [] x-stainless-empty-object: false inbound_card_authorization_simulation_result: additionalProperties: false description: The results of a Card Authorization simulation. example: declined_transaction: null pending_transaction: account_id: account_in71c4amph0vgo2qllky amount: 100 completed_at: null created_at: '2020-01-31T23:59:59Z' currency: USD description: INVOICE 2468 held_amount: 100 id: pending_transaction_k1sfetcau2qbvjbzgju4 route_id: card_oubs0hwk5rn6knuecxg2 route_type: card source: card_authorization: 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 expires_at: '2020-01-31T23:59:59Z' id: card_authorization_6iqxap6ivd0fo5eu3i8x 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 pending_transaction_id: null 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 type: card_authorization 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 category: card_authorization status: pending type: pending_transaction type: inbound_card_authorization_simulation_result properties: declined_transaction: anyOf: - $ref: '#/components/schemas/declined_transaction' description: 'If the authorization attempt fails, this will contain the resulting [Declined Transaction](#declined-transactions) object. The Declined Transaction''s `source` will be of `category: card_decline`.' x-documentation-priority: default - type: 'null' pending_transaction: anyOf: - $ref: '#/components/schemas/pending_transaction' description: 'If the authorization attempt succeeds, this will contain the resulting Pending Transaction object. The Pending Transaction''s `source` will be of `category: card_authorization`.' x-documentation-priority: default - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `inbound_card_authorization_simulation_result`. enum: - inbound_card_authorization_simulation_result type: string x-documentation-priority: default required: - type - pending_transaction - declined_transaction title: Inbound Card Authorization Simulation Result type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound Card Authorization Simulation Results sandbox_create_a_card_authentication_attempt_parameters: additionalProperties: false example: card_id: card_oubs0hwk5rn6knuecxg2 merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_country: US purchase_amount: 1000 properties: card_id: description: The identifier of the Card to be authorized. type: string x-documentation-priority: default x-id-reference-to: Cards category: description: The category of the card authentication attempt. enum: - payment_authentication - non_payment_authentication type: string x-documentation-priority: default x-enum-descriptions: - The authentication attempt is for a payment. - The authentication attempt is not for a payment. device_channel: description: The device channel of the card authentication attempt. enum: - app - browser - three_ds_requestor_initiated type: string x-documentation-priority: default x-enum-descriptions: - The authentication attempt was made from an app. - The authentication attempt was made from a browser. - The authentication attempt was initiated by the 3DS Requestor. merchant_acceptor_id: description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. maxLength: 200 minLength: 1 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. maxLength: 200 minLength: 1 type: string x-documentation-priority: default merchant_country: description: The country the merchant resides in. maxLength: 200 minLength: 1 type: string x-documentation-priority: default merchant_name: description: The name of the merchant maxLength: 200 minLength: 1 type: string x-documentation-priority: default purchase_amount: description: The purchase amount in cents. maximum: 1000000000 minimum: 1 type: integer x-documentation-priority: default required: - card_id type: object x-event-categories: [] x-stainless-empty-object: false sandbox_create_an_account_revenue_payment_parameters: additionalProperties: false example: account_id: account_in71c4amph0vgo2qllky amount: 1000 properties: account_id: description: The identifier of the Account the Account Revenue Payment should be paid to. type: string x-documentation-priority: default x-id-reference-to: Accounts accrued_on_account_id: description: The identifier of the Account the account revenue accrued on. Defaults to `account_id`. type: string x-documentation-priority: default x-id-reference-to: Accounts amount: description: The account revenue amount in cents. Must be positive. maximum: 1000000000 minimum: 1 type: integer x-documentation-priority: default period_end: description: The end of the account revenue period. If not provided, defaults to the current time. format: date-time type: string x-documentation-priority: default period_start: description: The start of the account revenue period. If not provided, defaults to the current time. format: date-time type: string x-documentation-priority: default required: - account_id - amount type: object x-event-categories: [] x-stainless-empty-object: false 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: [] sandbox_create_a_notification_of_change_for_an_ach_transfer_parameters: additionalProperties: false example: change_code: incorrect_routing_number corrected_data: '123456789' properties: change_code: description: The reason for the notification of change. enum: - incorrect_account_number - incorrect_routing_number - incorrect_routing_number_and_account_number - incorrect_transaction_code - incorrect_account_number_and_transaction_code - incorrect_routing_number_account_number_and_transaction_code - incorrect_receiving_depository_financial_institution_identification - incorrect_individual_identification_number - addenda_format_error - incorrect_standard_entry_class_code_for_outbound_international_payment - misrouted_notification_of_change - incorrect_trace_number - incorrect_company_identification_number - incorrect_identification_number - incorrectly_formatted_corrected_data - incorrect_discretionary_data - routing_number_not_from_original_entry_detail_record - depository_financial_institution_account_number_not_from_original_entry_detail_record - incorrect_transaction_code_by_originating_depository_financial_institution type: string x-documentation-priority: default x-enum-descriptions: - The account number was incorrect. - The routing number was incorrect. - Both the routing number and the account number were incorrect. - The transaction code was incorrect. Try changing the `funding` parameter from checking to savings or vice-versa. - The account number and the transaction code were incorrect. - The routing number, account number, and transaction code were incorrect. - The receiving depository financial institution identification was incorrect. - The individual identification number was incorrect. - The addenda had an incorrect format. - The standard entry class code was incorrect for an outbound international payment. - The notification of change was misrouted. - The trace number was incorrect. - The company identification number was incorrect. - The individual identification number or identification number was incorrect. - The corrected data was incorrectly formatted. - The discretionary data was incorrect. - The routing number was not from the original entry detail record. - The depository financial institution account number was not from the original entry detail record. - The transaction code was incorrect, initiated by the originating depository financial institution. corrected_data: description: The corrected data for the notification of change (e.g., a new routing number). maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - change_code - corrected_data type: object x-event-categories: [] x-stainless-empty-object: false inbound_funds_hold: additionalProperties: true description: We hold funds for certain transaction types to account for return windows where funds might still be clawed back by the sending institution. example: amount: 100 automatically_releases_at: '2020-01-31T23:59:59Z' created_at: '2020-01-31T23:59:59Z' currency: USD held_transaction_id: transaction_uyrp7fld2ium70oa7oi pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4 released_at: null status: held type: inbound_funds_hold properties: amount: description: The held amount in the minor unit of the account's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default automatically_releases_at: description: When the hold will be released automatically. Certain conditions may cause it to be released before this time. format: date-time type: string x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the hold 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 hold's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) held_transaction_id: anyOf: - description: The ID of the Transaction for which funds were held. type: string x-documentation-priority: default x-id-reference-to: Transactions - type: 'null' pending_transaction_id: anyOf: - description: The ID of the Pending Transaction representing the held funds. type: string x-documentation-priority: default x-id-reference-to: Pending Transactions - type: 'null' released_at: anyOf: - description: When the hold was released (if it has been released). format: date-time type: string x-documentation-priority: default - type: 'null' status: description: The status of the hold. enum: - held - complete type: string x-documentation-priority: default x-enum-descriptions: - Funds are still being held. - Funds have been released. type: description: A constant representing the object's type. For this resource it will always be `inbound_funds_hold`. enum: - inbound_funds_hold type: string x-documentation-priority: default required: - type - amount - created_at - currency - automatically_releases_at - released_at - status - held_transaction_id - pending_transaction_id title: Inbound Funds Hold type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound Funds Holds sandbox_create_a_physical_card_shipment_tracking_update_parameters: additionalProperties: false example: category: delivered city: New York postal_code: '10045' state: NY properties: carrier_estimated_delivery_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time when the carrier expects the card to be delivered. format: date-time type: string x-documentation-priority: default category: description: The type of tracking event. enum: - in_transit - processed_for_delivery - delivered - delivery_issue - returned_to_sender type: string x-documentation-priority: default x-enum-descriptions: - The physical card is in transit. - The physical card has been processed for delivery. - The physical card has been delivered. - There is an issue preventing delivery. The delivery will be attempted again if possible. If the issue cannot be resolved, the physical card will be returned to sender. - Delivery failed and the physical card was returned to sender. city: description: The city where the event took place. maxLength: 200 minLength: 1 type: string x-documentation-priority: default postal_code: description: The postal code where the event took place. maxLength: 200 minLength: 1 type: string x-documentation-priority: default state: description: The state where the event took place. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - category type: object x-event-categories: [] x-stainless-empty-object: false entity_onboarding_session: additionalProperties: false description: Entity Onboarding Sessions let your customers onboard themselves by completing Increase-hosted forms. Create a session and redirect your customer to the returned URL. When they're done, they'll be redirected back to your site. This API is used for [hosted onboarding](/documentation/hosted-onboarding). example: created_at: '2020-01-31T23:59:59Z' entity_id: entity_n8y8tnk2p9339ti393yi expires_at: '2020-02-01T05:59:59+00:00' id: entity_onboarding_session_wid2ug11fsmvh3k9hymd idempotency_key: null program_id: program_i2v2os4mwza1oetokh9i redirect_url: https://example.com/onboarding/completed session_url: https://onboarding.increase.com/onboarding/sessions?id=HIrdj46cXyyNqT5RDcIR38dzPqzRBgTdG84XwzOz status: active type: entity_onboarding_session properties: created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Entity Onboarding Session was created. format: date-time type: string x-documentation-priority: default entity_id: anyOf: - description: The identifier of the Entity associated with this session, if one has been created or was provided when creating the session. type: string x-documentation-priority: default x-id-reference-to: Entities - type: 'null' expires_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Entity Onboarding Session will expire. format: date-time type: string x-documentation-priority: default id: description: The Entity Onboarding Session's identifier. type: string x-documentation-priority: default x-id-reference-to: Entity Onboarding Sessions idempotency_key: anyOf: - description: The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys). type: string x-documentation-priority: default - type: 'null' program_id: description: The identifier of the Program the Entity will be onboarded to. type: string x-documentation-priority: default x-id-reference-to: Programs redirect_url: description: The URL to redirect to after the onboarding session is complete. Increase will include the query parameters `entity_onboarding_session_id` and `entity_id` when redirecting. type: string x-documentation-priority: default session_url: anyOf: - description: The URL containing the onboarding form. You should share this link with your customer. Only present when the session is active. type: string x-documentation-priority: default - type: 'null' status: description: The status of the onboarding session. enum: - active - expired type: string x-documentation-priority: default x-enum-descriptions: - The Entity Onboarding Session is active. - The Entity Onboarding Session has expired. type: description: A constant representing the object's type. For this resource it will always be `entity_onboarding_session`. enum: - entity_onboarding_session type: string x-documentation-priority: default required: - type - id - entity_id - created_at - status - expires_at - redirect_url - session_url - program_id - idempotency_key title: Entity Onboarding Session type: object x-event-categories: [] x-stainless-empty-object: false x-tag: Entity Onboarding Sessions x-title-plural: Entity Onboarding Sessions sandbox_adjust_a_check_deposit_parameters: additionalProperties: false example: {} properties: amount: description: The adjustment amount in the minor unit of the Check Deposit's currency (e.g., cents). A negative amount means that the funds are being clawed back by the other bank and is a debit to your account. Defaults to the negative of the Check Deposit amount. maximum: 1000000000 minimum: -1000000000 type: integer x-documentation-priority: default reason: description: The reason for the adjustment. Defaults to `non_conforming_item`, which is often used for a low quality image that the recipient wasn't able to handle. 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. type: object x-event-categories: [] x-stainless-empty-object: false sandbox_settle_a_card_authorization_parameters: additionalProperties: false example: card_id: card_oubs0hwk5rn6knuecxg2 pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4 properties: amount: description: The amount to be settled. This defaults to the amount of the Pending Transaction being settled. minimum: 1 type: integer x-documentation-priority: default card_id: description: The identifier of the Card to create a settlement on. type: string x-documentation-priority: default x-id-reference-to: Cards pending_transaction_id: description: The identifier of the Pending Transaction for the Card Authorization you wish to settle. type: string x-documentation-priority: default x-id-reference-to: Pending Transactions required: - card_id - pending_transaction_id type: object x-event-categories: [] x-stainless-empty-object: false wire_transfer: additionalProperties: true description: Wire transfers move funds between your Increase account and any other account accessible by Fedwire. example: account_id: account_in71c4amph0vgo2qllky account_number: '987654321' amount: 100 approval: approved_at: '2020-01-31T23:59:59Z' approved_by: null cancellation: null created_at: '2020-01-31T23:59:59Z' created_by: category: user user: email: user@example.com creditor: address: unstructured: line1: 33 Liberty Street line2: null line3: null name: National Phonograph Company currency: USD debtor: null external_account_id: external_account_ukk55lr923a3ac0pp7iv id: wire_transfer_5akynk7dqsq25qwk9q2u idempotency_key: null inbound_wire_drawdown_request_id: null network: wire pending_transaction_id: null remittance: category: unstructured unstructured: message: Invoice 29582 reversal: null routing_number: '101050001' source_account_number_id: null status: complete submission: null transaction_id: transaction_uyrp7fld2ium70oa7oi type: wire_transfer unique_end_to_end_transaction_reference: null properties: account_id: description: The Account to which the transfer belongs. type: string x-documentation-priority: default x-id-reference-to: Accounts 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 approval: anyOf: - additionalProperties: false description: If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval. example: approved_at: '2020-01-31T23:59:59Z' approved_by: null properties: approved_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved. format: date-time type: string x-documentation-priority: default approved_by: anyOf: - description: If the Transfer was approved by a user in the dashboard, the email address of that user. type: string x-documentation-priority: default - type: 'null' required: - approved_at - approved_by title: Wire Transfer Transfer Approval type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Transfer Approvals - type: 'null' cancellation: anyOf: - additionalProperties: false description: If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation. example: canceled_at: '2020-01-31T23:59:59Z' canceled_by: null properties: canceled_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled. format: date-time type: string x-documentation-priority: default canceled_by: anyOf: - description: If the Transfer was canceled by a user in the dashboard, the email address of that user. type: string x-documentation-priority: default - type: 'null' required: - canceled_at - canceled_by title: Wire Transfer Transfer Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Transfer Cancellations - type: 'null' 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 created_by: anyOf: - additionalProperties: false description: What object created the transfer, either via the API or the dashboard. example: category: user user: email: user@example.com properties: api_key: anyOf: - additionalProperties: false description: If present, details about the API key that created the transfer. properties: description: anyOf: - description: The description set for the API key when it was created. type: string x-documentation-priority: default - type: 'null' required: - description title: Wire Transfer Transfer Creator ApiKey type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: ApiKeys - type: 'null' category: description: The type of object that created this transfer. enum: - api_key - oauth_application - user type: string x-documentation-priority: default x-enum-descriptions: - An API key. Details will be under the `api_key` object. - An OAuth application you connected to Increase. Details will be under the `oauth_application` object. - A User in the Increase dashboard. Details will be under the `user` object. oauth_application: anyOf: - additionalProperties: false description: If present, details about the OAuth Application that created the transfer. properties: name: description: The name of the OAuth Application. type: string x-documentation-priority: default required: - name title: Wire Transfer Transfer Creator OAuthApplication type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: OAuthApplications - type: 'null' user: anyOf: - additionalProperties: false description: If present, details about the User that created the transfer. properties: email: description: The email address of the User. type: string x-documentation-priority: default required: - email title: Wire Transfer Transfer Creator User type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Users - type: 'null' required: - category title: Wire Transfer Transfer Creator type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Transfer Creators - type: 'null' creditor: anyOf: - additionalProperties: false description: The person or business that is receiving the funds from the transfer. properties: address: anyOf: - additionalProperties: false description: The person or business's address. properties: unstructured: anyOf: - additionalProperties: false description: Unstructured address lines. properties: line1: anyOf: - description: The first line. type: string x-documentation-priority: default - type: 'null' line2: anyOf: - description: The second line. type: string x-documentation-priority: default - type: 'null' line3: anyOf: - description: The third line. type: string x-documentation-priority: default - type: 'null' required: - line1 - line2 - line3 title: Wire Transfer Party Address Unstructured type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Unstructureds - type: 'null' required: - unstructured title: Wire Transfer Party Address type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Addresses - type: 'null' name: anyOf: - description: The person or business's name. type: string x-documentation-priority: default - type: 'null' required: - name - address title: Wire Transfer Party type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Parties - type: 'null' currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For wire transfers this is always equal to `usd`. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) debtor: anyOf: - additionalProperties: false description: The person or business whose funds are being transferred. properties: address: anyOf: - additionalProperties: false description: The person or business's address. properties: unstructured: anyOf: - additionalProperties: false description: Unstructured address lines. properties: line1: anyOf: - description: The first line. type: string x-documentation-priority: default - type: 'null' line2: anyOf: - description: The second line. type: string x-documentation-priority: default - type: 'null' line3: anyOf: - description: The third line. type: string x-documentation-priority: default - type: 'null' required: - line1 - line2 - line3 title: Wire Transfer Party Address Unstructured type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Unstructureds - type: 'null' required: - unstructured title: Wire Transfer Party Address type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Addresses - type: 'null' name: anyOf: - description: The person or business's name. type: string x-documentation-priority: default - type: 'null' required: - name - address title: Wire Transfer Party type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Parties - type: 'null' external_account_id: anyOf: - description: The identifier of the External Account the transfer was made to, if any. type: string x-documentation-priority: default x-id-reference-to: External Accounts - type: 'null' id: description: The wire transfer's identifier. type: string x-documentation-priority: default x-id-reference-to: Wire Transfers idempotency_key: anyOf: - description: The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys). type: string x-documentation-priority: default - type: 'null' inbound_wire_drawdown_request_id: anyOf: - description: The ID of an Inbound Wire Drawdown Request in response to which this transfer was sent. type: string x-documentation-priority: default x-id-reference-to: Inbound Wire Drawdown Requests - type: 'null' network: description: The transfer's network. enum: - wire type: string x-documentation-priority: default pending_transaction_id: anyOf: - description: The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) by someone else in your organization. type: string x-documentation-priority: default x-id-reference-to: Pending Transactions - type: 'null' remittance: anyOf: - additionalProperties: false description: Remittance information sent with the wire transfer. example: category: unstructured unstructured: message: Invoice 29582 properties: category: description: The type of remittance information being passed. enum: - unstructured - tax type: string x-documentation-priority: default x-enum-descriptions: - The wire transfer contains unstructured remittance information. - The wire transfer is for tax payment purposes to the Internal Revenue Service (IRS). tax: anyOf: - additionalProperties: false description: Internal Revenue Service (IRS) tax repayment information. Required if `category` is equal to `tax`. properties: date: description: The month and year the tax payment is for, in YYYY-MM-DD format. The day is ignored. format: date type: string x-documentation-priority: default identification_number: description: The 9-digit Tax Identification Number (TIN) or Employer Identification Number (EIN). type: string x-documentation-priority: default type_code: description: The 5-character tax type code. type: string x-documentation-priority: default required: - date - type_code - identification_number title: Wire Transfer Wire Transfer Remittance information Tax type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Taxes - type: 'null' unstructured: anyOf: - additionalProperties: false description: Unstructured remittance information. Required if `category` is equal to `unstructured`. properties: message: description: The message to the beneficiary. type: string x-documentation-priority: default required: - message title: Wire Transfer Wire Transfer Remittance information Unstructured type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Unstructureds - type: 'null' required: - category title: Wire Transfer Wire Transfer Remittance information type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Wire Transfer Remittance information - type: 'null' reversal: anyOf: - additionalProperties: true description: If your transfer is reversed, this will contain details of the reversal. 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: Wire Transfer 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' routing_number: description: The American Bankers' Association (ABA) Routing Transit Number (RTN). type: string x-documentation-priority: default source_account_number_id: anyOf: - description: The Account Number that was passed to the wire's recipient. type: string x-documentation-priority: default x-id-reference-to: Account Numbers - type: 'null' status: description: The lifecycle status of the transfer. enum: - pending_approval - canceled - pending_reviewing - rejected - requires_attention - pending_creating - reversed - submitted - complete type: string x-documentation-priority: default x-enum-descriptions: - The transfer is pending approval. - The transfer has been canceled. - The transfer is pending review by Increase. - The transfer has been rejected by Increase. - The transfer requires attention from an Increase operator. - The transfer is pending creation. - The transfer has been reversed. - The transfer has been submitted to Fedwire. - The transfer has been acknowledged by Fedwire and can be considered complete. submission: anyOf: - additionalProperties: false description: After the transfer is submitted to Fedwire, this will contain supplemental details. example: input_message_accountability_data: 20220118MMQFMP0P000002 submitted_at: '2020-01-31T23:59:59Z' properties: input_message_accountability_data: description: The accountability data for the submission. type: string x-documentation-priority: default submitted_at: description: When this wire transfer was submitted to Fedwire. format: date-time type: string x-documentation-priority: default required: - input_message_accountability_data - submitted_at title: Wire Transfer Wire Transfer Submission type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Wire Transfer Submissions - type: 'null' transaction_id: anyOf: - description: The ID for the transaction funding the transfer. type: string x-documentation-priority: default x-id-reference-to: Transactions - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `wire_transfer`. enum: - wire_transfer type: string x-documentation-priority: default 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' required: - type - id - amount - currency - account_number - remittance - creditor - debtor - account_id - source_account_number_id - inbound_wire_drawdown_request_id - external_account_id - routing_number - approval - cancellation - reversal - created_at - network - status - submission - transaction_id - pending_transaction_id - created_by - unique_end_to_end_transaction_reference - idempotency_key title: Wire Transfer type: object x-event-categories: - wire_transfer.created - wire_transfer.updated x-stainless-empty-object: false x-tag: Wire Transfers x-title-plural: Wire Transfers inbound_check_deposit: additionalProperties: false description: Inbound Check Deposits are records of third-parties attempting to deposit checks against your account. example: accepted_at: '2020-01-31T23:59:59Z' account_id: account_in71c4amph0vgo2qllky account_number_id: account_number_v18nkfqm6afpsrvy82b2 adjustments: [] amount: 1000 back_image_file_id: file_makxrc67oh9l6sg7w9yc bank_of_first_deposit_routing_number: '101050001' check_number: '123' check_transfer_id: check_transfer_30b43acfu9vw8fyc4f5 created_at: '2020-01-31T23:59:59Z' currency: USD declined_at: null declined_transaction_id: null deposit_return: null front_image_file_id: file_makxrc67oh9l6sg7w9yc id: inbound_check_deposit_zoshvqybq0cjjm31mra payee_name_analysis: name_matches status: accepted transaction_id: transaction_uyrp7fld2ium70oa7oi type: inbound_check_deposit properties: accepted_at: anyOf: - description: If the Inbound Check Deposit was accepted, the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this took place. format: date-time type: string x-documentation-priority: default - type: 'null' account_id: description: The Account the check is being deposited against. type: string x-documentation-priority: default x-id-reference-to: Accounts account_number_id: anyOf: - description: The Account Number the check is being deposited against. type: string x-documentation-priority: default x-id-reference-to: Account Numbers - type: 'null' adjustments: description: If the deposit or the return was adjusted by the sending institution, this will contain details of the adjustments. items: additionalProperties: false properties: adjusted_at: description: The time at which the return adjustment was received. format: date-time type: string x-documentation-priority: default amount: description: The amount of the adjustment. type: integer x-documentation-priority: default reason: description: The reason for the adjustment. enum: - late_return - wrong_payee_credit 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. transaction_id: description: The id of the transaction for the adjustment. type: string x-documentation-priority: default x-id-reference-to: Transactions required: - adjusted_at - transaction_id - reason - amount title: Inbound Check Deposit AdjustmentsElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: AdjustmentsElements type: array x-documentation-priority: default amount: description: The deposited amount in USD cents. type: integer x-documentation-priority: default back_image_file_id: anyOf: - description: The ID for the File containing the image of the back of the 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' check_number: anyOf: - description: The check number printed on the check being deposited. type: string x-documentation-priority: default - type: 'null' check_transfer_id: anyOf: - description: If this deposit is for an existing Check Transfer, the identifier of that Check Transfer. type: string x-documentation-priority: default x-id-reference-to: Check Transfers - type: 'null' created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the deposit was attempted. format: date-time type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the deposit. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) declined_at: anyOf: - description: If the Inbound Check Deposit was declined, the [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which this took place. format: date-time type: string x-documentation-priority: default - type: 'null' declined_transaction_id: anyOf: - description: If the deposit attempt has been rejected, the identifier of the Declined Transaction object created as a result of the failed deposit. type: string x-documentation-priority: default x-id-reference-to: Declined Transactions - type: 'null' deposit_return: anyOf: - additionalProperties: false description: If you requested a return of this deposit, this will contain details of the return. properties: reason: description: The reason the deposit was returned. enum: - altered_or_fictitious - not_authorized - duplicate_presentment - endorsement_missing - endorsement_irregular - refer_to_maker type: string x-documentation-priority: default x-enum-descriptions: - The check was altered or fictitious. - The check was not authorized. - The check was a duplicate presentment. - The check was not endorsed. - The check was not endorsed by the payee. - The maker of the check requested its return. returned_at: description: The time at which the deposit was returned. format: date-time type: string x-documentation-priority: default transaction_id: description: The id of the transaction for the returned deposit. type: string x-documentation-priority: default x-id-reference-to: Transactions required: - returned_at - transaction_id - reason title: Inbound Check Deposit DepositReturn type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: DepositReturns - type: 'null' front_image_file_id: anyOf: - description: The ID for the File containing the image of the front of the check. type: string x-documentation-priority: default x-id-reference-to: Files - type: 'null' id: description: The deposit's identifier. type: string x-documentation-priority: default x-id-reference-to: Inbound Check Deposits payee_name_analysis: description: Whether the details on the check match the recipient name of the check transfer. This is an optional feature, contact sales to enable. enum: - name_matches - does_not_match - not_evaluated type: string x-documentation-priority: default x-enum-descriptions: - The details on the check match the recipient name of the check transfer. - The details on the check do not match the recipient name of the check transfer. - The payee name analysis was not evaluated. status: description: The status of the Inbound Check Deposit. enum: - pending - accepted - declined - returned - requires_attention type: string x-documentation-priority: default x-enum-descriptions: - The Inbound Check Deposit is pending. - The Inbound Check Deposit was accepted. - The Inbound Check Deposit was rejected. - The Inbound Check Deposit was returned. - The Inbound Check Deposit requires attention from an Increase operator. transaction_id: anyOf: - description: If the deposit attempt has been accepted, the identifier of the Transaction object created as a result of the successful deposit. type: string x-documentation-priority: default x-id-reference-to: Transactions - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `inbound_check_deposit`. enum: - inbound_check_deposit type: string x-documentation-priority: default required: - type - id - amount - created_at - currency - status - account_id - account_number_id - check_transfer_id - front_image_file_id - back_image_file_id - transaction_id - declined_transaction_id - deposit_return - adjustments - accepted_at - declined_at - bank_of_first_deposit_routing_number - check_number - payee_name_analysis title: Inbound Check Deposit type: object x-event-categories: - inbound_check_deposit.created - inbound_check_deposit.updated x-stainless-empty-object: false x-tag: Inbound Check Deposits x-title-plural: Inbound Check Deposits card_dispute_visa_user_submission: additionalProperties: false properties: accepted_at: anyOf: - description: The date and time at which the Visa Card Dispute User Submission was reviewed and accepted. format: date-time type: string x-documentation-priority: default - type: 'null' amount: anyOf: - description: The amount of the dispute if it is different from the amount of a prior user submission or the disputed transaction. type: integer x-documentation-priority: default - type: 'null' attachment_files: description: The files attached to the Visa Card Dispute User Submission. items: $ref: '#/components/schemas/card_dispute_file_attachment' type: array x-documentation-priority: default category: description: The category of the user submission. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully. enum: - chargeback - merchant_prearbitration_decline - user_prearbitration type: string x-documentation-priority: default x-enum-descriptions: - 'Visa Card Dispute Chargeback User Submission Chargeback Details: details will be under the `chargeback` object.' - 'Visa Card Dispute Merchant Pre-Arbitration Decline User Submission: details will be under the `merchant_prearbitration_decline` object.' - 'Visa Card Dispute User-Initiated Pre-Arbitration User Submission: details will be under the `user_prearbitration` object.' chargeback: anyOf: - additionalProperties: false description: A Visa Card Dispute Chargeback User Submission Chargeback Details object. This field will be present in the JSON response if and only if `category` is equal to `chargeback`. Contains the details specific to a Visa chargeback User Submission for a Card Dispute. example: authorization: null category: fraud consumer_canceled_merchandise: null consumer_canceled_recurring_transaction: null consumer_canceled_services: null consumer_counterfeit_merchandise: null consumer_credit_not_processed: null consumer_damaged_or_defective_merchandise: null consumer_merchandise_misrepresentation: null consumer_merchandise_not_as_described: null consumer_merchandise_not_received: null consumer_non_receipt_of_cash: null consumer_original_credit_transaction_not_accepted: null consumer_quality_merchandise: null consumer_quality_services: null consumer_services_misrepresentation: null consumer_services_not_as_described: null consumer_services_not_received: null fraud: fraud_type: lost processing_error: null properties: authorization: anyOf: - additionalProperties: false description: Authorization. Present if and only if `category` is `authorization`. properties: account_status: description: Account status. enum: - account_closed - credit_problem - fraud type: string x-documentation-priority: default x-enum-descriptions: - Account closed. - Credit problem. - Fraud. required: - account_status title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Authorization type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Authorizations - type: 'null' category: description: Category. enum: - authorization - consumer_canceled_merchandise - consumer_canceled_recurring_transaction - consumer_canceled_services - consumer_counterfeit_merchandise - consumer_credit_not_processed - consumer_damaged_or_defective_merchandise - consumer_merchandise_misrepresentation - consumer_merchandise_not_as_described - consumer_merchandise_not_received - consumer_non_receipt_of_cash - consumer_original_credit_transaction_not_accepted - consumer_quality_merchandise - consumer_quality_services - consumer_services_misrepresentation - consumer_services_not_as_described - consumer_services_not_received - fraud - processing_error type: string x-documentation-priority: default x-enum-descriptions: - Authorization. - 'Consumer: canceled merchandise.' - 'Consumer: canceled recurring transaction.' - 'Consumer: canceled services.' - 'Consumer: counterfeit merchandise.' - 'Consumer: credit not processed.' - 'Consumer: damaged or defective merchandise.' - 'Consumer: merchandise misrepresentation.' - 'Consumer: merchandise not as described.' - 'Consumer: merchandise not received.' - 'Consumer: non-receipt of cash.' - 'Consumer: Original Credit Transaction (OCT) not accepted.' - 'Consumer: merchandise quality issue.' - 'Consumer: services quality issue.' - 'Consumer: services misrepresentation.' - 'Consumer: services not as described.' - 'Consumer: services not received.' - Fraud. - Processing error. consumer_canceled_merchandise: anyOf: - additionalProperties: false description: Canceled merchandise. Present if and only if `category` is `consumer_canceled_merchandise`. properties: cardholder_cancellation: anyOf: - additionalProperties: false description: Cardholder cancellation. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default canceled_prior_to_ship_date: description: Canceled prior to ship date. enum: - canceled_prior_to_ship_date - not_canceled_prior_to_ship_date type: string x-documentation-priority: default x-enum-descriptions: - Canceled prior to ship date. - Not canceled prior to ship date. cancellation_policy_provided: description: Cancellation policy provided. enum: - not_provided - provided type: string x-documentation-priority: default x-enum-descriptions: - Not provided. - Provided. reason: description: Reason. type: string x-documentation-priority: default required: - canceled_at - canceled_prior_to_ship_date - cancellation_policy_provided - reason title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Merchandise Cardholder Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholder Cancellations - type: 'null' merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. not_returned: anyOf: - additionalProperties: false description: Not returned. Present if and only if `return_outcome` is `not_returned`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Merchandise Not Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Not Returneds - type: 'null' purchase_explanation: description: Purchase explanation. type: string x-documentation-priority: default received_or_expected_at: description: Received or expected at. format: date type: string x-documentation-priority: default return_attempted: anyOf: - additionalProperties: false description: Return attempted. Present if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Merchandise Return Attempted type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Return Attempteds - type: 'null' return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: anyOf: - additionalProperties: false description: Returned. Present if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: anyOf: - description: Merchant received return at. format: date type: string x-documentation-priority: default - type: 'null' other_explanation: anyOf: - description: Other explanation. Required if and only if the return method is `other`. type: string x-documentation-priority: default - type: 'null' return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: anyOf: - description: Tracking number. type: string x-documentation-priority: default - type: 'null' required: - merchant_received_return_at - other_explanation - return_method - returned_at - tracking_number title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Merchandise Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Returneds - type: 'null' required: - cardholder_cancellation - merchant_resolution_attempted - not_returned - purchase_explanation - received_or_expected_at - return_attempted - return_outcome - returned title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Merchandise type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Canceled Merchandises - type: 'null' consumer_canceled_recurring_transaction: anyOf: - additionalProperties: false description: Canceled recurring transaction. Present if and only if `category` is `consumer_canceled_recurring_transaction`. properties: cancellation_target: description: Cancellation target. enum: - account - transaction type: string x-documentation-priority: default x-enum-descriptions: - Account. - Transaction. merchant_contact_methods: additionalProperties: false description: Merchant contact methods. properties: application_name: anyOf: - description: Application name. type: string x-documentation-priority: default - type: 'null' call_center_phone_number: anyOf: - description: Call center phone number. type: string x-documentation-priority: default - type: 'null' email_address: anyOf: - description: Email address. type: string x-documentation-priority: default - type: 'null' in_person_address: anyOf: - description: In person address. type: string x-documentation-priority: default - type: 'null' mailing_address: anyOf: - description: Mailing address. type: string x-documentation-priority: default - type: 'null' text_phone_number: anyOf: - description: Text phone number. type: string x-documentation-priority: default - type: 'null' required: - application_name - call_center_phone_number - email_address - in_person_address - mailing_address - text_phone_number title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Recurring Transaction Merchant Contact Methods type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Merchant Contact Methods other_form_of_payment_explanation: anyOf: - description: Other form of payment explanation. type: string x-documentation-priority: default - type: 'null' transaction_or_account_canceled_at: description: Transaction or account canceled at. format: date type: string x-documentation-priority: default required: - cancellation_target - merchant_contact_methods - other_form_of_payment_explanation - transaction_or_account_canceled_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Recurring Transaction type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Canceled Recurring Transactions - type: 'null' consumer_canceled_services: anyOf: - additionalProperties: false description: Canceled services. Present if and only if `category` is `consumer_canceled_services`. properties: cardholder_cancellation: additionalProperties: false description: Cardholder cancellation. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default cancellation_policy_provided: description: Cancellation policy provided. enum: - not_provided - provided type: string x-documentation-priority: default x-enum-descriptions: - Not provided. - Provided. reason: description: Reason. type: string x-documentation-priority: default required: - canceled_at - cancellation_policy_provided - reason title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Services Cardholder Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholder Cancellations contracted_at: description: Contracted at. format: date type: string x-documentation-priority: default guaranteed_reservation: anyOf: - additionalProperties: false description: Guaranteed reservation explanation. Present if and only if `service_type` is `guaranteed_reservation`. properties: explanation: description: Explanation. enum: - cardholder_canceled_prior_to_service - cardholder_cancellation_attempt_within_24_hours_of_confirmation - merchant_billed_no_show type: string x-documentation-priority: default x-enum-descriptions: - Cardholder canceled prior to service. - Cardholder cancellation attempt within 24 hours of confirmation. - Merchant billed for no-show. required: - explanation title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Services Guaranteed Reservation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Guaranteed Reservations - type: 'null' merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. other: anyOf: - additionalProperties: false description: Other service type explanation. Present if and only if `service_type` is `other`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Services Other type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Others - type: 'null' purchase_explanation: description: Purchase explanation. type: string x-documentation-priority: default service_type: description: Service type. enum: - guaranteed_reservation - other - timeshare type: string x-documentation-priority: default x-enum-descriptions: - Guaranteed reservation. - Other. - Timeshare. timeshare: anyOf: - additionalProperties: false description: Timeshare explanation. Present if and only if `service_type` is `timeshare`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Services Timeshare type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Timeshares - type: 'null' required: - cardholder_cancellation - contracted_at - guaranteed_reservation - merchant_resolution_attempted - other - purchase_explanation - service_type - timeshare title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Canceled Services type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Canceled Services - type: 'null' consumer_counterfeit_merchandise: anyOf: - additionalProperties: false description: Counterfeit merchandise. Present if and only if `category` is `consumer_counterfeit_merchandise`. properties: counterfeit_explanation: description: Counterfeit explanation. type: string x-documentation-priority: default disposition_explanation: description: Disposition explanation. type: string x-documentation-priority: default order_explanation: description: Order explanation. type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default required: - counterfeit_explanation - disposition_explanation - order_explanation - received_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Counterfeit Merchandise type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Counterfeit Merchandises - type: 'null' consumer_credit_not_processed: anyOf: - additionalProperties: false description: Credit not processed. Present if and only if `category` is `consumer_credit_not_processed`. properties: canceled_or_returned_at: anyOf: - description: Canceled or returned at. format: date type: string x-documentation-priority: default - type: 'null' credit_expected_at: anyOf: - description: Credit expected at. format: date type: string x-documentation-priority: default - type: 'null' required: - canceled_or_returned_at - credit_expected_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Credit Not Processed type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Credit Not Processeds - type: 'null' consumer_damaged_or_defective_merchandise: anyOf: - additionalProperties: false description: Damaged or defective merchandise. Present if and only if `category` is `consumer_damaged_or_defective_merchandise`. properties: merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. not_returned: anyOf: - additionalProperties: false description: Not returned. Present if and only if `return_outcome` is `not_returned`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Damaged Or Defective Merchandise Not Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Not Returneds - type: 'null' order_and_issue_explanation: description: Order and issue explanation. type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default return_attempted: anyOf: - additionalProperties: false description: Return attempted. Present if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Damaged Or Defective Merchandise Return Attempted type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Return Attempteds - type: 'null' return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: anyOf: - additionalProperties: false description: Returned. Present if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: anyOf: - description: Merchant received return at. format: date type: string x-documentation-priority: default - type: 'null' other_explanation: anyOf: - description: Other explanation. Required if and only if the return method is `other`. type: string x-documentation-priority: default - type: 'null' return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: anyOf: - description: Tracking number. type: string x-documentation-priority: default - type: 'null' required: - merchant_received_return_at - other_explanation - return_method - returned_at - tracking_number title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Damaged Or Defective Merchandise Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Returneds - type: 'null' required: - merchant_resolution_attempted - not_returned - order_and_issue_explanation - received_at - return_attempted - return_outcome - returned title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Damaged Or Defective Merchandise type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Damaged Or Defective Merchandises - type: 'null' consumer_merchandise_misrepresentation: anyOf: - additionalProperties: false description: Merchandise misrepresentation. Present if and only if `category` is `consumer_merchandise_misrepresentation`. properties: merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. misrepresentation_explanation: description: Misrepresentation explanation. type: string x-documentation-priority: default not_returned: anyOf: - additionalProperties: false description: Not returned. Present if and only if `return_outcome` is `not_returned`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Misrepresentation Not Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Not Returneds - type: 'null' purchase_explanation: description: Purchase explanation. type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default return_attempted: anyOf: - additionalProperties: false description: Return attempted. Present if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Misrepresentation Return Attempted type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Return Attempteds - type: 'null' return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: anyOf: - additionalProperties: false description: Returned. Present if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: anyOf: - description: Merchant received return at. format: date type: string x-documentation-priority: default - type: 'null' other_explanation: anyOf: - description: Other explanation. Required if and only if the return method is `other`. type: string x-documentation-priority: default - type: 'null' return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: anyOf: - description: Tracking number. type: string x-documentation-priority: default - type: 'null' required: - merchant_received_return_at - other_explanation - return_method - returned_at - tracking_number title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Misrepresentation Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Returneds - type: 'null' required: - merchant_resolution_attempted - misrepresentation_explanation - not_returned - purchase_explanation - received_at - return_attempted - return_outcome - returned title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Misrepresentation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Merchandise Misrepresentations - type: 'null' consumer_merchandise_not_as_described: anyOf: - additionalProperties: false description: Merchandise not as described. Present if and only if `category` is `consumer_merchandise_not_as_described`. properties: merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. received_at: description: Received at. format: date type: string x-documentation-priority: default return_attempted: anyOf: - additionalProperties: false description: Return attempted. Present if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not As Described Return Attempted type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Return Attempteds - type: 'null' return_outcome: description: Return outcome. enum: - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Returned. - Return attempted. returned: anyOf: - additionalProperties: false description: Returned. Present if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: anyOf: - description: Merchant received return at. format: date type: string x-documentation-priority: default - type: 'null' other_explanation: anyOf: - description: Other explanation. Required if and only if the return method is `other`. type: string x-documentation-priority: default - type: 'null' return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: anyOf: - description: Tracking number. type: string x-documentation-priority: default - type: 'null' required: - merchant_received_return_at - other_explanation - return_method - returned_at - tracking_number title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not As Described Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Returneds - type: 'null' required: - merchant_resolution_attempted - received_at - return_attempted - return_outcome - returned title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not As Described type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Merchandise Not As Describeds - type: 'null' consumer_merchandise_not_received: anyOf: - additionalProperties: false description: Merchandise not received. Present if and only if `category` is `consumer_merchandise_not_received`. properties: cancellation_outcome: description: Cancellation outcome. enum: - cardholder_cancellation_prior_to_expected_receipt - merchant_cancellation - no_cancellation type: string x-documentation-priority: default x-enum-descriptions: - Cardholder cancellation prior to expected receipt. - Merchant cancellation. - No cancellation. cardholder_cancellation_prior_to_expected_receipt: anyOf: - additionalProperties: false description: Cardholder cancellation prior to expected receipt. Present if and only if `cancellation_outcome` is `cardholder_cancellation_prior_to_expected_receipt`. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: anyOf: - description: Reason. type: string x-documentation-priority: default - type: 'null' required: - canceled_at - reason title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Cardholder Cancellation Prior To Expected Receipt type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholder Cancellation Prior To Expected Receipts - type: 'null' delayed: anyOf: - additionalProperties: false description: Delayed. Present if and only if `delivery_issue` is `delayed`. properties: explanation: description: Explanation. type: string x-documentation-priority: default not_returned: anyOf: - additionalProperties: false description: Not returned. Present if and only if `return_outcome` is `not_returned`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Delayed Not Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Not Returneds - type: 'null' return_attempted: anyOf: - additionalProperties: false description: Return attempted. Present if and only if `return_outcome` is `return_attempted`. properties: attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default required: - attempted_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Delayed Return Attempted type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Return Attempteds - type: 'null' return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: anyOf: - additionalProperties: false description: Returned. Present if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: description: Merchant received return at. format: date type: string x-documentation-priority: default returned_at: description: Returned at. format: date type: string x-documentation-priority: default required: - merchant_received_return_at - returned_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Delayed Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Returneds - type: 'null' required: - explanation - not_returned - return_attempted - return_outcome - returned title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Delayed type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Delayeds - type: 'null' delivered_to_wrong_location: anyOf: - additionalProperties: false description: Delivered to wrong location. Present if and only if `delivery_issue` is `delivered_to_wrong_location`. properties: agreed_location: description: Agreed location. type: string x-documentation-priority: default required: - agreed_location title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Delivered To Wrong Location type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Delivered To Wrong Locations - type: 'null' delivery_issue: description: Delivery issue. enum: - delayed - delivered_to_wrong_location type: string x-documentation-priority: default x-enum-descriptions: - Delayed. - Delivered to wrong location. last_expected_receipt_at: description: Last expected receipt at. format: date type: string x-documentation-priority: default merchant_cancellation: anyOf: - additionalProperties: false description: Merchant cancellation. Present if and only if `cancellation_outcome` is `merchant_cancellation`. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default required: - canceled_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received Merchant Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Merchant Cancellations - type: 'null' merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. no_cancellation: anyOf: - additionalProperties: false description: No cancellation. Present if and only if `cancellation_outcome` is `no_cancellation`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received No Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: No Cancellations - type: 'null' purchase_info_and_explanation: description: Purchase information and explanation. type: string x-documentation-priority: default required: - cancellation_outcome - cardholder_cancellation_prior_to_expected_receipt - delayed - delivered_to_wrong_location - delivery_issue - last_expected_receipt_at - merchant_cancellation - merchant_resolution_attempted - no_cancellation - purchase_info_and_explanation title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Merchandise Not Received type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Merchandise Not Receiveds - type: 'null' consumer_non_receipt_of_cash: anyOf: - additionalProperties: false description: Non-receipt of cash. Present if and only if `category` is `consumer_non_receipt_of_cash`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Non Receipt Of Cash type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Consumer Non Receipt Of Cashes - type: 'null' consumer_original_credit_transaction_not_accepted: anyOf: - additionalProperties: false description: Original Credit Transaction (OCT) not accepted. Present if and only if `category` is `consumer_original_credit_transaction_not_accepted`. properties: explanation: description: Explanation. type: string x-documentation-priority: default reason: description: Reason. enum: - prohibited_by_local_laws_or_regulation - recipient_refused type: string x-documentation-priority: default x-enum-descriptions: - Prohibited by local laws or regulation. - Recipient refused. required: - explanation - reason title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Original Credit Transaction Not Accepted type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Original Credit Transaction Not Accepteds - type: 'null' consumer_quality_merchandise: anyOf: - additionalProperties: false description: Merchandise quality issue. Present if and only if `category` is `consumer_quality_merchandise`. properties: expected_at: description: Expected at. format: date type: string x-documentation-priority: default merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. not_returned: anyOf: - additionalProperties: false description: Not returned. Present if and only if `return_outcome` is `not_returned`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Merchandise Not Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Not Returneds - type: 'null' ongoing_negotiations: anyOf: - additionalProperties: false description: Ongoing negotiations. Exclude if there is no evidence of ongoing negotiations. properties: explanation: description: Explanation of the previous ongoing negotiations between the cardholder and merchant. type: string x-documentation-priority: default issuer_first_notified_at: description: Date the cardholder first notified the issuer of the dispute. format: date type: string x-documentation-priority: default started_at: description: Started at. format: date type: string x-documentation-priority: default required: - explanation - issuer_first_notified_at - started_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Merchandise Ongoing Negotiations type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Ongoing Negotiations - type: 'null' purchase_info_and_quality_issue: description: Purchase information and quality issue. type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default return_attempted: anyOf: - additionalProperties: false description: Return attempted. Present if and only if `return_outcome` is `return_attempted`. properties: attempt_explanation: description: Attempt explanation. type: string x-documentation-priority: default attempt_reason: description: Attempt reason. enum: - merchant_not_responding - no_return_authorization_provided - no_return_instructions - requested_not_to_return - return_not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Merchant not responding. - No return authorization provided. - No return instructions. - Requested not to return. - Return not accepted. attempted_at: description: Attempted at. format: date type: string x-documentation-priority: default merchandise_disposition: description: Merchandise disposition. type: string x-documentation-priority: default required: - attempt_explanation - attempt_reason - attempted_at - merchandise_disposition title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Merchandise Return Attempted type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Return Attempteds - type: 'null' return_outcome: description: Return outcome. enum: - not_returned - returned - return_attempted type: string x-documentation-priority: default x-enum-descriptions: - Not returned. - Returned. - Return attempted. returned: anyOf: - additionalProperties: false description: Returned. Present if and only if `return_outcome` is `returned`. properties: merchant_received_return_at: anyOf: - description: Merchant received return at. format: date type: string x-documentation-priority: default - type: 'null' other_explanation: anyOf: - description: Other explanation. Required if and only if the return method is `other`. type: string x-documentation-priority: default - type: 'null' return_method: description: Return method. enum: - dhl - face_to_face - fedex - other - postal_service - ups type: string x-documentation-priority: default x-enum-descriptions: - DHL. - Face-to-face. - FedEx. - Other. - Postal service. - UPS. returned_at: description: Returned at. format: date type: string x-documentation-priority: default tracking_number: anyOf: - description: Tracking number. type: string x-documentation-priority: default - type: 'null' required: - merchant_received_return_at - other_explanation - return_method - returned_at - tracking_number title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Merchandise Returned type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Returneds - type: 'null' required: - expected_at - merchant_resolution_attempted - not_returned - ongoing_negotiations - purchase_info_and_quality_issue - received_at - return_attempted - return_outcome - returned title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Merchandise type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Quality Merchandises - type: 'null' consumer_quality_services: anyOf: - additionalProperties: false description: Services quality issue. Present if and only if `category` is `consumer_quality_services`. properties: cardholder_cancellation: additionalProperties: false description: Cardholder cancellation. properties: accepted_by_merchant: description: Accepted by merchant. enum: - accepted - not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Accepted. - Not accepted. canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: description: Reason. type: string x-documentation-priority: default required: - accepted_by_merchant - canceled_at - reason title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Services Cardholder Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholder Cancellations cardholder_paid_to_have_work_redone: anyOf: - description: Cardholder paid to have work redone. enum: - did_not_pay_to_have_work_redone - paid_to_have_work_redone type: string x-documentation-priority: default x-enum-descriptions: - Cardholder did not pay to have work redone. - Cardholder paid to have work redone. - type: 'null' non_fiat_currency_or_non_fungible_token_related_and_not_matching_description: description: Non-fiat currency or non-fungible token related and not matching description. enum: - not_related - related type: string x-documentation-priority: default x-enum-descriptions: - Not related. - Related. ongoing_negotiations: anyOf: - additionalProperties: false description: Ongoing negotiations. Exclude if there is no evidence of ongoing negotiations. properties: explanation: description: Explanation of the previous ongoing negotiations between the cardholder and merchant. type: string x-documentation-priority: default issuer_first_notified_at: description: Date the cardholder first notified the issuer of the dispute. format: date type: string x-documentation-priority: default started_at: description: Started at. format: date type: string x-documentation-priority: default required: - explanation - issuer_first_notified_at - started_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Services Ongoing Negotiations type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Ongoing Negotiations - type: 'null' purchase_info_and_quality_issue: description: Purchase information and quality issue. type: string x-documentation-priority: default restaurant_food_related: anyOf: - description: Whether the dispute is related to the quality of food from an eating place or restaurant. Must be provided when Merchant Category Code (MCC) is 5812, 5813 or 5814. enum: - not_related - related type: string x-documentation-priority: default x-enum-descriptions: - Not related. - Related. - type: 'null' services_received_at: description: Services received at. format: date type: string x-documentation-priority: default required: - cardholder_cancellation - cardholder_paid_to_have_work_redone - non_fiat_currency_or_non_fungible_token_related_and_not_matching_description - ongoing_negotiations - purchase_info_and_quality_issue - restaurant_food_related - services_received_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Quality Services type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Quality Services - type: 'null' consumer_services_misrepresentation: anyOf: - additionalProperties: false description: Services misrepresentation. Present if and only if `category` is `consumer_services_misrepresentation`. properties: cardholder_cancellation: additionalProperties: false description: Cardholder cancellation. properties: accepted_by_merchant: description: Accepted by merchant. enum: - accepted - not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Accepted. - Not accepted. canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: description: Reason. type: string x-documentation-priority: default required: - accepted_by_merchant - canceled_at - reason title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Misrepresentation Cardholder Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholder Cancellations merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. misrepresentation_explanation: description: Misrepresentation explanation. type: string x-documentation-priority: default purchase_explanation: description: Purchase explanation. type: string x-documentation-priority: default received_at: description: Received at. format: date type: string x-documentation-priority: default required: - cardholder_cancellation - merchant_resolution_attempted - misrepresentation_explanation - purchase_explanation - received_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Misrepresentation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Services Misrepresentations - type: 'null' consumer_services_not_as_described: anyOf: - additionalProperties: false description: Services not as described. Present if and only if `category` is `consumer_services_not_as_described`. properties: cardholder_cancellation: additionalProperties: false description: Cardholder cancellation. properties: accepted_by_merchant: description: Accepted by merchant. enum: - accepted - not_accepted type: string x-documentation-priority: default x-enum-descriptions: - Accepted. - Not accepted. canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: description: Reason. type: string x-documentation-priority: default required: - accepted_by_merchant - canceled_at - reason title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Not As Described Cardholder Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholder Cancellations explanation: description: Explanation of what was ordered and was not as described. type: string x-documentation-priority: default merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. received_at: description: Received at. format: date type: string x-documentation-priority: default required: - cardholder_cancellation - explanation - merchant_resolution_attempted - received_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Not As Described type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Services Not As Describeds - type: 'null' consumer_services_not_received: anyOf: - additionalProperties: false description: Services not received. Present if and only if `category` is `consumer_services_not_received`. properties: cancellation_outcome: description: Cancellation outcome. enum: - cardholder_cancellation_prior_to_expected_receipt - merchant_cancellation - no_cancellation type: string x-documentation-priority: default x-enum-descriptions: - Cardholder cancellation prior to expected receipt. - Merchant cancellation. - No cancellation. cardholder_cancellation_prior_to_expected_receipt: anyOf: - additionalProperties: false description: Cardholder cancellation prior to expected receipt. Present if and only if `cancellation_outcome` is `cardholder_cancellation_prior_to_expected_receipt`. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default reason: anyOf: - description: Reason. type: string x-documentation-priority: default - type: 'null' required: - canceled_at - reason title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Not Received Cardholder Cancellation Prior To Expected Receipt type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Cardholder Cancellation Prior To Expected Receipts - type: 'null' last_expected_receipt_at: description: Last expected receipt at. format: date type: string x-documentation-priority: default merchant_cancellation: anyOf: - additionalProperties: false description: Merchant cancellation. Present if and only if `cancellation_outcome` is `merchant_cancellation`. properties: canceled_at: description: Canceled at. format: date type: string x-documentation-priority: default required: - canceled_at title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Not Received Merchant Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Merchant Cancellations - type: 'null' merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. no_cancellation: anyOf: - additionalProperties: false description: No cancellation. Present if and only if `cancellation_outcome` is `no_cancellation`. properties: {} title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Not Received No Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: No Cancellations - type: 'null' purchase_info_and_explanation: description: Purchase information and explanation. type: string x-documentation-priority: default required: - cancellation_outcome - cardholder_cancellation_prior_to_expected_receipt - last_expected_receipt_at - merchant_cancellation - merchant_resolution_attempted - no_cancellation - purchase_info_and_explanation title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Consumer Services Not Received type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Consumer Services Not Receiveds - type: 'null' fraud: anyOf: - additionalProperties: false description: Fraud. Present if and only if `category` is `fraud`. properties: fraud_type: description: Fraud type. enum: - account_or_credentials_takeover - card_not_received_as_issued - fraudulent_application - fraudulent_use_of_account_number - incorrect_processing - issuer_reported_counterfeit - lost - manipulation_of_account_holder - merchant_misrepresentation - miscellaneous - stolen type: string x-documentation-priority: default x-enum-descriptions: - Account or credentials takeover. - Card not received as issued. - Fraudulent application. - Fraudulent use of account number. - Incorrect processing. - Issuer reported counterfeit. - Lost. - Manipulation of account holder. - Merchant misrepresentation. - Miscellaneous. - Stolen. required: - fraud_type title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Fraud type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Frauds - type: 'null' processing_error: anyOf: - additionalProperties: false description: Processing error. Present if and only if `category` is `processing_error`. properties: duplicate_transaction: anyOf: - additionalProperties: false description: Duplicate transaction. Present if and only if `error_reason` is `duplicate_transaction`. properties: other_transaction_id: description: Other transaction ID. type: string x-documentation-priority: default required: - other_transaction_id title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Processing Error Duplicate Transaction type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Duplicate Transactions - type: 'null' error_reason: description: Error reason. enum: - duplicate_transaction - incorrect_amount - paid_by_other_means type: string x-documentation-priority: default x-enum-descriptions: - Duplicate transaction. - Incorrect amount. - Paid by other means. incorrect_amount: anyOf: - additionalProperties: false description: Incorrect amount. Present if and only if `error_reason` is `incorrect_amount`. properties: expected_amount: description: Expected amount. type: integer x-documentation-priority: default required: - expected_amount title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Processing Error Incorrect Amount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Incorrect Amounts - type: 'null' merchant_resolution_attempted: description: Merchant resolution attempted. enum: - attempted - prohibited_by_local_law type: string x-documentation-priority: default x-enum-descriptions: - Attempted. - Prohibited by local law. paid_by_other_means: anyOf: - additionalProperties: false description: Paid by other means. Present if and only if `error_reason` is `paid_by_other_means`. properties: other_form_of_payment_evidence: description: Other form of payment evidence. enum: - canceled_check - card_transaction - cash_receipt - other - statement - voucher type: string x-documentation-priority: default x-enum-descriptions: - Canceled check. - Card transaction. - Cash receipt. - Other. - Statement. - Voucher. other_transaction_id: anyOf: - description: Other transaction ID. type: string x-documentation-priority: default - type: 'null' required: - other_form_of_payment_evidence - other_transaction_id title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Processing Error Paid By Other Means type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Paid By Other Means - type: 'null' required: - duplicate_transaction - error_reason - incorrect_amount - merchant_resolution_attempted - paid_by_other_means title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details Processing Error type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Processing Errors - type: 'null' required: - authorization - category - consumer_canceled_merchandise - consumer_canceled_recurring_transaction - consumer_canceled_services - consumer_counterfeit_merchandise - consumer_credit_not_processed - consumer_damaged_or_defective_merchandise - consumer_merchandise_misrepresentation - consumer_merchandise_not_as_described - consumer_merchandise_not_received - consumer_non_receipt_of_cash - consumer_original_credit_transaction_not_accepted - consumer_quality_merchandise - consumer_quality_services - consumer_services_misrepresentation - consumer_services_not_as_described - consumer_services_not_received - fraud - processing_error title: Visa Card Dispute User Submission Visa Card Dispute Chargeback User Submission Chargeback Details type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Visa Card Dispute Chargeback User Submission Chargeback Details - type: 'null' created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Visa Card Dispute User Submission was created. format: date-time type: string x-documentation-priority: default explanation: anyOf: - description: The free-form explanation provided to Increase to provide more context for the user submission. This field is not sent directly to the card networks. type: string x-documentation-priority: default - type: 'null' further_information_requested_at: anyOf: - description: The date and time at which Increase requested further information from the user for the Visa Card Dispute. format: date-time type: string x-documentation-priority: default - type: 'null' further_information_requested_reason: anyOf: - description: The reason for Increase requesting further information from the user for the Visa Card Dispute. type: string x-documentation-priority: default - type: 'null' merchant_prearbitration_decline: anyOf: - additionalProperties: false description: A Visa Card Dispute Merchant Pre-Arbitration Decline User Submission object. This field will be present in the JSON response if and only if `category` is equal to `merchant_prearbitration_decline`. Contains the details specific to a merchant prearbitration decline Visa Card Dispute User Submission. example: reason: I do not believe the explanation given by the merchant is valid. properties: reason: description: The reason the user declined the merchant's request for pre-arbitration in their favor. type: string x-documentation-priority: default required: - reason title: Visa Card Dispute User Submission Visa Card Dispute Merchant Pre-Arbitration Decline User Submission type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Visa Card Dispute Merchant Pre-Arbitration Decline User Submissions - type: 'null' status: description: The status of the Visa Card Dispute User Submission. enum: - abandoned - accepted - further_information_requested - pending_reviewing type: string x-documentation-priority: default x-enum-descriptions: - The User Submission was abandoned. - The User Submission was accepted. - Further information is requested, please resubmit with the requested information. - The User Submission is pending review. updated_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Visa Card Dispute User Submission was updated. format: date-time type: string x-documentation-priority: default user_prearbitration: anyOf: - additionalProperties: false description: A Visa Card Dispute User-Initiated Pre-Arbitration User Submission object. This field will be present in the JSON response if and only if `category` is equal to `user_prearbitration`. Contains the details specific to a user-initiated pre-arbitration Visa Card Dispute User Submission. example: category_change: category: fraud reason: Based on the response from the merchant. reason: I disagree with the explanation given by the merchant. properties: category_change: anyOf: - additionalProperties: false description: Category change details for the pre-arbitration request, if requested. properties: category: description: The category the dispute is being changed to. enum: - authorization - consumer_canceled_merchandise - consumer_canceled_recurring_transaction - consumer_canceled_services - consumer_counterfeit_merchandise - consumer_credit_not_processed - consumer_damaged_or_defective_merchandise - consumer_merchandise_misrepresentation - consumer_merchandise_not_as_described - consumer_merchandise_not_received - consumer_non_receipt_of_cash - consumer_original_credit_transaction_not_accepted - consumer_quality_merchandise - consumer_quality_services - consumer_services_misrepresentation - consumer_services_not_as_described - consumer_services_not_received - fraud - processing_error type: string x-documentation-priority: default x-enum-descriptions: - Authorization. - 'Consumer: canceled merchandise.' - 'Consumer: canceled recurring transaction.' - 'Consumer: canceled services.' - 'Consumer: counterfeit merchandise.' - 'Consumer: credit not processed.' - 'Consumer: damaged or defective merchandise.' - 'Consumer: merchandise misrepresentation.' - 'Consumer: merchandise not as described.' - 'Consumer: merchandise not received.' - 'Consumer: non-receipt of cash.' - 'Consumer: Original Credit Transaction (OCT) not accepted.' - 'Consumer: merchandise quality issue.' - 'Consumer: services quality issue.' - 'Consumer: services misrepresentation.' - 'Consumer: services not as described.' - 'Consumer: services not received.' - Fraud. - Processing error. reason: description: The reason for the pre-arbitration request. type: string x-documentation-priority: default required: - category - reason title: Visa Card Dispute User Submission Visa Card Dispute User-Initiated Pre-Arbitration User Submission Category Change type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Category Changes - type: 'null' reason: description: The reason for the pre-arbitration request. type: string x-documentation-priority: default required: - reason - category_change title: Visa Card Dispute User Submission Visa Card Dispute User-Initiated Pre-Arbitration User Submission type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Visa Card Dispute User-Initiated Pre-Arbitration User Submissions - type: 'null' required: - created_at - updated_at - amount - explanation - attachment_files - status - accepted_at - further_information_requested_at - further_information_requested_reason - category title: Visa Card Dispute User Submission type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Visa Card Dispute User Submissions sandbox_create_a_card_authorization_parameters: additionalProperties: false example: amount: 1000 card_id: card_oubs0hwk5rn6knuecxg2 event_subscription_id: event_subscription_001dzz0r20rcdxgb013zqb8m04g merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_descriptor: AMAZON.COM merchant_state: NY properties: amount: description: The authorization amount in cents. maximum: 1000000000 minimum: 1 type: integer x-documentation-priority: default authenticated_card_payment_id: description: The identifier of a Card Payment with a `card_authentication` if you want to simulate an authenticated authorization. type: string x-documentation-priority: default x-id-reference-to: Card Payments card_id: description: The identifier of the Card to be authorized. type: string x-documentation-priority: default x-id-reference-to: Cards decline_reason: description: Forces a card decline with a specific reason. No real time decision will be sent. enum: - account_closed - card_not_active - card_canceled - physical_card_not_active - entity_not_active - group_locked - insufficient_funds - cvv2_mismatch - pin_mismatch - card_expiration_mismatch - transaction_not_allowed - breaches_limit - webhook_declined - webhook_timed_out - declined_by_stand_in_processing - invalid_physical_card - missing_original_authorization - invalid_cryptogram - failed_3ds_authentication - suspected_card_testing - suspected_fraud type: string x-documentation-priority: default x-enum-descriptions: - The account has been closed. - The Card was not active. - The Card has been canceled. - The Physical Card was not active. - The account's entity was not active. - The account was inactive. - The Card's Account did not have a sufficient available balance. - The given CVV2 did not match the card's value. - The given PIN did not match the card's value. - The given expiration date did not match the card's value. Only applies when a CVV2 is present. - The attempted card transaction is not allowed per Increase's terms. - The transaction was blocked by a Limit. - Your application declined the transaction via webhook. - Your application webhook did not respond without the required timeout. - Declined by stand-in processing. - The card read had an invalid CVV or dCVV. - The original card authorization for this incremental authorization does not exist. - The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase. - The transaction was declined because the 3DS authentication failed. - The transaction was suspected to be used by a card tester to test for valid card numbers. - The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information. digital_wallet_token_id: description: The identifier of the Digital Wallet Token to be authorized. type: string x-documentation-priority: default x-id-reference-to: Digital Wallet Tokens event_subscription_id: description: The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes. type: string x-documentation-priority: default x-id-reference-to: Event Subscriptions merchant_acceptor_id: description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. maxLength: 200 minLength: 1 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. maxLength: 200 minLength: 1 type: string x-documentation-priority: default merchant_city: description: The city the merchant resides in. maxLength: 200 minLength: 1 type: string x-documentation-priority: default merchant_country: description: The country the merchant resides in. maxLength: 200 minLength: 1 type: string x-documentation-priority: default merchant_descriptor: description: The merchant descriptor of the merchant the card is transacting with. maxLength: 200 minLength: 1 type: string x-documentation-priority: default merchant_state: description: The state the merchant resides in. maxLength: 200 minLength: 1 type: string x-documentation-priority: default network_details: additionalProperties: false description: Fields specific to a given card network. properties: visa: additionalProperties: false description: Fields specific to the Visa network. properties: stand_in_processing_reason: description: The reason code for the 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: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - visa type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false network_risk_score: 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. maximum: 99 minimum: 0 type: integer x-documentation-priority: default physical_card_id: description: The identifier of the Physical Card to be authorized. type: string x-documentation-priority: default x-id-reference-to: Physical Cards processing_category: additionalProperties: false description: Fields specific to a specific type of authorization, such as Automatic Fuel Dispensers, Refund Authorizations, or Cash Disbursements. properties: category: description: The processing category describes the intent behind the authorization, such as whether it was used for bill payments or an automatic fuel dispenser. enum: - account_funding - automatic_fuel_dispenser - bill_payment - original_credit - purchase - quasi_cash - refund - cash_disbursement - balance_inquiry 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. refund: additionalProperties: false description: Details related to refund authorizations. properties: original_card_payment_id: description: The card payment to link this refund to. type: string x-documentation-priority: default x-id-reference-to: Card Payments type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - category type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false terminal_id: description: The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - amount type: object x-event-categories: [] x-stainless-empty-object: false sandbox_expire_a_card_authorization_parameters: additionalProperties: false example: card_payment_id: card_payment_nd3k2kacrqjli8482ave properties: card_payment_id: description: The identifier of the Card Payment to expire. type: string x-documentation-priority: default x-id-reference-to: Card Payments required: - card_payment_id type: object x-event-categories: [] x-stainless-empty-object: false 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 ach_decline: additionalProperties: true example: amount: 1750 id: ach_decline_72v1mcwxudctq56efipa inbound_ach_transfer_id: inbound_ach_transfer_tdrwqr3fq9gnnq49odev originator_company_descriptive_date: null originator_company_discretionary_data: null originator_company_id: 0987654321 originator_company_name: BIG BANK reason: insufficient_funds receiver_id_number: '12345678900' receiver_name: IAN CREASE trace_number: 021000038461022 type: ach_decline properties: amount: description: The declined amount in USD cents. type: integer x-documentation-priority: default id: description: The ACH Decline's identifier. type: string x-documentation-priority: default x-id-reference-to: ACH Declines inbound_ach_transfer_id: description: The identifier of the Inbound ACH Transfer object associated with this decline. type: string x-documentation-priority: default x-id-reference-to: Inbound ACH Transfers originator_company_descriptive_date: anyOf: - description: The descriptive date of the transfer. type: string x-documentation-priority: default - type: 'null' originator_company_discretionary_data: anyOf: - description: The additional information included with the transfer. type: string x-documentation-priority: default - type: 'null' originator_company_id: description: The identifier of the company that initiated the transfer. type: string x-documentation-priority: default originator_company_name: description: The name of the company that initiated the transfer. type: string x-documentation-priority: default reason: description: Why the ACH transfer was declined. enum: - ach_route_canceled - ach_route_disabled - breaches_limit - entity_not_active - group_locked - transaction_not_allowed - returned_per_odfi_request - user_initiated - insufficient_funds - authorization_revoked_by_customer - payment_stopped - customer_advised_unauthorized_improper_ineligible_or_incomplete - representative_payee_deceased_or_unable_to_continue_in_that_capacity - beneficiary_or_account_holder_deceased - credit_entry_refused_by_receiver - duplicate_entry - corporate_customer_advised_not_authorized type: string x-documentation-priority: default x-enum-descriptions: - The account number is canceled. - The account number is disabled. - The transaction would cause an Increase limit to be exceeded. - The account's entity is not active. - Your account is inactive. - The transaction is not allowed per Increase's terms. - The originating financial institution asked for this transfer to be returned. The receiving bank is complying with the request. - Your integration declined this transfer via the API. - Your account contains insufficient funds. - The customer no longer authorizes this transaction. - The customer asked for the payment to be stopped. - The customer advises that the debit was unauthorized. - The payee is deceased. - The account holder is deceased. - The customer refused a credit entry. - The account holder identified this transaction as a duplicate. - The corporate customer no longer authorizes this transaction. receiver_id_number: anyOf: - description: The id of the receiver of the transfer. type: string x-documentation-priority: default - type: 'null' receiver_name: anyOf: - description: The name of the receiver of the transfer. type: string x-documentation-priority: default - type: 'null' trace_number: description: The trace number of the transfer. type: string x-documentation-priority: default type: description: A constant representing the object's type. For this resource it will always be `ach_decline`. enum: - ach_decline type: string x-documentation-priority: default required: - type - id - amount - originator_company_name - originator_company_descriptive_date - originator_company_discretionary_data - originator_company_id - reason - receiver_id_number - receiver_name - trace_number - inbound_ach_transfer_id title: ACH Decline type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: ACH Declines sandbox_settle_an_ach_transfer_parameters: additionalProperties: false example: inbound_funds_hold_behavior: release_immediately properties: inbound_funds_hold_behavior: description: The behavior of the inbound funds hold that is created when the ACH Transfer is settled. If no behavior is specified, the inbound funds hold will be released immediately in order for the funds to be available for use. enum: - release_immediately - release_on_default_schedule type: string x-documentation-priority: default x-enum-descriptions: - Release the inbound funds hold immediately. - Release the inbound funds hold on the default schedule. type: object x-event-categories: [] x-stainless-empty-object: false sandbox_create_a_card_token_parameters: additionalProperties: false example: capabilities: - cross_border_push_transfers: supported domestic_push_transfers: supported route: visa expiration: '2020-01-31T23:59:59Z' last4: '1234' prefix: '41234567' primary_account_number_length: 16 properties: capabilities: description: The capabilities of the outbound card token. items: additionalProperties: false properties: cross_border_push_transfers: description: The cross-border push transfers capability. enum: - supported - not_supported type: string x-documentation-priority: default x-enum-descriptions: - The capability is supported. - The capability is not supported. domestic_push_transfers: description: The domestic push transfers capability. enum: - supported - not_supported type: string x-documentation-priority: default x-enum-descriptions: - The capability is supported. - The capability is not supported. route: description: The route of the capability. enum: - visa - mastercard - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa and Interlink - Mastercard and Maestro - Pulse required: - route - domestic_push_transfers - cross_border_push_transfers type: object x-event-categories: [] x-stainless-empty-object: false type: array x-documentation-priority: default expiration: description: The expiration date of the card. format: date type: string x-documentation-priority: default last4: description: The last 4 digits of the card number. maxLength: 4 minLength: 4 type: string x-documentation-priority: default outcome: additionalProperties: false description: The outcome to simulate for card push transfers using this token. properties: decline: additionalProperties: false description: If the result is declined, the details of the decline. properties: reason: description: The reason for the decline. enum: - do_not_honor - activity_count_limit_exceeded - refer_to_card_issuer - refer_to_card_issuer_special_condition - invalid_merchant - pick_up_card - error - pick_up_card_special - invalid_transaction - invalid_amount - invalid_account_number - no_such_issuer - re_enter_transaction - no_credit_account - pick_up_card_lost - pick_up_card_stolen - closed_account - insufficient_funds - no_checking_account - no_savings_account - expired_card - transaction_not_permitted_to_cardholder - transaction_not_allowed_at_terminal - transaction_not_supported_or_blocked_by_issuer - suspected_fraud - activity_amount_limit_exceeded - restricted_card - security_violation - transaction_does_not_fulfill_anti_money_laundering_requirement - blocked_by_cardholder - blocked_first_use - credit_issuer_unavailable - negative_card_verification_value_results - issuer_unavailable - financial_institution_cannot_be_found - transaction_cannot_be_completed - duplicate_transaction - system_malfunction - additional_customer_authentication_required - surcharge_amount_not_permitted - decline_for_cvv2_failure - stop_payment_order - revocation_of_authorization_order - revocation_of_all_authorizations_order - unable_to_locate_record - file_is_temporarily_unavailable - incorrect_pin - allowable_number_of_pin_entry_tries_exceeded - unable_to_locate_previous_message - pin_error_found - cannot_verify_pin - verification_data_failed - surcharge_amount_not_supported_by_debit_network_issuer - cash_service_not_available - cashback_request_exceeds_issuer_limit - transaction_amount_exceeds_pre_authorized_approval_amount - transaction_does_not_qualify_for_visa_pin - offline_declined - unable_to_go_online - valid_account_but_amount_not_supported - invalid_use_of_merchant_category_code_correct_and_reattempt - card_authentication_failed type: string x-documentation-priority: default x-enum-descriptions: - The card issuer has declined the transaction without providing a specific reason. - The number of transactions for the card has exceeded the limit set by the issuer. - The card issuer requires the cardholder to contact them for further information regarding the transaction. - The card issuer requires the cardholder to contact them due to a special condition related to the transaction. - The merchant is not valid for this transaction. - The card should be retained by the terminal. - An error occurred during processing of the transaction. - The card should be retained by the terminal due to a special condition. - The transaction is invalid and cannot be processed. - The amount of the transaction is invalid. - The account number provided is invalid. - The issuer of the card could not be found. - The transaction should be re-entered for processing. - There is no credit account associated with the card. - The card should be retained by the terminal because it has been reported lost. - The card should be retained by the terminal because it has been reported stolen. - The account associated with the card has been closed. - There are insufficient funds in the account to complete the transaction. - There is no checking account associated with the card. - There is no savings account associated with the card. - The card has expired and cannot be used for transactions. - The transaction is not permitted for this cardholder. - The transaction is not allowed at this terminal. - The transaction is not supported or has been blocked by the issuer. - The transaction has been flagged as suspected fraud and cannot be processed. - The amount of activity on the card has exceeded the limit set by the issuer. - The card has restrictions that prevent it from being used for this transaction. - A security violation has occurred, preventing the transaction from being processed. - The transaction does not meet the anti-money laundering requirements set by the issuer. - The transaction was blocked by the cardholder. - The first use of the card has been blocked by the issuer. - The credit issuer is currently unavailable to process the transaction. - The card verification value (CVV) results were negative, indicating a potential issue with the card. - The issuer of the card is currently unavailable to process the transaction. - The financial institution associated with the card could not be found. - The transaction cannot be completed due to an unspecified reason. - The transaction is a duplicate of a previous transaction and cannot be processed again. - A system malfunction occurred, preventing the transaction from being processed. - Additional customer authentication is required to complete the transaction. - The surcharge amount applied to the transaction is not permitted by the issuer. - The transaction was declined due to a failure in verifying the CVV2 code. - A stop payment order has been placed on this transaction. - An order has been placed to revoke authorization for this transaction. - An order has been placed to revoke all authorizations for this cardholder. - The record associated with the transaction could not be located. - The file needed for the transaction is temporarily unavailable. - The PIN entered for the transaction is incorrect. - The allowable number of PIN entry tries has been exceeded. - The previous message associated with the transaction could not be located. - An error was found with the PIN associated with the transaction. - The PIN associated with the transaction could not be verified. - The verification data associated with the transaction has failed. - The surcharge amount is not supported by the debit network issuer. - Cash service is not available for this transaction. - The cashback request exceeds the issuer limit. - The transaction amount exceeds the pre-authorized approval amount. - The transaction does not qualify for Visa PIN processing. - The transaction was declined offline. - The terminal was unable to go online to process the transaction. - The account is valid but the transaction amount is not supported. - The merchant category code was used incorrectly; correct it and reattempt the transaction. - The card authentication process has failed. type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false result: description: Whether card push transfers or validations will be approved or declined. enum: - approve - decline type: string x-documentation-priority: default x-enum-descriptions: - Any card push transfers or validations will be approved. - Any card push transfers or validations will be declined. required: - result type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false prefix: description: The prefix of the card number, usually the first 8 digits. maxLength: 8 minLength: 1 type: string x-documentation-priority: default primary_account_number_length: description: The total length of the card number, including prefix and last4. maximum: 19 minimum: 12 type: integer x-documentation-priority: default type: object x-event-categories: [] x-stainless-empty-object: false check_transfer_stop_payment_request: additionalProperties: true description: A Check Transfer Stop Payment Request is created when a check transfer is stopped. It offsets the Check Transfer Intention. example: reason: mail_delivery_failed requested_at: '2020-01-31T23:59:59Z' transfer_id: check_transfer_30b43acfu9vw8fyc4f5 type: check_transfer_stop_payment_request properties: reason: description: The reason why this transfer was stopped. enum: - mail_delivery_failed - rejected_by_increase - not_authorized - valid_until_date_passed - unknown type: string x-documentation-priority: default x-enum-descriptions: - The check could not be delivered. - The check was canceled by an Increase operator who will provide details out-of-band. - The check was not authorized. - The check was stopped for `valid_until_date` being in the past. - The check was stopped for another reason. requested_at: description: The time the stop-payment was requested. format: date-time type: string x-documentation-priority: default transfer_id: description: The ID of the check transfer that was stopped. type: string x-documentation-priority: default x-id-reference-to: Check Transfers type: description: A constant representing the object's type. For this resource it will always be `check_transfer_stop_payment_request`. enum: - check_transfer_stop_payment_request type: string x-documentation-priority: default required: - type - transfer_id - reason - requested_at title: Check Transfer Stop Payment Request type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Check Transfer Stop Payment Requests inbound_digital_wallet_token_request_simulation_result: additionalProperties: false description: The results of a Digital Wallet Token simulation. example: decline_reason: null digital_wallet_token_id: digital_wallet_token_izi62go3h51p369jrie0 type: inbound_digital_wallet_token_request_simulation_result properties: decline_reason: anyOf: - description: If the simulated tokenization attempt was declined, this field contains details as to why. enum: - card_not_active - no_verification_method - webhook_timed_out - webhook_declined type: string x-documentation-priority: default x-enum-descriptions: - The card is not active. - The card does not have a two-factor authentication method. - Your webhook timed out when evaluating the token provisioning attempt. - Your webhook declined the token provisioning attempt. - type: 'null' digital_wallet_token_id: anyOf: - description: If the simulated tokenization attempt was accepted, this field contains the id of the Digital Wallet Token that was created. type: string x-documentation-priority: default x-id-reference-to: Digital Wallet Tokens - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `inbound_digital_wallet_token_request_simulation_result`. enum: - inbound_digital_wallet_token_request_simulation_result type: string x-documentation-priority: default required: - type - decline_reason - digital_wallet_token_id title: Inbound Digital Wallet Token Request Simulation Result type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound Digital Wallet Token Request Simulation Results sandbox_create_a_card_authentication_challenge_attempt_parameters: additionalProperties: false example: one_time_code: '123456' properties: one_time_code: description: The one-time code to be validated. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - one_time_code type: object x-event-categories: [] x-stainless-empty-object: false entity_supplemental_document: additionalProperties: false description: Supplemental Documents are uploaded files connected to an Entity during onboarding. example: created_at: '2020-01-31T23:59:59Z' entity_id: entity_n8y8tnk2p9339ti393yi file_id: file_makxrc67oh9l6sg7w9yc idempotency_key: null type: entity_supplemental_document properties: created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Supplemental Document was created. format: date-time type: string x-documentation-priority: default entity_id: description: The Entity the supplemental document is attached to. type: string x-documentation-priority: default x-id-reference-to: Entities file_id: description: The File containing the document. type: string x-documentation-priority: default x-id-reference-to: Files idempotency_key: anyOf: - description: The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys). type: string x-documentation-priority: default - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `entity_supplemental_document`. enum: - entity_supplemental_document type: string x-documentation-priority: default required: - type - entity_id - file_id - created_at - idempotency_key title: Supplemental Document type: object x-event-categories: [] x-stainless-empty-object: false x-tag: Supplemental Documents x-title-plural: Supplemental Documents sandbox_refund_a_card_transaction_parameters: additionalProperties: false example: transaction_id: transaction_uyrp7fld2ium70oa7oi properties: amount: description: The refund amount in cents. Pulled off the `pending_transaction` or the `transaction` if not provided. maximum: 1000000000 minimum: 1 type: integer x-documentation-priority: default pending_transaction_id: description: The identifier of the Pending Transaction for the refund authorization. If this is provided, `transaction` must not be provided as a refund with a refund authorized can not be linked to a regular transaction. type: string x-documentation-priority: default x-id-reference-to: Pending Transactions transaction_id: description: The identifier for the Transaction to refund. The Transaction's source must have a category of card_settlement. type: string x-documentation-priority: default x-id-reference-to: Transactions type: object x-event-categories: [] x-stainless-empty-object: false entity: additionalProperties: true description: Entities are the legal entities that own accounts. They can be people, corporations, partnerships, government authorities, or trusts. To learn more, see [Entities](/documentation/entities). example: corporation: address: city: New York country: US line1: 33 Liberty Street line2: null state: NY zip: '10045' beneficial_owners: - company_title: CEO id: entity_beneficial_owner_vozma8szzu1sxezp5zq6 individual: address: city: New York country: US line1: 33 Liberty Street line2: null state: NY zip: '10045' date_of_birth: '1970-01-31' identification: method: social_security_number number_last4: '1120' name: Ian Crease prongs: - control - ownership email: null incorporation_state: NY industry_code: null legal_identifier: category: us_employer_identification_number value: '602214076' name: National Phonograph Company website: https://example.com created_at: '2020-01-31T23:59:59Z' creating_entity_onboarding_session_id: null description: null details_confirmed_at: null government_authority: null id: entity_n8y8tnk2p9339ti393yi idempotency_key: null joint: null natural_person: null risk_rating: null status: active structure: corporation supplemental_documents: - created_at: '2020-01-31T23:59:59Z' entity_id: entity_n8y8tnk2p9339ti393yi file_id: file_makxrc67oh9l6sg7w9yc idempotency_key: null type: entity_supplemental_document terms_agreements: - agreed_at: '2020-01-31T23:59:59Z' ip_address: 128.32.0.1 terms_url: https://increase.com/example_terms third_party_verification: null trust: null type: entity validation: null properties: corporation: anyOf: - additionalProperties: true description: Details of the corporation entity. Will be present if `structure` is equal to `corporation`. properties: address: additionalProperties: false description: The corporation's address. example: city: New York country: US line1: 33 Liberty Street line2: null state: NY zip: '10045' properties: city: anyOf: - description: The city, district, town, or village of the address. type: string x-documentation-priority: default - type: 'null' country: description: The two-letter ISO 3166-1 alpha-2 code for the country of the address. type: string x-documentation-priority: default line1: description: The first line of the address. type: string x-documentation-priority: default line2: anyOf: - description: The second line of the address. type: string x-documentation-priority: default - type: 'null' state: anyOf: - description: The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. type: string x-documentation-priority: default - type: 'null' zip: anyOf: - description: The ZIP or postal code of the address. type: string x-documentation-priority: default - type: 'null' required: - line1 - line2 - city - state - zip - country title: Entity Corporation Address type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Addresses beneficial_owners: description: The identifying details of anyone controlling or owning 25% or more of the corporation. items: additionalProperties: true example: company_title: CEO id: entity_beneficial_owner_vozma8szzu1sxezp5zq6 individual: address: city: New York country: US line1: 33 Liberty Street line2: null state: NY zip: '10045' date_of_birth: '1970-01-31' identification: method: social_security_number number_last4: '1120' name: Ian Crease prongs: - control - ownership properties: company_title: anyOf: - description: This person's role or title within the entity. type: string x-documentation-priority: default - type: 'null' id: description: The identifier of this beneficial owner. type: string x-documentation-priority: default x-id-reference-to: Beneficial Owners individual: additionalProperties: false description: Personal details for the beneficial owner. properties: address: additionalProperties: false description: The person's address. example: city: New York country: US line1: 33 Liberty Street line2: null state: NY zip: '10045' properties: city: anyOf: - description: The city, district, town, or village of the address. type: string x-documentation-priority: default - type: 'null' country: description: The two-letter ISO 3166-1 alpha-2 code for the country of the address. type: string x-documentation-priority: default line1: description: The first line of the address. type: string x-documentation-priority: default line2: anyOf: - description: The second line of the address. type: string x-documentation-priority: default - type: 'null' state: anyOf: - description: The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. type: string x-documentation-priority: default - type: 'null' zip: anyOf: - description: The ZIP or postal code of the address. type: string x-documentation-priority: default - type: 'null' required: - line1 - line2 - city - state - zip - country title: Entity Corporation Beneficial Owner Reference Individual Address type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Addresses date_of_birth: description: The person's date of birth in YYYY-MM-DD format. format: date type: string x-documentation-priority: default identification: anyOf: - additionalProperties: true description: A means of verifying the person's identity. properties: method: description: A method that can be used to verify the individual's identity. enum: - social_security_number - individual_taxpayer_identification_number - passport - drivers_license - other type: string x-documentation-priority: default x-enum-descriptions: - A social security number. - An individual taxpayer identification number (ITIN). - A passport number. - A driver's license number. - Another identifying document. number_last4: description: The last 4 digits of the identification number that can be used to verify the individual's identity. type: string x-documentation-priority: default required: - method - number_last4 title: Entity Corporation Beneficial Owner Reference Individual Identification type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Identifications - type: 'null' name: description: The person's legal name. type: string x-documentation-priority: default required: - name - date_of_birth - address - identification title: Entity Corporation Beneficial Owner Reference Individual type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Individuals prongs: description: Why this person is considered a beneficial owner of the entity. items: enum: - ownership - control type: string x-enum-descriptions: - A person with 25% or greater direct or indirect ownership of the entity. - A person who manages, directs, or has significant control of the entity. type: array x-documentation-priority: default required: - id - individual - company_title - prongs title: Entity Corporation Beneficial Owner Reference type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Beneficial Owner References type: array x-documentation-priority: default email: anyOf: - description: An email address for the business. type: string x-documentation-priority: default - type: 'null' incorporation_state: anyOf: - description: The two-letter United States Postal Service (USPS) abbreviation for the corporation's state of incorporation. type: string x-documentation-priority: default - type: 'null' industry_code: anyOf: - description: The numeric North American Industry Classification System (NAICS) code submitted for the corporation. type: string x-documentation-priority: default - type: 'null' legal_identifier: anyOf: - additionalProperties: false description: The legal identifier of the corporation. properties: category: description: The category of the legal identifier. enum: - us_employer_identification_number - other type: string x-documentation-priority: default x-enum-descriptions: - The Employer Identification Number (EIN) for the company. The EIN is a 9-digit number assigned by the IRS; submit it as nine digits with no dashes or other separators. - A legal identifier issued by a foreign government, like a tax identification number or registration number. value: description: The identifier of the legal identifier. type: string x-documentation-priority: default required: - category - value title: Entity Corporation LegalIdentifier type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: LegalIdentifiers - type: 'null' name: description: The legal name of the corporation. type: string x-documentation-priority: default website: anyOf: - description: The website of the corporation. type: string x-documentation-priority: default - type: 'null' required: - name - website - email - legal_identifier - incorporation_state - industry_code - address - beneficial_owners title: Entity Corporation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Corporations - type: 'null' created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity was created. format: date-time type: string x-documentation-priority: default creating_entity_onboarding_session_id: anyOf: - description: The identifier of the Entity Onboarding Session that was used to create this Entity, if any. type: string x-documentation-priority: default x-id-reference-to: Entity Onboarding Sessions - type: 'null' description: anyOf: - description: The entity's description for display purposes. type: string x-documentation-priority: low - type: 'null' details_confirmed_at: anyOf: - description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Entity's details were most recently confirmed. format: date-time type: string x-documentation-priority: low - type: 'null' government_authority: anyOf: - additionalProperties: false description: Details of the government authority entity. Will be present if `structure` is equal to `government_authority`. properties: address: additionalProperties: false description: The government authority's address. example: city: New York country: US line1: 33 Liberty Street line2: null state: NY zip: '10045' properties: city: anyOf: - description: The city, district, town, or village of the address. type: string x-documentation-priority: default - type: 'null' country: description: The two-letter ISO 3166-1 alpha-2 code for the country of the address. type: string x-documentation-priority: default line1: description: The first line of the address. type: string x-documentation-priority: default line2: anyOf: - description: The second line of the address. type: string x-documentation-priority: default - type: 'null' state: anyOf: - description: The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. type: string x-documentation-priority: default - type: 'null' zip: anyOf: - description: The ZIP or postal code of the address. type: string x-documentation-priority: default - type: 'null' required: - line1 - line2 - city - state - zip - country title: Entity GovernmentAuthority Address type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Addresses authorized_persons: description: The identifying details of authorized persons of the government authority. items: additionalProperties: false properties: authorized_person_id: description: The identifier of this authorized person. type: string x-documentation-priority: default name: description: The person's legal name. type: string x-documentation-priority: default required: - name - authorized_person_id title: Entity GovernmentAuthority AuthorizedPersonsElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: AuthorizedPersonsElements type: array x-documentation-priority: default category: description: The category of the government authority. enum: - municipality - state_agency - state_government - federal_agency type: string x-documentation-priority: default x-enum-descriptions: - A municipality. - A state agency. - A state government. - A federal agency. name: description: The government authority's name. type: string x-documentation-priority: default tax_identifier: anyOf: - description: The Employer Identification Number (EIN) of the government authority. type: string x-documentation-priority: default - type: 'null' website: anyOf: - description: The government authority's website. type: string x-documentation-priority: default - type: 'null' required: - name - category - address - website - tax_identifier - authorized_persons title: Entity GovernmentAuthority type: object x-documentation-priority: low x-event-categories: [] x-stainless-empty-object: false x-title-plural: GovernmentAuthorities - type: 'null' id: description: The entity's identifier. type: string x-documentation-priority: default x-id-reference-to: Entities idempotency_key: anyOf: - description: The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys). type: string x-documentation-priority: default - type: 'null' joint: anyOf: - additionalProperties: false description: Details of the joint entity. Will be present if `structure` is equal to `joint`. properties: individuals: description: The two individuals that share control of the entity. items: additionalProperties: false properties: address: additionalProperties: false description: The person's address. example: city: New York country: US line1: 33 Liberty Street line2: null state: NY zip: '10045' properties: city: anyOf: - description: The city, district, town, or village of the address. type: string x-documentation-priority: default - type: 'null' country: description: The two-letter ISO 3166-1 alpha-2 code for the country of the address. type: string x-documentation-priority: default line1: description: The first line of the address. type: string x-documentation-priority: default line2: anyOf: - description: The second line of the address. type: string x-documentation-priority: default - type: 'null' state: anyOf: - description: The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. type: string x-documentation-priority: default - type: 'null' zip: anyOf: - description: The ZIP or postal code of the address. type: string x-documentation-priority: default - type: 'null' required: - line1 - line2 - city - state - zip - country title: Entity Joint Individual Address type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Addresses date_of_birth: description: The person's date of birth in YYYY-MM-DD format. format: date type: string x-documentation-priority: default identification: anyOf: - additionalProperties: true description: A means of verifying the person's identity. properties: method: description: A method that can be used to verify the individual's identity. enum: - social_security_number - individual_taxpayer_identification_number - passport - drivers_license - other type: string x-documentation-priority: default x-enum-descriptions: - A social security number. - An individual taxpayer identification number (ITIN). - A passport number. - A driver's license number. - Another identifying document. number_last4: description: The last 4 digits of the identification number that can be used to verify the individual's identity. type: string x-documentation-priority: default required: - method - number_last4 title: Entity Joint Individual Identification type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Identifications - type: 'null' name: description: The person's legal name. type: string x-documentation-priority: default required: - name - date_of_birth - address - identification title: Entity Joint Individual type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Individuals type: array x-documentation-priority: default name: description: The entity's name. type: string x-documentation-priority: default required: - name - individuals title: Entity Joint type: object x-documentation-priority: low x-event-categories: [] x-stainless-empty-object: false x-title-plural: Joints - type: 'null' natural_person: anyOf: - additionalProperties: false description: Details of the natural person entity. Will be present if `structure` is equal to `natural_person`. properties: address: additionalProperties: false description: The person's address. example: city: New York country: US line1: 33 Liberty Street line2: null state: NY zip: '10045' properties: city: anyOf: - description: The city, district, town, or village of the address. type: string x-documentation-priority: default - type: 'null' country: description: The two-letter ISO 3166-1 alpha-2 code for the country of the address. type: string x-documentation-priority: default line1: description: The first line of the address. type: string x-documentation-priority: default line2: anyOf: - description: The second line of the address. type: string x-documentation-priority: default - type: 'null' state: anyOf: - description: The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. type: string x-documentation-priority: default - type: 'null' zip: anyOf: - description: The ZIP or postal code of the address. type: string x-documentation-priority: default - type: 'null' required: - line1 - line2 - city - state - zip - country title: Entity Individual Address type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Addresses date_of_birth: description: The person's date of birth in YYYY-MM-DD format. format: date type: string x-documentation-priority: default identification: anyOf: - additionalProperties: true description: A means of verifying the person's identity. properties: method: description: A method that can be used to verify the individual's identity. enum: - social_security_number - individual_taxpayer_identification_number - passport - drivers_license - other type: string x-documentation-priority: default x-enum-descriptions: - A social security number. - An individual taxpayer identification number (ITIN). - A passport number. - A driver's license number. - Another identifying document. number_last4: description: The last 4 digits of the identification number that can be used to verify the individual's identity. type: string x-documentation-priority: default required: - method - number_last4 title: Entity Individual Identification type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Identifications - type: 'null' name: description: The person's legal name. type: string x-documentation-priority: default required: - name - date_of_birth - address - identification title: Entity Individual type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Individuals - type: 'null' risk_rating: anyOf: - additionalProperties: false description: An assessment of the entity’s potential risk of involvement in financial crimes, such as money laundering. properties: rated_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the risk rating was performed. format: date-time type: string x-documentation-priority: default rating: description: The rating given to this entity. enum: - low - medium - high type: string x-documentation-priority: default x-enum-descriptions: - Minimal risk of involvement in financial crime. - Moderate risk of involvement in financial crime. - Elevated risk of involvement in financial crime. required: - rating - rated_at title: Entity RiskRating type: object x-documentation-priority: low x-event-categories: [] x-stainless-empty-object: false x-title-plural: RiskRatings - type: 'null' status: description: The status of the entity. enum: - active - archived - disabled type: string x-documentation-priority: default x-enum-descriptions: - The entity is active. - The entity is archived, and can no longer be used to create accounts. - The entity is temporarily disabled and cannot be used for financial activity. structure: description: The entity's legal structure. enum: - corporation - natural_person - joint - trust - government_authority type: string x-documentation-priority: default x-enum-descriptions: - A corporation. - An individual person. - Multiple individual people. - A trust. - A government authority. supplemental_documents: description: Additional documentation associated with the entity. This is limited to the first 10 documents for an entity. If an entity has more than 10 documents, use the GET /entity_supplemental_documents list endpoint to retrieve them. items: $ref: '#/components/schemas/entity_supplemental_document' type: array x-documentation-priority: low terms_agreements: description: The terms that the Entity agreed to. Not all programs are required to submit this data. items: additionalProperties: false properties: agreed_at: description: The timestamp of when the Entity agreed to the terms. format: date-time type: string x-documentation-priority: default ip_address: description: The IP address the Entity accessed reviewed the terms from. type: string x-documentation-priority: default terms_url: description: The URL of the terms agreement. This link will be provided by your bank partner. type: string x-documentation-priority: default required: - terms_url - ip_address - agreed_at title: Entity TermsAgreementsElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: TermsAgreementsElements type: array x-documentation-priority: low third_party_verification: anyOf: - additionalProperties: false description: If you are using a third-party service for identity verification, you can use this field to associate this Entity with the identifier that represents them in that service. properties: reference: description: The reference identifier for the third party verification. type: string x-documentation-priority: default vendor: description: The vendor that was used to perform the verification. enum: - alloy - middesk - oscilar - persona - taktile type: string x-documentation-priority: default x-enum-descriptions: - Alloy. See https://alloy.com for more information. - Middesk. See https://middesk.com for more information. - Oscilar. See https://oscilar.com for more information. - Persona. See https://withpersona.com for more information. - Taktile. See https://taktile.com for more information. required: - reference - vendor title: Entity ThirdPartyVerification type: object x-documentation-priority: low x-event-categories: [] x-stainless-empty-object: false x-title-plural: ThirdPartyVerifications - type: 'null' trust: anyOf: - additionalProperties: false description: Details of the trust entity. Will be present if `structure` is equal to `trust`. properties: address: additionalProperties: false description: The trust's address. example: city: New York country: US line1: 33 Liberty Street line2: null state: NY zip: '10045' properties: city: anyOf: - description: The city, district, town, or village of the address. type: string x-documentation-priority: default - type: 'null' country: description: The two-letter ISO 3166-1 alpha-2 code for the country of the address. type: string x-documentation-priority: default line1: description: The first line of the address. type: string x-documentation-priority: default line2: anyOf: - description: The second line of the address. type: string x-documentation-priority: default - type: 'null' state: anyOf: - description: The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. type: string x-documentation-priority: default - type: 'null' zip: anyOf: - description: The ZIP or postal code of the address. type: string x-documentation-priority: default - type: 'null' required: - line1 - line2 - city - state - zip - country title: Entity Trust Address type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Addresses category: description: Whether the trust is `revocable` or `irrevocable`. enum: - revocable - irrevocable type: string x-documentation-priority: default x-enum-descriptions: - The trust is revocable by the grantor. - The trust cannot be revoked. formation_document_file_id: anyOf: - description: The ID for the File containing the formation document of the trust. type: string x-documentation-priority: default x-id-reference-to: Files - type: 'null' formation_state: anyOf: - description: The two-letter United States Postal Service (USPS) abbreviation for the state in which the trust was formed. type: string x-documentation-priority: default - type: 'null' grantor: anyOf: - additionalProperties: false description: The grantor of the trust. Will be present if the `category` is `revocable`. properties: address: additionalProperties: false description: The person's address. example: city: New York country: US line1: 33 Liberty Street line2: null state: NY zip: '10045' properties: city: anyOf: - description: The city, district, town, or village of the address. type: string x-documentation-priority: default - type: 'null' country: description: The two-letter ISO 3166-1 alpha-2 code for the country of the address. type: string x-documentation-priority: default line1: description: The first line of the address. type: string x-documentation-priority: default line2: anyOf: - description: The second line of the address. type: string x-documentation-priority: default - type: 'null' state: anyOf: - description: The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. type: string x-documentation-priority: default - type: 'null' zip: anyOf: - description: The ZIP or postal code of the address. type: string x-documentation-priority: default - type: 'null' required: - line1 - line2 - city - state - zip - country title: Entity Trust Individual Address type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Addresses date_of_birth: description: The person's date of birth in YYYY-MM-DD format. format: date type: string x-documentation-priority: default identification: anyOf: - additionalProperties: true description: A means of verifying the person's identity. properties: method: description: A method that can be used to verify the individual's identity. enum: - social_security_number - individual_taxpayer_identification_number - passport - drivers_license - other type: string x-documentation-priority: default x-enum-descriptions: - A social security number. - An individual taxpayer identification number (ITIN). - A passport number. - A driver's license number. - Another identifying document. number_last4: description: The last 4 digits of the identification number that can be used to verify the individual's identity. type: string x-documentation-priority: default required: - method - number_last4 title: Entity Trust Individual Identification type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Identifications - type: 'null' name: description: The person's legal name. type: string x-documentation-priority: default required: - name - date_of_birth - address - identification title: Entity Trust Individual type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Individuals - type: 'null' name: description: The trust's name. type: string x-documentation-priority: default tax_identifier: anyOf: - description: The Employer Identification Number (EIN) of the trust itself. type: string x-documentation-priority: default - type: 'null' trustees: description: The trustees of the trust. items: additionalProperties: false properties: individual: anyOf: - additionalProperties: false description: The individual trustee of the trust. Will be present if the trustee's `structure` is equal to `individual`. properties: address: additionalProperties: false description: The person's address. example: city: New York country: US line1: 33 Liberty Street line2: null state: NY zip: '10045' properties: city: anyOf: - description: The city, district, town, or village of the address. type: string x-documentation-priority: default - type: 'null' country: description: The two-letter ISO 3166-1 alpha-2 code for the country of the address. type: string x-documentation-priority: default line1: description: The first line of the address. type: string x-documentation-priority: default line2: anyOf: - description: The second line of the address. type: string x-documentation-priority: default - type: 'null' state: anyOf: - description: The two-letter United States Postal Service (USPS) abbreviation for the US state, province, or region of the address. type: string x-documentation-priority: default - type: 'null' zip: anyOf: - description: The ZIP or postal code of the address. type: string x-documentation-priority: default - type: 'null' required: - line1 - line2 - city - state - zip - country title: Entity Trust TrusteesElement Individual Address type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Addresses date_of_birth: description: The person's date of birth in YYYY-MM-DD format. format: date type: string x-documentation-priority: default identification: anyOf: - additionalProperties: true description: A means of verifying the person's identity. properties: method: description: A method that can be used to verify the individual's identity. enum: - social_security_number - individual_taxpayer_identification_number - passport - drivers_license - other type: string x-documentation-priority: default x-enum-descriptions: - A social security number. - An individual taxpayer identification number (ITIN). - A passport number. - A driver's license number. - Another identifying document. number_last4: description: The last 4 digits of the identification number that can be used to verify the individual's identity. type: string x-documentation-priority: default required: - method - number_last4 title: Entity Trust TrusteesElement Individual Identification type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Identifications - type: 'null' name: description: The person's legal name. type: string x-documentation-priority: default required: - name - date_of_birth - address - identification title: Entity Trust TrusteesElement Individual type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Individuals - type: 'null' structure: description: The structure of the trustee. Will always be equal to `individual`. enum: - individual type: string x-documentation-priority: default x-enum-descriptions: - The trustee is an individual. required: - structure - individual title: Entity Trust TrusteesElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: TrusteesElements type: array x-documentation-priority: default required: - name - category - address - formation_state - tax_identifier - trustees - grantor - formation_document_file_id title: Entity Trust type: object x-documentation-priority: low x-event-categories: [] x-stainless-empty-object: false x-title-plural: Trusts - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `entity`. enum: - entity type: string x-documentation-priority: default validation: anyOf: - additionalProperties: false description: The validation results for the entity. Learn more about [validations](/documentation/entity-validation). properties: issues: description: The list of issues that need to be addressed. items: additionalProperties: false properties: beneficial_owner_address: anyOf: - additionalProperties: false description: Details when the issue is with a beneficial owner's address. properties: beneficial_owner_id: description: The ID of the beneficial owner. type: string x-documentation-priority: default x-id-reference-to: Beneficial Owners reason: description: The reason the address is invalid. enum: - mailbox_address type: string x-documentation-priority: default x-enum-descriptions: - The address is a mailbox or other non-physical address. required: - beneficial_owner_id - reason title: Entity EntityValidation IssuesElement BeneficialOwnerAddress type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: BeneficialOwnerAddresses - type: 'null' beneficial_owner_identity: anyOf: - additionalProperties: false description: Details when the issue is with a beneficial owner's identity verification. properties: beneficial_owner_id: description: The ID of the beneficial owner. type: string x-documentation-priority: default x-id-reference-to: Beneficial Owners required: - beneficial_owner_id title: Entity EntityValidation IssuesElement BeneficialOwnerIdentity type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: BeneficialOwnerIdentities - type: 'null' category: description: The type of issue. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully. enum: - entity_tax_identifier - entity_address - beneficial_owner_identity - beneficial_owner_address type: string x-documentation-priority: default x-enum-descriptions: - The entity's tax identifier could not be validated. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier). - The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.address). - A beneficial owner's identity could not be verified. Update the identification with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner). - A beneficial owner's address could not be validated. Update the address with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner). entity_address: anyOf: - additionalProperties: false description: Details when the issue is with the entity's address. properties: reason: description: The reason the address is invalid. enum: - mailbox_address type: string x-documentation-priority: default x-enum-descriptions: - The address is a mailbox or other non-physical address. required: - reason title: Entity EntityValidation IssuesElement EntityAddress type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: EntityAddresses - type: 'null' entity_tax_identifier: anyOf: - additionalProperties: false description: Details when the issue is with the entity's tax ID. properties: {} title: Entity EntityValidation IssuesElement EntityTaxIdentifier type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: EntityTaxIdentifiers - type: 'null' required: - category - entity_tax_identifier - entity_address - beneficial_owner_identity - beneficial_owner_address title: Entity EntityValidation IssuesElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: IssuesElements type: array x-documentation-priority: default status: description: The validation status for the entity. If the status is `invalid`, the `issues` array will be populated. enum: - pending - valid - invalid type: string x-documentation-priority: default x-enum-descriptions: - The submitted data is being validated. - The submitted data is valid. - Additional information is required to validate the data. required: - status - issues title: Entity EntityValidation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' required: - type - id - structure - corporation - natural_person - joint - government_authority - trust - idempotency_key - third_party_verification - risk_rating - terms_agreements - description - status - details_confirmed_at - creating_entity_onboarding_session_id - created_at - validation - supplemental_documents title: Entity type: object x-event-categories: - entity.created - entity.updated x-stainless-empty-object: false x-tag: Entities x-title-plural: Entities card_payment: additionalProperties: false description: Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement. example: account_id: account_in71c4amph0vgo2qllky card_id: card_oubs0hwk5rn6knuecxg2 created_at: '2020-01-31T23:59:59Z' digital_wallet_token_id: null elements: - card_authorization: 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 expires_at: '2020-01-31T23:59:59Z' id: card_authorization_6iqxap6ivd0fo5eu3i8x 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 pending_transaction_id: null 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 type: card_authorization 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 category: card_authorization created_at: '2020-01-31T23:59:59Z' - card_reversal: card_authorization_id: card_authorization_6iqxap6ivd0fo5eu3i8x currency: USD id: card_reversal_8vr9qy60cgf5d0slpb68 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: visa network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4 presentment_currency: USD reversal_amount: 20 reversal_presentment_amount: 20 reversal_reason: reversed_by_customer 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 type: card_reversal updated_authorization_amount: 80 updated_authorization_presentment_amount: 80 category: card_reversal created_at: '2020-01-31T23:59:59Z' - card_increment: actioner: increase additional_amounts: clinic: null dental: null original: null prescription: null surcharge: null total_cumulative: null total_healthcare: null transit: null unknown: null vision: null amount: 20 card_authorization_id: card_authorization_6iqxap6ivd0fo5eu3i8x currency: USD id: card_increment_6ztayc58j1od0rpebp3e network: visa network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' network_risk_score: 10 pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4 presentment_amount: 20 presentment_currency: USD real_time_decision_id: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' type: card_increment updated_authorization_amount: 120 category: card_increment created_at: '2020-01-31T23:59:59Z' - card_settlement: 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 category: card_settlement created_at: '2020-01-31T23:59:59Z' id: card_payment_nd3k2kacrqjli8482ave physical_card_id: null state: authorized_amount: 100 fuel_confirmed_amount: 0 incremented_amount: 20 refund_authorized_amount: 0 refunded_amount: 0 reversed_amount: 20 settled_amount: 100 type: card_payment properties: account_id: description: The identifier for the Account the Transaction belongs to. type: string x-documentation-priority: default x-id-reference-to: Accounts card_id: description: The Card identifier for this payment. type: string x-documentation-priority: default x-id-reference-to: Cards created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card Payment was created. format: date-time type: string x-documentation-priority: default digital_wallet_token_id: anyOf: - description: The Digital Wallet Token identifier for this payment. type: string x-documentation-priority: default x-id-reference-to: Digital Wallet Tokens - type: 'null' elements: description: The interactions related to this card payment. items: additionalProperties: false example: card_authorization: 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 expires_at: '2020-01-31T23:59:59Z' id: card_authorization_6iqxap6ivd0fo5eu3i8x 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 pending_transaction_id: null 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 type: card_authorization 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 category: card_authorization created_at: '2020-01-31T23:59:59Z' properties: card_authentication: anyOf: - $ref: '#/components/schemas/card_authentication' description: A Card Authentication object. This field will be present in the JSON response if and only if `category` is equal to `card_authentication`. Card Authentications are attempts to authenticate a transaction or a card with 3DS. x-documentation-priority: default - type: 'null' card_authorization: anyOf: - $ref: '#/components/schemas/card_authorization' description: A Card Authorization object. This field will be present in the JSON response if and only if `category` is equal to `card_authorization`. Card Authorizations are temporary holds placed on a customer's funds with the intent to later clear a transaction. x-documentation-priority: default - type: 'null' card_authorization_expiration: anyOf: - $ref: '#/components/schemas/card_authorization_expiration' description: A Card Authorization Expiration object. This field will be present in the JSON response if and only if `category` is equal to `card_authorization_expiration`. Card Authorization Expirations are cancellations of authorizations that were never settled by the acquirer. x-documentation-priority: default - type: 'null' card_balance_inquiry: anyOf: - $ref: '#/components/schemas/card_balance_inquiry' description: A Card Balance Inquiry object. This field will be present in the JSON response if and only if `category` is equal to `card_balance_inquiry`. Card Balance Inquiries are transactions that allow merchants to check the available balance on a card without placing a hold on funds, commonly used when a customer requests their balance at an ATM. x-documentation-priority: default - type: 'null' card_decline: anyOf: - additionalProperties: true description: A Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_decline`. example: actioner: increase additional_amounts: clinic: null dental: null original: null prescription: null surcharge: amount: 10 currency: USD total_cumulative: null total_healthcare: null transit: null unknown: null vision: null amount: -1000 card_payment_id: card_payment_nd3k2kacrqjli8482ave currency: USD declined_transaction_id: declined_transaction_17jbn0yyhvkt4v4ooym8 digital_wallet_token_id: null direction: settlement id: card_decline_bx3o8zd7glq8yvtwg25v incremented_card_authorization_id: null merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_descriptor: AMAZON.COM merchant_postal_code: '10045' merchant_state: null network_details: category: visa pulse: null visa: electronic_commerce_indicator: secure_electronic_commerce point_of_service_entry_mode: manual stand_in_processing_reason: null terminal_entry_capability: magnetic_stripe network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' network_risk_score: 10 physical_card_id: null presentment_amount: -1000 presentment_currency: USD processing_category: purchase real_time_decision_id: null real_time_decision_reason: null reason: insufficient_funds scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' terminal_id: RCN5VNXS verification: card_verification_code: result: match cardholder_address: actual_line1: 33 Liberty Street actual_postal_code: '94131' provided_line1: 33 Liberty Street provided_postal_code: '94132' result: postal_code_no_match_address_match cardholder_name: null properties: actioner: description: Whether this authorization was approved by Increase, the card network through stand-in processing, or the user through a real-time decision. enum: - user - increase - network type: string x-documentation-priority: default x-enum-descriptions: - This object was actioned by the user through a real-time decision. - This object was actioned by Increase without user intervention. - This object was actioned by the network, through stand-in processing. additional_amounts: additionalProperties: false description: Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction. properties: clinic: anyOf: - additionalProperties: false description: The part of this transaction amount that was for clinic-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' dental: anyOf: - additionalProperties: false description: The part of this transaction amount that was for dental-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' original: anyOf: - additionalProperties: false description: The original pre-authorized amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' prescription: anyOf: - additionalProperties: false description: The part of this transaction amount that was for healthcare prescriptions. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' surcharge: anyOf: - additionalProperties: false description: The surcharge amount charged for this transaction by the merchant. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_cumulative: anyOf: - additionalProperties: false description: The total amount of a series of incremental authorizations, optionally provided. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_healthcare: anyOf: - additionalProperties: false description: The total amount of healthcare-related additional amounts. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' transit: anyOf: - additionalProperties: false description: The part of this transaction amount that was for transit-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' unknown: anyOf: - additionalProperties: false description: An unknown additional amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' vision: anyOf: - additionalProperties: false description: The part of this transaction amount that was for vision-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Payment Card Payment Element Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' required: - total_healthcare - total_cumulative - surcharge - transit - vision - clinic - dental - prescription - original - unknown title: Card Payment Card Payment Element Card Decline AdditionalAmounts type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s amount: description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default card_payment_id: description: The ID of the Card Payment this transaction belongs to. type: string x-documentation-priority: default x-id-reference-to: Card Payments currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) declined_transaction_id: description: The identifier of the declined transaction created for this Card Decline. type: string x-documentation-priority: default x-id-reference-to: Declined Transactions digital_wallet_token_id: anyOf: - description: If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used. type: string x-documentation-priority: default x-id-reference-to: Digital Wallet Tokens - type: 'null' direction: description: The direction describes the direction the funds will move, either from the cardholder to the merchant or from the merchant to the cardholder. enum: - settlement - refund type: string x-documentation-priority: default x-enum-descriptions: - A regular card authorization where funds are debited from the cardholder. - A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. id: description: The Card Decline identifier. type: string x-documentation-priority: default x-id-reference-to: Card Declines incremented_card_authorization_id: anyOf: - description: The identifier of the card authorization this request attempted to incrementally authorize. type: string x-documentation-priority: default x-id-reference-to: Card Authorizations - type: 'null' merchant_acceptor_id: description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_category_code: description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_city: anyOf: - description: The city the merchant resides in. type: string x-documentation-priority: default - type: 'null' merchant_country: description: The country the merchant resides in. type: string x-documentation-priority: default merchant_descriptor: description: The merchant descriptor of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_postal_code: anyOf: - description: The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash. type: string x-documentation-priority: default - type: 'null' merchant_state: anyOf: - description: The state the merchant resides in. type: string x-documentation-priority: default - type: 'null' network_details: additionalProperties: false description: Fields specific to the `network`. properties: category: description: The payment network used to process this card authorization. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa - Pulse pulse: anyOf: - additionalProperties: false description: Fields specific to the `pulse` network. properties: {} title: Card Payment Card Payment Element Card Decline NetworkDetails Pulse type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Pulses - type: 'null' visa: anyOf: - additionalProperties: false description: Fields specific to the `visa` network. properties: electronic_commerce_indicator: anyOf: - description: For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order. enum: - mail_phone_order - recurring - installment - unknown_mail_phone_order - secure_electronic_commerce - non_authenticated_security_transaction_at_3ds_capable_merchant - non_authenticated_security_transaction - non_secure_transaction type: string x-documentation-priority: default x-enum-descriptions: - 'Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.' - 'Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.' - 'Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.' - 'Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.' - 'Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure' - 'Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.' - 'Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however, cardholder authentication is not performed using 3-D Secure.' - 'Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection.' - type: 'null' point_of_service_entry_mode: anyOf: - description: The method used to enter the cardholder's primary account number and card expiration date. enum: - unknown - manual - magnetic_stripe_no_cvv - optical_code - integrated_circuit_card - contactless - credential_on_file - magnetic_stripe - contactless_magnetic_stripe - integrated_circuit_card_no_cvv type: string x-documentation-priority: default x-enum-descriptions: - Unknown - Manual key entry - Magnetic stripe read, without card verification value - Optical code - Contact chip card - Contactless read of chip card - Transaction initiated using a credential that has previously been stored on file - Magnetic stripe read - Contactless read of magnetic stripe data - Contact chip card, without card verification value - type: 'null' stand_in_processing_reason: anyOf: - description: 'Only present when `actioner: network`. Describes why a card authorization was approved or declined by Visa through stand-in processing.' enum: - issuer_error - invalid_physical_card - invalid_cryptogram - invalid_cardholder_authentication_verification_value - internal_visa_error - merchant_transaction_advisory_service_authentication_required - payment_fraud_disruption_acquirer_block - other type: string x-documentation-priority: default x-enum-descriptions: - Increase failed to process the authorization in a timely manner. - The physical card read had an invalid CVV or dCVV. - The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase. - The 3DS cardholder authentication verification value was invalid. - An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays. - The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier. - The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing. - An unspecific reason for stand-in processing. - type: 'null' terminal_entry_capability: anyOf: - description: The capability of the terminal being used to read the card. Shows whether a terminal can e.g., accept chip cards or if it only supports magnetic stripe reads. This reflects the highest capability of the terminal — for example, a terminal that supports both chip and magnetic stripe will be identified as chip-capable. enum: - unknown - terminal_not_used - magnetic_stripe - barcode - optical_character_recognition - chip_or_contactless - contactless_only - no_capability type: string x-documentation-priority: default x-enum-descriptions: - Unknown - No terminal was used for this transaction. - The terminal can only read magnetic stripes and does not have chip or contactless reading capability. - The terminal can only read barcodes. - The terminal can only read cards via Optical Character Recognition. - The terminal supports contact chip cards and can also read the magnetic stripe. If contact chip is supported, this value is used regardless of whether contactless is also supported. - The terminal supports contactless reads but does not support contact chip. Only used when the terminal lacks contact chip capability. - The terminal has no card reading capability. - type: 'null' required: - electronic_commerce_indicator - point_of_service_entry_mode - stand_in_processing_reason - terminal_entry_capability title: Card Payment Card Payment Element Card Decline NetworkDetails Visa type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Visas - type: 'null' required: - category - visa - pulse title: Card Payment Card Payment Element Card Decline NetworkDetails type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s network_identifiers: additionalProperties: false description: Network-specific identifiers for a specific request or transaction. example: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' properties: authorization_identification_response: anyOf: - description: The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response. type: string x-documentation-priority: default - type: 'null' retrieval_reference_number: anyOf: - description: A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter. type: string x-documentation-priority: default - type: 'null' trace_number: anyOf: - description: A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time. type: string x-documentation-priority: default - type: 'null' transaction_id: anyOf: - description: A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests. type: string x-documentation-priority: default - type: 'null' required: - transaction_id - trace_number - retrieval_reference_number - authorization_identification_response title: Card Payment Card Payment Element Card Decline NetworkIdentifiers type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s network_risk_score: anyOf: - description: The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the score is from 0 to 999, where 999 is the riskiest. type: integer x-documentation-priority: default - type: 'null' physical_card_id: anyOf: - description: If the authorization was made in-person with a physical card, the Physical Card that was used. type: string x-documentation-priority: default x-id-reference-to: Physical Cards - type: 'null' presentment_amount: description: The declined amount in the minor unit of the transaction's presentment currency. type: integer x-documentation-priority: default presentment_currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency. type: string x-documentation-priority: default processing_category: description: The processing category describes the intent behind the authorization, such as whether it was used for bill payments or an automatic fuel dispenser. enum: - account_funding - automatic_fuel_dispenser - bill_payment - original_credit - purchase - quasi_cash - refund - cash_disbursement - balance_inquiry - unknown type: string x-documentation-priority: default x-enum-descriptions: - Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts. - Automatic fuel dispenser authorizations occur when a card is used at a gas pump, prior to the actual transaction amount being known. They are followed by an advice message that updates the amount of the pending transaction. - A transaction used to pay a bill. - Original credit transactions are used to send money to a cardholder. - A regular purchase. - Quasi-cash transactions represent purchases of items which may be convertible to cash. - A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. - Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale. - A balance inquiry transaction is used to check the balance of an account associated with a card. - The processing category is unknown. real_time_decision_id: anyOf: - description: The identifier of the Real-Time Decision sent to approve or decline this transaction. type: string x-documentation-priority: default x-id-reference-to: Real-Time Decisions - type: 'null' real_time_decision_reason: anyOf: - description: This is present if a specific decline reason was given in the real-time decision. enum: - insufficient_funds - transaction_never_allowed - exceeds_approval_limit - card_temporarily_disabled - suspected_fraud - other type: string x-documentation-priority: default x-enum-descriptions: - The cardholder does not have sufficient funds to cover the transaction. The merchant may attempt to process the transaction again. - This type of transaction is not allowed for this card. This transaction should not be retried. - The transaction amount exceeds the cardholder's approval limit. The merchant may attempt to process the transaction again. - The card has been temporarily disabled or not yet activated. The merchant may attempt to process the transaction again. - The transaction is suspected to be fraudulent. The merchant may attempt to process the transaction again. - The transaction was declined for another reason. The merchant may attempt to process the transaction again. This should be used sparingly. - type: 'null' reason: description: Why the transaction was declined. enum: - account_closed - card_not_active - card_canceled - physical_card_not_active - entity_not_active - group_locked - insufficient_funds - cvv2_mismatch - pin_mismatch - card_expiration_mismatch - transaction_not_allowed - breaches_limit - webhook_declined - webhook_timed_out - declined_by_stand_in_processing - invalid_physical_card - missing_original_authorization - invalid_cryptogram - failed_3ds_authentication - suspected_card_testing - suspected_fraud type: string x-documentation-priority: default x-enum-descriptions: - The account has been closed. - The Card was not active. - The Card has been canceled. - The Physical Card was not active. - The account's entity was not active. - The account was inactive. - The Card's Account did not have a sufficient available balance. - The given CVV2 did not match the card's value. - The given PIN did not match the card's value. - The given expiration date did not match the card's value. Only applies when a CVV2 is present. - The attempted card transaction is not allowed per Increase's terms. - The transaction was blocked by a Limit. - Your application declined the transaction via webhook. - Your application webhook did not respond without the required timeout. - Declined by stand-in processing. - The card read had an invalid CVV or dCVV. - The original card authorization for this incremental authorization does not exist. - The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase. - The transaction was declined because the 3DS authentication failed. - The transaction was suspected to be used by a card tester to test for valid card numbers. - The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information. scheme_fees: description: The scheme fees associated with this card decline. items: additionalProperties: false example: amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' properties: amount: description: The fee amount given as a string containing a decimal number. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created. format: date-time type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) fee_type: description: The type of fee being assessed. enum: - visa_international_service_assessment_single_currency - visa_international_service_assessment_cross_currency - visa_authorization_domestic_point_of_sale - visa_authorization_international_point_of_sale - visa_authorization_canada_point_of_sale - visa_authorization_reversal_point_of_sale - visa_authorization_reversal_international_point_of_sale - visa_authorization_address_verification_service - visa_advanced_authorization - visa_message_transmission - visa_account_verification_domestic - visa_account_verification_international - visa_account_verification_canada - visa_corporate_acceptance_fee - visa_consumer_debit_acceptance_fee - visa_business_debit_acceptance_fee - visa_purchasing_acceptance_fee - visa_purchase_domestic - visa_purchase_international - visa_credit_purchase_token - visa_debit_purchase_token - visa_clearing_transmission - visa_direct_authorization - visa_direct_transaction_domestic - visa_service_commercial_credit - visa_advertising_service_commercial_credit - visa_community_growth_acceleration_program - visa_processing_guarantee_commercial_credit - pulse_switch_fee type: string x-documentation-priority: default x-enum-descriptions: - International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency. - International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes. - Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions). - Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point. - Activity, per inquiry, related to the domestic Issuer for Account Number Verification. - Activity, per inquiry, related to the international Issuer for Account Number Verification. - Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification. - The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation. - The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions. - The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - Activity and fees for the processing of a sales draft original for a purchase transaction. - Activity and fees for the processing of an international sales draft original for a purchase transaction. - Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - A per transaction fee assessed for Base II financial draft - Issuer. - Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. - Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions. - Issuer card service fee for Commercial Credit cards. - Issuer Advertising Service Fee for Commercial Credit cards. - Issuer Community Growth Acceleration Program Fee. - Issuer Processing Guarantee for Commercial Credit cards. - Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network. fixed_component: anyOf: - description: The fixed component of the fee, if applicable, given in major units of the fee amount. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' variable_rate: anyOf: - description: The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' required: - created_at - amount - currency - fee_type - variable_rate - fixed_component title: Card Payment Card Payment Element Card Decline Card Scheme Fee type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Scheme Fees type: array x-documentation-priority: default terminal_id: anyOf: - description: The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with. type: string x-documentation-priority: default - type: 'null' verification: additionalProperties: false description: Fields related to verification of cardholder-provided values. properties: card_verification_code: additionalProperties: false description: Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. properties: result: description: The result of verifying the Card Verification Code. enum: - not_checked - match - no_match type: string x-documentation-priority: default x-enum-descriptions: - No card verification code was provided in the authorization request. - The card verification code matched the one on file. - The card verification code did not match the one on file. required: - result title: Card Payment Card Payment Element Card Decline Verification CardVerificationCode type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardVerificationCodes cardholder_address: additionalProperties: false description: Cardholder address provided in the authorization request and the address on file we verified it against. properties: actual_line1: anyOf: - description: Line 1 of the address on file for the cardholder. type: string x-documentation-priority: default - type: 'null' actual_postal_code: anyOf: - description: The postal code of the address on file for the cardholder. type: string x-documentation-priority: default - type: 'null' provided_line1: anyOf: - description: The cardholder address line 1 provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_postal_code: anyOf: - description: The postal code provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' result: description: The address verification result returned to the card network. enum: - not_checked - postal_code_match_address_no_match - postal_code_no_match_address_match - match - no_match - postal_code_match_address_not_checked type: string x-documentation-priority: default x-enum-descriptions: - No address information was provided in the authorization request. - Postal code matches, but the street address does not match or was not provided. - Postal code does not match, but the street address matches or was not provided. - Postal code and street address match. - Postal code and street address do not match. - Postal code matches, but the street address was not verified. (deprecated) required: - provided_postal_code - provided_line1 - actual_postal_code - actual_line1 - result title: Card Payment Card Payment Element Card Decline Verification CardholderAddress type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardholderAddresses cardholder_name: anyOf: - additionalProperties: false description: Cardholder name provided in the authorization request. properties: provided_first_name: anyOf: - description: The first name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_last_name: anyOf: - description: The last name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_middle_name: anyOf: - description: The middle name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' required: - provided_first_name - provided_middle_name - provided_last_name title: Card Payment Card Payment Element Card Decline Verification CardholderName type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardholderNames - type: 'null' required: - cardholder_address - cardholder_name - card_verification_code title: Card Payment Card Payment Element Card Decline Verification type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s required: - merchant_acceptor_id - merchant_descriptor - merchant_category_code - terminal_id - merchant_city - merchant_state - merchant_postal_code - merchant_country - digital_wallet_token_id - physical_card_id - verification - additional_amounts - network_identifiers - network_risk_score - network_details - id - card_payment_id - amount - presentment_amount - presentment_currency - currency - processing_category - reason - real_time_decision_reason - incremented_card_authorization_id - actioner - direction - real_time_decision_id - scheme_fees - declined_transaction_id title: Card Payment Card Payment Element Card Decline type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Declines - 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_fuel_confirmation: anyOf: - $ref: '#/components/schemas/card_fuel_confirmation' description: A Card Fuel Confirmation object. This field will be present in the JSON response if and only if `category` is equal to `card_fuel_confirmation`. Card Fuel Confirmations update the amount of a Card Authorization after a fuel pump transaction is completed. x-documentation-priority: default - type: 'null' card_increment: anyOf: - $ref: '#/components/schemas/card_increment' description: A Card Increment object. This field will be present in the JSON response if and only if `category` is equal to `card_increment`. Card Increments increase the pending amount of an authorized transaction. x-documentation-priority: default - 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_reversal: anyOf: - $ref: '#/components/schemas/card_reversal' description: A Card Reversal object. This field will be present in the JSON response if and only if `category` is equal to `card_reversal`. Card Reversals cancel parts of or the entirety of an existing Card Authorization. x-documentation-priority: default - 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' card_validation: anyOf: - $ref: '#/components/schemas/inbound_card_validation' description: An Inbound Card Validation object. This field will be present in the JSON response if and only if `category` is equal to `card_validation`. Inbound Card Validations are requests from a merchant to verify that a card number and optionally its address and/or Card Verification Value are valid. x-documentation-priority: default - 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: - card_authorization - card_authentication - card_balance_inquiry - card_validation - card_decline - card_reversal - card_authorization_expiration - card_increment - card_settlement - card_refund - card_fuel_confirmation - card_financial - other type: string x-documentation-priority: default x-enum-descriptions: - 'Card Authorization: details will be under the `card_authorization` object.' - 'Card Authentication: details will be under the `card_authentication` object.' - 'Card Balance Inquiry: details will be under the `card_balance_inquiry` object.' - 'Inbound Card Validation: details will be under the `card_validation` object.' - 'Card Decline: details will be under the `card_decline` object.' - 'Card Reversal: details will be under the `card_reversal` object.' - 'Card Authorization Expiration: details will be under the `card_authorization_expiration` object.' - 'Card Increment: details will be under the `card_increment` object.' - 'Card Settlement: details will be under the `card_settlement` object.' - 'Card Refund: details will be under the `card_refund` object.' - 'Card Fuel Confirmation: details will be under the `card_fuel_confirmation` object.' - 'Card Financial: details will be under the `card_financial` object.' - Unknown card payment element. created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the card payment element was created. format: date-time type: string x-documentation-priority: default 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: Card Payment Card Payment Element Other type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Others - type: 'null' required: - category - created_at title: Card Payment Card Payment Element type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Payment Elements type: array x-documentation-priority: default id: description: The Card Payment identifier. type: string x-documentation-priority: default x-id-reference-to: Card Payments physical_card_id: anyOf: - description: The Physical Card identifier for this payment. type: string x-documentation-priority: default x-id-reference-to: Physical Cards - type: 'null' state: additionalProperties: false description: The summarized state of this card payment. example: authorized_amount: 100 fuel_confirmed_amount: 0 incremented_amount: 20 refund_authorized_amount: 0 refunded_amount: 0 reversed_amount: 20 settled_amount: 100 properties: authorized_amount: description: The total authorized amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default fuel_confirmed_amount: description: The total amount from fuel confirmations in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default incremented_amount: description: The total incrementally updated authorized amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default refund_authorized_amount: description: The total refund authorized amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default refunded_amount: description: The total refunded amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default reversed_amount: description: The total reversed amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default settled_amount: description: The total settled amount in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default required: - authorized_amount - refund_authorized_amount - incremented_amount - reversed_amount - fuel_confirmed_amount - settled_amount - refunded_amount title: Card Payment Card Payment State type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Payment States type: description: A constant representing the object's type. For this resource it will always be `card_payment`. enum: - card_payment type: string x-documentation-priority: default required: - type - id - created_at - account_id - card_id - physical_card_id - digital_wallet_token_id - elements - state title: Card Payment type: object x-event-categories: - card_payment.created - card_payment.updated x-stainless-empty-object: false x-tag: Card Payments x-title-plural: Card Payments card_authentication: additionalProperties: true description: Card Authentications are attempts to authenticate a transaction or a card with 3DS. example: access_control_server_transaction_identifier: 1a628378-4d43-4438-a31f-25c0e1bf2537 billing_address_city: New York billing_address_country: US billing_address_line1: 33 Liberty Street billing_address_line2: null billing_address_line3: null billing_address_postal_code: '10045' billing_address_state: NY card_id: card_oubs0hwk5rn6knuecxg2 card_payment_id: card_payment_nd3k2kacrqjli8482ave cardholder_email: user@example.com cardholder_name: Ian Crease challenge: attempts: - created_at: '2020-01-31T23:59:59Z' outcome: successful created_at: '2020-01-31T23:59:59Z' one_time_code: '123456' real_time_decision_id: real_time_decision_j76n2e810ezcg3zh5qtn verification_method: text_message verification_value: '+16505046304' created_at: '2020-01-31T23:59:59Z' deny_reason: null device_channel: browser: accept_header: text/html ip_address: 203.0.113.0 javascript_enabled: enabled language: en-US user_agent: Mozilla/5.0 category: browser merchant_initiated: null directory_server_transaction_identifier: 8990a978-5eb2-4440-8539-5619e24b0b0d id: card_authentication_xft30xjdubptlgrxboch merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_country: US merchant_name: AMAZON.COM message_category: category: payment_authentication non_payment: null payment: purchase_amount: 861 purchase_amount_cardholder_estimated: 1000 purchase_currency: EUR transaction_type: goods_service_purchase prior_authenticated_card_payment_id: null real_time_decision_id: null requestor_authentication_indicator: payment_transaction requestor_challenge_indicator: no_preference requestor_name: Example Requestor requestor_url: https://example.com shipping_address_city: New York shipping_address_country: US shipping_address_line1: 33 Liberty Street shipping_address_line2: null shipping_address_line3: null shipping_address_postal_code: '10045' shipping_address_state: NY status: validating_challenge three_d_secure_server_transaction_identifier: 6839e1b0-dcae-482d-8166-40e44dd0d8cd type: card_authentication properties: access_control_server_transaction_identifier: description: A unique identifier assigned by the Access Control Server (us) for this transaction. type: string x-documentation-priority: default billing_address_city: anyOf: - description: The city of the cardholder billing address associated with the card used for this purchase. type: string x-documentation-priority: default - type: 'null' billing_address_country: anyOf: - description: The country of the cardholder billing address associated with the card used for this purchase. type: string x-documentation-priority: default - type: 'null' billing_address_line1: anyOf: - description: The first line of the cardholder billing address associated with the card used for this purchase. type: string x-documentation-priority: default - type: 'null' billing_address_line2: anyOf: - description: The second line of the cardholder billing address associated with the card used for this purchase. type: string x-documentation-priority: default - type: 'null' billing_address_line3: anyOf: - description: The third line of the cardholder billing address associated with the card used for this purchase. type: string x-documentation-priority: default - type: 'null' billing_address_postal_code: anyOf: - description: The postal code of the cardholder billing address associated with the card used for this purchase. type: string x-documentation-priority: default - type: 'null' billing_address_state: anyOf: - description: The US state of the cardholder billing address associated with the card used for this purchase. type: string x-documentation-priority: default - type: 'null' card_id: description: The identifier of the Card. type: string x-documentation-priority: default x-id-reference-to: Cards 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 cardholder_email: anyOf: - description: The email address of the cardholder. type: string x-documentation-priority: default - type: 'null' cardholder_name: anyOf: - description: The name of the cardholder. type: string x-documentation-priority: default - type: 'null' challenge: anyOf: - additionalProperties: false description: Details about the challenge, if one was requested. properties: attempts: description: Details about the challenge verification attempts, if any happened. items: additionalProperties: false properties: created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time of the Card Authentication Challenge Attempt. format: date-time type: string x-documentation-priority: default outcome: description: The outcome of the Card Authentication Challenge Attempt. enum: - successful - failed type: string x-documentation-priority: default x-enum-descriptions: - The attempt was successful. - The attempt was unsuccessful. required: - created_at - outcome title: Card Authentication Challenge AttemptsElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: AttemptsElements type: array x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card Authentication Challenge was started. format: date-time type: string x-documentation-priority: default one_time_code: description: The one-time code used for the Card Authentication Challenge. type: string x-documentation-priority: default real_time_decision_id: anyOf: - description: The identifier of the Real-Time Decision used to deliver this challenge. type: string x-documentation-priority: default x-id-reference-to: Real-Time Decisions - type: 'null' verification_method: description: The method used to verify the Card Authentication Challenge. enum: - text_message - email - none_available type: string x-documentation-priority: default x-enum-descriptions: - The one-time code was sent via text message. - The one-time code was sent via email. - The one-time code was not successfully delivered. verification_value: anyOf: - description: E.g., the email address or phone number used for the Card Authentication Challenge. type: string x-documentation-priority: default - type: 'null' required: - created_at - one_time_code - verification_method - verification_value - real_time_decision_id - attempts title: Card Authentication Challenge type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Challenges - type: 'null' created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Card Authentication was attempted. format: date-time type: string x-documentation-priority: default deny_reason: anyOf: - description: The reason why this authentication attempt was denied, if it was. enum: - group_locked - card_not_active - entity_not_active - transaction_not_allowed - webhook_denied - webhook_timed_out type: string x-documentation-priority: default x-enum-descriptions: - The group was locked. - The card was not active. - The entity was not active. - The transaction was not allowed. - The webhook was denied. - The webhook timed out. - type: 'null' device_channel: additionalProperties: false description: The device channel of the card authentication attempt. properties: browser: anyOf: - additionalProperties: false description: Fields specific to the browser device channel. properties: accept_header: anyOf: - description: The accept header from the cardholder's browser. type: string x-documentation-priority: default - type: 'null' ip_address: anyOf: - description: The IP address of the cardholder's browser. type: string x-documentation-priority: default - type: 'null' javascript_enabled: anyOf: - description: Whether JavaScript is enabled in the cardholder's browser. enum: - enabled - disabled type: string x-documentation-priority: default x-enum-descriptions: - JavaScript is enabled in the cardholder's browser. - JavaScript is not enabled in the cardholder's browser. - type: 'null' language: anyOf: - description: The language of the cardholder's browser. type: string x-documentation-priority: default - type: 'null' user_agent: anyOf: - description: The user agent of the cardholder's browser. type: string x-documentation-priority: default - type: 'null' required: - accept_header - ip_address - javascript_enabled - language - user_agent title: Card Authentication DeviceChannel Browser type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Browsers - type: 'null' category: description: The category of the device channel. enum: - app - browser - three_ds_requestor_initiated type: string x-documentation-priority: default x-enum-descriptions: - The authentication attempt was made from an app. - The authentication attempt was made from a browser. - The authentication attempt was initiated by the 3DS Requestor. merchant_initiated: anyOf: - additionalProperties: false description: Fields specific to merchant initiated transactions. properties: indicator: description: The merchant initiated indicator for the transaction. enum: - recurring_transaction - installment_transaction - add_card - maintain_card_information - account_verification - split_delayed_shipment - top_up - mail_order - telephone_order - whitelist_status_check - other_payment - billing_agreement - device_binding_status_check - card_security_code_status_check - delayed_shipment - split_payment - fido_credential_deletion - fido_credential_registration - decoupled_authentication_fallback type: string x-documentation-priority: default x-enum-descriptions: - Recurring transaction. - Installment transaction. - Add card. - Maintain card information. - Account verification. - Split or delayed shipment. - Top up. - Mail order. - Telephone order. - Whitelist status check. - Other payment. - Billing agreement. - Device binding status check. - Card security code status check. - Delayed shipment. - Split payment. - FIDO credential deletion. - FIDO credential registration. - Decoupled authentication fallback. required: - indicator title: Card Authentication DeviceChannel MerchantInitiated type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: MerchantInitiateds - type: 'null' required: - category - merchant_initiated - browser title: Card Authentication DeviceChannel type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s directory_server_transaction_identifier: description: A unique identifier assigned by the Directory Server (the card network) for this transaction. type: string x-documentation-priority: default id: description: The Card Authentication identifier. type: string x-documentation-priority: default x-id-reference-to: Card Authentications merchant_acceptor_id: anyOf: - description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. type: string x-documentation-priority: default - type: 'null' merchant_category_code: anyOf: - description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with. type: string x-documentation-priority: default - type: 'null' merchant_country: anyOf: - description: The country the merchant resides in. type: string x-documentation-priority: default - type: 'null' merchant_name: anyOf: - description: The name of the merchant. type: string x-documentation-priority: default - type: 'null' message_category: additionalProperties: false description: The message category of the card authentication attempt. properties: category: description: The category of the card authentication attempt. enum: - payment_authentication - non_payment_authentication type: string x-documentation-priority: default x-enum-descriptions: - The authentication attempt is for a payment. - The authentication attempt is not for a payment. non_payment: anyOf: - additionalProperties: false description: Fields specific to non-payment authentication attempts. properties: {} title: Card Authentication MessageCategory NonPayment type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: NonPayments - type: 'null' payment: anyOf: - additionalProperties: false description: Fields specific to payment authentication attempts. properties: purchase_amount: description: The purchase amount in minor units. type: integer x-documentation-priority: default purchase_amount_cardholder_estimated: anyOf: - description: The purchase amount in the cardholder's currency (i.e., USD) estimated using daily conversion rates from the card network. type: integer x-documentation-priority: default - type: 'null' purchase_currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the authentication attempt's purchase currency. type: string x-documentation-priority: default transaction_type: anyOf: - description: The type of transaction being authenticated. enum: - goods_service_purchase - check_acceptance - account_funding - quasi_cash_transaction - prepaid_activation_and_load type: string x-documentation-priority: default x-enum-descriptions: - Purchase of goods or services. - Check acceptance. - Account funding. - Quasi-cash transaction. - Prepaid activation and load. - type: 'null' required: - purchase_amount - purchase_currency - purchase_amount_cardholder_estimated - transaction_type title: Card Authentication MessageCategory Payment type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Payments - type: 'null' required: - category - payment - non_payment title: Card Authentication MessageCategory type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s prior_authenticated_card_payment_id: anyOf: - description: The ID of a prior Card Authentication that the requestor used to authenticate this cardholder for a previous transaction. type: string x-documentation-priority: default x-id-reference-to: Card Authentications - type: 'null' real_time_decision_id: anyOf: - description: The identifier of the Real-Time Decision sent to approve or decline this authentication attempt. type: string x-documentation-priority: default x-id-reference-to: Real-Time Decisions - type: 'null' requestor_authentication_indicator: anyOf: - description: The 3DS requestor authentication indicator describes why the authentication attempt is performed, such as for a recurring transaction. enum: - payment_transaction - recurring_transaction - installment_transaction - add_card - maintain_card - emv_token_cardholder_verification - billing_agreement type: string x-documentation-priority: default x-enum-descriptions: - The authentication is for a payment transaction. - The authentication is for a recurring transaction. - The authentication is for an installment transaction. - The authentication is for adding a card. - The authentication is for maintaining a card. - The authentication is for EMV token cardholder verification. - The authentication is for a billing agreement. - type: 'null' requestor_challenge_indicator: anyOf: - description: Indicates whether a challenge is requested for this transaction. enum: - no_preference - no_challenge_requested - challenge_requested_3ds_requestor_preference - challenge_requested_mandate - no_challenge_requested_transactional_risk_analysis_already_performed - no_challenge_requested_data_share_only - no_challenge_requested_strong_consumer_authentication_already_performed - no_challenge_requested_utilize_whitelist_exemption_if_no_challenge_required - challenge_requested_whitelist_prompt_requested_if_challenge_required type: string x-documentation-priority: default x-enum-descriptions: - No preference. - No challenge requested. - Challenge requested, 3DS Requestor preference. - Challenge requested, mandate. - No challenge requested, transactional risk analysis already performed. - No challenge requested, data share only. - No challenge requested, strong consumer authentication already performed. - No challenge requested, utilize whitelist exemption if no challenge required. - Challenge requested, whitelist prompt requested if challenge required. - type: 'null' requestor_name: description: The name of the 3DS requestor. type: string x-documentation-priority: default requestor_url: description: The URL of the 3DS requestor. type: string x-documentation-priority: default shipping_address_city: anyOf: - description: The city of the shipping address associated with this purchase. type: string x-documentation-priority: default - type: 'null' shipping_address_country: anyOf: - description: The country of the shipping address associated with this purchase. type: string x-documentation-priority: default - type: 'null' shipping_address_line1: anyOf: - description: The first line of the shipping address associated with this purchase. type: string x-documentation-priority: default - type: 'null' shipping_address_line2: anyOf: - description: The second line of the shipping address associated with this purchase. type: string x-documentation-priority: default - type: 'null' shipping_address_line3: anyOf: - description: The third line of the shipping address associated with this purchase. type: string x-documentation-priority: default - type: 'null' shipping_address_postal_code: anyOf: - description: The postal code of the shipping address associated with this purchase. type: string x-documentation-priority: default - type: 'null' shipping_address_state: anyOf: - description: The US state of the shipping address associated with this purchase. type: string x-documentation-priority: default - type: 'null' status: description: The status of the card authentication. enum: - denied - authenticated_with_challenge - authenticated_without_challenge - awaiting_challenge - validating_challenge - canceled - timed_out_awaiting_challenge - errored - exceeded_attempt_threshold type: string x-documentation-priority: default x-enum-descriptions: - The authentication attempt was denied. - The authentication attempt was authenticated with a challenge. - The authentication attempt was authenticated without a challenge. - The authentication attempt is awaiting a challenge. - The authentication attempt is validating a challenge. - The authentication attempt was canceled. - The authentication attempt timed out while awaiting a challenge. - The authentication attempt errored. - The authentication attempt exceeded the attempt threshold. three_d_secure_server_transaction_identifier: description: A unique identifier assigned by the 3DS Server initiating the authentication attempt for this transaction. type: string x-documentation-priority: default type: description: A constant representing the object's type. For this resource it will always be `card_authentication`. enum: - card_authentication type: string x-documentation-priority: default required: - type - id - created_at - card_payment_id - card_id - prior_authenticated_card_payment_id - message_category - access_control_server_transaction_identifier - three_d_secure_server_transaction_identifier - directory_server_transaction_identifier - device_channel - cardholder_name - cardholder_email - requestor_authentication_indicator - requestor_challenge_indicator - requestor_name - requestor_url - merchant_category_code - merchant_acceptor_id - merchant_name - merchant_country - billing_address_line1 - billing_address_line2 - billing_address_line3 - billing_address_city - billing_address_state - billing_address_postal_code - billing_address_country - shipping_address_line1 - shipping_address_line2 - shipping_address_line3 - shipping_address_city - shipping_address_state - shipping_address_postal_code - shipping_address_country - status - deny_reason - real_time_decision_id - challenge title: Card Authentication type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Authentications 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 card_authorization: additionalProperties: true description: Card Authorizations 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 expires_at: '2020-01-31T23:59:59Z' id: card_authorization_6iqxap6ivd0fo5eu3i8x 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 pending_transaction_id: null 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 type: card_authorization verification: card_verification_code: result: match cardholder_address: actual_line1: 33 Liberty Street actual_postal_code: '94131' provided_line1: 33 Liberty Street provided_postal_code: '94132' result: postal_code_no_match_address_match cardholder_name: null properties: actioner: description: Whether this authorization was approved by Increase, the card network through stand-in processing, or the user through a real-time decision. enum: - user - increase - network type: string x-documentation-priority: default x-enum-descriptions: - This object was actioned by the user through a real-time decision. - This object was actioned by Increase without user intervention. - This object was actioned by the network, through stand-in processing. additional_amounts: additionalProperties: false description: Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction. properties: clinic: anyOf: - additionalProperties: false description: The part of this transaction amount that was for clinic-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Authorization 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 Authorization 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 Authorization 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 Authorization 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 Authorization 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 Authorization 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 Authorization 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 Authorization 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 Authorization 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 Authorization 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 Authorization 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. expires_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) when this authorization will expire and the pending transaction will be released. format: date-time type: string x-documentation-priority: default id: description: The Card Authorization identifier. type: string x-documentation-priority: default x-id-reference-to: Card Authorizations 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 Authorization 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 Authorization 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 Authorization 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 Authorization 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' 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' 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 authorization, such as whether it was used for bill payments or an automatic fuel dispenser. enum: - account_funding - automatic_fuel_dispenser - bill_payment - original_credit - purchase - quasi_cash - refund - cash_disbursement - balance_inquiry - unknown type: string x-documentation-priority: default x-enum-descriptions: - Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts. - Automatic fuel dispenser authorizations occur when a card is used at a gas pump, prior to the actual transaction amount being known. They are followed by an advice message that updates the amount of the pending transaction. - A transaction used to pay a bill. - Original credit transactions are used to send money to a cardholder. - A regular purchase. - Quasi-cash transactions represent purchases of items which may be convertible to cash. - A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. - Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale. - A balance inquiry transaction is used to check the balance of an account associated with a card. - The processing category is unknown. real_time_decision_id: anyOf: - description: The identifier of the Real-Time Decision sent to approve or decline this transaction. type: string x-documentation-priority: default x-id-reference-to: Real-Time Decisions - type: 'null' scheme_fees: description: The scheme fees associated with this card authorization. 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 Authorization 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' type: description: A constant representing the object's type. For this resource it will always be `card_authorization`. enum: - card_authorization 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 Authorization 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 Authorization 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 Authorization 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 Authorization 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 - expires_at - real_time_decision_id - pending_transaction_id - scheme_fees title: Card Authorization type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Authorizations sandbox_create_an_interest_payment_parameters: additionalProperties: false example: account_id: account_in71c4amph0vgo2qllky amount: 1000 properties: account_id: description: The identifier of the Account the Interest Payment should be paid to is for. type: string x-documentation-priority: default x-id-reference-to: Accounts accrued_on_account_id: description: The identifier of the Account the Interest accrued on. Defaults to `account_id`. type: string x-documentation-priority: default x-id-reference-to: Accounts amount: description: The interest amount in cents. Must be positive. maximum: 1000000000 minimum: 1 type: integer x-documentation-priority: default period_end: description: The end of the interest period. If not provided, defaults to the current time. format: date-time type: string x-documentation-priority: default period_start: description: The start of the interest period. If not provided, defaults to the current time. format: date-time type: string x-documentation-priority: default required: - account_id - amount type: object x-event-categories: [] x-stainless-empty-object: false card_fuel_confirmation: additionalProperties: true description: Card Fuel Confirmations update the amount of a Card Authorization after a fuel pump transaction is completed. example: card_authorization_id: card_authorization_6iqxap6ivd0fo5eu3i8x currency: USD id: card_fuel_confirmation_wuy91qate4judq2la80a network: visa network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4 scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' type: card_fuel_confirmation updated_authorization_amount: 120 properties: card_authorization_id: description: The identifier for the Card Authorization this updates. type: string x-documentation-priority: default x-id-reference-to: Card Authorizations currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) id: description: The Card Fuel Confirmation identifier. type: string x-documentation-priority: default x-id-reference-to: Card Fuel Confirmations network: description: The card network used to process this card authorization. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa - Pulse network_identifiers: additionalProperties: false description: Network-specific identifiers for a specific request or transaction. example: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' properties: authorization_identification_response: anyOf: - description: The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response. type: string x-documentation-priority: default - type: 'null' retrieval_reference_number: anyOf: - description: A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter. type: string x-documentation-priority: default - type: 'null' trace_number: anyOf: - description: A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time. type: string x-documentation-priority: default - type: 'null' transaction_id: anyOf: - description: A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests. type: string x-documentation-priority: default - type: 'null' required: - transaction_id - trace_number - retrieval_reference_number - authorization_identification_response title: Card Fuel Confirmation NetworkIdentifiers type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s pending_transaction_id: anyOf: - description: The identifier of the Pending Transaction associated with this Card Fuel Confirmation. type: string x-documentation-priority: default x-id-reference-to: Pending Transactions - type: 'null' scheme_fees: description: The scheme fees associated with this card fuel confirmation. 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 Fuel Confirmation 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 type: description: A constant representing the object's type. For this resource it will always be `card_fuel_confirmation`. enum: - card_fuel_confirmation type: string x-documentation-priority: default updated_authorization_amount: description: The updated authorization amount after this fuel confirmation, in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default required: - type - id - updated_authorization_amount - currency - card_authorization_id - network - pending_transaction_id - network_identifiers - scheme_fees title: Card Fuel Confirmation type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Fuel Confirmations sandbox_increment_a_card_authorization_parameters: additionalProperties: false example: amount: 500 card_payment_id: card_payment_nd3k2kacrqjli8482ave properties: amount: description: The amount of the increment in minor units in the card authorization's currency. maximum: 1000000000 minimum: 1 type: integer x-documentation-priority: default card_payment_id: description: The identifier of the Card Payment to create an increment on. type: string x-documentation-priority: default x-id-reference-to: Card Payments event_subscription_id: description: The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes. type: string x-documentation-priority: default x-id-reference-to: Event Subscriptions required: - card_payment_id - amount type: object x-event-categories: [] x-stainless-empty-object: false card_dispute_visa: additionalProperties: false properties: network_events: description: The network events for the Card Dispute. items: $ref: '#/components/schemas/card_dispute_visa_network_event' type: array x-documentation-priority: default required_user_submission_category: anyOf: - description: The category of the currently required user submission if the user wishes to proceed with the dispute. Present if and only if status is `user_submission_required`. Otherwise, this will be `nil`. enum: - chargeback - merchant_prearbitration_decline - user_prearbitration type: string x-documentation-priority: default x-enum-descriptions: - A Chargeback User Submission is required. - A Merchant Pre Arbitration Decline User Submission is required. - A User Initiated Pre Arbitration User Submission is required. - type: 'null' user_submissions: description: The user submissions for the Card Dispute. items: $ref: '#/components/schemas/card_dispute_visa_user_submission' type: array x-documentation-priority: default required: - network_events - required_user_submission_category - user_submissions title: Card Dispute Visa-specific details type: object x-event-categories: - card_dispute.created - card_dispute.updated x-stainless-empty-object: false x-title-plural: Card Dispute Visa-specific details inbound_mail_item: additionalProperties: true description: Inbound Mail Items represent pieces of physical mail delivered to a Lockbox Address. example: checks: - amount: 1750 back_file_id: file_makxrc67oh9l6sg7w9yc check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1 front_file_id: file_makxrc67oh9l6sg7w9yc status: deposited - amount: 1750 back_file_id: file_makxrc67oh9l6sg7w9yc check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1 front_file_id: file_makxrc67oh9l6sg7w9yc status: deposited created_at: '2020-01-31T23:59:59Z' file_id: file_makxrc67oh9l6sg7w9yc id: inbound_mail_item_q6rrg7mmqpplx80zceev lockbox_address_id: lockbox_address_lw6sbzl9ol5dfd8hdml6 lockbox_recipient_id: lockbox_3xt21ok13q19advds4t5 recipient_name: Ian Crease rejection_reason: null status: processed type: inbound_mail_item properties: checks: description: The checks in the mail item. items: $ref: '#/components/schemas/inbound_mail_item_check' type: array x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Inbound Mail Item was created. format: date-time type: string x-documentation-priority: default file_id: description: The identifier for the File containing the scanned contents of the mail item. type: string x-documentation-priority: default x-id-reference-to: Files id: description: The Inbound Mail Item identifier. type: string x-documentation-priority: default x-id-reference-to: Inbound Mail Items lockbox_address_id: description: The identifier for the Lockbox Address that received this mail item. type: string x-documentation-priority: default x-id-reference-to: Lockbox Addresses lockbox_recipient_id: anyOf: - description: The identifier for the Lockbox Recipient that received this mail item. For mail items that could not be routed to a Lockbox Recipient, this will be null. type: string x-documentation-priority: default x-id-reference-to: Lockbox Recipients - type: 'null' recipient_name: anyOf: - description: The recipient name as written on the mail item. type: string x-documentation-priority: default - type: 'null' rejection_reason: anyOf: - description: If the mail item has been rejected, why it was rejected. enum: - no_matching_lockbox - no_check - lockbox_not_active - lockbox_address_not_active - lockbox_recipient_not_active type: string x-documentation-priority: default x-enum-descriptions: - The mail item does not match any lockbox. - The mail item does not contain a check. - The Lockbox or its associated Account is not active. - The Lockbox Address is not active. - The Lockbox Recipient or its associated Account is not active. - type: 'null' status: description: If the mail item has been processed. enum: - pending - processed - rejected type: string x-documentation-priority: default x-enum-descriptions: - The mail item is pending processing. - The mail item has been processed. - The mail item has been rejected. type: description: A constant representing the object's type. For this resource it will always be `inbound_mail_item`. enum: - inbound_mail_item type: string x-documentation-priority: default required: - type - id - created_at - recipient_name - status - rejection_reason - file_id - lockbox_recipient_id - lockbox_address_id - checks title: Inbound Mail Item type: object x-event-categories: - inbound_mail_item.created - inbound_mail_item.updated x-stainless-empty-object: false x-tag: Inbound Mail Items x-title-plural: Inbound Mail Items card_reversal: additionalProperties: true description: Card Reversals cancel parts of or the entirety of an existing Card Authorization. example: card_authorization_id: card_authorization_6iqxap6ivd0fo5eu3i8x currency: USD id: card_reversal_8vr9qy60cgf5d0slpb68 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: visa network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4 presentment_currency: USD reversal_amount: 20 reversal_presentment_amount: 20 reversal_reason: reversed_by_customer 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 type: card_reversal updated_authorization_amount: 80 updated_authorization_presentment_amount: 80 properties: card_authorization_id: description: The identifier for the Card Authorization this reverses. type: string x-documentation-priority: default x-id-reference-to: Card Authorizations currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) id: description: The Card Reversal identifier. type: string x-documentation-priority: default x-id-reference-to: Card Reversals 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: anyOf: - description: The country the merchant resides in. type: string x-documentation-priority: default - type: 'null' 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: description: The card network used to process this card authorization. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa - Pulse network_identifiers: additionalProperties: false description: Network-specific identifiers for a specific request or transaction. example: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' properties: authorization_identification_response: anyOf: - description: The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response. type: string x-documentation-priority: default - type: 'null' retrieval_reference_number: anyOf: - description: A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter. type: string x-documentation-priority: default - type: 'null' trace_number: anyOf: - description: A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time. type: string x-documentation-priority: default - type: 'null' transaction_id: anyOf: - description: A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests. type: string x-documentation-priority: default - type: 'null' required: - transaction_id - trace_number - retrieval_reference_number - authorization_identification_response title: Card Reversal NetworkIdentifiers type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s pending_transaction_id: anyOf: - description: The identifier of the Pending Transaction associated with this Card Reversal. type: string x-documentation-priority: default x-id-reference-to: Pending Transactions - type: 'null' presentment_currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's presentment currency. type: string x-documentation-priority: default reversal_amount: description: The amount of this reversal in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default reversal_presentment_amount: description: The amount of this reversal in the minor unit of the transaction's presentment currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default reversal_reason: anyOf: - description: Why this reversal was initiated. enum: - reversed_by_customer - reversed_by_network_or_acquirer - reversed_by_point_of_sale - partial_reversal type: string x-documentation-priority: default x-enum-descriptions: - The Card Reversal was initiated at the customer's request. - The Card Reversal was initiated by the network or acquirer. - The Card Reversal was initiated by the point of sale device. - The Card Reversal was a partial reversal, for any reason. - type: 'null' scheme_fees: description: The scheme fees associated with this card reversal. 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 Reversal 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' type: description: A constant representing the object's type. For this resource it will always be `card_reversal`. enum: - card_reversal type: string x-documentation-priority: default updated_authorization_amount: description: The amount left pending on the Card Authorization in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default updated_authorization_presentment_amount: description: The amount left pending on the Card Authorization in the minor unit of the transaction's presentment currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default required: - type - id - reversal_amount - reversal_presentment_amount - updated_authorization_amount - updated_authorization_presentment_amount - currency - presentment_currency - card_authorization_id - network - pending_transaction_id - network_identifiers - reversal_reason - merchant_acceptor_id - merchant_descriptor - merchant_category_code - merchant_city - merchant_state - merchant_postal_code - merchant_country - terminal_id - scheme_fees title: Card Reversal type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Reversals wire_drawdown_request: additionalProperties: true description: Wire drawdown requests enable you to request that someone else send you a wire. Because there is nuance to making sure your counterparty's bank processes these correctly, we ask that you reach out to [support@increase.com](mailto:support@increase.com) to enable this feature so we can help you plan your integration. For more information, see our [Wire Drawdown Requests documentation](/documentation/wire-drawdown-requests). example: account_number_id: account_number_v18nkfqm6afpsrvy82b2 amount: 10000 created_at: '2020-01-31T23:59:59Z' creditor_address: city: New York country: US line1: 33 Liberty Street line2: null postal_code: '10045' state: NY creditor_name: Ian Crease currency: USD debtor_account_number: '987654321' debtor_address: city: New York country: US line1: 33 Liberty Street line2: null postal_code: '10045' state: NY debtor_external_account_id: null debtor_name: Ian Crease debtor_routing_number: '101050001' fulfillment_inbound_wire_transfer_id: inbound_wire_transfer_f228m6bmhtcxjco9pwp0 id: wire_drawdown_request_q6lmocus3glo0lr2bfv3 idempotency_key: null status: fulfilled submission: input_message_accountability_data: 20220118MMQFMP0P000003 type: wire_drawdown_request unstructured_remittance_information: Invoice 29582 properties: account_number_id: description: The Account Number to which the debtor—the recipient of this request—is being requested to send funds. type: string x-documentation-priority: default x-id-reference-to: Account Numbers amount: description: The amount being requested in 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 wire drawdown request was created. format: date-time type: string x-documentation-priority: default creditor_address: additionalProperties: false description: The creditor's address. properties: city: description: The city, district, town, or village of the address. type: string x-documentation-priority: default country: description: The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country of the address. type: string x-documentation-priority: default line1: description: The first line of the address. type: string x-documentation-priority: default line2: anyOf: - description: The second line of the address. type: string x-documentation-priority: default - type: 'null' postal_code: anyOf: - description: The ZIP code of the address. type: string x-documentation-priority: default - type: 'null' state: anyOf: - description: The address state. type: string x-documentation-priority: default - type: 'null' required: - line1 - line2 - city - state - postal_code - country title: Wire Drawdown Request Address type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Addresses creditor_name: description: The creditor's name. type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being requested. Will always be "USD". type: string x-documentation-priority: default debtor_account_number: description: The debtor's account number. type: string x-documentation-priority: default debtor_address: additionalProperties: false description: The debtor's address. properties: city: description: The city, district, town, or village of the address. type: string x-documentation-priority: default country: description: The two-letter [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2) code for the country of the address. type: string x-documentation-priority: default line1: description: The first line of the address. type: string x-documentation-priority: default line2: anyOf: - description: The second line of the address. type: string x-documentation-priority: default - type: 'null' postal_code: anyOf: - description: The ZIP code of the address. type: string x-documentation-priority: default - type: 'null' state: anyOf: - description: The address state. type: string x-documentation-priority: default - type: 'null' required: - line1 - line2 - city - state - postal_code - country title: Wire Drawdown Request Address type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Addresses debtor_external_account_id: anyOf: - description: The debtor's external account identifier. type: string x-documentation-priority: default x-id-reference-to: External Accounts - type: 'null' debtor_name: description: The debtor's name. type: string x-documentation-priority: default debtor_routing_number: description: The debtor's routing number. type: string x-documentation-priority: default fulfillment_inbound_wire_transfer_id: anyOf: - description: If the recipient fulfills the drawdown request by sending funds, then this will be the identifier of the corresponding Transaction. type: string x-documentation-priority: default x-id-reference-to: Inbound Wire Transfers - type: 'null' id: description: The Wire drawdown request identifier. type: string x-documentation-priority: default x-id-reference-to: Wire Drawdown Requests idempotency_key: anyOf: - description: The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys). type: string x-documentation-priority: default - type: 'null' status: description: The lifecycle status of the drawdown request. enum: - pending_submission - fulfilled - pending_response - refused type: string x-documentation-priority: default x-enum-descriptions: - The drawdown request is queued to be submitted to Fedwire. - The drawdown request has been fulfilled by the recipient. - The drawdown request has been sent and the recipient should respond in some way. - The drawdown request has been refused by the recipient. submission: anyOf: - additionalProperties: false description: After the drawdown request is submitted to Fedwire, this will contain supplemental details. example: input_message_accountability_data: 20220118MMQFMP0P000003 properties: input_message_accountability_data: description: The input message accountability data (IMAD) uniquely identifying the submission with Fedwire. type: string x-documentation-priority: default required: - input_message_accountability_data title: Wire Drawdown Request Wire Drawdown Request Submission type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Wire Drawdown Request Submissions - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `wire_drawdown_request`. enum: - wire_drawdown_request type: string x-documentation-priority: default unstructured_remittance_information: description: Remittance information the debtor will see as part of the drawdown request. type: string x-documentation-priority: default required: - type - id - created_at - account_number_id - debtor_account_number - debtor_routing_number - debtor_external_account_id - amount - currency - unstructured_remittance_information - debtor_name - debtor_address - creditor_name - creditor_address - submission - fulfillment_inbound_wire_transfer_id - status - idempotency_key title: Wire Drawdown Request type: object x-event-categories: - wire_drawdown_request.created - wire_drawdown_request.updated x-stainless-empty-object: false x-tag: Wire Drawdown Requests x-title-plural: Wire Drawdown Requests sandbox_return_an_ach_transfer_parameters: additionalProperties: false example: {} properties: reason: description: The reason why the Federal Reserve or destination bank returned this transfer. Defaults to `no_account`. 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. type: object x-event-categories: [] x-stainless-empty-object: false inbound_mail_item_check: additionalProperties: false description: Inbound Mail Item Checks represent the checks in an Inbound Mail Item. example: amount: 1750 back_file_id: file_makxrc67oh9l6sg7w9yc check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1 front_file_id: file_makxrc67oh9l6sg7w9yc status: deposited properties: amount: description: The amount of the check. type: integer x-documentation-priority: default back_file_id: anyOf: - description: The identifier for the File containing the back of the check. type: string x-documentation-priority: default x-id-reference-to: Files - type: 'null' check_deposit_id: anyOf: - description: The identifier of the Check Deposit if this check was deposited. type: string x-documentation-priority: default x-id-reference-to: Check Deposits - type: 'null' front_file_id: anyOf: - description: The identifier for the File containing the front of the check. type: string x-documentation-priority: default x-id-reference-to: Files - type: 'null' status: anyOf: - description: The status of the Inbound Mail Item Check. enum: - pending - deposited - ignored type: string x-documentation-priority: default x-enum-descriptions: - The check is pending processing. - The check has been deposited. - The check has been ignored. - type: 'null' required: - amount - status - front_file_id - back_file_id - check_deposit_id title: Inbound Mail Item Check type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound Mail Item Checks 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 sandbox_simulate_validation_of_an_entity_parameters: additionalProperties: false example: issues: - category: entity_tax_identifier properties: issues: description: The validation issues to attach. If no issues are provided, the validation status will be set to `valid`. items: additionalProperties: false properties: category: description: The type of issue. enum: - entity_tax_identifier - entity_address - beneficial_owner_identity - beneficial_owner_address type: string x-documentation-priority: default x-enum-descriptions: - The entity's tax identifier could not be validated. Update the tax ID with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.legal_identifier). - The entity's address could not be validated. Update the address with the [update an entity API](/documentation/api/entities#update-an-entity.corporation.address). - A beneficial owner's identity could not be verified. Update the identification with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner). - A beneficial owner's address could not be validated. Update the address with the [update a beneficial owner API](/documentation/api/beneficial-owners#update-a-beneficial-owner). required: - category type: object x-event-categories: [] x-stainless-empty-object: false type: array x-documentation-priority: default required: - issues type: object x-event-categories: [] x-stainless-empty-object: false inbound_wire_drawdown_request: additionalProperties: true description: Inbound wire drawdown requests are requests from someone else to send them a wire. For more information, see our [Wire Drawdown Requests documentation](/documentation/wire-drawdown-requests). example: amount: 10000 created_at: '2020-01-31T23:59:59Z' creditor_account_number: '987654321' creditor_address_line1: 33 Liberty Street creditor_address_line2: New York, NY, 10045 creditor_address_line3: null creditor_name: Ian Crease creditor_routing_number: '101050001' currency: USD debtor_address_line1: 33 Liberty Street debtor_address_line2: New York, NY, 10045 debtor_address_line3: null debtor_name: Ian Crease end_to_end_identification: Invoice 29582 id: inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e input_message_accountability_data: null instruction_identification: null recipient_account_number_id: account_number_v18nkfqm6afpsrvy82b2 type: inbound_wire_drawdown_request unique_end_to_end_transaction_reference: null unstructured_remittance_information: null properties: amount: description: The amount being requested in 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 inbound wire drawdown request was created. format: date-time type: string x-documentation-priority: default creditor_account_number: description: The creditor's account number. type: string 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' creditor_routing_number: description: The creditor's routing number. type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the amount being requested. Will always be "USD". type: string x-documentation-priority: default 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' end_to_end_identification: anyOf: - description: A free-form reference string set by the sender, to help identify the drawdown request. type: string x-documentation-priority: default - type: 'null' id: description: The Wire drawdown request identifier. type: string x-documentation-priority: default x-id-reference-to: Inbound Wire Drawdown Requests 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' instruction_identification: anyOf: - description: The sending bank's identifier for the drawdown request. type: string x-documentation-priority: default - type: 'null' recipient_account_number_id: description: The Account Number from which the recipient of this request is being requested to send funds. type: string x-documentation-priority: default x-id-reference-to: Account Numbers type: description: A constant representing the object's type. For this resource it will always be `inbound_wire_drawdown_request`. enum: - inbound_wire_drawdown_request type: string x-documentation-priority: default 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 drawdown request. 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: - type - id - created_at - recipient_account_number_id - amount - currency - input_message_accountability_data - unique_end_to_end_transaction_reference - instruction_identification - end_to_end_identification - creditor_name - creditor_routing_number - creditor_account_number - creditor_address_line1 - creditor_address_line2 - creditor_address_line3 - debtor_name - debtor_address_line1 - debtor_address_line2 - debtor_address_line3 - unstructured_remittance_information title: Inbound Wire Drawdown Request type: object x-event-categories: - inbound_wire_drawdown_request.created x-stainless-empty-object: false x-tag: Inbound Wire Drawdown Requests x-title-plural: Inbound Wire Drawdown Requests declined_transaction: additionalProperties: true description: Declined Transactions are refused additions and removals of money from your bank account. For example, Declined Transactions are caused when your Account has an insufficient balance or your Limits are triggered. example: account_id: account_in71c4amph0vgo2qllky amount: 1750 created_at: '2020-01-31T23:59:59Z' currency: USD description: INVOICE 2468 id: declined_transaction_17jbn0yyhvkt4v4ooym8 route_id: account_number_v18nkfqm6afpsrvy82b2 route_type: account_number source: ach_decline: amount: 1750 id: ach_decline_72v1mcwxudctq56efipa inbound_ach_transfer_id: inbound_ach_transfer_tdrwqr3fq9gnnq49odev originator_company_descriptive_date: null originator_company_discretionary_data: null originator_company_id: 0987654321 originator_company_name: BIG BANK reason: insufficient_funds receiver_id_number: '12345678900' receiver_name: IAN CREASE trace_number: 021000038461022 type: ach_decline category: ach_decline type: declined_transaction properties: account_id: description: The identifier for the Account the Declined Transaction belongs to. type: string x-documentation-priority: default x-id-reference-to: Accounts amount: description: The Declined Transaction amount in the minor unit of its currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date on which the Transaction occurred. format: date-time type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Declined Transaction's currency. This will match the currency on the Declined Transaction's Account. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) description: description: This is the description the vendor provides. type: string x-documentation-priority: default id: description: The Declined Transaction identifier. type: string x-documentation-priority: default x-id-reference-to: Declined Transactions route_id: anyOf: - description: The identifier for the route this Declined Transaction came through. Routes are things like cards and ACH details. type: string x-documentation-priority: default - type: 'null' route_type: anyOf: - description: The type of the route this Declined Transaction came through. enum: - account_number - card - lockbox type: string x-documentation-priority: default x-enum-descriptions: - An Account Number. - A Card. - A Lockbox. - type: 'null' source: additionalProperties: true description: This is an object giving more details on the network-level event that caused the Declined Transaction. For example, for a card transaction this lists the merchant's industry and location. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future. example: ach_decline: amount: 1750 id: ach_decline_72v1mcwxudctq56efipa inbound_ach_transfer_id: inbound_ach_transfer_tdrwqr3fq9gnnq49odev originator_company_descriptive_date: null originator_company_discretionary_data: null originator_company_id: 0987654321 originator_company_name: BIG BANK reason: insufficient_funds receiver_id_number: '12345678900' receiver_name: IAN CREASE trace_number: 021000038461022 type: ach_decline category: ach_decline properties: ach_decline: anyOf: - $ref: '#/components/schemas/ach_decline' description: An ACH Decline object. This field will be present in the JSON response if and only if `category` is equal to `ach_decline`. x-documentation-priority: default - type: 'null' card_decline: anyOf: - additionalProperties: true description: A Card Decline object. This field will be present in the JSON response if and only if `category` is equal to `card_decline`. example: actioner: increase additional_amounts: clinic: null dental: null original: null prescription: null surcharge: amount: 10 currency: USD total_cumulative: null total_healthcare: null transit: null unknown: null vision: null amount: -1000 card_payment_id: card_payment_nd3k2kacrqjli8482ave currency: USD declined_transaction_id: declined_transaction_17jbn0yyhvkt4v4ooym8 digital_wallet_token_id: null direction: settlement id: card_decline_bx3o8zd7glq8yvtwg25v incremented_card_authorization_id: null merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_descriptor: AMAZON.COM merchant_postal_code: '10045' merchant_state: null network_details: category: visa pulse: null visa: electronic_commerce_indicator: secure_electronic_commerce point_of_service_entry_mode: manual stand_in_processing_reason: null terminal_entry_capability: magnetic_stripe network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' network_risk_score: 10 physical_card_id: null presentment_amount: -1000 presentment_currency: USD processing_category: purchase real_time_decision_id: null real_time_decision_reason: null reason: insufficient_funds scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' terminal_id: RCN5VNXS verification: card_verification_code: result: match cardholder_address: actual_line1: 33 Liberty Street actual_postal_code: '94131' provided_line1: 33 Liberty Street provided_postal_code: '94132' result: postal_code_no_match_address_match cardholder_name: null properties: actioner: description: Whether this authorization was approved by Increase, the card network through stand-in processing, or the user through a real-time decision. enum: - user - increase - network type: string x-documentation-priority: default x-enum-descriptions: - This object was actioned by the user through a real-time decision. - This object was actioned by Increase without user intervention. - This object was actioned by the network, through stand-in processing. additional_amounts: additionalProperties: false description: Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction. properties: clinic: anyOf: - additionalProperties: false description: The part of this transaction amount that was for clinic-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' dental: anyOf: - additionalProperties: false description: The part of this transaction amount that was for dental-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' original: anyOf: - additionalProperties: false description: The original pre-authorized amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' prescription: anyOf: - additionalProperties: false description: The part of this transaction amount that was for healthcare prescriptions. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' surcharge: anyOf: - additionalProperties: false description: The surcharge amount charged for this transaction by the merchant. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_cumulative: anyOf: - additionalProperties: false description: The total amount of a series of incremental authorizations, optionally provided. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_healthcare: anyOf: - additionalProperties: false description: The total amount of healthcare-related additional amounts. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' transit: anyOf: - additionalProperties: false description: The part of this transaction amount that was for transit-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' unknown: anyOf: - additionalProperties: false description: An unknown additional amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' vision: anyOf: - additionalProperties: false description: The part of this transaction amount that was for vision-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' required: - total_healthcare - total_cumulative - surcharge - transit - vision - clinic - dental - prescription - original - unknown title: Declined Transaction Declined Transaction Source Card Decline AdditionalAmounts type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s amount: description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default card_payment_id: description: The ID of the Card Payment this transaction belongs to. type: string x-documentation-priority: default x-id-reference-to: Card Payments currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the destination account currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) declined_transaction_id: description: The identifier of the declined transaction created for this Card Decline. type: string x-documentation-priority: default x-id-reference-to: Declined Transactions digital_wallet_token_id: anyOf: - description: If the authorization was made via a Digital Wallet Token (such as an Apple Pay purchase), the identifier of the token that was used. type: string x-documentation-priority: default x-id-reference-to: Digital Wallet Tokens - type: 'null' direction: description: The direction describes the direction the funds will move, either from the cardholder to the merchant or from the merchant to the cardholder. enum: - settlement - refund type: string x-documentation-priority: default x-enum-descriptions: - A regular card authorization where funds are debited from the cardholder. - A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. id: description: The Card Decline identifier. type: string x-documentation-priority: default x-id-reference-to: Card Declines incremented_card_authorization_id: anyOf: - description: The identifier of the card authorization this request attempted to incrementally authorize. type: string x-documentation-priority: default x-id-reference-to: Card Authorizations - type: 'null' merchant_acceptor_id: description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_category_code: description: The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_city: anyOf: - description: The city the merchant resides in. type: string x-documentation-priority: default - type: 'null' merchant_country: description: The country the merchant resides in. type: string x-documentation-priority: default merchant_descriptor: description: The merchant descriptor of the merchant the card is transacting with. type: string x-documentation-priority: default merchant_postal_code: anyOf: - description: The merchant's postal code. For US merchants this is either a 5-digit or 9-digit ZIP code, where the first 5 and last 4 are separated by a dash. type: string x-documentation-priority: default - type: 'null' merchant_state: anyOf: - description: The state the merchant resides in. type: string x-documentation-priority: default - type: 'null' network_details: additionalProperties: false description: Fields specific to the `network`. properties: category: description: The payment network used to process this card authorization. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa - Pulse pulse: anyOf: - additionalProperties: false description: Fields specific to the `pulse` network. properties: {} title: Declined Transaction Declined Transaction Source Card Decline NetworkDetails Pulse type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Pulses - type: 'null' visa: anyOf: - additionalProperties: false description: Fields specific to the `visa` network. properties: electronic_commerce_indicator: anyOf: - description: For electronic commerce transactions, this identifies the level of security used in obtaining the customer's payment credential. For mail or telephone order transactions, identifies the type of mail or telephone order. enum: - mail_phone_order - recurring - installment - unknown_mail_phone_order - secure_electronic_commerce - non_authenticated_security_transaction_at_3ds_capable_merchant - non_authenticated_security_transaction - non_secure_transaction type: string x-documentation-priority: default x-enum-descriptions: - 'Single transaction of a mail/phone order: Use to indicate that the transaction is a mail/phone order purchase, not a recurring transaction or installment payment. For domestic transactions in the US region, this value may also indicate one bill payment transaction in the card-present or card-absent environments.' - 'Recurring transaction: Payment indicator used to indicate a recurring transaction that originates from an acquirer in the US region.' - 'Installment payment: Payment indicator used to indicate one purchase of goods or services that is billed to the account in multiple charges over a period of time agreed upon by the cardholder and merchant from transactions that originate from an acquirer in the US region.' - 'Unknown classification: other mail order: Use to indicate that the type of mail/telephone order is unknown.' - 'Secure electronic commerce transaction: Use to indicate that the electronic commerce transaction has been authenticated using e.g., 3-D Secure' - 'Non-authenticated security transaction at a 3-D Secure-capable merchant, and merchant attempted to authenticate the cardholder using 3-D Secure: Use to identify an electronic commerce transaction where the merchant attempted to authenticate the cardholder using 3-D Secure, but was unable to complete the authentication because the issuer or cardholder does not participate in the 3-D Secure program.' - 'Non-authenticated security transaction: Use to identify an electronic commerce transaction that uses data encryption for security however, cardholder authentication is not performed using 3-D Secure.' - 'Non-secure transaction: Use to identify an electronic commerce transaction that has no data protection.' - type: 'null' point_of_service_entry_mode: anyOf: - description: The method used to enter the cardholder's primary account number and card expiration date. enum: - unknown - manual - magnetic_stripe_no_cvv - optical_code - integrated_circuit_card - contactless - credential_on_file - magnetic_stripe - contactless_magnetic_stripe - integrated_circuit_card_no_cvv type: string x-documentation-priority: default x-enum-descriptions: - Unknown - Manual key entry - Magnetic stripe read, without card verification value - Optical code - Contact chip card - Contactless read of chip card - Transaction initiated using a credential that has previously been stored on file - Magnetic stripe read - Contactless read of magnetic stripe data - Contact chip card, without card verification value - type: 'null' stand_in_processing_reason: anyOf: - description: 'Only present when `actioner: network`. Describes why a card authorization was approved or declined by Visa through stand-in processing.' enum: - issuer_error - invalid_physical_card - invalid_cryptogram - invalid_cardholder_authentication_verification_value - internal_visa_error - merchant_transaction_advisory_service_authentication_required - payment_fraud_disruption_acquirer_block - other type: string x-documentation-priority: default x-enum-descriptions: - Increase failed to process the authorization in a timely manner. - The physical card read had an invalid CVV or dCVV. - The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase. - The 3DS cardholder authentication verification value was invalid. - An internal Visa error occurred. Visa uses this reason code for certain expected occurrences as well, such as Application Transaction Counter (ATC) replays. - The merchant has enabled Visa's Transaction Advisory Service and requires further authentication to perform the transaction. In practice this is often utilized at fuel pumps to tell the cardholder to see the cashier. - The transaction was blocked by Visa's Payment Fraud Disruption service due to fraudulent Acquirer behavior, such as card testing. - An unspecific reason for stand-in processing. - type: 'null' terminal_entry_capability: anyOf: - description: The capability of the terminal being used to read the card. Shows whether a terminal can e.g., accept chip cards or if it only supports magnetic stripe reads. This reflects the highest capability of the terminal — for example, a terminal that supports both chip and magnetic stripe will be identified as chip-capable. enum: - unknown - terminal_not_used - magnetic_stripe - barcode - optical_character_recognition - chip_or_contactless - contactless_only - no_capability type: string x-documentation-priority: default x-enum-descriptions: - Unknown - No terminal was used for this transaction. - The terminal can only read magnetic stripes and does not have chip or contactless reading capability. - The terminal can only read barcodes. - The terminal can only read cards via Optical Character Recognition. - The terminal supports contact chip cards and can also read the magnetic stripe. If contact chip is supported, this value is used regardless of whether contactless is also supported. - The terminal supports contactless reads but does not support contact chip. Only used when the terminal lacks contact chip capability. - The terminal has no card reading capability. - type: 'null' required: - electronic_commerce_indicator - point_of_service_entry_mode - stand_in_processing_reason - terminal_entry_capability title: Declined Transaction Declined Transaction Source Card Decline NetworkDetails Visa type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Visas - type: 'null' required: - category - visa - pulse title: Declined Transaction Declined Transaction Source Card Decline NetworkDetails type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s network_identifiers: additionalProperties: false description: Network-specific identifiers for a specific request or transaction. example: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' properties: authorization_identification_response: anyOf: - description: The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response. type: string x-documentation-priority: default - type: 'null' retrieval_reference_number: anyOf: - description: A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter. type: string x-documentation-priority: default - type: 'null' trace_number: anyOf: - description: A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time. type: string x-documentation-priority: default - type: 'null' transaction_id: anyOf: - description: A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests. type: string x-documentation-priority: default - type: 'null' required: - transaction_id - trace_number - retrieval_reference_number - authorization_identification_response title: Declined Transaction Declined Transaction Source Card Decline NetworkIdentifiers type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s network_risk_score: anyOf: - description: The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. For Pulse the score is from 0 to 999, where 999 is the riskiest. type: integer x-documentation-priority: default - type: 'null' physical_card_id: anyOf: - description: If the authorization was made in-person with a physical card, the Physical Card that was used. type: string x-documentation-priority: default x-id-reference-to: Physical Cards - type: 'null' presentment_amount: description: The declined amount in the minor unit of the transaction's presentment currency. type: integer x-documentation-priority: default presentment_currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency. type: string x-documentation-priority: default processing_category: description: The processing category describes the intent behind the authorization, such as whether it was used for bill payments or an automatic fuel dispenser. enum: - account_funding - automatic_fuel_dispenser - bill_payment - original_credit - purchase - quasi_cash - refund - cash_disbursement - balance_inquiry - unknown type: string x-documentation-priority: default x-enum-descriptions: - Account funding transactions are transactions used to e.g., fund an account or transfer funds between accounts. - Automatic fuel dispenser authorizations occur when a card is used at a gas pump, prior to the actual transaction amount being known. They are followed by an advice message that updates the amount of the pending transaction. - A transaction used to pay a bill. - Original credit transactions are used to send money to a cardholder. - A regular purchase. - Quasi-cash transactions represent purchases of items which may be convertible to cash. - A refund card authorization, sometimes referred to as a credit voucher authorization, where funds are credited to the cardholder. - Cash disbursement transactions are used to withdraw cash from an ATM or a point of sale. - A balance inquiry transaction is used to check the balance of an account associated with a card. - The processing category is unknown. real_time_decision_id: anyOf: - description: The identifier of the Real-Time Decision sent to approve or decline this transaction. type: string x-documentation-priority: default x-id-reference-to: Real-Time Decisions - type: 'null' real_time_decision_reason: anyOf: - description: This is present if a specific decline reason was given in the real-time decision. enum: - insufficient_funds - transaction_never_allowed - exceeds_approval_limit - card_temporarily_disabled - suspected_fraud - other type: string x-documentation-priority: default x-enum-descriptions: - The cardholder does not have sufficient funds to cover the transaction. The merchant may attempt to process the transaction again. - This type of transaction is not allowed for this card. This transaction should not be retried. - The transaction amount exceeds the cardholder's approval limit. The merchant may attempt to process the transaction again. - The card has been temporarily disabled or not yet activated. The merchant may attempt to process the transaction again. - The transaction is suspected to be fraudulent. The merchant may attempt to process the transaction again. - The transaction was declined for another reason. The merchant may attempt to process the transaction again. This should be used sparingly. - type: 'null' reason: description: Why the transaction was declined. enum: - account_closed - card_not_active - card_canceled - physical_card_not_active - entity_not_active - group_locked - insufficient_funds - cvv2_mismatch - pin_mismatch - card_expiration_mismatch - transaction_not_allowed - breaches_limit - webhook_declined - webhook_timed_out - declined_by_stand_in_processing - invalid_physical_card - missing_original_authorization - invalid_cryptogram - failed_3ds_authentication - suspected_card_testing - suspected_fraud type: string x-documentation-priority: default x-enum-descriptions: - The account has been closed. - The Card was not active. - The Card has been canceled. - The Physical Card was not active. - The account's entity was not active. - The account was inactive. - The Card's Account did not have a sufficient available balance. - The given CVV2 did not match the card's value. - The given PIN did not match the card's value. - The given expiration date did not match the card's value. Only applies when a CVV2 is present. - The attempted card transaction is not allowed per Increase's terms. - The transaction was blocked by a Limit. - Your application declined the transaction via webhook. - Your application webhook did not respond without the required timeout. - Declined by stand-in processing. - The card read had an invalid CVV or dCVV. - The original card authorization for this incremental authorization does not exist. - The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase. - The transaction was declined because the 3DS authentication failed. - The transaction was suspected to be used by a card tester to test for valid card numbers. - The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information. scheme_fees: description: The scheme fees associated with this card decline. items: additionalProperties: false example: amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' properties: amount: description: The fee amount given as a string containing a decimal number. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created. format: date-time type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) fee_type: description: The type of fee being assessed. enum: - visa_international_service_assessment_single_currency - visa_international_service_assessment_cross_currency - visa_authorization_domestic_point_of_sale - visa_authorization_international_point_of_sale - visa_authorization_canada_point_of_sale - visa_authorization_reversal_point_of_sale - visa_authorization_reversal_international_point_of_sale - visa_authorization_address_verification_service - visa_advanced_authorization - visa_message_transmission - visa_account_verification_domestic - visa_account_verification_international - visa_account_verification_canada - visa_corporate_acceptance_fee - visa_consumer_debit_acceptance_fee - visa_business_debit_acceptance_fee - visa_purchasing_acceptance_fee - visa_purchase_domestic - visa_purchase_international - visa_credit_purchase_token - visa_debit_purchase_token - visa_clearing_transmission - visa_direct_authorization - visa_direct_transaction_domestic - visa_service_commercial_credit - visa_advertising_service_commercial_credit - visa_community_growth_acceleration_program - visa_processing_guarantee_commercial_credit - pulse_switch_fee type: string x-documentation-priority: default x-enum-descriptions: - International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency. - International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes. - Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions). - Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point. - Activity, per inquiry, related to the domestic Issuer for Account Number Verification. - Activity, per inquiry, related to the international Issuer for Account Number Verification. - Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification. - The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation. - The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions. - The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - Activity and fees for the processing of a sales draft original for a purchase transaction. - Activity and fees for the processing of an international sales draft original for a purchase transaction. - Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - A per transaction fee assessed for Base II financial draft - Issuer. - Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. - Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions. - Issuer card service fee for Commercial Credit cards. - Issuer Advertising Service Fee for Commercial Credit cards. - Issuer Community Growth Acceleration Program Fee. - Issuer Processing Guarantee for Commercial Credit cards. - Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network. fixed_component: anyOf: - description: The fixed component of the fee, if applicable, given in major units of the fee amount. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' variable_rate: anyOf: - description: The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' required: - created_at - amount - currency - fee_type - variable_rate - fixed_component title: Declined Transaction Declined Transaction Source Card Decline Card Scheme Fee type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Scheme Fees type: array x-documentation-priority: default terminal_id: anyOf: - description: The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with. type: string x-documentation-priority: default - type: 'null' verification: additionalProperties: false description: Fields related to verification of cardholder-provided values. properties: card_verification_code: additionalProperties: false description: Fields related to verification of the Card Verification Code, a 3-digit code on the back of the card. properties: result: description: The result of verifying the Card Verification Code. enum: - not_checked - match - no_match type: string x-documentation-priority: default x-enum-descriptions: - No card verification code was provided in the authorization request. - The card verification code matched the one on file. - The card verification code did not match the one on file. required: - result title: Declined Transaction Declined Transaction Source Card Decline Verification CardVerificationCode type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardVerificationCodes cardholder_address: additionalProperties: false description: Cardholder address provided in the authorization request and the address on file we verified it against. properties: actual_line1: anyOf: - description: Line 1 of the address on file for the cardholder. type: string x-documentation-priority: default - type: 'null' actual_postal_code: anyOf: - description: The postal code of the address on file for the cardholder. type: string x-documentation-priority: default - type: 'null' provided_line1: anyOf: - description: The cardholder address line 1 provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_postal_code: anyOf: - description: The postal code provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' result: description: The address verification result returned to the card network. enum: - not_checked - postal_code_match_address_no_match - postal_code_no_match_address_match - match - no_match - postal_code_match_address_not_checked type: string x-documentation-priority: default x-enum-descriptions: - No address information was provided in the authorization request. - Postal code matches, but the street address does not match or was not provided. - Postal code does not match, but the street address matches or was not provided. - Postal code and street address match. - Postal code and street address do not match. - Postal code matches, but the street address was not verified. (deprecated) required: - provided_postal_code - provided_line1 - actual_postal_code - actual_line1 - result title: Declined Transaction Declined Transaction Source Card Decline Verification CardholderAddress type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardholderAddresses cardholder_name: anyOf: - additionalProperties: false description: Cardholder name provided in the authorization request. properties: provided_first_name: anyOf: - description: The first name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_last_name: anyOf: - description: The last name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' provided_middle_name: anyOf: - description: The middle name provided for verification in the authorization request. type: string x-documentation-priority: default - type: 'null' required: - provided_first_name - provided_middle_name - provided_last_name title: Declined Transaction Declined Transaction Source Card Decline Verification CardholderName type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: CardholderNames - type: 'null' required: - cardholder_address - cardholder_name - card_verification_code title: Declined Transaction Declined Transaction Source Card Decline Verification type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s required: - merchant_acceptor_id - merchant_descriptor - merchant_category_code - terminal_id - merchant_city - merchant_state - merchant_postal_code - merchant_country - digital_wallet_token_id - physical_card_id - verification - additional_amounts - network_identifiers - network_risk_score - network_details - id - card_payment_id - amount - presentment_amount - presentment_currency - currency - processing_category - reason - real_time_decision_reason - incremented_card_authorization_id - actioner - direction - real_time_decision_id - scheme_fees - declined_transaction_id title: Declined Transaction Declined Transaction Source Card Decline type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Declines - type: 'null' category: description: The type of the resource. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully. enum: - ach_decline - card_decline - check_decline - inbound_real_time_payments_transfer_decline - inbound_fednow_transfer_decline - wire_decline - check_deposit_rejection - other type: string x-documentation-priority: default x-enum-descriptions: - 'ACH Decline: details will be under the `ach_decline` object.' - 'Card Decline: details will be under the `card_decline` object.' - 'Check Decline: details will be under the `check_decline` object.' - 'Inbound Real-Time Payments Transfer Decline: details will be under the `inbound_real_time_payments_transfer_decline` object.' - 'Inbound FedNow Transfer Decline: details will be under the `inbound_fednow_transfer_decline` object.' - 'Wire Decline: details will be under the `wire_decline` object.' - 'Check Deposit Rejection: details will be under the `check_deposit_rejection` object.' - The Declined Transaction was made for an undocumented or deprecated reason. check_decline: anyOf: - additionalProperties: true description: A Check Decline object. This field will be present in the JSON response if and only if `category` is equal to `check_decline`. example: amount: -1000 auxiliary_on_us: '99999' back_image_file_id: null check_transfer_id: check_transfer_30b43acfu9vw8fyc4f5 front_image_file_id: null inbound_check_deposit_id: inbound_check_deposit_zoshvqybq0cjjm31mra reason: insufficient_funds properties: amount: description: The declined amount in USD cents. type: integer x-documentation-priority: default auxiliary_on_us: anyOf: - description: A computer-readable number printed on the MICR line of business checks, usually the check number. This is useful for positive pay checks, but can be unreliably transmitted by the bank of first deposit. type: string x-documentation-priority: default - type: 'null' back_image_file_id: anyOf: - description: The identifier of the API File object containing an image of the back of the declined check. type: string x-documentation-priority: default x-id-reference-to: Files - type: 'null' check_transfer_id: anyOf: - description: The identifier of the Check Transfer object associated with this decline. type: string x-documentation-priority: default x-id-reference-to: Check Transfers - type: 'null' front_image_file_id: anyOf: - description: The identifier of the API File object containing an image of the front of the declined check. type: string x-documentation-priority: default x-id-reference-to: Files - type: 'null' inbound_check_deposit_id: anyOf: - description: The identifier of the Inbound Check Deposit object associated with this decline. type: string x-documentation-priority: default x-id-reference-to: Inbound Check Deposits - type: 'null' reason: description: Why the check was declined. enum: - ach_route_disabled - ach_route_canceled - altered_or_fictitious - breaches_limit - endorsement_irregular - entity_not_active - group_locked - insufficient_funds - stop_payment_requested - duplicate_presentment - not_authorized - amount_mismatch - not_our_item - no_account_number_found - refer_to_image - unable_to_process - unusable_image - user_initiated type: string x-documentation-priority: default x-enum-descriptions: - The account number is disabled. - The account number is canceled. - The deposited check was altered or fictitious. - The transaction would cause a limit to be exceeded. - The check was not endorsed by the payee. - The account's entity is not active. - Your account is inactive. - Your account contains insufficient funds. - Stop payment requested for this check. - The check was a duplicate deposit. - The check was not authorized. - The amount the receiving bank is attempting to deposit does not match the amount on the check. - The check attempting to be deposited does not belong to Increase. - The account number on the check does not exist at Increase. - The check is not readable. Please refer to the image. - 'The check cannot be processed. This is rare: please contact support.' - The check image is unusable. - Your integration declined this check via the API. required: - amount - auxiliary_on_us - reason - front_image_file_id - back_image_file_id - inbound_check_deposit_id - check_transfer_id title: Declined Transaction Declined Transaction Source Check Decline type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Check Declines - type: 'null' check_deposit_rejection: anyOf: - additionalProperties: true description: A Check Deposit Rejection object. This field will be present in the JSON response if and only if `category` is equal to `check_deposit_rejection`. example: amount: 1750 check_deposit_id: check_deposit_f06n9gpg7sxn8t19lfc1 currency: USD declined_transaction_id: declined_transaction_17jbn0yyhvkt4v4ooym8 reason: incomplete_image rejected_at: '2020-01-31T23:59:59Z' properties: amount: description: The rejected amount in the minor unit of check's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default check_deposit_id: description: The identifier of the Check Deposit that was rejected. type: string x-documentation-priority: default x-id-reference-to: Check Deposits currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the check's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) declined_transaction_id: description: The identifier of the associated declined transaction. type: string x-documentation-priority: default x-id-reference-to: Declined Transactions reason: description: Why the check deposit was rejected. enum: - incomplete_image - duplicate - poor_image_quality - incorrect_amount - incorrect_recipient - not_eligible_for_mobile_deposit - missing_required_data_elements - suspected_fraud - deposit_window_expired - requested_by_user - international - unknown type: string x-documentation-priority: default x-enum-descriptions: - The check's image is incomplete. - This is a duplicate check submission. - This check has poor image quality. - The check was deposited with the incorrect amount. - The check is made out to someone other than the account holder. - This check was not eligible for mobile deposit. - This check is missing at least one required field. - This check is suspected to be fraudulent. - This check's deposit window has expired. - The check was rejected at the user's request. - The check is not a U.S. domestic check and cannot be processed. - The check was rejected for an unknown reason. rejected_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the check deposit was rejected. format: date-time type: string x-documentation-priority: default required: - check_deposit_id - declined_transaction_id - amount - currency - reason - rejected_at title: Declined Transaction Declined Transaction Source Check Deposit Rejection type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Check Deposit Rejections - type: 'null' inbound_fednow_transfer_decline: anyOf: - additionalProperties: true description: An Inbound FedNow Transfer Decline object. This field will be present in the JSON response if and only if `category` is equal to `inbound_fednow_transfer_decline`. example: reason: account_number_disabled transfer_id: inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20 properties: reason: description: Why the transfer was declined. enum: - account_number_canceled - account_number_disabled - account_restricted - group_locked - entity_not_active - fednow_not_enabled type: string x-documentation-priority: default x-enum-descriptions: - The account number is canceled. - The account number is disabled. - Your account is restricted. - Your account is inactive. - The account's entity is not active. - Your account is not enabled to receive FedNow transfers. transfer_id: description: The identifier of the FedNow Transfer that led to this declined transaction. type: string x-documentation-priority: default x-id-reference-to: Inbound FedNow Transfers required: - reason - transfer_id title: Declined Transaction Declined Transaction Source Inbound FedNow Transfer Decline type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound FedNow Transfer Declines - type: 'null' inbound_real_time_payments_transfer_decline: anyOf: - additionalProperties: true description: An Inbound Real-Time Payments Transfer Decline object. This field will be present in the JSON response if and only if `category` is equal to `inbound_real_time_payments_transfer_decline`. example: amount: 100 creditor_name: Ian Crease currency: USD debtor_account_number: '987654321' debtor_name: National Phonograph Company debtor_routing_number: '101050001' reason: account_number_disabled transaction_identification: 20220501234567891T1BSLZO01745013025 transfer_id: inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr unstructured_remittance_information: Invoice 29582 properties: amount: description: The declined amount in the minor unit of the destination account currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default creditor_name: description: The name the sender of the transfer specified as the recipient of the transfer. type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code of the declined transfer's currency. This will always be "USD" for a Real-Time Payments transfer. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) debtor_account_number: description: The account number of the account that sent the transfer. type: string x-documentation-priority: default debtor_name: description: The name provided by the sender of the transfer. type: string x-documentation-priority: default debtor_routing_number: description: The routing number of the account that sent the transfer. type: string x-documentation-priority: default reason: description: Why the transfer was declined. enum: - account_number_canceled - account_number_disabled - account_restricted - group_locked - entity_not_active - real_time_payments_not_enabled type: string x-documentation-priority: default x-enum-descriptions: - The account number is canceled. - The account number is disabled. - Your account is restricted. - Your account is inactive. - The account's entity is not active. - Your account is not enabled to receive Real-Time Payments transfers. transaction_identification: description: The Real-Time Payments network identification of the declined transfer. type: string x-documentation-priority: default transfer_id: description: The identifier of the Real-Time Payments Transfer that led to this Transaction. type: string x-documentation-priority: default x-id-reference-to: Inbound Real-Time Payments Transfers unstructured_remittance_information: anyOf: - description: Additional information included with the transfer. type: string x-documentation-priority: default - type: 'null' required: - amount - currency - reason - creditor_name - debtor_name - debtor_account_number - debtor_routing_number - transaction_identification - unstructured_remittance_information - transfer_id title: Declined Transaction Declined Transaction Source Inbound Real-Time Payments Transfer Decline type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound Real-Time Payments Transfer Declines - type: 'null' other: anyOf: - additionalProperties: false description: If the category of this Transaction source is equal to `other`, this field will contain an empty object, otherwise it will contain null. properties: {} title: Declined Transaction Declined Transaction Source Other type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true x-title-plural: Others - type: 'null' wire_decline: anyOf: - additionalProperties: true description: A Wire Decline object. This field will be present in the JSON response if and only if `category` is equal to `wire_decline`. example: inbound_wire_transfer_id: inbound_wire_transfer_f228m6bmhtcxjco9pwp0 reason: account_number_disabled properties: inbound_wire_transfer_id: description: The identifier of the Inbound Wire Transfer that was declined. type: string x-documentation-priority: default x-id-reference-to: Inbound Wire Transfers reason: description: Why the wire transfer was declined. enum: - account_number_canceled - account_number_disabled - entity_not_active - group_locked - no_account_number - transaction_not_allowed type: string x-documentation-priority: default x-enum-descriptions: - The account number is canceled. - The account number is disabled. - The account's entity is not active. - Your account is inactive. - The beneficiary account number does not exist. - The transaction is not allowed per Increase's terms. required: - reason - inbound_wire_transfer_id title: Declined Transaction Declined Transaction Source Wire Decline type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Wire Declines - type: 'null' required: - category title: Declined Transaction Declined Transaction Source type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Declined Transaction Sources type: description: A constant representing the object's type. For this resource it will always be `declined_transaction`. enum: - declined_transaction type: string x-documentation-priority: default required: - type - account_id - amount - currency - created_at - description - id - route_id - route_type - source title: Declined Transaction type: object x-event-categories: - declined_transaction.created x-stainless-empty-object: false x-tag: Declined Transactions x-title-plural: Declined Transactions card_increment: additionalProperties: true description: Card Increments increase the pending amount of an authorized transaction. example: actioner: increase additional_amounts: clinic: null dental: null original: null prescription: null surcharge: null total_cumulative: null total_healthcare: null transit: null unknown: null vision: null amount: 20 card_authorization_id: card_authorization_6iqxap6ivd0fo5eu3i8x currency: USD id: card_increment_6ztayc58j1od0rpebp3e network: visa network_identifiers: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' network_risk_score: 10 pending_transaction_id: pending_transaction_k1sfetcau2qbvjbzgju4 presentment_amount: 20 presentment_currency: USD real_time_decision_id: null scheme_fees: - amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' type: card_increment updated_authorization_amount: 120 properties: actioner: description: Whether this authorization was approved by Increase, the card network through stand-in processing, or the user through a real-time decision. enum: - user - increase - network type: string x-documentation-priority: default x-enum-descriptions: - This object was actioned by the user through a real-time decision. - This object was actioned by Increase without user intervention. - This object was actioned by the network, through stand-in processing. additional_amounts: additionalProperties: false description: Additional amounts associated with the card authorization, such as ATM surcharges fees. These are usually a subset of the `amount` field and are used to provide more detailed information about the transaction. properties: clinic: anyOf: - additionalProperties: false description: The part of this transaction amount that was for clinic-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' dental: anyOf: - additionalProperties: false description: The part of this transaction amount that was for dental-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' original: anyOf: - additionalProperties: false description: The original pre-authorized amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' prescription: anyOf: - additionalProperties: false description: The part of this transaction amount that was for healthcare prescriptions. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' surcharge: anyOf: - additionalProperties: false description: The surcharge amount charged for this transaction by the merchant. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_cumulative: anyOf: - additionalProperties: false description: The total amount of a series of incremental authorizations, optionally provided. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' total_healthcare: anyOf: - additionalProperties: false description: The total amount of healthcare-related additional amounts. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' transit: anyOf: - additionalProperties: false description: The part of this transaction amount that was for transit-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' unknown: anyOf: - additionalProperties: false description: An unknown additional amount. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' vision: anyOf: - additionalProperties: false description: The part of this transaction amount that was for vision-related services. properties: amount: description: The amount in minor units of the `currency` field. The amount is positive if it is added to the amount (such as an ATM surcharge fee) and negative if it is subtracted from the amount (such as a discount). type: integer x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the additional amount's currency. type: string x-documentation-priority: default required: - amount - currency title: Card Increment AdditionalAmounts AdditionalAmount type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s - type: 'null' required: - total_healthcare - total_cumulative - surcharge - transit - vision - clinic - dental - prescription - original - unknown title: Card Increment AdditionalAmounts type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s amount: description: The amount of this increment in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default card_authorization_id: description: The identifier for the Card Authorization this increments. type: string x-documentation-priority: default x-id-reference-to: Card Authorizations currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the increment's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) id: description: The Card Increment identifier. type: string x-documentation-priority: default x-id-reference-to: Card Increments network: description: The card network used to process this card authorization. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa - Pulse network_identifiers: additionalProperties: false description: Network-specific identifiers for a specific request or transaction. example: authorization_identification_response: null retrieval_reference_number: '785867080153' trace_number: '487941' transaction_id: '627199945183184' properties: authorization_identification_response: anyOf: - description: The randomly generated 6-character Authorization Identification Response code sent back to the acquirer in an approved response. type: string x-documentation-priority: default - type: 'null' retrieval_reference_number: anyOf: - description: A life-cycle identifier used across e.g., an authorization and a reversal. Expected to be unique per acquirer within a window of time. For some card networks the retrieval reference number includes the trace counter. type: string x-documentation-priority: default - type: 'null' trace_number: anyOf: - description: A counter used to verify an individual authorization. Expected to be unique per acquirer within a window of time. type: string x-documentation-priority: default - type: 'null' transaction_id: anyOf: - description: A globally unique transaction identifier provided by the card network, used across multiple life-cycle requests. type: string x-documentation-priority: default - type: 'null' required: - transaction_id - trace_number - retrieval_reference_number - authorization_identification_response title: Card Increment NetworkIdentifiers type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: s network_risk_score: anyOf: - description: The risk score generated by the card network. For Visa this is the Visa Advanced Authorization risk score, from 0 to 99, where 99 is the riskiest. type: integer x-documentation-priority: default - type: 'null' pending_transaction_id: anyOf: - description: The identifier of the Pending Transaction associated with this Card Increment. type: string x-documentation-priority: default x-id-reference-to: Pending Transactions - type: 'null' presentment_amount: description: The amount of this increment in the minor unit of the transaction's presentment currency. type: integer x-documentation-priority: default presentment_currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transaction's presentment currency. type: string x-documentation-priority: default real_time_decision_id: anyOf: - description: The identifier of the Real-Time Decision sent to approve or decline this incremental authorization. type: string x-documentation-priority: default x-id-reference-to: Real-Time Decisions - type: 'null' scheme_fees: description: The scheme fees associated with this card increment. items: additionalProperties: false example: amount: '0.137465' created_at: '2020-01-31T23:59:59Z' currency: USD fee_type: visa_corporate_acceptance_fee fixed_component: null variable_rate: '0.0002' properties: amount: description: The fee amount given as a string containing a decimal number. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the fee was created. format: date-time type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the fee reimbursement. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) fee_type: description: The type of fee being assessed. enum: - visa_international_service_assessment_single_currency - visa_international_service_assessment_cross_currency - visa_authorization_domestic_point_of_sale - visa_authorization_international_point_of_sale - visa_authorization_canada_point_of_sale - visa_authorization_reversal_point_of_sale - visa_authorization_reversal_international_point_of_sale - visa_authorization_address_verification_service - visa_advanced_authorization - visa_message_transmission - visa_account_verification_domestic - visa_account_verification_international - visa_account_verification_canada - visa_corporate_acceptance_fee - visa_consumer_debit_acceptance_fee - visa_business_debit_acceptance_fee - visa_purchasing_acceptance_fee - visa_purchase_domestic - visa_purchase_international - visa_credit_purchase_token - visa_debit_purchase_token - visa_clearing_transmission - visa_direct_authorization - visa_direct_transaction_domestic - visa_service_commercial_credit - visa_advertising_service_commercial_credit - visa_community_growth_acceleration_program - visa_processing_guarantee_commercial_credit - pulse_switch_fee type: string x-documentation-priority: default x-enum-descriptions: - International Service Assessment (ISA) single-currency is a fee assessed by the card network for cross-border transactions presented and settled in the same currency. - International Service Assessment (ISA) cross-currency is a fee assessed by the card network for cross-border transactions presented and settled in different currencies. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for POS (Point-Of-Sale) International authorization transactions. Authorization is the process of approving or declining the transaction amount specified. The fee is assessed to the Issuer. - Activity and charges for Visa Settlement System processing for Canada Region POS (Point-of-Sale) authorization transactions. Authorization is the process of approving or declining the transaction amount specified. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - Activity only for Visa Settlement System authorization processing of POS (Point-Of-Sale) International reversal transactions. Authorization reversal represents a VSS message that undoes the complete or partial actions of a previous authorization request. - A per Address Verification Service (AVS) result fee. Applies to all usable AVS result codes. - Advanced Authorization is a fraud detection tool that monitors and risk evaluates 100 percent of US VisaNet authorizations in real-time. Activity related to Purchase (includes Signature Authenticated Visa and PIN Authenticated Visa Debit (PAVD) transactions). - Issuer Transactions Visa represents a charge based on total actual monthly processing (Visa transactions only) through a VisaNet Access Point (VAP). Charges are assessed to the processor for each VisaNet Access Point. - Activity, per inquiry, related to the domestic Issuer for Account Number Verification. - Activity, per inquiry, related to the international Issuer for Account Number Verification. - Activity, per inquiry, related to the US-Canada Issuer for Account Number Verification. - The Corporate Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - The Consumer Debit Acceptance Fee is charged to issuers and is based on the monthly sales volume of Consumer Debit or Prepaid card transactions. The cashback portion of a Debit and Prepaid card transaction is excluded from the sales volume calculation. - The Business Acceptance Fee is charged to issuers and is based on the monthly sales volume on Business Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. The cashback portion is included in the sales volume calculation with the exception of a Debit and Prepaid card transactions. - The Purchasing Card Acceptance Fee is charged to issuers and is based on the monthly sales volume on Commercial and Government Debit, Prepaid, Credit, Charge, or Deferred Debit card transactions. - Activity and fees for the processing of a sales draft original for a purchase transaction. - Activity and fees for the processing of an international sales draft original for a purchase transaction. - Apple Pay Credit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - Apple Pay Debit Product Token Purchase Original Transactions. This fee is billed by Visa on behalf of Apple Inc. for Apple Pay transactions. - A per transaction fee assessed for Base II financial draft - Issuer. - Issuer charge for Non-Financial OCT/AFT Authorization 0100 and Declined Financial OCT/AFT 0200 transactions. - Data processing charge for Visa Direct OCTs for all business application identifiers (BAIs) other than money transfer-bank initiated (BI). BASE II transactions. - Issuer card service fee for Commercial Credit cards. - Issuer Advertising Service Fee for Commercial Credit cards. - Issuer Community Growth Acceleration Program Fee. - Issuer Processing Guarantee for Commercial Credit cards. - Pulse Switch Fee is a fee charged by the Pulse network for processing transactions on its network. fixed_component: anyOf: - description: The fixed component of the fee, if applicable, given in major units of the fee amount. pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' variable_rate: anyOf: - description: The variable rate component of the fee, if applicable, given as a decimal (e.g., 0.015 for 1.5%). pattern: ^-?\d+(\.\d+)?$ type: string x-documentation-priority: default - type: 'null' required: - created_at - amount - currency - fee_type - variable_rate - fixed_component title: Card Increment 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 type: description: A constant representing the object's type. For this resource it will always be `card_increment`. enum: - card_increment type: string x-documentation-priority: default updated_authorization_amount: description: The updated authorization amount after this increment, in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default required: - type - id - amount - presentment_amount - updated_authorization_amount - currency - presentment_currency - card_authorization_id - network - actioner - real_time_decision_id - pending_transaction_id - additional_amounts - network_risk_score - network_identifiers - scheme_fees title: Card Increment type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Increments sandbox_create_an_inbound_wire_transfer_parameters: additionalProperties: false example: account_number_id: account_number_v18nkfqm6afpsrvy82b2 amount: 1000 properties: account_number_id: description: The identifier of the Account Number the inbound Wire Transfer is for. type: string x-documentation-priority: default x-id-reference-to: Account Numbers amount: description: The transfer amount in cents. Must be positive. minimum: 1 type: integer x-documentation-priority: default creditor_address_line1: description: The sending bank will set creditor_address_line1 in production. You can simulate any value here. maxLength: 200 minLength: 1 type: string x-documentation-priority: default creditor_address_line2: description: The sending bank will set creditor_address_line2 in production. You can simulate any value here. maxLength: 200 minLength: 1 type: string x-documentation-priority: default creditor_address_line3: description: The sending bank will set creditor_address_line3 in production. You can simulate any value here. maxLength: 200 minLength: 1 type: string x-documentation-priority: default creditor_name: description: The sending bank will set creditor_name in production. You can simulate any value here. maxLength: 200 minLength: 1 type: string x-documentation-priority: default debtor_address_line1: description: The sending bank will set debtor_address_line1 in production. You can simulate any value here. maxLength: 200 minLength: 1 type: string x-documentation-priority: default debtor_address_line2: description: The sending bank will set debtor_address_line2 in production. You can simulate any value here. maxLength: 200 minLength: 1 type: string x-documentation-priority: default debtor_address_line3: description: The sending bank will set debtor_address_line3 in production. You can simulate any value here. maxLength: 200 minLength: 1 type: string x-documentation-priority: default debtor_name: description: The sending bank will set debtor_name in production. You can simulate any value here. maxLength: 200 minLength: 1 type: string x-documentation-priority: default end_to_end_identification: description: The sending bank will set end_to_end_identification in production. You can simulate any value here. maxLength: 200 minLength: 1 type: string x-documentation-priority: default instructing_agent_routing_number: description: The sending bank will set instructing_agent_routing_number in production. You can simulate any value here. maxLength: 200 minLength: 1 type: string x-documentation-priority: default instruction_identification: description: The sending bank will set instruction_identification in production. You can simulate any value here. maxLength: 200 minLength: 1 type: string x-documentation-priority: default unique_end_to_end_transaction_reference: description: The sending bank will set unique_end_to_end_transaction_reference in production. You can simulate any value here. maxLength: 200 minLength: 1 type: string x-documentation-priority: default unstructured_remittance_information: description: The sending bank will set unstructured_remittance_information in production. You can simulate any value here. maxLength: 200 minLength: 1 type: string x-documentation-priority: default wire_drawdown_request_id: description: The identifier of a Wire Drawdown Request the inbound Wire Transfer is fulfilling. type: string x-documentation-priority: default x-id-reference-to: Wire Drawdown Requests required: - account_number_id - amount type: object x-event-categories: [] x-stainless-empty-object: false sandbox_advance_the_state_of_a_card_dispute_parameters: additionalProperties: false example: network: visa visa: accept_user_submission: {} action: accept_user_submission properties: network: description: The network of the Card Dispute. Details specific to the network are required under the sub-object with the same identifier as the network. enum: - visa type: string x-documentation-priority: default x-enum-descriptions: - Visa visa: additionalProperties: false description: The Visa-specific parameters for the taking action on the dispute. Required if and only if `network` is `visa`. properties: accept_chargeback: additionalProperties: false description: The parameters for accepting the chargeback. Required if and only if `action` is `accept_chargeback`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true accept_user_submission: additionalProperties: false description: The parameters for accepting the user submission. Required if and only if `action` is `accept_user_submission`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true action: description: The action to take. Details specific to the action are required under the sub-object with the same identifier as the action. enum: - accept_chargeback - accept_user_submission - decline_user_prearbitration - receive_merchant_prearbitration - represent - request_further_information - time_out_chargeback - time_out_merchant_prearbitration - time_out_representment - time_out_user_prearbitration type: string x-documentation-priority: default x-enum-descriptions: - Simulate the merchant accepting the chargeback. This will move the dispute to a `won` state. - Accept the user's submission and transmit it to the network. This will move the dispute to a `pending_response` state. - Simulate the merchant declining the user's pre-arbitration. This will move the dispute to a `lost` state. - Simulate the merchant issuing pre-arbitration. This will move the dispute to a `user_submission_required` state. - Simulate the merchant re-presenting the dispute. This will move the dispute to a `user_submission_required` state. - Simulate further information being requested from the user. This will move the dispute to a `user_submission_required` state. - Simulate the merchant timing out responding to the chargeback. This will move the dispute to a `won` state. - Simulate the user timing out responding to a merchant pre-arbitration. This will move the dispute to a `lost` state. - Simulate the user timing out responding to a merchant re-presentment. This will move the dispute to a `lost` state. - Simulate the merchant timing out responding to a user pre-arbitration. This will move the dispute to a `win` state. decline_user_prearbitration: additionalProperties: false description: The parameters for declining the prearbitration. Required if and only if `action` is `decline_user_prearbitration`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true receive_merchant_prearbitration: additionalProperties: false description: The parameters for receiving the prearbitration. Required if and only if `action` is `receive_merchant_prearbitration`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true represent: additionalProperties: false description: The parameters for re-presenting the dispute. Required if and only if `action` is `represent`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true request_further_information: additionalProperties: false description: The parameters for requesting further information from the user. Required if and only if `action` is `request_further_information`. properties: reason: description: The reason for requesting further information from the user. maxLength: 200 minLength: 1 type: string x-documentation-priority: default required: - reason type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false time_out_chargeback: additionalProperties: false description: The parameters for timing out the chargeback. Required if and only if `action` is `time_out_chargeback`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true time_out_merchant_prearbitration: additionalProperties: false description: The parameters for timing out the merchant prearbitration. Required if and only if `action` is `time_out_merchant_prearbitration`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true time_out_representment: additionalProperties: false description: The parameters for timing out the re-presentment. Required if and only if `action` is `time_out_representment`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true time_out_user_prearbitration: additionalProperties: false description: The parameters for timing out the user prearbitration. Required if and only if `action` is `time_out_user_prearbitration`. properties: {} type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: true required: - action type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - network type: object x-event-categories: [] x-stainless-empty-object: false sandbox_create_a_card_balance_inquiry_parameters: additionalProperties: false example: balance: 1000000 card_id: card_oubs0hwk5rn6knuecxg2 event_subscription_id: event_subscription_001dzz0r20rcdxgb013zqb8m04g merchant_acceptor_id: '5665270011000168' merchant_category_code: '5734' merchant_city: New York merchant_country: US merchant_descriptor: CITIBANK merchant_state: NY properties: balance: description: The balance amount in cents. The account balance will be used if not provided. maximum: 1000000000 minimum: 1 type: integer x-documentation-priority: default card_id: description: The identifier of the Card to be authorized. type: string x-documentation-priority: default x-id-reference-to: Cards decline_reason: description: Forces a card decline with a specific reason. No real time decision will be sent. enum: - account_closed - card_not_active - card_canceled - physical_card_not_active - entity_not_active - group_locked - insufficient_funds - cvv2_mismatch - pin_mismatch - card_expiration_mismatch - transaction_not_allowed - breaches_limit - webhook_declined - webhook_timed_out - declined_by_stand_in_processing - invalid_physical_card - missing_original_authorization - invalid_cryptogram - failed_3ds_authentication - suspected_card_testing - suspected_fraud type: string x-documentation-priority: default x-enum-descriptions: - The account has been closed. - The Card was not active. - The Card has been canceled. - The Physical Card was not active. - The account's entity was not active. - The account was inactive. - The Card's Account did not have a sufficient available balance. - The given CVV2 did not match the card's value. - The given PIN did not match the card's value. - The given expiration date did not match the card's value. Only applies when a CVV2 is present. - The attempted card transaction is not allowed per Increase's terms. - The transaction was blocked by a Limit. - Your application declined the transaction via webhook. - Your application webhook did not respond without the required timeout. - Declined by stand-in processing. - The card read had an invalid CVV or dCVV. - The original card authorization for this incremental authorization does not exist. - The card's authorization request cryptogram was invalid. The cryptogram can be from a physical card or a Digital Wallet Token purchase. - The transaction was declined because the 3DS authentication failed. - The transaction was suspected to be used by a card tester to test for valid card numbers. - The transaction was suspected to be fraudulent. Please reach out to support@increase.com for more information. digital_wallet_token_id: description: The identifier of the Digital Wallet Token to be authorized. type: string x-documentation-priority: default x-id-reference-to: Digital Wallet Tokens event_subscription_id: description: The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes. type: string x-documentation-priority: default x-id-reference-to: Event Subscriptions merchant_acceptor_id: description: The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with. maxLength: 200 minLength: 1 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. maxLength: 200 minLength: 1 type: string x-documentation-priority: default merchant_city: description: The city the merchant resides in. maxLength: 200 minLength: 1 type: string x-documentation-priority: default merchant_country: description: The country the merchant resides in. maxLength: 200 minLength: 1 type: string x-documentation-priority: default merchant_descriptor: description: The merchant descriptor of the merchant the card is transacting with. maxLength: 200 minLength: 1 type: string x-documentation-priority: default merchant_state: description: The state the merchant resides in. maxLength: 200 minLength: 1 type: string x-documentation-priority: default network_details: additionalProperties: false description: Fields specific to a given card network. properties: visa: additionalProperties: false description: Fields specific to the Visa network. properties: stand_in_processing_reason: description: The reason code for the 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: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false required: - visa type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false network_risk_score: 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. maximum: 99 minimum: 0 type: integer x-documentation-priority: default physical_card_id: description: The identifier of the Physical Card to be authorized. type: string x-documentation-priority: default x-id-reference-to: Physical Cards terminal_id: description: The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with. maxLength: 200 minLength: 1 type: string x-documentation-priority: default type: object x-event-categories: [] x-stainless-empty-object: false card_authorization_expiration: additionalProperties: true description: Card Authorization Expirations are cancellations of authorizations that were never settled by the acquirer. example: card_authorization_id: card_authorization_6iqxap6ivd0fo5eu3i8x currency: USD expired_amount: 20 id: card_authorization_expiration_9xxbjtmixs8sfluzux2e network: visa type: card_authorization_expiration properties: card_authorization_id: description: The identifier for the Card Authorization this reverses. type: string x-documentation-priority: default x-id-reference-to: Card Authorizations currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the reversal's currency. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) expired_amount: description: The amount of this authorization expiration in the minor unit of the transaction's currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default id: description: The Card Authorization Expiration identifier. type: string x-documentation-priority: default x-id-reference-to: Card Authorization Expirations network: description: The card network used to process this card authorization. enum: - visa - pulse type: string x-documentation-priority: default x-enum-descriptions: - Visa - Pulse type: description: A constant representing the object's type. For this resource it will always be `card_authorization_expiration`. enum: - card_authorization_expiration type: string x-documentation-priority: default required: - type - id - expired_amount - currency - card_authorization_id - network title: Card Authorization Expiration type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: Card Authorization Expirations inbound_fednow_transfer: additionalProperties: false description: An Inbound FedNow Transfer is a FedNow transfer initiated outside of Increase to your account. example: account_id: account_in71c4amph0vgo2qllky account_number_id: account_number_v18nkfqm6afpsrvy82b2 amount: 100 confirmation: transfer_id: inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20 created_at: '2020-01-31T23:59:59Z' creditor_name: Ian Crease currency: USD debtor_account_number: '987654321' debtor_name: National Phonograph Company debtor_routing_number: '101050001' decline: reason: account_number_disabled transfer_id: inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20 id: inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20 status: confirmed transaction_id: transaction_uyrp7fld2ium70oa7oi type: inbound_fednow_transfer unstructured_remittance_information: Invoice 29582 properties: account_id: description: The Account to which the transfer was sent. type: string x-documentation-priority: default x-id-reference-to: Accounts account_number_id: description: The identifier of the Account Number to which this transfer was sent. type: string x-documentation-priority: default x-id-reference-to: Account Numbers amount: description: The amount in USD cents. type: integer x-documentation-priority: default confirmation: anyOf: - additionalProperties: true description: If your transfer is confirmed, this will contain details of the confirmation. 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: Inbound FedNow Transfer 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' 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 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 FedNow 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 decline: anyOf: - additionalProperties: true description: If your transfer is declined, this will contain details of the decline. example: reason: account_number_disabled transfer_id: inbound_fednow_transfer_ctxxbc07oh5ke5w1hk20 properties: reason: description: Why the transfer was declined. enum: - account_number_canceled - account_number_disabled - account_restricted - group_locked - entity_not_active - fednow_not_enabled type: string x-documentation-priority: default x-enum-descriptions: - The account number is canceled. - The account number is disabled. - Your account is restricted. - Your account is inactive. - The account's entity is not active. - Your account is not enabled to receive FedNow transfers. transfer_id: description: The identifier of the FedNow Transfer that led to this declined transaction. type: string x-documentation-priority: default x-id-reference-to: Inbound FedNow Transfers required: - reason - transfer_id title: Inbound FedNow Transfer Inbound FedNow Transfer Decline type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Inbound FedNow Transfer Declines - type: 'null' id: description: The inbound FedNow transfer's identifier. type: string x-documentation-priority: default x-id-reference-to: Inbound FedNow Transfers status: description: The lifecycle status of the transfer. enum: - pending_confirming - timed_out - confirmed - declined - requires_attention type: string x-documentation-priority: default x-enum-descriptions: - The transfer is pending confirmation. - The transfer was not responded to in time. - The transfer has been received successfully and is confirmed. - The transfer has been declined. - The transfer requires attention from an Increase operator. transaction_id: anyOf: - description: The identifier of the Transaction object created when the transfer was confirmed. type: string x-documentation-priority: default x-id-reference-to: Transactions - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `inbound_fednow_transfer`. enum: - inbound_fednow_transfer type: string x-documentation-priority: default unstructured_remittance_information: anyOf: - description: Additional information included with the transfer. type: string x-documentation-priority: default - type: 'null' required: - type - id - amount - currency - creditor_name - debtor_name - debtor_account_number - debtor_routing_number - unstructured_remittance_information - status - account_id - account_number_id - created_at - transaction_id - decline - confirmation title: Inbound FedNow Transfer type: object x-event-categories: - inbound_fednow_transfer.created - inbound_fednow_transfer.updated x-stainless-empty-object: false x-tag: Inbound FedNow Transfers x-title-plural: Inbound FedNow Transfers sandbox_create_an_inbound_check_deposit_adjustment_parameters: additionalProperties: false example: amount: 1000 properties: amount: description: The adjustment amount in cents. Defaults to the amount of the Inbound Check Deposit. minimum: 0 type: integer x-documentation-priority: default reason: description: The reason for the adjustment. Defaults to `wrong_payee_credit`. 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. type: object x-event-categories: [] x-stainless-empty-object: false 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 ach_transfer: additionalProperties: true description: ACH transfers move funds between your Increase account and any other account accessible by the Automated Clearing House (ACH). example: account_id: account_in71c4amph0vgo2qllky account_number: '987654321' acknowledgement: acknowledged_at: '2020-01-31T23:59:59Z' addenda: null amount: 100 approval: approved_at: '2020-01-31T23:59:59Z' approved_by: null cancellation: null company_descriptive_date: null company_discretionary_data: null company_entry_description: null company_id: '1234987601' company_name: National Phonograph Company created_at: '2020-01-31T23:59:59Z' created_by: category: user user: email: user@example.com currency: USD destination_account_holder: business external_account_id: external_account_ukk55lr923a3ac0pp7iv funding: checking id: ach_transfer_uoxatyh3lt5evrsdvo7q idempotency_key: null inbound_funds_hold: null individual_id: null individual_name: Ian Crease network: ach notifications_of_change: [] pending_transaction_id: null preferred_effective_date: date: null settlement_schedule: same_day return: null routing_number: '101050001' settlement: null standard_entry_class_code: corporate_credit_or_debit statement_descriptor: Statement descriptor status: returned submission: administrative_returns_expected_by: '2020-02-05T11:00:00Z' effective_date: '2020-01-31' expected_funds_settlement_at: '2020-02-03T13:30:00Z' expected_settlement_schedule: future_dated submitted_at: '2020-01-31T23:59:59Z' trace_number: 058349238292834 transaction_id: transaction_uyrp7fld2ium70oa7oi type: ach_transfer properties: account_id: description: The Account to which the transfer belongs. type: string x-documentation-priority: default x-id-reference-to: Accounts account_number: description: The destination account number. type: string x-documentation-priority: default acknowledgement: anyOf: - additionalProperties: false description: After the transfer is acknowledged by FedACH, this will contain supplemental details. The Federal Reserve sends an acknowledgement message for each file that Increase submits. example: acknowledged_at: '2020-01-31T23:59:59Z' properties: acknowledged_at: description: When the Federal Reserve acknowledged the submitted file containing this transfer. type: string x-documentation-priority: default required: - acknowledged_at title: ACH Transfer ACH Transfer Acknowledgement type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: ACH Transfer Acknowledgements - type: 'null' addenda: anyOf: - additionalProperties: false description: Additional information that will be sent to the recipient. example: category: freeform freeform: entries: - payment_related_information: addendum properties: 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: - freeform - payment_order_remittance_advice - other type: string x-documentation-priority: default x-enum-descriptions: - Unstructured `payment_related_information` passed through with the transfer. - Structured ASC X12 820 remittance advice records. Please reach out to [support@increase.com](mailto:support@increase.com) for more information. - Unknown addenda type. freeform: anyOf: - additionalProperties: false description: Unstructured `payment_related_information` passed through with the transfer. properties: entries: description: Each entry represents an addendum sent with the transfer. 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: ACH Transfer ACH Transfer 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: ACH Transfer ACH Transfer Addenda Freeform type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Freeforms - type: 'null' payment_order_remittance_advice: anyOf: - additionalProperties: false description: Structured ASC X12 820 remittance advice records. Please reach out to [support@increase.com](mailto:support@increase.com) for more information. properties: invoices: description: ASC X12 RMR records for this specific transfer. items: additionalProperties: false properties: invoice_number: description: The invoice number for this reference, determined in advance with the receiver. type: string x-documentation-priority: default paid_amount: description: The amount that was paid for this invoice in the minor unit of its currency. For dollars, for example, this is cents. type: integer x-documentation-priority: default required: - invoice_number - paid_amount title: ACH Transfer ACH Transfer Addenda PaymentOrderRemittanceAdvice InvoicesElement type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: InvoicesElements type: array x-documentation-priority: default required: - invoices title: ACH Transfer ACH Transfer Addenda PaymentOrderRemittanceAdvice type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: PaymentOrderRemittanceAdvices - type: 'null' required: - category title: ACH Transfer ACH Transfer Addenda type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: ACH Transfer Addendas - type: 'null' amount: description: The transfer amount in USD cents. A positive amount indicates a credit transfer pushing funds to the receiving account. A negative amount indicates a debit transfer pulling funds from the receiving account. type: integer x-documentation-priority: default approval: anyOf: - additionalProperties: false description: If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval. example: approved_at: '2020-01-31T23:59:59Z' approved_by: null properties: approved_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved. format: date-time type: string x-documentation-priority: default approved_by: anyOf: - description: If the Transfer was approved by a user in the dashboard, the email address of that user. type: string x-documentation-priority: default - type: 'null' required: - approved_at - approved_by title: ACH Transfer Transfer Approval type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Transfer Approvals - type: 'null' cancellation: anyOf: - additionalProperties: false description: If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation. example: canceled_at: '2020-01-31T23:59:59Z' canceled_by: null properties: canceled_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled. format: date-time type: string x-documentation-priority: default canceled_by: anyOf: - description: If the Transfer was canceled by a user in the dashboard, the email address of that user. type: string x-documentation-priority: default - type: 'null' required: - canceled_at - canceled_by title: ACH Transfer Transfer Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Transfer Cancellations - type: 'null' company_descriptive_date: anyOf: - description: The description of the date of the transfer. type: string x-documentation-priority: default - type: 'null' company_discretionary_data: anyOf: - description: The data you chose to associate with the transfer. type: string x-documentation-priority: default - type: 'null' company_entry_description: anyOf: - description: The description of the transfer you set to be shown to the recipient. type: string x-documentation-priority: default - type: 'null' company_id: description: The company ID associated with the transfer. type: string x-documentation-priority: default company_name: anyOf: - description: The name by which the recipient knows you. type: string x-documentation-priority: default - type: 'null' 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 created_by: anyOf: - additionalProperties: false description: What object created the transfer, either via the API or the dashboard. example: category: user user: email: user@example.com properties: api_key: anyOf: - additionalProperties: false description: If present, details about the API key that created the transfer. properties: description: anyOf: - description: The description set for the API key when it was created. type: string x-documentation-priority: default - type: 'null' required: - description title: ACH Transfer Transfer Creator ApiKey type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: ApiKeys - type: 'null' category: description: The type of object that created this transfer. enum: - api_key - oauth_application - user type: string x-documentation-priority: default x-enum-descriptions: - An API key. Details will be under the `api_key` object. - An OAuth application you connected to Increase. Details will be under the `oauth_application` object. - A User in the Increase dashboard. Details will be under the `user` object. oauth_application: anyOf: - additionalProperties: false description: If present, details about the OAuth Application that created the transfer. properties: name: description: The name of the OAuth Application. type: string x-documentation-priority: default required: - name title: ACH Transfer Transfer Creator OAuthApplication type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: OAuthApplications - type: 'null' user: anyOf: - additionalProperties: false description: If present, details about the User that created the transfer. properties: email: description: The email address of the User. type: string x-documentation-priority: default required: - email title: ACH Transfer Transfer Creator User type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Users - type: 'null' required: - category title: ACH Transfer Transfer Creator type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Transfer Creators - type: 'null' currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For ACH transfers this is always equal to `usd`. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) destination_account_holder: description: The type of entity that owns the account to which the ACH Transfer is being sent. enum: - business - individual - unknown type: string x-documentation-priority: default x-enum-descriptions: - The External Account is owned by a business. - The External Account is owned by an individual. - It's unknown what kind of entity owns the External Account. external_account_id: anyOf: - description: The identifier of the External Account the transfer was made to, if any. type: string x-documentation-priority: default x-id-reference-to: External Accounts - type: 'null' funding: description: The type of the account to which the transfer will be sent. enum: - checking - savings - general_ledger type: string x-documentation-priority: default x-enum-descriptions: - A checking account. - A savings account. - A bank's general ledger. Uncommon. id: description: The ACH transfer's identifier. type: string x-documentation-priority: default x-id-reference-to: ACH Transfers idempotency_key: anyOf: - description: The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys). type: string x-documentation-priority: default - type: 'null' inbound_funds_hold: anyOf: - $ref: '#/components/schemas/inbound_funds_hold' description: Increase will sometimes hold the funds for ACH debit transfers. If funds are held, this sub-object will contain details of the hold. x-documentation-priority: default - type: 'null' individual_id: anyOf: - description: Your identifier for the transfer recipient. type: string x-documentation-priority: default - type: 'null' individual_name: anyOf: - description: The name of the transfer recipient. This value is informational and not verified by the recipient's bank. type: string x-documentation-priority: default - type: 'null' network: description: The transfer's network. enum: - ach type: string x-documentation-priority: default notifications_of_change: description: If the receiving bank accepts the transfer but notifies that future transfers should use different details, this will contain those details. items: additionalProperties: false example: change_code: incorrect_transaction_code corrected_data: '32' created_at: '2020-01-31T23:59:59Z' properties: change_code: description: The required type of change that is being signaled by the receiving financial institution. enum: - incorrect_account_number - incorrect_routing_number - incorrect_routing_number_and_account_number - incorrect_transaction_code - incorrect_account_number_and_transaction_code - incorrect_routing_number_account_number_and_transaction_code - incorrect_receiving_depository_financial_institution_identification - incorrect_individual_identification_number - addenda_format_error - incorrect_standard_entry_class_code_for_outbound_international_payment - misrouted_notification_of_change - incorrect_trace_number - incorrect_company_identification_number - incorrect_identification_number - incorrectly_formatted_corrected_data - incorrect_discretionary_data - routing_number_not_from_original_entry_detail_record - depository_financial_institution_account_number_not_from_original_entry_detail_record - incorrect_transaction_code_by_originating_depository_financial_institution type: string x-documentation-priority: default x-enum-descriptions: - The account number was incorrect. - The routing number was incorrect. - Both the routing number and the account number were incorrect. - The transaction code was incorrect. Try changing the `funding` parameter from checking to savings or vice-versa. - The account number and the transaction code were incorrect. - The routing number, account number, and transaction code were incorrect. - The receiving depository financial institution identification was incorrect. - The individual identification number was incorrect. - The addenda had an incorrect format. - The standard entry class code was incorrect for an outbound international payment. - The notification of change was misrouted. - The trace number was incorrect. - The company identification number was incorrect. - The individual identification number or identification number was incorrect. - The corrected data was incorrectly formatted. - The discretionary data was incorrect. - The routing number was not from the original entry detail record. - The depository financial institution account number was not from the original entry detail record. - The transaction code was incorrect, initiated by the originating depository financial institution. corrected_data: description: The corrected data that should be used in future ACHs to this account. This may contain the suggested new account number or routing number. When the `change_code` is `incorrect_transaction_code`, this field contains an integer. Numbers starting with a 2 encourage changing the `funding` parameter to checking; numbers starting with a 3 encourage changing to savings. type: string x-documentation-priority: default created_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the notification occurred. format: date-time type: string x-documentation-priority: default required: - created_at - change_code - corrected_data title: ACH Transfer ACH Notification of Change type: object x-event-categories: [] x-stainless-empty-object: false x-title-plural: ACH Notifications of change type: array x-documentation-priority: default pending_transaction_id: anyOf: - description: The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) by someone else in your organization. type: string x-documentation-priority: default x-id-reference-to: Pending Transactions - type: 'null' preferred_effective_date: additionalProperties: false description: Configuration for how the effective date of the transfer will be set. This determines same-day vs future-dated settlement timing. If not set, defaults to a `settlement_schedule` of `same_day`. If set, exactly one of the child attributes must be set. properties: date: anyOf: - description: A specific date in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format to use as the effective date when submitting this transfer. format: date type: string x-documentation-priority: default - type: 'null' settlement_schedule: anyOf: - description: A schedule by which Increase will choose an effective date for the transfer. enum: - same_day - future_dated type: string x-documentation-priority: default x-enum-descriptions: - 'The chosen effective date will be the same as the ACH processing date on which the transfer is submitted. This is necessary, but not sufficient for the transfer to be settled same-day: it must also be submitted before the last same-day cutoff and be less than or equal to $1,000.000.00. ' - The chosen effective date will be the business day following the ACH processing date on which the transfer is submitted. The transfer will be settled on that future day. - type: 'null' required: - date - settlement_schedule title: ACH Transfer PreferredEffectiveDate type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: PreferredEffectiveDates return: anyOf: - additionalProperties: true description: If your transfer is returned, this will contain details of the return. 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: ACH Transfer 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' routing_number: description: The American Bankers' Association (ABA) Routing Transit Number (RTN). type: string x-documentation-priority: default settlement: anyOf: - additionalProperties: false description: A subhash containing information about when and how the transfer settled at the Federal Reserve. properties: settled_at: description: When the funds for this transfer have settled at the destination bank at the Federal Reserve. format: date-time type: string x-documentation-priority: default required: - settled_at title: ACH Transfer Settlement type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Settlements - type: 'null' standard_entry_class_code: description: The [Standard Entry Class (SEC) code](/documentation/ach-standard-entry-class-codes) to use for the transfer. enum: - corporate_credit_or_debit - corporate_trade_exchange - prearranged_payments_and_deposit - internet_initiated type: string x-documentation-priority: default x-enum-descriptions: - Corporate Credit and Debit (CCD) is used for business-to-business payments. - Corporate Trade Exchange (CTX) allows for including extensive remittance information with business-to-business payments. - Prearranged Payments and Deposits (PPD) is used for credits or debits originated by an organization to a consumer, such as payroll direct deposits. - Internet Initiated (WEB) is used for consumer payments initiated or authorized via the Internet. Debits can only be initiated by non-consumers to debit a consumer’s account. Credits can only be used for consumer to consumer transactions. statement_descriptor: description: The descriptor that will show on the recipient's bank statement. type: string x-documentation-priority: default status: description: The lifecycle status of the transfer. enum: - pending_approval - pending_transfer_session_confirmation - canceled - pending_submission - pending_reviewing - requires_attention - rejected - submitted - returned type: string x-documentation-priority: default x-enum-descriptions: - The transfer is pending approval. - The transfer belongs to a Transfer Session that is pending confirmation. - The transfer has been canceled. - The transfer is pending submission to the Federal Reserve. - The transfer is pending review by Increase. - The transfer requires attention from an Increase operator. - The transfer has been rejected. - The transfer is complete. - The transfer has been returned. submission: anyOf: - additionalProperties: false description: After the transfer is submitted to FedACH, this will contain supplemental details. Increase batches transfers and submits a file to the Federal Reserve roughly every 30 minutes. The Federal Reserve processes ACH transfers during weekdays according to their [posted schedule](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html). example: administrative_returns_expected_by: '2020-02-05T11:00:00Z' effective_date: '2020-01-31' expected_funds_settlement_at: '2020-02-03T13:30:00Z' expected_settlement_schedule: future_dated submitted_at: '2020-01-31T23:59:59Z' trace_number: 058349238292834 properties: administrative_returns_expected_by: description: 'The timestamp by which any administrative returns are expected to be received by. This follows the NACHA guidelines for return windows, which are: "In general, return entries must be received by the RDFI’s ACH Operator by its deposit deadline for the return entry to be made available to the ODFI no later than the opening of business on the second banking day following the Settlement Date of the original entry.".' format: date-time type: string x-documentation-priority: default effective_date: description: The ACH transfer's effective date as sent to the Federal Reserve. If a specific date was configured using `preferred_effective_date`, this will match that value. Otherwise, it will be the date selected (following the specified settlement schedule) at the time the transfer was submitted. format: date type: string x-documentation-priority: default expected_funds_settlement_at: description: When the transfer is expected to settle in the recipient's account. Credits may be available sooner, at the receiving bank's discretion. The FedACH schedule is published [here](https://www.frbservices.org/resources/resource-centers/same-day-ach/fedach-processing-schedule.html). format: date-time type: string x-documentation-priority: default expected_settlement_schedule: description: The settlement schedule the transfer is expected to follow. This expectation takes into account the `effective_date`, `submitted_at`, and the amount of the transfer. enum: - same_day - future_dated type: string x-documentation-priority: default x-enum-descriptions: - The transfer is expected to settle same-day. - The transfer is expected to settle on a future date. submitted_at: description: When the ACH transfer was sent to FedACH. format: date-time type: string x-documentation-priority: default trace_number: description: A 15 digit number recorded in the Nacha file and transmitted to the receiving bank. Along with the amount, date, and originating routing number, this can be used to identify the ACH transfer at the receiving 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 required: - trace_number - submitted_at - expected_funds_settlement_at - effective_date - expected_settlement_schedule - administrative_returns_expected_by title: ACH Transfer ACH Transfer Submission type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: ACH Transfer Submissions - type: 'null' transaction_id: anyOf: - description: The ID for the transaction funding the transfer. type: string x-documentation-priority: default x-id-reference-to: Transactions - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `ach_transfer`. enum: - ach_transfer type: string x-documentation-priority: default required: - type - account_id - account_number - addenda - amount - currency - approval - cancellation - created_at - destination_account_holder - external_account_id - id - network - notifications_of_change - return - routing_number - statement_descriptor - status - submission - acknowledgement - settlement - inbound_funds_hold - transaction_id - pending_transaction_id - company_descriptive_date - company_discretionary_data - company_entry_description - company_name - company_id - funding - individual_id - individual_name - preferred_effective_date - standard_entry_class_code - created_by - idempotency_key title: ACH Transfer type: object x-event-categories: - ach_transfer.created - ach_transfer.updated x-stainless-empty-object: false x-tag: ACH Transfers x-title-plural: ACH Transfers sandbox_create_an_inbound_mail_item_parameters: additionalProperties: true example: amount: 1000 lockbox_recipient_id: lockbox_3xt21ok13q19advds4t5 properties: amount: description: The amount of the check to be simulated, in cents. minimum: 0 type: integer x-documentation-priority: default contents_file_id: description: The file containing the PDF contents. If not present, a default check image file will be used. type: string x-documentation-priority: default x-id-reference-to: Files lockbox_address_id: description: The identifier of the Lockbox Address to simulate inbound mail to. type: string x-documentation-priority: default x-id-reference-to: Lockbox Addresses lockbox_recipient_id: description: The identifier of the Lockbox Recipient to simulate inbound mail to. type: string x-documentation-priority: default x-id-reference-to: Lockbox Recipients required: - amount type: object x-event-categories: [] x-stainless-empty-object: false real_time_payments_transfer: additionalProperties: true description: Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network. example: account_id: account_in71c4amph0vgo2qllky account_number: '987654321' acknowledgement: acknowledged_at: '2020-01-31T23:59:59Z' amount: 100 approval: null cancellation: null created_at: '2020-01-31T23:59:59Z' created_by: category: user user: email: user@example.com creditor_name: Ian Crease currency: USD debtor_name: null external_account_id: null id: real_time_payments_transfer_iyuhl5kdn7ssmup83mvq idempotency_key: null pending_transaction_id: null rejection: null routing_number: '101050001' source_account_number_id: account_number_v18nkfqm6afpsrvy82b2 status: complete submission: submitted_at: '2020-01-31T23:59:59Z' transaction_identification: 20220501234567891T1BSLZO01745013025 transaction_id: transaction_uyrp7fld2ium70oa7oi type: real_time_payments_transfer ultimate_creditor_name: null ultimate_debtor_name: null unstructured_remittance_information: Invoice 29582 properties: account_id: description: The Account from which the transfer was sent. type: string x-documentation-priority: default x-id-reference-to: Accounts account_number: description: The destination account number. type: string x-documentation-priority: default acknowledgement: anyOf: - additionalProperties: false description: If the transfer is acknowledged by the recipient bank, this will contain supplemental details. example: acknowledged_at: '2020-01-31T23:59:59Z' properties: acknowledged_at: description: When the transfer was acknowledged. format: date-time type: string x-documentation-priority: default required: - acknowledged_at title: Real-Time Payments Transfer 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' amount: description: The transfer amount in USD cents. type: integer x-documentation-priority: default approval: anyOf: - additionalProperties: false description: If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval. example: approved_at: '2020-01-31T23:59:59Z' approved_by: null properties: approved_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was approved. format: date-time type: string x-documentation-priority: default approved_by: anyOf: - description: If the Transfer was approved by a user in the dashboard, the email address of that user. type: string x-documentation-priority: default - type: 'null' required: - approved_at - approved_by title: Real-Time Payments Transfer Transfer Approval type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Transfer Approvals - type: 'null' cancellation: anyOf: - additionalProperties: false description: If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation. example: canceled_at: '2020-01-31T23:59:59Z' canceled_by: null properties: canceled_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Transfer was canceled. format: date-time type: string x-documentation-priority: default canceled_by: anyOf: - description: If the Transfer was canceled by a user in the dashboard, the email address of that user. type: string x-documentation-priority: default - type: 'null' required: - canceled_at - canceled_by title: Real-Time Payments Transfer Transfer Cancellation type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Transfer Cancellations - type: 'null' 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 created_by: anyOf: - additionalProperties: false description: What object created the transfer, either via the API or the dashboard. example: category: user user: email: user@example.com properties: api_key: anyOf: - additionalProperties: false description: If present, details about the API key that created the transfer. properties: description: anyOf: - description: The description set for the API key when it was created. type: string x-documentation-priority: default - type: 'null' required: - description title: Real-Time Payments Transfer Transfer Creator ApiKey type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: ApiKeys - type: 'null' category: description: The type of object that created this transfer. enum: - api_key - oauth_application - user type: string x-documentation-priority: default x-enum-descriptions: - An API key. Details will be under the `api_key` object. - An OAuth application you connected to Increase. Details will be under the `oauth_application` object. - A User in the Increase dashboard. Details will be under the `user` object. oauth_application: anyOf: - additionalProperties: false description: If present, details about the OAuth Application that created the transfer. properties: name: description: The name of the OAuth Application. type: string x-documentation-priority: default required: - name title: Real-Time Payments Transfer Transfer Creator OAuthApplication type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: OAuthApplications - type: 'null' user: anyOf: - additionalProperties: false description: If present, details about the User that created the transfer. properties: email: description: The email address of the User. type: string x-documentation-priority: default required: - email title: Real-Time Payments Transfer Transfer Creator User type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Users - type: 'null' required: - category title: Real-Time Payments Transfer Transfer Creator type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Transfer Creators - type: 'null' creditor_name: description: The name of the transfer's recipient. This is set by the sender when creating the transfer. type: string x-documentation-priority: default currency: description: The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the transfer's currency. For real-time payments transfers this is always equal to `USD`. enum: - USD type: string x-documentation-priority: default x-enum-descriptions: - US Dollar (USD) debtor_name: anyOf: - description: The name of the transfer's sender. If not provided, defaults to the name of the account's entity. type: string x-documentation-priority: default - type: 'null' external_account_id: anyOf: - description: The identifier of the External Account the transfer was made to, if any. type: string x-documentation-priority: default x-id-reference-to: External Accounts - type: 'null' id: description: The Real-Time Payments Transfer's identifier. type: string x-documentation-priority: default x-id-reference-to: Real-Time Payments Transfers idempotency_key: anyOf: - description: The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](https://increase.com/documentation/idempotency-keys). type: string x-documentation-priority: default - type: 'null' pending_transaction_id: anyOf: - description: The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](https://increase.com/documentation/transfer-approvals#transfer-approvals) by someone else in your organization. type: string x-documentation-priority: default x-id-reference-to: Pending Transactions - type: 'null' rejection: anyOf: - additionalProperties: false description: If the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details. example: reject_reason_additional_information: null reject_reason_code: account_closed rejected_at: '2020-01-31T23:59:59Z' properties: reject_reason_additional_information: anyOf: - description: Additional information about the rejection provided by the recipient bank when the `reject_reason_code` is `NARRATIVE`. type: string x-documentation-priority: default - type: 'null' reject_reason_code: description: The reason the transfer was rejected as provided by the recipient bank or the Real-Time Payments network. enum: - account_closed - account_blocked - invalid_creditor_account_type - invalid_creditor_account_number - invalid_creditor_financial_institution_identifier - end_customer_deceased - narrative - transaction_forbidden - transaction_type_not_supported - unexpected_amount - amount_exceeds_bank_limits - invalid_creditor_address - unknown_end_customer - invalid_debtor_address - timeout - unsupported_message_for_recipient - recipient_connection_not_available - real_time_payments_suspended - instructed_agent_signed_off - processing_error - other type: string x-documentation-priority: default x-enum-descriptions: - The destination account is closed. Corresponds to the Real-Time Payments reason code `AC04`. - The destination account is currently blocked from receiving transactions. Corresponds to the Real-Time Payments reason code `AC06`. - The destination account is ineligible to receive Real-Time Payments transfers. Corresponds to the Real-Time Payments reason code `AC14`. - The destination account does not exist. Corresponds to the Real-Time Payments reason code `AC03`. - The destination routing number is invalid. Corresponds to the Real-Time Payments reason code `RC04`. - The destination account holder is deceased. Corresponds to the Real-Time Payments reason code `MD07`. - The reason is provided as narrative information in the additional information field. - Real-Time Payments transfers are not allowed to the destination account. Corresponds to the Real-Time Payments reason code `AG01`. - Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code `AG03`. - The amount of the transfer is different than expected by the recipient. Corresponds to the Real-Time Payments reason code `AM09`. - The amount is higher than the recipient is authorized to send or receive. Corresponds to the Real-Time Payments reason code `AM14`. - The creditor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code `BE04`. - The specified creditor is unknown. Corresponds to the Real-Time Payments reason code `BE06`. - The debtor's address is required, but missing or invalid. Corresponds to the Real-Time Payments reason code `BE07`. - There was a timeout processing the transfer. Corresponds to the Real-Time Payments reason code `DS24`. - Real-Time Payments transfers are not enabled for the destination account. Corresponds to the Real-Time Payments reason code `NOAT`. - The destination financial institution is currently not connected to Real-Time Payments. Corresponds to the Real-Time Payments reason code `9912`. - Real-Time Payments is currently unavailable. Corresponds to the Real-Time Payments reason code `9948`. - The destination financial institution is currently signed off of Real-Time Payments. Corresponds to the Real-Time Payments reason code `9910`. - The transfer was rejected due to an internal Increase issue. We have been notified. - Some other error or issue has occurred. rejected_at: anyOf: - description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was rejected. format: date-time type: string x-documentation-priority: default - type: 'null' required: - rejected_at - reject_reason_code - reject_reason_additional_information title: Real-Time Payments Transfer Real-Time Payments Transfer Rejection type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Real-Time Payments Transfer Rejections - type: 'null' routing_number: description: The destination American Bankers' Association (ABA) Routing Transit Number (RTN). type: string x-documentation-priority: default source_account_number_id: description: The Account Number the recipient will see as having sent the transfer. type: string x-documentation-priority: default x-id-reference-to: Account Numbers status: description: The lifecycle status of the transfer. enum: - pending_approval - canceled - pending_reviewing - requires_attention - rejected - pending_submission - submitted - complete type: string x-documentation-priority: default x-enum-descriptions: - The transfer is pending approval. - The transfer has been canceled. - The transfer is pending review by Increase. - The transfer requires attention from an Increase operator. - The transfer was rejected by the network or the recipient's bank. - The transfer is queued to be submitted to Real-Time Payments. - The transfer has been submitted and is pending a response from Real-Time Payments. - The transfer has been sent successfully and is complete. submission: anyOf: - additionalProperties: false description: After the transfer is submitted to Real-Time Payments, this will contain supplemental details. example: submitted_at: '2020-01-31T23:59:59Z' transaction_identification: 20220501234567891T1BSLZO01745013025 properties: submitted_at: anyOf: - description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was submitted to The Clearing House. format: date-time type: string x-documentation-priority: default - type: 'null' transaction_identification: description: The Real-Time Payments network identification of the transfer. type: string x-documentation-priority: default required: - submitted_at - transaction_identification title: Real-Time Payments Transfer Real-Time Payments Transfer Submission type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Real-Time Payments Transfer Submissions - type: 'null' transaction_id: anyOf: - description: The Transaction funding the transfer once it is complete. type: string x-documentation-priority: default x-id-reference-to: Transactions - type: 'null' type: description: A constant representing the object's type. For this resource it will always be `real_time_payments_transfer`. enum: - real_time_payments_transfer type: string x-documentation-priority: default ultimate_creditor_name: anyOf: - description: The name of the ultimate recipient of the transfer. Set this if the creditor is an intermediary receiving the payment for someone else. type: string x-documentation-priority: default - type: 'null' ultimate_debtor_name: anyOf: - description: The name of the ultimate sender of the transfer. Set this if the funds are being sent on behalf of someone who is not the account holder at Increase. type: string x-documentation-priority: default - type: 'null' unstructured_remittance_information: description: Unstructured information that will show on the recipient's bank statement. type: string x-documentation-priority: default required: - type - id - approval - cancellation - status - created_at - account_id - external_account_id - source_account_number_id - debtor_name - creditor_name - ultimate_creditor_name - ultimate_debtor_name - unstructured_remittance_information - amount - currency - account_number - routing_number - transaction_id - pending_transaction_id - submission - rejection - acknowledgement - created_by - idempotency_key title: Real-Time Payments Transfer type: object x-event-categories: - real_time_payments_transfer.created - real_time_payments_transfer.updated x-stainless-empty-object: false x-tag: Real-Time Payments Transfers x-title-plural: Real-Time Payments Transfers inbound_wire_transfer: additionalProperties: true description: An Inbound Wire Transfer is a wire transfer initiated outside of Increase to your account. example: acceptance: null account_id: account_in71c4amph0vgo2qllky account_number_id: account_number_v18nkfqm6afpsrvy82b2 amount: 100 created_at: '2020-01-31T23:59:59Z' 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 id: inbound_wire_transfer_f228m6bmhtcxjco9pwp0 input_message_accountability_data: null instructing_agent_routing_number: null instruction_identification: null reversal: null status: accepted type: inbound_wire_transfer unique_end_to_end_transaction_reference: null unstructured_remittance_information: null wire_drawdown_request_id: null properties: acceptance: anyOf: - additionalProperties: false description: If the transfer is accepted, this will contain details of the acceptance. properties: accepted_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was accepted. format: date-time type: string x-documentation-priority: default transaction_id: description: The identifier of the transaction for the accepted transfer. type: string x-documentation-priority: default x-id-reference-to: Transactions required: - accepted_at - transaction_id title: Inbound Wire Transfer Acceptance type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Acceptances - type: 'null' account_id: description: The Account to which the transfer belongs. type: string x-documentation-priority: default x-id-reference-to: Accounts account_number_id: description: The identifier of the Account Number to which this transfer was sent. type: string x-documentation-priority: default x-id-reference-to: Account Numbers amount: description: The amount 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 inbound wire transfer was created. format: date-time type: string 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' id: description: The inbound wire transfer's identifier. type: string x-documentation-priority: default x-id-reference-to: Inbound Wire Transfers 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' reversal: anyOf: - additionalProperties: false description: If the transfer is reversed, this will contain details of the reversal. properties: reason: description: The reason for the reversal. enum: - duplicate - creditor_request - transaction_forbidden type: string x-documentation-priority: default x-enum-descriptions: - The inbound wire transfer was a duplicate. - The recipient of the wire transfer requested the funds be returned to the sender. - The account cannot currently receive inbound wires. reversed_at: description: The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was reversed. format: date-time type: string x-documentation-priority: default required: - reason - reversed_at title: Inbound Wire Transfer Reversal type: object x-documentation-priority: default x-event-categories: [] x-stainless-empty-object: false x-title-plural: Reversals - type: 'null' status: description: The status of the transfer. enum: - pending - accepted - declined - reversed type: string x-documentation-priority: default x-enum-descriptions: - The Inbound Wire Transfer is awaiting action, will transition automatically if no action is taken. - The Inbound Wire Transfer is accepted. - The Inbound Wire Transfer was declined. - The Inbound Wire Transfer was reversed. type: description: A constant representing the object's type. For this resource it will always be `inbound_wire_transfer`. enum: - inbound_wire_transfer type: string x-documentation-priority: default 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' wire_drawdown_request_id: anyOf: - description: The wire drawdown request the inbound wire transfer is fulfilling. type: string x-documentation-priority: default x-id-reference-to: Wire Drawdown Requests - type: 'null' required: - type - id - amount - account_id - account_number_id - status - created_at - description - input_message_accountability_data - 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 - wire_drawdown_request_id - acceptance - reversal title: Inbound Wire Transfer type: object x-event-categories: - inbound_wire_transfer.created - inbound_wire_transfer.updated x-stainless-empty-object: false x-tag: Inbound Wire Transfers x-title-plural: Inbound Wire Transfers 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