[Skip to main content](/content/documentation/api/ach-transfers#main-content/index.html)

[Increase home](/content/site-root.html)

Docs

[Guides](/content/documentation/index.html) [API Reference](/content/documentation/api/overview/index.html) [Changelog](/content/updates?filter=Product+Updates/index.html)
Search

[Status](https://status.increase.com/) [Dashboard](https://dashboard.increase.com/)

ACH Transfers

[Guides\\
\\
Explanatory and how-to content](/content/documentation/api/ach-transfers#/index.html) [API Reference\\
\\
Technical documentation](/content/documentation/api/overview/index.html) [Changelog\\
\\
Release notes](/content/updates?filter=Changelog/index.html) [Dashboard\\
\\
Manage your account](https://dashboard.increase.com/) [Status\\
\\
Service status](https://status.increase.com/)

API Reference

Overview

[API Reference](/content/documentation/api/overview/index.html)

[Overview](/content/documentation/api/overview#api-reference/index.html) [Authorization and Testing](/content/documentation/api/overview#authorization-and-testing/index.html) [OpenAPI](/content/documentation/api/overview#openapi/index.html) [SDKs](/content/documentation/api/overview#software-development-kits/index.html) [OAuth](/content/documentation/api/overview#oauth/index.html) [Requests and Responses](/content/documentation/api/overview#requests-and-responses/index.html) [Object Lists](/content/documentation/api/overview#object-lists/index.html) [Errors](/content/documentation/api/overview#errors/index.html) [Idempotency](/content/documentation/api/overview#idempotency/index.html) [Sandbox Simulations](/content/documentation/api/overview#sandbox-simulations/index.html)

Accounts

[Accounts](/content/documentation/api/accounts/index.html)

[Overview](/content/documentation/api/accounts#accounts/index.html) [The Account object](/content/documentation/api/accounts#account-object/index.html) [List Accounts](/content/documentation/api/accounts#list-accounts/index.html) [Create an Account](/content/documentation/api/accounts#create-an-account/index.html) [Retrieve an Account](/content/documentation/api/accounts#retrieve-an-account/index.html) [Update an Account](/content/documentation/api/accounts#update-an-account/index.html) [Retrieve an Account Balance](/content/documentation/api/accounts#retrieve-an-account-balance/index.html) [Close an Account](/content/documentation/api/accounts#close-an-account/index.html) [Sandbox: Create an account revenue payment](/content/documentation/api/accounts#sandbox-create-an-account-revenue-payment/index.html) [Sandbox: Create an interest payment](/content/documentation/api/accounts#sandbox-create-an-interest-payment/index.html)

[Account Numbers](/content/documentation/api/account-numbers/index.html)

[Overview](/content/documentation/api/account-numbers#account-numbers/index.html) [The Account Number object](/content/documentation/api/account-numbers#account-number-object/index.html) [List Account Numbers](/content/documentation/api/account-numbers#list-account-numbers/index.html) [Create an Account Number](/content/documentation/api/account-numbers#create-an-account-number/index.html) [Retrieve an Account Number](/content/documentation/api/account-numbers#retrieve-an-account-number/index.html) [Update an Account Number](/content/documentation/api/account-numbers#update-an-account-number/index.html)

[Account Transfers](/content/documentation/api/account-transfers/index.html)

[Overview](/content/documentation/api/account-transfers#account-transfers/index.html) [The Account Transfer object](/content/documentation/api/account-transfers#account-transfer-object/index.html) [List Account Transfers](/content/documentation/api/account-transfers#list-account-transfers/index.html) [Create an Account Transfer](/content/documentation/api/account-transfers#create-an-account-transfer/index.html) [Retrieve an Account Transfer](/content/documentation/api/account-transfers#retrieve-an-account-transfer/index.html) [Approve an Account Transfer](/content/documentation/api/account-transfers#approve-an-account-transfer/index.html) [Cancel an Account Transfer](/content/documentation/api/account-transfers#cancel-an-account-transfer/index.html)

Transactions

[Transactions](/content/documentation/api/transactions/index.html)

[Overview](/content/documentation/api/transactions#transactions/index.html) [The Transaction object](/content/documentation/api/transactions#transaction-object/index.html) [List Transactions](/content/documentation/api/transactions#list-transactions/index.html) [Retrieve a Transaction](/content/documentation/api/transactions#retrieve-a-transaction/index.html)

[Pending Transactions](/content/documentation/api/pending-transactions/index.html)

[Overview](/content/documentation/api/pending-transactions#pending-transactions/index.html) [The Pending Transaction object](/content/documentation/api/pending-transactions#pending-transaction-object/index.html) [List Pending Transactions](/content/documentation/api/pending-transactions#list-pending-transactions/index.html) [Create a Pending Transaction](/content/documentation/api/pending-transactions#create-a-pending-transaction/index.html) [Retrieve a Pending Transaction](/content/documentation/api/pending-transactions#retrieve-a-pending-transaction/index.html) [Release a user-initiated Pending Transaction](/content/documentation/api/pending-transactions#release-a-user-initiated-pending-transaction/index.html) [Sandbox: Release an Inbound Funds Hold](/content/documentation/api/pending-transactions#sandbox-release-an-inbound-funds-hold/index.html)

[Declined Transactions](/content/documentation/api/declined-transactions/index.html)

[Overview](/content/documentation/api/declined-transactions#declined-transactions/index.html) [The Declined Transaction object](/content/documentation/api/declined-transactions#declined-transaction-object/index.html) [List Declined Transactions](/content/documentation/api/declined-transactions#list-declined-transactions/index.html) [Retrieve a Declined Transaction](/content/documentation/api/declined-transactions#retrieve-a-declined-transaction/index.html)

Ach Transfers

[ACH Transfers](/content/documentation/api/ach-transfers/index.html)

[Overview](/content/documentation/api/ach-transfers#ach-transfers/index.html) [The ACH Transfer object](/content/documentation/api/ach-transfers#ach-transfer-object/index.html) [List ACH Transfers](/content/documentation/api/ach-transfers#list-ach-transfers/index.html) [Create an ACH Transfer](/content/documentation/api/ach-transfers#create-an-ach-transfer/index.html) [Retrieve an ACH Transfer](/content/documentation/api/ach-transfers#retrieve-an-ach-transfer/index.html) [Approve an ACH Transfer](/content/documentation/api/ach-transfers#approve-an-ach-transfer/index.html) [Cancel a pending ACH Transfer](/content/documentation/api/ach-transfers#cancel-a-pending-ach-transfer/index.html) [Sandbox: Acknowledge an ACH Transfer](/content/documentation/api/ach-transfers#sandbox-acknowledge-an-ach-transfer/index.html) [Sandbox: Create a Notification of Change for an ACH Transfer](/content/documentation/api/ach-transfers#sandbox-create-a-notification-of-change-for-an-ach-transfer/index.html) [Sandbox: Return an ACH Transfer](/content/documentation/api/ach-transfers#sandbox-return-an-ach-transfer/index.html) [Sandbox: Settle an ACH Transfer](/content/documentation/api/ach-transfers#sandbox-settle-an-ach-transfer/index.html) [Sandbox: Submit an ACH Transfer](/content/documentation/api/ach-transfers#sandbox-submit-an-ach-transfer/index.html)

[Inbound ACH Transfers](/content/documentation/api/inbound-ach-transfers/index.html)

[Overview](/content/documentation/api/inbound-ach-transfers#inbound-ach-transfers/index.html) [The Inbound ACH Transfer object](/content/documentation/api/inbound-ach-transfers#inbound-ach-transfer-object/index.html) [List Inbound ACH Transfers](/content/documentation/api/inbound-ach-transfers#list-inbound-ach-transfers/index.html) [Retrieve an Inbound ACH Transfer](/content/documentation/api/inbound-ach-transfers#retrieve-an-inbound-ach-transfer/index.html) [Create a notification of change for an Inbound ACH Transfer](/content/documentation/api/inbound-ach-transfers#create-a-notification-of-change-for-an-inbound-ach-transfer/index.html) [Decline an Inbound ACH Transfer](/content/documentation/api/inbound-ach-transfers#decline-an-inbound-ach-transfer/index.html) [Return an Inbound ACH Transfer](/content/documentation/api/inbound-ach-transfers#return-an-inbound-ach-transfer/index.html) [Sandbox: Create an Inbound ACH Transfer](/content/documentation/api/inbound-ach-transfers#sandbox-create-an-inbound-ach-transfer/index.html)

[ACH Prenotifications](/content/documentation/api/ach-prenotifications/index.html)

[Overview](/content/documentation/api/ach-prenotifications#ach-prenotifications/index.html) [The ACH Prenotification object](/content/documentation/api/ach-prenotifications#ach-prenotification-object/index.html) [List ACH Prenotifications](/content/documentation/api/ach-prenotifications#list-ach-prenotifications/index.html) [Create an ACH Prenotification](/content/documentation/api/ach-prenotifications#create-an-ach-prenotification/index.html) [Retrieve an ACH Prenotification](/content/documentation/api/ach-prenotifications#retrieve-an-ach-prenotification/index.html)

Check Transfers

[Check Transfers](/content/documentation/api/check-transfers/index.html)

[Overview](/content/documentation/api/check-transfers#check-transfers/index.html) [The Check Transfer object](/content/documentation/api/check-transfers#check-transfer-object/index.html) [List Check Transfers](/content/documentation/api/check-transfers#list-check-transfers/index.html) [Create a Check Transfer](/content/documentation/api/check-transfers#create-a-check-transfer/index.html) [Retrieve a Check Transfer](/content/documentation/api/check-transfers#retrieve-a-check-transfer/index.html) [Approve a Check Transfer](/content/documentation/api/check-transfers#approve-a-check-transfer/index.html) [Cancel a pending Check Transfer](/content/documentation/api/check-transfers#cancel-a-pending-check-transfer/index.html) [Stop payment on a Check Transfer](/content/documentation/api/check-transfers#stop-payment-on-a-check-transfer/index.html) [Sandbox: Mail a Check Transfer](/content/documentation/api/check-transfers#sandbox-mail-a-check-transfer/index.html)

[Inbound Check Deposits](/content/documentation/api/inbound-check-deposits/index.html)

[Overview](/content/documentation/api/inbound-check-deposits#inbound-check-deposits/index.html) [The Inbound Check Deposit object](/content/documentation/api/inbound-check-deposits#inbound-check-deposit-object/index.html) [List Inbound Check Deposits](/content/documentation/api/inbound-check-deposits#list-inbound-check-deposits/index.html) [Retrieve an Inbound Check Deposit](/content/documentation/api/inbound-check-deposits#retrieve-an-inbound-check-deposit/index.html) [Decline an Inbound Check Deposit](/content/documentation/api/inbound-check-deposits#decline-an-inbound-check-deposit/index.html) [Return an Inbound Check Deposit](/content/documentation/api/inbound-check-deposits#return-an-inbound-check-deposit/index.html) [Sandbox: Create an Inbound Check Deposit](/content/documentation/api/inbound-check-deposits#sandbox-create-an-inbound-check-deposit/index.html) [Sandbox: Accept an Inbound Check Deposit](/content/documentation/api/inbound-check-deposits#sandbox-accept-an-inbound-check-deposit/index.html) [Sandbox: Create an Inbound Check Deposit Adjustment](/content/documentation/api/inbound-check-deposits#sandbox-create-an-inbound-check-deposit-adjustment/index.html)

[Physical Check Batches](/content/documentation/api/physical-check-batches/index.html)

[Overview](/content/documentation/api/physical-check-batches#physical-check-batches/index.html) [The Physical Check Batch object](/content/documentation/api/physical-check-batches#physical-check-batch-object/index.html) [Create a Physical Check Batch](/content/documentation/api/physical-check-batches#create-a-physical-check-batch/index.html) [Cancel a Physical Check Batch](/content/documentation/api/physical-check-batches#cancel-a-physical-check-batch/index.html) [Complete a Physical Check Batch](/content/documentation/api/physical-check-batches#complete-a-physical-check-batch/index.html)

Real Time Payments Transfers

[Real-Time Payments Transfers](/content/documentation/api/real-time-payments-transfers/index.html)

[Overview](/content/documentation/api/real-time-payments-transfers#real-time-payments-transfers/index.html) [The Real-Time Payments Transfer object](/content/documentation/api/real-time-payments-transfers#real-time-payments-transfer-object/index.html) [List Real-Time Payments Transfers](/content/documentation/api/real-time-payments-transfers#list-real-time-payments-transfers/index.html) [Create a Real-Time Payments Transfer](/content/documentation/api/real-time-payments-transfers#create-a-real-time-payments-transfer/index.html) [Retrieve a Real-Time Payments Transfer](/content/documentation/api/real-time-payments-transfers#retrieve-a-real-time-payments-transfer/index.html) [Approve a Real-Time Payments Transfer](/content/documentation/api/real-time-payments-transfers#approve-a-real-time-payments-transfer/index.html) [Cancel a pending Real-Time Payments Transfer](/content/documentation/api/real-time-payments-transfers#cancel-a-pending-real-time-payments-transfer/index.html) [Sandbox: Complete a Real-Time Payments Transfer](/content/documentation/api/real-time-payments-transfers#sandbox-complete-a-real-time-payments-transfer/index.html)

[Inbound Real-Time Payments Transfers](/content/documentation/api/inbound-real-time-payments-transfers/index.html)

[Overview](/content/documentation/api/inbound-real-time-payments-transfers#inbound-real-time-payments-transfers/index.html) [The Inbound Real-Time Payments Transfer object](/content/documentation/api/inbound-real-time-payments-transfers#inbound-real-time-payments-transfer-object/index.html) [List Inbound Real-Time Payments Transfers](/content/documentation/api/inbound-real-time-payments-transfers#list-inbound-real-time-payments-transfers/index.html) [Retrieve an Inbound Real-Time Payments Transfer](/content/documentation/api/inbound-real-time-payments-transfers#retrieve-an-inbound-real-time-payments-transfer/index.html) [Sandbox: Create an Inbound Real-Time Payments Transfer](/content/documentation/api/inbound-real-time-payments-transfers#sandbox-create-an-inbound-real-time-payments-transfer/index.html)

[Real-Time Payments Requests for Payment](/content/documentation/api/real-time-payments-requests-for-payment/index.html)

[Overview](/content/documentation/api/real-time-payments-requests-for-payment#real-time-payments-requests-for-payment/index.html) [The Real-Time Payments Request for Payment object](/content/documentation/api/real-time-payments-requests-for-payment#real-time-payments-request-for-payment-object/index.html) [List Real-Time Payments Requests for Payment](/content/documentation/api/real-time-payments-requests-for-payment#list-real-time-payments-requests-for-payment/index.html) [Create a Real-Time Payments Request for Payment](/content/documentation/api/real-time-payments-requests-for-payment#create-a-real-time-payments-request-for-payment/index.html) [Retrieve a Real-Time Payments Request for Payment](/content/documentation/api/real-time-payments-requests-for-payment#retrieve-a-real-time-payments-request-for-payment/index.html)

[Inbound Real-Time Payments Requests for Payment](/content/documentation/api/inbound-real-time-payments-requests-for-payment/index.html)

[Overview](/content/documentation/api/inbound-real-time-payments-requests-for-payment#inbound-real-time-payments-requests-for-payment/index.html) [The Inbound Real-Time Payments Request for Payment object](/content/documentation/api/inbound-real-time-payments-requests-for-payment#inbound-real-time-payments-request-for-payment-object/index.html) [List Inbound Real-Time Payments Requests for Payment](/content/documentation/api/inbound-real-time-payments-requests-for-payment#list-inbound-real-time-payments-requests-for-payment/index.html) [Retrieve an Inbound Real-Time Payments Request for Payment](/content/documentation/api/inbound-real-time-payments-requests-for-payment#retrieve-an-inbound-real-time-payments-request-for-payment/index.html)

Fednow Transfers

[FedNow Transfers](/content/documentation/api/fednow-transfers/index.html)

[Overview](/content/documentation/api/fednow-transfers#fednow-transfers/index.html) [The FedNow Transfer object](/content/documentation/api/fednow-transfers#fednow-transfer-object/index.html) [List FedNow Transfers](/content/documentation/api/fednow-transfers#list-fednow-transfers/index.html) [Create a FedNow Transfer](/content/documentation/api/fednow-transfers#create-a-fednow-transfer/index.html) [Retrieve a FedNow Transfer](/content/documentation/api/fednow-transfers#retrieve-a-fednow-transfer/index.html) [Approve a FedNow Transfer](/content/documentation/api/fednow-transfers#approve-a-fednow-transfer/index.html) [Cancel a pending FedNow Transfer](/content/documentation/api/fednow-transfers#cancel-a-pending-fednow-transfer/index.html) [Sandbox: Complete a FedNow Transfer](/content/documentation/api/fednow-transfers#sandbox-complete-a-fednow-transfer/index.html)

[Inbound FedNow Transfers](/content/documentation/api/inbound-fednow-transfers/index.html)

[Overview](/content/documentation/api/inbound-fednow-transfers#inbound-fednow-transfers/index.html) [The Inbound FedNow Transfer object](/content/documentation/api/inbound-fednow-transfers#inbound-fednow-transfer-object/index.html) [List Inbound FedNow Transfers](/content/documentation/api/inbound-fednow-transfers#list-inbound-fednow-transfers/index.html) [Retrieve an Inbound FedNow Transfer](/content/documentation/api/inbound-fednow-transfers#retrieve-an-inbound-fednow-transfer/index.html) [Sandbox: Create an Inbound FedNow Transfer](/content/documentation/api/inbound-fednow-transfers#sandbox-create-an-inbound-fednow-transfer/index.html)

Swift Transfers

[Swift Transfers](/content/documentation/api/swift-transfers/index.html)

[Overview](/content/documentation/api/swift-transfers#swift-transfers/index.html) [The Swift Transfer object](/content/documentation/api/swift-transfers#swift-transfer-object/index.html) [List Swift Transfers](/content/documentation/api/swift-transfers#list-swift-transfers/index.html) [Create a Swift Transfer](/content/documentation/api/swift-transfers#create-a-swift-transfer/index.html) [Retrieve a Swift Transfer](/content/documentation/api/swift-transfers#retrieve-a-swift-transfer/index.html) [Approve a Swift Transfer](/content/documentation/api/swift-transfers#approve-a-swift-transfer/index.html) [Cancel a pending Swift Transfer](/content/documentation/api/swift-transfers#cancel-a-pending-swift-transfer/index.html)

Wire Transfers

[Wire Transfers](/content/documentation/api/wire-transfers/index.html)

[Overview](/content/documentation/api/wire-transfers#wire-transfers/index.html) [The Wire Transfer object](/content/documentation/api/wire-transfers#wire-transfer-object/index.html) [List Wire Transfers](/content/documentation/api/wire-transfers#list-wire-transfers/index.html) [Create a Wire Transfer](/content/documentation/api/wire-transfers#create-a-wire-transfer/index.html) [Retrieve a Wire Transfer](/content/documentation/api/wire-transfers#retrieve-a-wire-transfer/index.html) [Approve a Wire Transfer](/content/documentation/api/wire-transfers#approve-a-wire-transfer/index.html) [Cancel a pending Wire Transfer](/content/documentation/api/wire-transfers#cancel-a-pending-wire-transfer/index.html) [Sandbox: Reverse a Wire Transfer](/content/documentation/api/wire-transfers#sandbox-reverse-a-wire-transfer/index.html) [Sandbox: Submit a Wire Transfer](/content/documentation/api/wire-transfers#sandbox-submit-a-wire-transfer/index.html)

[Inbound Wire Transfers](/content/documentation/api/inbound-wire-transfers/index.html)

[Overview](/content/documentation/api/inbound-wire-transfers#inbound-wire-transfers/index.html) [The Inbound Wire Transfer object](/content/documentation/api/inbound-wire-transfers#inbound-wire-transfer-object/index.html) [List Inbound Wire Transfers](/content/documentation/api/inbound-wire-transfers#list-inbound-wire-transfers/index.html) [Retrieve an Inbound Wire Transfer](/content/documentation/api/inbound-wire-transfers#retrieve-an-inbound-wire-transfer/index.html) [Reverse an Inbound Wire Transfer](/content/documentation/api/inbound-wire-transfers#reverse-an-inbound-wire-transfer/index.html) [Sandbox: Create an Inbound Wire Transfer](/content/documentation/api/inbound-wire-transfers#sandbox-create-an-inbound-wire-transfer/index.html)

[Wire Drawdown Requests](/content/documentation/api/wire-drawdown-requests/index.html)

[Overview](/content/documentation/api/wire-drawdown-requests#wire-drawdown-requests/index.html) [The Wire Drawdown Request object](/content/documentation/api/wire-drawdown-requests#wire-drawdown-request-object/index.html) [List Wire Drawdown Requests](/content/documentation/api/wire-drawdown-requests#list-wire-drawdown-requests/index.html) [Create a Wire Drawdown Request](/content/documentation/api/wire-drawdown-requests#create-a-wire-drawdown-request/index.html) [Retrieve a Wire Drawdown Request](/content/documentation/api/wire-drawdown-requests#retrieve-a-wire-drawdown-request/index.html) [Sandbox: Refuse a Wire Drawdown Request](/content/documentation/api/wire-drawdown-requests#sandbox-refuse-a-wire-drawdown-request/index.html) [Sandbox: Submit a Wire Drawdown Request](/content/documentation/api/wire-drawdown-requests#sandbox-submit-a-wire-drawdown-request/index.html)

[Inbound Wire Drawdown Requests](/content/documentation/api/inbound-wire-drawdown-requests/index.html)

[Overview](/content/documentation/api/inbound-wire-drawdown-requests#inbound-wire-drawdown-requests/index.html) [The Inbound Wire Drawdown Request object](/content/documentation/api/inbound-wire-drawdown-requests#inbound-wire-drawdown-request-object/index.html) [List Inbound Wire Drawdown Requests](/content/documentation/api/inbound-wire-drawdown-requests#list-inbound-wire-drawdown-requests/index.html) [Retrieve an Inbound Wire Drawdown Request](/content/documentation/api/inbound-wire-drawdown-requests#retrieve-an-inbound-wire-drawdown-request/index.html) [Sandbox: Create an Inbound Wire Drawdown request](/content/documentation/api/inbound-wire-drawdown-requests#sandbox-create-an-inbound-wire-drawdown-request/index.html)

Card Transfers

[Card Tokens](/content/documentation/api/card-tokens/index.html)

[Overview](/content/documentation/api/card-tokens#card-tokens/index.html) [The Card Token object](/content/documentation/api/card-tokens#card-token-object/index.html) [List Card Tokens](/content/documentation/api/card-tokens#list-card-tokens/index.html) [Retrieve a Card Token](/content/documentation/api/card-tokens#retrieve-a-card-token/index.html) [Retrieve the capabilities of a Card Token](/content/documentation/api/card-tokens#retrieve-the-capabilities-of-a-card-token/index.html) [Sandbox: Create a Card Token](/content/documentation/api/card-tokens#sandbox-create-a-card-token/index.html)

[Card Push Transfers](/content/documentation/api/card-push-transfers/index.html)

[Overview](/content/documentation/api/card-push-transfers#card-push-transfers/index.html) [The Card Push Transfer object](/content/documentation/api/card-push-transfers#card-push-transfer-object/index.html) [List Card Push Transfers](/content/documentation/api/card-push-transfers#list-card-push-transfers/index.html) [Create a Card Push Transfer](/content/documentation/api/card-push-transfers#create-a-card-push-transfer/index.html) [Retrieve a Card Push Transfer](/content/documentation/api/card-push-transfers#retrieve-a-card-push-transfer/index.html) [Approve a Card Push Transfer](/content/documentation/api/card-push-transfers#approve-a-card-push-transfer/index.html) [Cancel a pending Card Push Transfer](/content/documentation/api/card-push-transfers#cancel-a-pending-card-push-transfer/index.html)

[Card Validations](/content/documentation/api/card-validations/index.html)

[Overview](/content/documentation/api/card-validations#card-validations/index.html) [The Card Validation object](/content/documentation/api/card-validations#card-validation-object/index.html) [List Card Validations](/content/documentation/api/card-validations#list-card-validations/index.html) [Create a Card Validation](/content/documentation/api/card-validations#create-a-card-validation/index.html) [Retrieve a Card Validation](/content/documentation/api/card-validations#retrieve-a-card-validation/index.html)

Check Deposits

[Check Deposits](/content/documentation/api/check-deposits/index.html)

[Overview](/content/documentation/api/check-deposits#check-deposits/index.html) [The Check Deposit object](/content/documentation/api/check-deposits#check-deposit-object/index.html) [List Check Deposits](/content/documentation/api/check-deposits#list-check-deposits/index.html) [Create a Check Deposit](/content/documentation/api/check-deposits#create-a-check-deposit/index.html) [Retrieve a Check Deposit](/content/documentation/api/check-deposits#retrieve-a-check-deposit/index.html) [Sandbox: Adjust a Check Deposit](/content/documentation/api/check-deposits#sandbox-adjust-a-check-deposit/index.html) [Sandbox: Reject a Check Deposit](/content/documentation/api/check-deposits#sandbox-reject-a-check-deposit/index.html) [Sandbox: Return a Check Deposit](/content/documentation/api/check-deposits#sandbox-return-a-check-deposit/index.html) [Sandbox: Submit a Check Deposit](/content/documentation/api/check-deposits#sandbox-submit-a-check-deposit/index.html)

[Lockbox Addresses](/content/documentation/api/lockbox-addresses/index.html)

[Overview](/content/documentation/api/lockbox-addresses#lockbox-addresses/index.html) [The Lockbox Address object](/content/documentation/api/lockbox-addresses#lockbox-address-object/index.html) [List Lockbox Addresses](/content/documentation/api/lockbox-addresses#list-lockbox-addresses/index.html) [Create a Lockbox Address](/content/documentation/api/lockbox-addresses#create-a-lockbox-address/index.html) [Retrieve a Lockbox Address](/content/documentation/api/lockbox-addresses#retrieve-a-lockbox-address/index.html) [Update a Lockbox Address](/content/documentation/api/lockbox-addresses#update-a-lockbox-address/index.html)

[Lockbox Recipients](/content/documentation/api/lockbox-recipients/index.html)

[Overview](/content/documentation/api/lockbox-recipients#lockbox-recipients/index.html) [The Lockbox Recipient object](/content/documentation/api/lockbox-recipients#lockbox-recipient-object/index.html) [List Lockbox Recipients](/content/documentation/api/lockbox-recipients#list-lockbox-recipients/index.html) [Create a Lockbox Recipient](/content/documentation/api/lockbox-recipients#create-a-lockbox-recipient/index.html) [Retrieve a Lockbox Recipient](/content/documentation/api/lockbox-recipients#retrieve-a-lockbox-recipient/index.html) [Update a Lockbox Recipient](/content/documentation/api/lockbox-recipients#update-a-lockbox-recipient/index.html)

[Inbound Mail Items](/content/documentation/api/inbound-mail-items/index.html)

[Overview](/content/documentation/api/inbound-mail-items#inbound-mail-items/index.html) [The Inbound Mail Item object](/content/documentation/api/inbound-mail-items#inbound-mail-item-object/index.html) [List Inbound Mail Items](/content/documentation/api/inbound-mail-items#list-inbound-mail-items/index.html) [Retrieve an Inbound Mail Item](/content/documentation/api/inbound-mail-items#retrieve-an-inbound-mail-item/index.html) [Action an Inbound Mail Item](/content/documentation/api/inbound-mail-items#action-an-inbound-mail-item/index.html) [Sandbox: Create an Inbound Mail Item](/content/documentation/api/inbound-mail-items#sandbox-create-an-inbound-mail-item/index.html)

Cards

[Cards](/content/documentation/api/cards/index.html)

[Overview](/content/documentation/api/cards#cards/index.html) [The Card object](/content/documentation/api/cards#card-object/index.html) [List Cards](/content/documentation/api/cards#list-cards/index.html) [Create a Card](/content/documentation/api/cards#create-a-card/index.html) [Retrieve a Card](/content/documentation/api/cards#retrieve-a-card/index.html) [Update a Card](/content/documentation/api/cards#update-a-card/index.html) [Create a Card details iframe](/content/documentation/api/cards#create-a-card-details-iframe/index.html) [Retrieve sensitive details for a Card](/content/documentation/api/cards#retrieve-sensitive-details-for-a-card/index.html) [Update a Card's PIN](/content/documentation/api/cards#update-a-card-s-pin/index.html)

[Card Payments](/content/documentation/api/card-payments/index.html)

[Overview](/content/documentation/api/card-payments#card-payments/index.html) [The Card Payment object](/content/documentation/api/card-payments#card-payment-object/index.html) [List Card Payments](/content/documentation/api/card-payments#list-card-payments/index.html) [Retrieve a Card Payment](/content/documentation/api/card-payments#retrieve-a-card-payment/index.html) [Sandbox: Create a Card Authentication attempt](/content/documentation/api/card-payments#sandbox-create-a-card-authentication-attempt/index.html) [Sandbox: Create a Card Authentication Challenge attempt](/content/documentation/api/card-payments#sandbox-create-a-card-authentication-challenge-attempt/index.html) [Sandbox: Create an initial Card Authentication Challenge](/content/documentation/api/card-payments#sandbox-create-an-initial-card-authentication-challenge/index.html) [Sandbox: Expire a Card Authorization](/content/documentation/api/card-payments#sandbox-expire-a-card-authorization/index.html) [Sandbox: Create a Card Authorization](/content/documentation/api/card-payments#sandbox-create-a-card-authorization/index.html) [Sandbox: Create a Card Balance Inquiry](/content/documentation/api/card-payments#sandbox-create-a-card-balance-inquiry/index.html) [Sandbox: Confirm the fuel pump amount for a Card Authorization](/content/documentation/api/card-payments#sandbox-confirm-the-fuel-pump-amount-for-a-card-authorization/index.html) [Sandbox: Increment a Card Authorization](/content/documentation/api/card-payments#sandbox-increment-a-card-authorization/index.html) [Sandbox: Refund a card transaction](/content/documentation/api/card-payments#sandbox-refund-a-card-transaction/index.html) [Sandbox: Reverse a Card Authorization](/content/documentation/api/card-payments#sandbox-reverse-a-card-authorization/index.html) [Sandbox: Settle a Card Authorization](/content/documentation/api/card-payments#sandbox-settle-a-card-authorization/index.html)

[Card Purchase Supplements](/content/documentation/api/card-purchase-supplements/index.html)

[Overview](/content/documentation/api/card-purchase-supplements#card-purchase-supplements/index.html) [The Card Purchase Supplement object](/content/documentation/api/card-purchase-supplements#card-purchase-supplement-object/index.html) [List Card Purchase Supplements](/content/documentation/api/card-purchase-supplements#list-card-purchase-supplements/index.html) [Retrieve a Card Purchase Supplement](/content/documentation/api/card-purchase-supplements#retrieve-a-card-purchase-supplement/index.html) [Sandbox: Create a Card Purchase Supplement](/content/documentation/api/card-purchase-supplements#sandbox-create-a-card-purchase-supplement/index.html)

[Card Disputes](/content/documentation/api/card-disputes/index.html)

[Overview](/content/documentation/api/card-disputes#card-disputes/index.html) [The Card Dispute object](/content/documentation/api/card-disputes#card-dispute-object/index.html) [List Card Disputes](/content/documentation/api/card-disputes#list-card-disputes/index.html) [Create a Card Dispute](/content/documentation/api/card-disputes#create-a-card-dispute/index.html) [Retrieve a Card Dispute](/content/documentation/api/card-disputes#retrieve-a-card-dispute/index.html) [Submit a User Submission for a Card Dispute](/content/documentation/api/card-disputes#submit-a-user-submission-for-a-card-dispute/index.html) [Withdraw a Card Dispute](/content/documentation/api/card-disputes#withdraw-a-card-dispute/index.html) [Sandbox: Advance the state of a Card Dispute](/content/documentation/api/card-disputes#sandbox-advance-the-state-of-a-card-dispute/index.html)

[Physical Cards](/content/documentation/api/physical-cards/index.html)

[Overview](/content/documentation/api/physical-cards#physical-cards/index.html) [The Physical Card object](/content/documentation/api/physical-cards#physical-card-object/index.html) [List Physical Cards](/content/documentation/api/physical-cards#list-physical-cards/index.html) [Create a Physical Card](/content/documentation/api/physical-cards#create-a-physical-card/index.html) [Retrieve a Physical Card](/content/documentation/api/physical-cards#retrieve-a-physical-card/index.html) [Update a Physical Card](/content/documentation/api/physical-cards#update-a-physical-card/index.html) [Sandbox: Advance the shipment status of a Physical Card](/content/documentation/api/physical-cards#sandbox-advance-the-shipment-status-of-a-physical-card/index.html) [Sandbox: Create a Physical Card Shipment Tracking Update](/content/documentation/api/physical-cards#sandbox-create-a-physical-card-shipment-tracking-update/index.html)

[Digital Card Profiles](/content/documentation/api/digital-card-profiles/index.html)

[Overview](/content/documentation/api/digital-card-profiles#digital-card-profiles/index.html) [The Digital Card Profile object](/content/documentation/api/digital-card-profiles#digital-card-profile-object/index.html) [List Card Profiles](/content/documentation/api/digital-card-profiles#list-card-profiles/index.html) [Create a Digital Card Profile](/content/documentation/api/digital-card-profiles#create-a-digital-card-profile/index.html) [Retrieve a Digital Card Profile](/content/documentation/api/digital-card-profiles#retrieve-a-digital-card-profile/index.html) [Archive a Digital Card Profile](/content/documentation/api/digital-card-profiles#archive-a-digital-card-profile/index.html) [Clones a Digital Card Profile](/content/documentation/api/digital-card-profiles#clones-a-digital-card-profile/index.html)

[Physical Card Profiles](/content/documentation/api/physical-card-profiles/index.html)

[Overview](/content/documentation/api/physical-card-profiles#physical-card-profiles/index.html) [The Physical Card Profile object](/content/documentation/api/physical-card-profiles#physical-card-profile-object/index.html) [List Physical Card Profiles](/content/documentation/api/physical-card-profiles#list-physical-card-profiles/index.html) [Create a Physical Card Profile](/content/documentation/api/physical-card-profiles#create-a-physical-card-profile/index.html) [Retrieve a Card Profile](/content/documentation/api/physical-card-profiles#retrieve-a-card-profile/index.html) [Archive a Physical Card Profile](/content/documentation/api/physical-card-profiles#archive-a-physical-card-profile/index.html) [Clone a Physical Card Profile](/content/documentation/api/physical-card-profiles#clone-a-physical-card-profile/index.html)

[Digital Wallet Tokens](/content/documentation/api/digital-wallet-tokens/index.html)

[Overview](/content/documentation/api/digital-wallet-tokens#digital-wallet-tokens/index.html) [The Digital Wallet Token object](/content/documentation/api/digital-wallet-tokens#digital-wallet-token-object/index.html) [List Digital Wallet Tokens](/content/documentation/api/digital-wallet-tokens#list-digital-wallet-tokens/index.html) [Retrieve a Digital Wallet Token](/content/documentation/api/digital-wallet-tokens#retrieve-a-digital-wallet-token/index.html) [Sandbox: Create a digital wallet token request](/content/documentation/api/digital-wallet-tokens#sandbox-create-a-digital-wallet-token-request/index.html)

Compliance

[Entities](/content/documentation/api/entities/index.html)

[Overview](/content/documentation/api/entities#entities/index.html) [The Entity object](/content/documentation/api/entities#entity-object/index.html) [List Entities](/content/documentation/api/entities#list-entities/index.html) [Create an Entity](/content/documentation/api/entities#create-an-entity/index.html) [Retrieve an Entity](/content/documentation/api/entities#retrieve-an-entity/index.html) [Update an Entity](/content/documentation/api/entities#update-an-entity/index.html) [Archive an Entity](/content/documentation/api/entities#archive-an-entity/index.html) [Sandbox: Simulate validation of an Entity](/content/documentation/api/entities#sandbox-simulate-validation-of-an-entity/index.html)

[Beneficial Owners](/content/documentation/api/beneficial-owners/index.html)

[Overview](/content/documentation/api/beneficial-owners#beneficial-owners/index.html) [The Beneficial Owner object](/content/documentation/api/beneficial-owners#beneficial-owner-object/index.html) [List Beneficial Owners](/content/documentation/api/beneficial-owners#list-beneficial-owners/index.html) [Create a Beneficial Owner](/content/documentation/api/beneficial-owners#create-a-beneficial-owner/index.html) [Retrieve a Beneficial Owner](/content/documentation/api/beneficial-owners#retrieve-a-beneficial-owner/index.html) [Update a Beneficial Owner](/content/documentation/api/beneficial-owners#update-a-beneficial-owner/index.html) [Archive a Beneficial Owner](/content/documentation/api/beneficial-owners#archive-a-beneficial-owner/index.html)

[Supplemental Documents](/content/documentation/api/supplemental-documents/index.html)

[Overview](/content/documentation/api/supplemental-documents#supplemental-documents/index.html) [The Supplemental Document object](/content/documentation/api/supplemental-documents#supplemental-document-object/index.html) [List Entity Supplemental Document Submissions](/content/documentation/api/supplemental-documents#list-entity-supplemental-document-submissions/index.html) [Create a supplemental document for an Entity](/content/documentation/api/supplemental-documents#create-a-supplemental-document-for-an-entity/index.html)

[Entity Onboarding Sessions](/content/documentation/api/entity-onboarding-sessions/index.html)

[Overview](/content/documentation/api/entity-onboarding-sessions#entity-onboarding-sessions/index.html) [The Entity Onboarding Session object](/content/documentation/api/entity-onboarding-sessions#entity-onboarding-session-object/index.html) [List Entity Onboarding Session](/content/documentation/api/entity-onboarding-sessions#list-entity-onboarding-session/index.html) [Create an Entity Onboarding Session](/content/documentation/api/entity-onboarding-sessions#create-an-entity-onboarding-session/index.html) [Retrieve an Entity Onboarding Session](/content/documentation/api/entity-onboarding-sessions#retrieve-an-entity-onboarding-session/index.html) [Expire an Entity Onboarding Session](/content/documentation/api/entity-onboarding-sessions#expire-an-entity-onboarding-session/index.html) [Sandbox: Submit an Entity Onboarding Session](/content/documentation/api/entity-onboarding-sessions#sandbox-submit-an-entity-onboarding-session/index.html)

[Programs](/content/documentation/api/programs/index.html)

[Overview](/content/documentation/api/programs#programs/index.html) [The Program object](/content/documentation/api/programs#program-object/index.html) [List Programs](/content/documentation/api/programs#list-programs/index.html) [Retrieve a Program](/content/documentation/api/programs#retrieve-a-program/index.html) [Sandbox: Create a Program](/content/documentation/api/programs#sandbox-create-a-program/index.html)

Events and Webhooks

[Events](/content/documentation/api/events/index.html)

[Overview](/content/documentation/api/events#events/index.html) [The Event object](/content/documentation/api/events#event-object/index.html) [List Events](/content/documentation/api/events#list-events/index.html) [Retrieve an Event](/content/documentation/api/events#retrieve-an-event/index.html)

[Event Subscriptions](/content/documentation/api/event-subscriptions/index.html)

[Overview](/content/documentation/api/event-subscriptions#event-subscriptions/index.html) [The Event Subscription object](/content/documentation/api/event-subscriptions#event-subscription-object/index.html) [List Event Subscriptions](/content/documentation/api/event-subscriptions#list-event-subscriptions/index.html) [Create an Event Subscription](/content/documentation/api/event-subscriptions#create-an-event-subscription/index.html) [Retrieve an Event Subscription](/content/documentation/api/event-subscriptions#retrieve-an-event-subscription/index.html) [Update an Event Subscription](/content/documentation/api/event-subscriptions#update-an-event-subscription/index.html)

[Real-Time Decisions](/content/documentation/api/real-time-decisions/index.html)

[Overview](/content/documentation/api/real-time-decisions#real-time-decisions/index.html) [The Real-Time Decision object](/content/documentation/api/real-time-decisions#real-time-decision-object/index.html) [Retrieve a Real-Time Decision](/content/documentation/api/real-time-decisions#retrieve-a-real-time-decision/index.html) [Action a Real-Time Decision](/content/documentation/api/real-time-decisions#action-a-real-time-decision/index.html)

External Accounts

[Routing Numbers](/content/documentation/api/routing-numbers/index.html)

[Overview](/content/documentation/api/routing-numbers#routing-numbers/index.html) [The Routing Number object](/content/documentation/api/routing-numbers#routing-number-object/index.html) [List Routing Numbers](/content/documentation/api/routing-numbers#list-routing-numbers/index.html)

[External Accounts](/content/documentation/api/external-accounts/index.html)

[Overview](/content/documentation/api/external-accounts#external-accounts/index.html) [The External Account object](/content/documentation/api/external-accounts#external-account-object/index.html) [List External Accounts](/content/documentation/api/external-accounts#list-external-accounts/index.html) [Create an External Account](/content/documentation/api/external-accounts#create-an-external-account/index.html) [Retrieve an External Account](/content/documentation/api/external-accounts#retrieve-an-external-account/index.html) [Update an External Account](/content/documentation/api/external-accounts#update-an-external-account/index.html)

Files and Exports

[Account Statements](/content/documentation/api/account-statements/index.html)

[Overview](/content/documentation/api/account-statements#account-statements/index.html) [The Account Statement object](/content/documentation/api/account-statements#account-statement-object/index.html) [List Account Statements](/content/documentation/api/account-statements#list-account-statements/index.html) [Retrieve an Account Statement](/content/documentation/api/account-statements#retrieve-an-account-statement/index.html) [Sandbox: Create an Account Statement](/content/documentation/api/account-statements#sandbox-create-an-account-statement/index.html)

[Files](/content/documentation/api/files/index.html)

[Overview](/content/documentation/api/files#files/index.html) [The File object](/content/documentation/api/files#file-object/index.html) [List Files](/content/documentation/api/files#list-files/index.html) [Create a File](/content/documentation/api/files#create-a-file/index.html) [Retrieve a File](/content/documentation/api/files#retrieve-a-file/index.html) [Get File Contents](/content/documentation/api/files#get-file-contents/index.html)

[File Links](/content/documentation/api/file-links/index.html)

[Overview](/content/documentation/api/file-links#file-links/index.html) [The File Link object](/content/documentation/api/file-links#file-link-object/index.html) [Create a File Link](/content/documentation/api/file-links#create-a-file-link/index.html)

[Exports](/content/documentation/api/exports/index.html)

[Overview](/content/documentation/api/exports#exports/index.html) [The Export object](/content/documentation/api/exports#export-object/index.html) [List Exports](/content/documentation/api/exports#list-exports/index.html) [Create an Export](/content/documentation/api/exports#create-an-export/index.html) [Retrieve an Export](/content/documentation/api/exports#retrieve-an-export/index.html) [Sandbox: Generate a Tax Form Export](/content/documentation/api/exports#sandbox-generate-a-tax-form-export/index.html)

OAuth

[Groups](/content/documentation/api/groups/index.html)

[Overview](/content/documentation/api/groups#groups/index.html) [The Group object](/content/documentation/api/groups#group-object/index.html) [Retrieve Group details](/content/documentation/api/groups#retrieve-group-details/index.html)

[OAuth Applications](/content/documentation/api/oauth-applications/index.html)

[Overview](/content/documentation/api/oauth-applications#oauth-applications/index.html) [The OAuth Application object](/content/documentation/api/oauth-applications#oauth-application-object/index.html) [List OAuth Applications](/content/documentation/api/oauth-applications#list-oauth-applications/index.html) [Retrieve an OAuth Application](/content/documentation/api/oauth-applications#retrieve-an-oauth-application/index.html)

[OAuth Connections](/content/documentation/api/oauth-connections/index.html)

[Overview](/content/documentation/api/oauth-connections#oauth-connections/index.html) [The OAuth Connection object](/content/documentation/api/oauth-connections#oauth-connection-object/index.html) [List OAuth Connections](/content/documentation/api/oauth-connections#list-oauth-connections/index.html) [Retrieve an OAuth Connection](/content/documentation/api/oauth-connections#retrieve-an-oauth-connection/index.html)

[OAuth Tokens](/content/documentation/api/oauth-tokens/index.html)

[Overview](/content/documentation/api/oauth-tokens#oauth-tokens/index.html) [The OAuth Token object](/content/documentation/api/oauth-tokens#oauth-token-object/index.html) [Create an OAuth Token](/content/documentation/api/oauth-tokens#create-an-oauth-token/index.html)

Intrafi

[IntraFi Account Enrollments](/content/documentation/api/intrafi-account-enrollments/index.html)

[Overview](/content/documentation/api/intrafi-account-enrollments#intrafi-account-enrollments/index.html) [The IntraFi Account Enrollment object](/content/documentation/api/intrafi-account-enrollments#intrafi-account-enrollment-object/index.html) [List IntraFi Account Enrollments](/content/documentation/api/intrafi-account-enrollments#list-intrafi-account-enrollments/index.html) [Enroll an account in the IntraFi deposit sweep network](/content/documentation/api/intrafi-account-enrollments#enroll-an-account-in-the-intrafi-deposit-sweep-network/index.html) [Get an IntraFi Account Enrollment](/content/documentation/api/intrafi-account-enrollments#get-an-intrafi-account-enrollment/index.html) [Unenroll an account from IntraFi](/content/documentation/api/intrafi-account-enrollments#unenroll-an-account-from-intrafi/index.html)

[IntraFi Balances](/content/documentation/api/intrafi-balances/index.html)

[Overview](/content/documentation/api/intrafi-balances#intrafi-balances/index.html) [The IntraFi Balance object](/content/documentation/api/intrafi-balances#intrafi-balance-object/index.html) [Get IntraFi balance](/content/documentation/api/intrafi-balances#get-intrafi-balance/index.html)

[IntraFi Exclusions](/content/documentation/api/intrafi-exclusions/index.html)

[Overview](/content/documentation/api/intrafi-exclusions#intrafi-exclusions/index.html) [The IntraFi Exclusion object](/content/documentation/api/intrafi-exclusions#intrafi-exclusion-object/index.html) [List IntraFi Exclusions](/content/documentation/api/intrafi-exclusions#list-intrafi-exclusions/index.html) [Create an IntraFi Exclusion](/content/documentation/api/intrafi-exclusions#create-an-intrafi-exclusion/index.html) [Get an IntraFi Exclusion](/content/documentation/api/intrafi-exclusions#get-an-intrafi-exclusion/index.html) [Archive an IntraFi Exclusion](/content/documentation/api/intrafi-exclusions#archive-an-intrafi-exclusion/index.html)

ACH Transfers

Copy for LLM

ACH transfers move funds between your Increase account and any other account accessible by the Automated Clearing House (ACH).

Events

Your application can listen to [webhooks](/content/documentation/api/events/index.html)
about this resource.
The events about ACH Transfers will
have the categories "ach\_transfer.created" or "ach\_transfer.updated"
.

The ACH Transfer object

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

```
{
  "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"
}
```

Attributes

account\_id

string

The Account to which the transfer belongs.

More about [Accounts](/content/documentation/api/accounts/index.html).

account\_number

string

The receiver’s account number.

acknowledgement

dictionary

Nullable

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.

Child attributes

addenda

dictionary

Nullable

Additional information that will be sent to the recipient.

Child attributes

amount

integer

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.

approval

dictionary

Nullable

If your account requires approvals for transfers and the transfer was approved, this will contain details of the approval.

Child attributes

cancellation

dictionary

Nullable

If your account requires approvals for transfers and the transfer was not approved, this will contain details of the cancellation.

Child attributes

company\_descriptive\_date

string

Nullable

The description of the date of the transfer.

company\_discretionary\_data

string

Nullable

The data you chose to associate with the transfer.

company\_entry\_description

string

Nullable

The description of the transfer you set to be shown to the recipient.

company\_id

string

The company ID associated with the transfer.

company\_name

string

Nullable

The name by which the recipient knows you.

created\_at

string

The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the transfer was created.

created\_by

dictionary

Nullable

What object created the transfer, either via the API or the dashboard.

Child attributes

currency

enum

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`.

Possible values

destination\_account\_holder

enum

The type of entity that owns the receiver’s account.

Possible values

external\_account\_id

string

Nullable

The identifier of the External Account the transfer was made to, if any.

More about [External Accounts](/content/documentation/api/external-accounts/index.html).

funding

enum

The type of the receiver’s bank account.

Possible values

id

string

The ACH transfer’s identifier.

idempotency\_key

string

Nullable

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](/content/documentation/idempotency-keys/index.html).

inbound\_funds\_hold

dictionary

Nullable

Increase will sometimes hold the funds for ACH debit transfers. If funds are held, this sub-object will contain details of the hold.

Child attributes

individual\_id

string

Nullable

Your internal identifier for the transfer recipient. This value is informational and not verified by the recipient’s bank.

individual\_name

string

Nullable

The name of the transfer recipient. This value is informational and not verified by the recipient’s bank.

network

string

The transfer’s network.

notifications\_of\_change

array

If the receiving bank notifies that future transfers should use different details, this will contain those details.

Child attributes

pending\_transaction\_id

string

Nullable

The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer [requires approval](/content/documentation/transfer-approvals#transfer-approvals/index.html) by someone else in your organization.

More about [Pending Transactions](/content/documentation/api/pending-transactions/index.html).

preferred\_effective\_date

dictionary

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.

Child attributes

return

dictionary

Nullable

If your transfer is returned, this will contain details of the return.

Child attributes

routing\_number

string

The American Bankers’ Association (ABA) Routing Transit Number (RTN) of the receiver’s bank.

settlement

dictionary

Nullable

A subhash containing information about when and how the transfer settled at the Federal Reserve.

Child attributes

standard\_entry\_class\_code

enum

The [Standard Entry Class (SEC) code](/content/documentation/ach-standard-entry-class-codes/index.html) to use for the transfer.

Possible values

statement\_descriptor

string

The descriptor that will show on the recipient’s bank statement.

status

enum

The lifecycle status of the transfer.

Possible values

submission

dictionary

Nullable

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).

Child attributes

transaction\_id

string

Nullable

The ID for the transaction funding the transfer.

More about [Transactions](/content/documentation/api/transactions/index.html).

type

string

A constant representing the object’s type. For this resource it will always be `ach_transfer`.

List ACH Transfers

cURL  TypeScript  Python  Ruby  Go  Java  Kotlin  PHP  C#

1

2

3

```
curl \
  --url "${INCREASE_URL}/ach_transfers?account_id=account_in71c4amph0vgo2qllky" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```

1

2

3

4

5

6

7

8

9

10

```
import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

// Automatically fetches more pages as needed.
for await (const achTransfer of client.achTransfers.list()) {
  console.log(achTransfer.id);
}
```

1

2

3

4

5

6

7

8

9

```
import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
page = client.ach_transfers.list()
page = page.data[0]
print(page.id)
```

1

2

3

4

5

6

7

8

9

```
require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

page = increase.ach_transfers.list

puts(page)
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

```
package main

import (
	"context"
	"fmt"
	"os"

"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	page, err := client.ACHTransfers.List(context.TODO(), increase.ACHTransferListParams{})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", page)
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

```
package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.achtransfers.AchTransferListPage;
import com.increase.api.models.achtransfers.AchTransferListParams;

public final class Main {
    private Main() {}

public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

AchTransferListPage page = client.achTransfers().list();
    }
}
```

1

2

3

4

5

6

7

8

9

10

11

12

```
package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.achtransfers.AchTransferListPage
import com.increase.api.models.achtransfers.AchTransferListParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

val page: AchTransferListPage = client.achTransfers().list()
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

```
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $page = $client->achTransfers->list(
    accountID: 'account_id',
    createdAt: [\
      'after' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),\
      'before' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),\
      'onOrAfter' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),\
      'onOrBefore' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),\
    ],
    cursor: 'cursor',
    externalAccountID: 'external_account_id',
    idempotencyKey: 'x',
    limit: 1,
    status: ['in' => ['pending_approval']],
  );

var_dump($page);
} catch (APIException $e) {
  echo $e->getMessage();
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

```
using System;
using Increase.Api;
using Increase.Api.Models.AchTransfers;

IncreaseClient client = new();

AchTransferListParams parameters = new();

var page = await client.AchTransfers.List(parameters);
await foreach (var item in page.Paginate())
{
    Console.WriteLine(item);
}
```

Returns a [list response](/content/documentation/api/overview#object-lists/index.html)
:

1

2

3

4

5

6

7

8

```
{
  "data": [\
    { /* ACH Transfer object */ },\
    { /* ACH Transfer object */ }\
    /* ... */\
  ],
  "next_cursor": "v57w5d",
}
```

Parameters

account\_id

string

Filter ACH Transfers to those that originated from the specified Account.

More about [Accounts](/content/documentation/api/accounts/index.html).

external\_account\_id

string

Filter ACH Transfers to those made to the specified External Account.

More about [External Accounts](/content/documentation/api/external-accounts/index.html).

idempotency\_key

string

Filter records to the one with the specified `idempotency_key` you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](/content/documentation/idempotency-keys/index.html).

Between 1 and 200 characters

status.in

array of strings

Return results whose value is in the provided list. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`.

Possible values

More parameters

Expand all

cursor

string

limit

integer

created\_at.after

string

created\_at.before

string

created\_at.on\_or\_after

string

created\_at.on\_or\_before

string

Create an ACH Transfer

cURL  TypeScript  Python  Ruby  Go  Java  Kotlin  PHP  C#

1

2

3

4

5

6

7

8

9

10

11

```
curl -X "POST" \
  --url "${INCREASE_URL}/ach_transfers" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "account_id": "account_in71c4amph0vgo2qllky",
    "account_number": "987654321",
    "amount": 100,
    "routing_number": "101050001",
    "statement_descriptor": "New ACH transfer"
  }'
```

1

2

3

4

5

6

7

8

9

10

11

12

13

```
import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const achTransfer = await client.achTransfers.create({
  account_id: 'account_in71c4amph0vgo2qllky',
  amount: 100,
  statement_descriptor: 'New ACH transfer',
});

console.log(achTransfer.id);
```

1

2

3

4

5

6

7

8

9

10

11

12

```
import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
ach_transfer = client.ach_transfers.create(
    account_id="account_in71c4amph0vgo2qllky",
    amount=100,
    statement_descriptor="New ACH transfer",
)
print(ach_transfer.id)
```

1

2

3

4

5

6

7

8

9

10

11

12

13

```
require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

ach_transfer = increase.ach_transfers.create(
  account_id: "account_in71c4amph0vgo2qllky",
  amount: 100,
  statement_descriptor: "New ACH transfer"
)

puts(ach_transfer)
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

```
package main

import (
	"context"
	"fmt"
	"os"

"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	achTransfer, err := client.ACHTransfers.New(context.TODO(), increase.ACHTransferNewParams{
		AccountID:           increase.F("account_in71c4amph0vgo2qllky"),
		Amount:              increase.F(int64(100)),
		StatementDescriptor: increase.F("New ACH transfer"),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", achTransfer.ID)
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

```
package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.achtransfers.AchTransfer;
import com.increase.api.models.achtransfers.AchTransferCreateParams;

public final class Main {
    private Main() {}

public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

AchTransferCreateParams params = AchTransferCreateParams.builder()
            .accountId("account_in71c4amph0vgo2qllky")
            .amount(100L)
            .statementDescriptor("New ACH transfer")
            .build();
        AchTransfer achTransfer = client.achTransfers().create(params);
    }
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

```
package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.achtransfers.AchTransfer
import com.increase.api.models.achtransfers.AchTransferCreateParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

val params: AchTransferCreateParams = AchTransferCreateParams.builder()
        .accountId("account_in71c4amph0vgo2qllky")
        .amount(100L)
        .statementDescriptor("New ACH transfer")
        .build()
    val achTransfer: AchTransfer = client.achTransfers().create(params)
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

```
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $achTransfer = $client->achTransfers->create(
    accountID: 'account_in71c4amph0vgo2qllky',
    amount: 100,
    statementDescriptor: 'New ACH transfer',
    accountNumber: '987654321',
    addenda: [\
      'category' => 'freeform',\
      'freeform' => [\
        'entries' => [\
          ['paymentRelatedInformation' => 'payment_related_information']\
        ],\
      ],\
      'paymentOrderRemittanceAdvice' => [\
        'invoices' => [['invoiceNumber' => 'sq', 'paidAmount' => 0]]\
      ],\
    ],
    companyDescriptiveDate: 'J!',
    companyDiscretionaryData: 'J!',
    companyEntryDescription: 'J!',
    companyName: 'company_name',
    destinationAccountHolder: 'business',
    externalAccountID: 'external_account_id',
    funding: 'checking',
    individualID: 'individual_id',
    individualName: 'individual_name',
    preferredEffectiveDate: [\
      'date' => '2019-12-27', 'settlementSchedule' => 'same_day'\
    ],
    requireApproval: true,
    routingNumber: '101050001',
    standardEntryClassCode: 'corporate_credit_or_debit',
  );

var_dump($achTransfer);
} catch (APIException $e) {
  echo $e->getMessage();
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

```
using System;
using Increase.Api;
using Increase.Api.Models.AchTransfers;

IncreaseClient client = new();

AchTransferCreateParams parameters = new()
{
    AccountID = "account_in71c4amph0vgo2qllky",
    Amount = 100,
    StatementDescriptor = "New ACH transfer",
};

var achTransfer = await client.AchTransfers.Create(parameters);

Console.WriteLine(achTransfer);
```

Parameters

account\_id

string

Required

The Increase identifier for the account that will send the transfer.

More about [Accounts](/content/documentation/api/accounts/index.html).

account\_number

string

The receiver’s account number. For credit transfers (positive `amount`) this is the account that funds will be sent to. For debit transfers (negative `amount`) this is the account that funds will be pulled from.

Between 1 and 17 characters, character restrictions apply

addenda

dictionary

Additional information passed through to the receiving bank with the transfer. Most ACH transfers do not need this. Only set this if your recipient has asked for addendum data, typically unstructured remittance information. Corporate Trade Exchange (CTX) flows can carry structured X12 remittance advice instead.

Child attributes

amount

integer

Required

The transfer amount in USD 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.

company\_descriptive\_date

string

A description of the transfer date (typically `YYMMDD`), sent in the company batch header. This value is informational and does not affect funds movement, settlement timing, or returns. Only set this if your recipient has asked for it.

Between 1 and 6 characters, character restrictions apply

company\_discretionary\_data

string

Custom data sent in the company batch header. This value is informational and does not affect funds movement, settlement timing, or returns. Most ACH transfers do not need this. Only set this if your recipient has asked for it.

Between 1 and 20 characters, character restrictions apply

company\_entry\_description

string

A short description sent in the company batch header. Most receivers do not surface this. Only set this if your recipient has asked for a specific value or if Nacha mandates one for your Standard Entry Class (SEC) code and use case. For example, Prearranged Payment and Deposit (PPD) payroll credits must use `PAYROLL`, and reversals must use `REVERSAL`.

Between 1 and 10 characters, character restrictions apply

company\_name

string

The name by which the recipient knows you, sent in the company batch header. We recommend setting this on every transfer; if you do not, we fall back to the ACH company name configured on your account.

Between 1 and 16 characters, character restrictions apply

destination\_account\_holder

enum

The type of entity that owns the receiver’s account.

Possible values

external\_account\_id

string

The ID of an External Account to initiate a transfer to. If this parameter is provided, `account_number`, `routing_number`, and `funding` must be absent.

More about [External Accounts](/content/documentation/api/external-accounts/index.html).

funding

enum

The type of the receiver’s bank account.

Defaults to `checking`

Possible values

individual\_id

string

Your internal identifier for the transfer recipient. This value is informational and not verified by the recipient’s bank. Most callers can leave this unset.

Between 1 and 15 characters, character restrictions apply

individual\_name

string

The name of the transfer recipient. This value is informational and not verified by the recipient’s bank.

Between 1 and 22 characters, character restrictions apply

preferred\_effective\_date

dictionary

Child attributes

require\_approval

boolean

Whether the transfer requires explicit approval via the dashboard or API.

routing\_number

string

The American Bankers’ Association (ABA) Routing Transit Number (RTN) of the receiver’s bank.

Exactly 9 characters, character restrictions apply

standard\_entry\_class\_code

enum

The [Standard Entry Class (SEC) code](/content/documentation/ach-standard-entry-class-codes/index.html) to use for the transfer. If not provided, the default is `corporate_credit_or_debit`.

Possible values

statement\_descriptor

string

Required

A description you choose to give the transfer. This will be saved with the transfer details, displayed in the dashboard, and returned by the API. If `individual_name` and `company_name` are not explicitly set by this API, the `statement_descriptor` will be sent in those fields to the receiving bank to help the customer recognize the transfer. You are highly encouraged to pass `individual_name` and `company_name` instead of relying on this fallback.

Between 1 and 200 characters, character restrictions apply

Retrieve an ACH Transfer

cURL  TypeScript  Python  Ruby  Go  Java  Kotlin  PHP  C#

1

2

3

```
curl \
  --url "${INCREASE_URL}/ach_transfers/ach_transfer_uoxatyh3lt5evrsdvo7q" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```

1

2

3

4

5

6

7

8

9

```
import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const achTransfer = await client.achTransfers.retrieve('ach_transfer_uoxatyh3lt5evrsdvo7q');

console.log(achTransfer.id);
```

1

2

3

4

5

6

7

8

9

10

```
import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
ach_transfer = client.ach_transfers.retrieve(
    "ach_transfer_uoxatyh3lt5evrsdvo7q",
)
print(ach_transfer.id)
```

1

2

3

4

5

6

7

8

9

```
require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

ach_transfer = increase.ach_transfers.retrieve("ach_transfer_uoxatyh3lt5evrsdvo7q")

puts(ach_transfer)
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

```
package main

import (
	"context"
	"fmt"
	"os"

"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	achTransfer, err := client.ACHTransfers.Get(context.TODO(), "ach_transfer_uoxatyh3lt5evrsdvo7q")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", achTransfer.ID)
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

```
package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.achtransfers.AchTransfer;
import com.increase.api.models.achtransfers.AchTransferRetrieveParams;

public final class Main {
    private Main() {}

public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

AchTransfer achTransfer = client.achTransfers().retrieve("ach_transfer_uoxatyh3lt5evrsdvo7q");
    }
}
```

1

2

3

4

5

6

7

8

9

10

11

12

```
package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.achtransfers.AchTransfer
import com.increase.api.models.achtransfers.AchTransferRetrieveParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

val achTransfer: AchTransfer = client.achTransfers().retrieve("ach_transfer_uoxatyh3lt5evrsdvo7q")
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

```
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $achTransfer = $client->achTransfers->retrieve(
    'ach_transfer_uoxatyh3lt5evrsdvo7q'
  );

var_dump($achTransfer);
} catch (APIException $e) {
  echo $e->getMessage();
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

```
using System;
using Increase.Api;
using Increase.Api.Models.AchTransfers;

IncreaseClient client = new();

AchTransferRetrieveParams parameters = new()
{
    AchTransferID = "ach_transfer_uoxatyh3lt5evrsdvo7q"
};

var achTransfer = await client.AchTransfers.Retrieve(parameters);

Console.WriteLine(achTransfer);
```

Parameters

ach\_transfer\_id

string

Required

The identifier of the ACH Transfer.

More about [ACH Transfers](/content/documentation/api/ach-transfers/index.html).

Approve an ACH Transfer

Approves an ACH Transfer in a pending\_approval state.

cURL  TypeScript  Python  Ruby  Go  Java  Kotlin  PHP  C#

1

2

3

```
curl -X "POST" \
  --url "${INCREASE_URL}/ach_transfers/ach_transfer_uoxatyh3lt5evrsdvo7q/approve" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```

1

2

3

4

5

6

7

8

9

```
import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const achTransfer = await client.achTransfers.approve('ach_transfer_uoxatyh3lt5evrsdvo7q');

console.log(achTransfer.id);
```

1

2

3

4

5

6

7

8

9

10

```
import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
ach_transfer = client.ach_transfers.approve(
    "ach_transfer_uoxatyh3lt5evrsdvo7q",
)
print(ach_transfer.id)
```

1

2

3

4

5

6

7

8

9

```
require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

ach_transfer = increase.ach_transfers.approve("ach_transfer_uoxatyh3lt5evrsdvo7q")

puts(ach_transfer)
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

```
package main

import (
	"context"
	"fmt"
	"os"

"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	achTransfer, err := client.ACHTransfers.Approve(context.TODO(), "ach_transfer_uoxatyh3lt5evrsdvo7q")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", achTransfer.ID)
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

```
package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.achtransfers.AchTransfer;
import com.increase.api.models.achtransfers.AchTransferApproveParams;

public final class Main {
    private Main() {}

public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

AchTransfer achTransfer = client.achTransfers().approve("ach_transfer_uoxatyh3lt5evrsdvo7q");
    }
}
```

1

2

3

4

5

6

7

8

9

10

11

12

```
package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.achtransfers.AchTransfer
import com.increase.api.models.achtransfers.AchTransferApproveParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

val achTransfer: AchTransfer = client.achTransfers().approve("ach_transfer_uoxatyh3lt5evrsdvo7q")
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

```
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $achTransfer = $client->achTransfers->approve(
    'ach_transfer_uoxatyh3lt5evrsdvo7q'
  );

var_dump($achTransfer);
} catch (APIException $e) {
  echo $e->getMessage();
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

```
using System;
using Increase.Api;
using Increase.Api.Models.AchTransfers;

IncreaseClient client = new();

AchTransferApproveParams parameters = new()
{
    AchTransferID = "ach_transfer_uoxatyh3lt5evrsdvo7q"
};

var achTransfer = await client.AchTransfers.Approve(parameters);

Console.WriteLine(achTransfer);
```

Parameters

ach\_transfer\_id

string

Required

The identifier of the ACH Transfer to approve.

More about [ACH Transfers](/content/documentation/api/ach-transfers/index.html).

Cancel a pending ACH Transfer

Cancels an ACH Transfer in a pending\_approval state.

cURL  TypeScript  Python  Ruby  Go  Java  Kotlin  PHP  C#

1

2

3

```
curl -X "POST" \
  --url "${INCREASE_URL}/ach_transfers/ach_transfer_uoxatyh3lt5evrsdvo7q/cancel" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```

1

2

3

4

5

6

7

8

9

```
import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const achTransfer = await client.achTransfers.cancel('ach_transfer_uoxatyh3lt5evrsdvo7q');

console.log(achTransfer.id);
```

1

2

3

4

5

6

7

8

9

10

```
import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
ach_transfer = client.ach_transfers.cancel(
    "ach_transfer_uoxatyh3lt5evrsdvo7q",
)
print(ach_transfer.id)
```

1

2

3

4

5

6

7

8

9

```
require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

ach_transfer = increase.ach_transfers.cancel("ach_transfer_uoxatyh3lt5evrsdvo7q")

puts(ach_transfer)
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

```
package main

import (
	"context"
	"fmt"
	"os"

"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	achTransfer, err := client.ACHTransfers.Cancel(context.TODO(), "ach_transfer_uoxatyh3lt5evrsdvo7q")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", achTransfer.ID)
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

```
package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.achtransfers.AchTransfer;
import com.increase.api.models.achtransfers.AchTransferCancelParams;

public final class Main {
    private Main() {}

public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

AchTransfer achTransfer = client.achTransfers().cancel("ach_transfer_uoxatyh3lt5evrsdvo7q");
    }
}
```

1

2

3

4

5

6

7

8

9

10

11

12

```
package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.achtransfers.AchTransfer
import com.increase.api.models.achtransfers.AchTransferCancelParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

val achTransfer: AchTransfer = client.achTransfers().cancel("ach_transfer_uoxatyh3lt5evrsdvo7q")
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

```
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $achTransfer = $client->achTransfers->cancel(
    'ach_transfer_uoxatyh3lt5evrsdvo7q'
  );

var_dump($achTransfer);
} catch (APIException $e) {
  echo $e->getMessage();
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

```
using System;
using Increase.Api;
using Increase.Api.Models.AchTransfers;

IncreaseClient client = new();

AchTransferCancelParams parameters = new()
{
    AchTransferID = "ach_transfer_uoxatyh3lt5evrsdvo7q"
};

var achTransfer = await client.AchTransfers.Cancel(parameters);

Console.WriteLine(achTransfer);
```

Parameters

ach\_transfer\_id

string

Required

The identifier of the pending ACH Transfer to cancel.

More about [ACH Transfers](/content/documentation/api/ach-transfers/index.html).

Sandbox: Acknowledge an ACH Transfer

Simulates the acknowledgement of an [ACH Transfer](/content/documentation/api/ach-transfers#ach-transfers/index.html) 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.

cURL  TypeScript  Python  Ruby  Go  Java  Kotlin  PHP  C#

1

2

3

```
curl -X "POST" \
  --url "${INCREASE_URL}/simulations/ach_transfers/ach_transfer_uoxatyh3lt5evrsdvo7q/acknowledge" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```

1

2

3

4

5

6

7

8

9

10

11

```
import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const achTransfer = await client.simulations.achTransfers.acknowledge(
  'ach_transfer_uoxatyh3lt5evrsdvo7q',
);

console.log(achTransfer.id);
```

1

2

3

4

5

6

7

8

9

10

```
import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
ach_transfer = client.simulations.ach_transfers.acknowledge(
    "ach_transfer_uoxatyh3lt5evrsdvo7q",
)
print(ach_transfer.id)
```

1

2

3

4

5

6

7

8

9

```
require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

ach_transfer = increase.simulations.ach_transfers.acknowledge("ach_transfer_uoxatyh3lt5evrsdvo7q")

puts(ach_transfer)
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

```
package main

import (
	"context"
	"fmt"
	"os"

"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	achTransfer, err := client.Simulations.ACHTransfers.Acknowledge(context.TODO(), "ach_transfer_uoxatyh3lt5evrsdvo7q")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", achTransfer.ID)
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

```
package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.achtransfers.AchTransfer;
import com.increase.api.models.simulations.achtransfers.AchTransferAcknowledgeParams;

public final class Main {
    private Main() {}

public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

AchTransfer achTransfer = client.simulations().achTransfers().acknowledge("ach_transfer_uoxatyh3lt5evrsdvo7q");
    }
}
```

1

2

3

4

5

6

7

8

9

10

11

12

```
package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.achtransfers.AchTransfer
import com.increase.api.models.simulations.achtransfers.AchTransferAcknowledgeParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

val achTransfer: AchTransfer = client.simulations().achTransfers().acknowledge("ach_transfer_uoxatyh3lt5evrsdvo7q")
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

```
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $achTransfer = $client->simulations->achTransfers->acknowledge(
    'ach_transfer_uoxatyh3lt5evrsdvo7q'
  );

var_dump($achTransfer);
} catch (APIException $e) {
  echo $e->getMessage();
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

```
using System;
using Increase.Api;
using Increase.Api.Models.Simulations.AchTransfers;

IncreaseClient client = new();

AchTransferAcknowledgeParams parameters = new()
{
    AchTransferID = "ach_transfer_uoxatyh3lt5evrsdvo7q"
};

var achTransfer = await client.Simulations.AchTransfers.Acknowledge(parameters);

Console.WriteLine(achTransfer);
```

Parameters

ach\_transfer\_id

string

Required

The identifier of the ACH Transfer you wish to become acknowledged.

More about [ACH Transfers](/content/documentation/api/ach-transfers/index.html).

Sandbox: Create a Notification of Change for an ACH Transfer

Simulates receiving a Notification of Change for an [ACH Transfer](/content/documentation/api/ach-transfers#ach-transfers/index.html).

cURL  TypeScript  Python  Ruby  Go  Java  Kotlin  PHP  C#

1

2

3

4

5

6

7

```
curl -X "POST" \
  --url "${INCREASE_URL}/simulations/ach_transfers/ach_transfer_uoxatyh3lt5evrsdvo7q/create_notification_of_change" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "corrected_routing_number": "123456789"
  }'
```

1

2

3

4

5

6

7

8

9

10

11

```
import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const achTransfer = await client.simulations.achTransfers.createNotificationOfChange(
  'ach_transfer_uoxatyh3lt5evrsdvo7q',
);

console.log(achTransfer.id);
```

1

2

3

4

5

6

7

8

9

10

```
import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
ach_transfer = client.simulations.ach_transfers.create_notification_of_change(
    ach_transfer_id="ach_transfer_uoxatyh3lt5evrsdvo7q",
)
print(ach_transfer.id)
```

1

2

3

4

5

6

7

8

9

```
require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

ach_transfer = increase.simulations.ach_transfers.create_notification_of_change("ach_transfer_uoxatyh3lt5evrsdvo7q")

puts(ach_transfer)
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

```
package main

import (
	"context"
	"fmt"
	"os"

"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	achTransfer, err := client.Simulations.ACHTransfers.NewNotificationOfChange(
		context.TODO(),
		"ach_transfer_uoxatyh3lt5evrsdvo7q",
		increase.SimulationACHTransferNewNotificationOfChangeParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", achTransfer.ID)
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

```
package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.achtransfers.AchTransfer;
import com.increase.api.models.simulations.achtransfers.AchTransferCreateNotificationOfChangeParams;

public final class Main {
    private Main() {}

public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

AchTransfer achTransfer = client.simulations().achTransfers().createNotificationOfChange("ach_transfer_uoxatyh3lt5evrsdvo7q");
    }
}
```

1

2

3

4

5

6

7

8

9

10

11

12

```
package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.achtransfers.AchTransfer
import com.increase.api.models.simulations.achtransfers.AchTransferCreateNotificationOfChangeParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

val achTransfer: AchTransfer = client.simulations().achTransfers().createNotificationOfChange("ach_transfer_uoxatyh3lt5evrsdvo7q")
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

```
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $achTransfer = $client->simulations->achTransfers->createNotificationOfChange(
    'ach_transfer_uoxatyh3lt5evrsdvo7q',
    correctedAccountFunding: 'checking',
    correctedAccountNumber: 'x',
    correctedIndividualID: 'x',
    correctedRoutingNumber: '123456789',
  );

var_dump($achTransfer);
} catch (APIException $e) {
  echo $e->getMessage();
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

```
using System;
using Increase.Api;
using Increase.Api.Models.Simulations.AchTransfers;

IncreaseClient client = new();

AchTransferCreateNotificationOfChangeParams parameters = new()
{
    AchTransferID = "ach_transfer_uoxatyh3lt5evrsdvo7q"
};

var achTransfer = await client.Simulations.AchTransfers.CreateNotificationOfChange(parameters);

Console.WriteLine(achTransfer);
```

Parameters

ach\_transfer\_id

string

Required

The identifier of the ACH Transfer you wish to create a notification of change for.

More about [ACH Transfers](/content/documentation/api/ach-transfers/index.html).

corrected\_account\_funding

enum

The corrected account funding type.

Possible values

corrected\_account\_number

string

The corrected account number.

Between 1 and 17 characters

corrected\_individual\_id

string

The corrected individual identifier.

Between 1 and 22 characters

corrected\_routing\_number

string

The corrected routing number.

Exactly 9 characters, character restrictions apply

Sandbox: Return an ACH Transfer

Simulates the return of an [ACH Transfer](/content/documentation/api/ach-transfers#ach-transfers/index.html) 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`.

cURL  TypeScript  Python  Ruby  Go  Java  Kotlin  PHP  C#

1

2

3

4

5

```
curl -X "POST" \
  --url "${INCREASE_URL}/simulations/ach_transfers/ach_transfer_uoxatyh3lt5evrsdvo7q/return" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{}'
```

1

2

3

4

5

6

7

8

9

10

11

```
import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const achTransfer = await client.simulations.achTransfers.return(
  'ach_transfer_uoxatyh3lt5evrsdvo7q',
);

console.log(achTransfer.id);
```

1

2

3

4

5

6

7

8

9

10

```
import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
ach_transfer = client.simulations.ach_transfers.return_(
    ach_transfer_id="ach_transfer_uoxatyh3lt5evrsdvo7q",
)
print(ach_transfer.id)
```

1

2

3

4

5

6

7

8

9

```
require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

ach_transfer = increase.simulations.ach_transfers.return_("ach_transfer_uoxatyh3lt5evrsdvo7q")

puts(ach_transfer)
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

```
package main

import (
	"context"
	"fmt"
	"os"

"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	achTransfer, err := client.Simulations.ACHTransfers.Return(
		context.TODO(),
		"ach_transfer_uoxatyh3lt5evrsdvo7q",
		increase.SimulationACHTransferReturnParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", achTransfer.ID)
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

```
package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.achtransfers.AchTransfer;
import com.increase.api.models.simulations.achtransfers.AchTransferReturnParams;

public final class Main {
    private Main() {}

public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

AchTransfer achTransfer = client.simulations().achTransfers().return_("ach_transfer_uoxatyh3lt5evrsdvo7q");
    }
}
```

1

2

3

4

5

6

7

8

9

10

11

12

```
package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.achtransfers.AchTransfer
import com.increase.api.models.simulations.achtransfers.AchTransferReturnParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

val achTransfer: AchTransfer = client.simulations().achTransfers().return_("ach_transfer_uoxatyh3lt5evrsdvo7q")
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

```
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $achTransfer = $client->simulations->achTransfers->return(
    'ach_transfer_uoxatyh3lt5evrsdvo7q',
    addendaInformation: 'x',
    reason: 'insufficient_fund',
  );

var_dump($achTransfer);
} catch (APIException $e) {
  echo $e->getMessage();
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

```
using System;
using Increase.Api;
using Increase.Api.Models.Simulations.AchTransfers;

IncreaseClient client = new();

AchTransferReturnParams parameters = new()
{
    AchTransferID = "ach_transfer_uoxatyh3lt5evrsdvo7q"
};

var achTransfer = await client.Simulations.AchTransfers.Return(parameters);

Console.WriteLine(achTransfer);
```

Parameters

ach\_transfer\_id

string

Required

The identifier of the ACH Transfer you wish to return.

More about [ACH Transfers](/content/documentation/api/ach-transfers/index.html).

addenda\_information

string

Free-form information the returning bank includes in the return addenda. For a `file_record_edit_criteria` (R17) return, set this to `QUESTIONABLE` to simulate a return the bank believes was initiated under questionable circumstances.

Between 1 and 200 characters

reason

enum

The reason why the Federal Reserve or destination bank returned this transfer.

Defaults to `no_account`

Possible values

Sandbox: Settle an ACH Transfer

Simulates the settlement of an [ACH Transfer](/content/documentation/api/ach-transfers#ach-transfers/index.html) 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.

cURL  TypeScript  Python  Ruby  Go  Java  Kotlin  PHP  C#

1

2

3

4

5

6

7

```
curl -X "POST" \
  --url "${INCREASE_URL}/simulations/ach_transfers/ach_transfer_uoxatyh3lt5evrsdvo7q/settle" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "inbound_funds_hold_behavior": "release_immediately"
  }'
```

1

2

3

4

5

6

7

8

9

10

11

```
import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const achTransfer = await client.simulations.achTransfers.settle(
  'ach_transfer_uoxatyh3lt5evrsdvo7q',
);

console.log(achTransfer.id);
```

1

2

3

4

5

6

7

8

9

10

```
import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
ach_transfer = client.simulations.ach_transfers.settle(
    ach_transfer_id="ach_transfer_uoxatyh3lt5evrsdvo7q",
)
print(ach_transfer.id)
```

1

2

3

4

5

6

7

8

9

```
require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

ach_transfer = increase.simulations.ach_transfers.settle("ach_transfer_uoxatyh3lt5evrsdvo7q")

puts(ach_transfer)
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

```
package main

import (
	"context"
	"fmt"
	"os"

"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	achTransfer, err := client.Simulations.ACHTransfers.Settle(
		context.TODO(),
		"ach_transfer_uoxatyh3lt5evrsdvo7q",
		increase.SimulationACHTransferSettleParams{},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", achTransfer.ID)
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

```
package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.achtransfers.AchTransfer;
import com.increase.api.models.simulations.achtransfers.AchTransferSettleParams;

public final class Main {
    private Main() {}

public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

AchTransfer achTransfer = client.simulations().achTransfers().settle("ach_transfer_uoxatyh3lt5evrsdvo7q");
    }
}
```

1

2

3

4

5

6

7

8

9

10

11

12

```
package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.achtransfers.AchTransfer
import com.increase.api.models.simulations.achtransfers.AchTransferSettleParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

val achTransfer: AchTransfer = client.simulations().achTransfers().settle("ach_transfer_uoxatyh3lt5evrsdvo7q")
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

```
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $achTransfer = $client->simulations->achTransfers->settle(
    'ach_transfer_uoxatyh3lt5evrsdvo7q',
    inboundFundsHoldBehavior: 'release_immediately',
  );

var_dump($achTransfer);
} catch (APIException $e) {
  echo $e->getMessage();
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

```
using System;
using Increase.Api;
using Increase.Api.Models.Simulations.AchTransfers;

IncreaseClient client = new();

AchTransferSettleParams parameters = new()
{
    AchTransferID = "ach_transfer_uoxatyh3lt5evrsdvo7q"
};

var achTransfer = await client.Simulations.AchTransfers.Settle(parameters);

Console.WriteLine(achTransfer);
```

Parameters

ach\_transfer\_id

string

Required

The identifier of the ACH Transfer you wish to become settled.

More about [ACH Transfers](/content/documentation/api/ach-transfers/index.html).

inbound\_funds\_hold\_behavior

enum

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.

Possible values

Sandbox: Submit an ACH Transfer

Simulates the submission of an [ACH Transfer](/content/documentation/api/ach-transfers#ach-transfers/index.html) 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`.

cURL  TypeScript  Python  Ruby  Go  Java  Kotlin  PHP  C#

1

2

3

```
curl -X "POST" \
  --url "${INCREASE_URL}/simulations/ach_transfers/ach_transfer_uoxatyh3lt5evrsdvo7q/submit" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"
```

1

2

3

4

5

6

7

8

9

10

11

```
import Increase from 'increase';

const client = new Increase({
  apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});

const achTransfer = await client.simulations.achTransfers.submit(
  'ach_transfer_uoxatyh3lt5evrsdvo7q',
);

console.log(achTransfer.id);
```

1

2

3

4

5

6

7

8

9

10

```
import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
ach_transfer = client.simulations.ach_transfers.submit(
    "ach_transfer_uoxatyh3lt5evrsdvo7q",
)
print(ach_transfer.id)
```

1

2

3

4

5

6

7

8

9

```
require "increase"

increase = Increase::Client.new(
  api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)

ach_transfer = increase.simulations.ach_transfers.submit("ach_transfer_uoxatyh3lt5evrsdvo7q")

puts(ach_transfer)
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

```
package main

import (
	"context"
	"fmt"
	"os"

"github.com/Increase/increase-go"
	"github.com/Increase/increase-go/option"
)

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	achTransfer, err := client.Simulations.ACHTransfers.Submit(context.TODO(), "ach_transfer_uoxatyh3lt5evrsdvo7q")
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", achTransfer.ID)
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

```
package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.achtransfers.AchTransfer;
import com.increase.api.models.simulations.achtransfers.AchTransferSubmitParams;

public final class Main {
    private Main() {}

public static void main(String[] args) {
        IncreaseClient client = IncreaseOkHttpClient.fromEnv();

AchTransfer achTransfer = client.simulations().achTransfers().submit("ach_transfer_uoxatyh3lt5evrsdvo7q");
    }
}
```

1

2

3

4

5

6

7

8

9

10

11

12

```
package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.achtransfers.AchTransfer
import com.increase.api.models.simulations.achtransfers.AchTransferSubmitParams

fun main() {
    val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()

val achTransfer: AchTransfer = client.simulations().achTransfers().submit("ach_transfer_uoxatyh3lt5evrsdvo7q")
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

```
<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Increase\Client;
use Increase\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('INCREASE_API_KEY'));

try {
  $achTransfer = $client->simulations->achTransfers->submit(
    'ach_transfer_uoxatyh3lt5evrsdvo7q'
  );

var_dump($achTransfer);
} catch (APIException $e) {
  echo $e->getMessage();
}
```

1

2

3

4

5

6

7

8

9

10

11

12

13

14

```
using System;
using Increase.Api;
using Increase.Api.Models.Simulations.AchTransfers;

IncreaseClient client = new();

AchTransferSubmitParams parameters = new()
{
    AchTransferID = "ach_transfer_uoxatyh3lt5evrsdvo7q"
};

var achTransfer = await client.Simulations.AchTransfers.Submit(parameters);

Console.WriteLine(achTransfer);
```

Parameters

ach\_transfer\_id

string

Required

The identifier of the ACH Transfer you wish to submit.

More about [ACH Transfers](/content/documentation/api/ach-transfers/index.html).
