[Skip to main content](/content/documentation/api/accounts#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/) Accounts [Guides\\ \\ Explanatory and how-to content](/content/documentation/api/accounts#/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) Accounts Copy for LLM Accounts are your bank accounts with Increase. They store money, receive transfers, and send payments. They earn interest and have depository insurance. Events Your application can listen to [webhooks](/content/documentation/api/events/index.html) about this resource. The events about Accounts will have the categories "account.created" or "account.updated" . The Account object Deposit account Loan account 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 ``` { "account_revenue_rate": null, "bank": "increase_bank", "closed_at": null, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "entity_id": "entity_n8y8tnk2p9339ti393yi", "funding": "deposits", "id": "account_in71c4amph0vgo2qllky", "idempotency_key": null, "informational_entity_id": null, "interest_rate": "0.055", "loan": null, "name": "My first account!", "program_id": "program_i2v2os4mwza1oetokh9i", "status": "open", "type": "account" } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 ``` { "account_revenue_rate": null, "bank": "increase_bank", "closed_at": null, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "entity_id": "entity_n8y8tnk2p9339ti393yi", "funding": "loan", "id": "account_in71c4amph0vgo2qllky", "idempotency_key": null, "informational_entity_id": null, "interest_rate": "0.055", "loan": { "credit_limit": 1000000, "grace_period_days": 21, "maturity_date": "2020-01-31", "statement_day_of_month": 1, "statement_payment_type": "balance" }, "name": "My first account!", "program_id": "program_i2v2os4mwza1oetokh9i", "status": "open", "type": "account" } ``` Attributes account\_revenue\_rate string Nullable The account revenue rate currently being earned on the account, as a string containing a decimal number. For example, a 1% account revenue rate would be represented as “0.01”. Account revenue is a type of non-interest income accrued on the account. bank enum The bank the Account is with. Possible values closed\_at string Nullable The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account was closed. created\_at string The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) time at which the Account was created. currency enum The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) code for the Account currency. Possible values entity\_id string The identifier for the Entity the Account belongs to. More about [Entities](/content/documentation/api/entities/index.html). funding enum Whether the Account is funded by a loan or by deposits. Possible values id string The Account 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). informational\_entity\_id string Nullable The identifier of an Entity that, while not owning the Account, is associated with its activity. More about [Entities](/content/documentation/api/entities/index.html). interest\_rate string The interest rate currently being earned on the account, as a string containing a decimal number. For example, a 1% interest rate would be represented as “0.01”. loan dictionary Nullable The Account’s loan-related information, if the Account is a loan account. Child attributes name string The name you choose for the Account. program\_id string The identifier of the Program determining the compliance and commercial terms of this Account. More about [Programs](/content/documentation/api/programs/index.html). status enum The status of the Account. Possible values type string A constant representing the object’s type. For this resource it will always be `account`. List Accounts cURL TypeScript Python Ruby Go Java Kotlin PHP C# 1 2 3 ``` curl \ --url "${INCREASE_URL}/accounts?entity_id=entity_n8y8tnk2p9339ti393yi" \ -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 account of client.accounts.list()) { console.log(account.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.accounts.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.accounts.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.Accounts.List(context.TODO(), increase.AccountListParams{}) 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.accounts.AccountListPage; import com.increase.api.models.accounts.AccountListParams; public final class Main { private Main() {} public static void main(String[] args) { IncreaseClient client = IncreaseOkHttpClient.fromEnv(); AccountListPage page = client.accounts().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.accounts.AccountListPage import com.increase.api.models.accounts.AccountListParams fun main() { val client: IncreaseClient = IncreaseOkHttpClient.fromEnv() val page: AccountListPage = client.accounts().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 30 ``` accounts->list( 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', entityID: 'entity_id', idempotencyKey: 'x', informationalEntityID: 'informational_entity_id', limit: 1, programID: 'program_id', status: ['in' => ['closed']], ); 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.Accounts; IncreaseClient client = new(); AccountListParams parameters = new(); var page = await client.Accounts.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": [\ { /* Account object */ },\ { /* Account object */ }\ /* ... */\ ], "next_cursor": "v57w5d", } ``` Parameters entity\_id string Filter Accounts for those belonging to the specified Entity. More about [Entities](/content/documentation/api/entities/index.html). informational\_entity\_id string Filter Accounts for those belonging to the specified Entity as informational. More about [Entities](/content/documentation/api/entities/index.html). program\_id string Filter Accounts for those in a specific Program. More about [Programs](/content/documentation/api/programs/index.html). status.in array of strings Filter Accounts for those with the specified status. For GET requests, this should be encoded as a comma-delimited string, such as `?in=one,two,three`. Possible values 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 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 Account cURL TypeScript Python Ruby Go Java Kotlin PHP C# 1 2 3 4 5 6 7 8 9 ``` curl -X "POST" \ --url "${INCREASE_URL}/accounts" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "entity_id": "entity_n8y8tnk2p9339ti393yi", "name": "New Account!", "program_id": "program_i2v2os4mwza1oetokh9i" }' ``` 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 account = await client.accounts.create({ name: 'New Account!' }); console.log(account.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 ) account = client.accounts.create( name="New Account!", ) print(account.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 ) account = increase.accounts.create(name: "New Account!") puts(account) ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 ``` 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 ) account, err := client.Accounts.New(context.TODO(), increase.AccountNewParams{ Name: increase.F("New Account!"), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", account.ID) } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 ``` package com.increase.api.example; import com.increase.api.client.IncreaseClient; import com.increase.api.client.okhttp.IncreaseOkHttpClient; import com.increase.api.models.accounts.Account; import com.increase.api.models.accounts.AccountCreateParams; public final class Main { private Main() {} public static void main(String[] args) { IncreaseClient client = IncreaseOkHttpClient.fromEnv(); AccountCreateParams params = AccountCreateParams.builder() .name("New Account!") .build(); Account account = client.accounts().create(params); } } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 ``` package com.increase.api.example import com.increase.api.client.IncreaseClient import com.increase.api.client.okhttp.IncreaseOkHttpClient import com.increase.api.models.accounts.Account import com.increase.api.models.accounts.AccountCreateParams fun main() { val client: IncreaseClient = IncreaseOkHttpClient.fromEnv() val params: AccountCreateParams = AccountCreateParams.builder() .name("New Account!") .build() val account: Account = client.accounts().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 ``` accounts->create( name: 'New Account!', entityID: 'entity_n8y8tnk2p9339ti393yi', funding: 'loan', informationalEntityID: 'informational_entity_id', loan: [\ 'creditLimit' => 0,\ 'gracePeriodDays' => 0,\ 'maturityDate' => '2019-12-27',\ 'statementDayOfMonth' => 1,\ 'statementPaymentType' => 'balance',\ ], programID: 'program_i2v2os4mwza1oetokh9i', ); var_dump($account); } catch (APIException $e) { echo $e->getMessage(); } ``` 1 2 3 4 5 6 7 8 9 10 11 ``` using System; using Increase.Api; using Increase.Api.Models.Accounts; IncreaseClient client = new(); AccountCreateParams parameters = new() { Name = "New Account!" }; var account = await client.Accounts.Create(parameters); Console.WriteLine(account); ``` Parameters entity\_id string The identifier for the Entity that will own the Account. More about [Entities](/content/documentation/api/entities/index.html). funding enum Whether the Account is funded by a loan or by deposits. Possible values informational\_entity\_id string The identifier of an Entity that, while not owning the Account, is associated with its activity. This is generally the beneficiary of the funds. More about [Entities](/content/documentation/api/entities/index.html). loan dictionary The loan details for the account. Child attributes name string Required The name you choose for the Account. Between 1 and 200 characters program\_id string The identifier for the Program that this Account falls under. Required if your Group operates more than one Program. List your [Programs](/content/documentation/api/accounts#programs/index.html) to find their identifiers. More about [Programs](/content/documentation/api/programs/index.html). Retrieve an Account cURL TypeScript Python Ruby Go Java Kotlin PHP C# 1 2 3 ``` curl \ --url "${INCREASE_URL}/accounts/account_in71c4amph0vgo2qllky" \ -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 account = await client.accounts.retrieve('account_in71c4amph0vgo2qllky'); console.log(account.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 ) account = client.accounts.retrieve( "account_in71c4amph0vgo2qllky", ) print(account.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 ) account = increase.accounts.retrieve("account_in71c4amph0vgo2qllky") puts(account) ``` 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 ) account, err := client.Accounts.Get(context.TODO(), "account_in71c4amph0vgo2qllky") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", account.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.accounts.Account; import com.increase.api.models.accounts.AccountRetrieveParams; public final class Main { private Main() {} public static void main(String[] args) { IncreaseClient client = IncreaseOkHttpClient.fromEnv(); Account account = client.accounts().retrieve("account_in71c4amph0vgo2qllky"); } } ``` 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.accounts.Account import com.increase.api.models.accounts.AccountRetrieveParams fun main() { val client: IncreaseClient = IncreaseOkHttpClient.fromEnv() val account: Account = client.accounts().retrieve("account_in71c4amph0vgo2qllky") } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 ``` accounts->retrieve('account_in71c4amph0vgo2qllky'); var_dump($account); } 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.Accounts; IncreaseClient client = new(); AccountRetrieveParams parameters = new() { AccountID = "account_in71c4amph0vgo2qllky" }; var account = await client.Accounts.Retrieve(parameters); Console.WriteLine(account); ``` Parameters account\_id string Required The identifier of the Account to retrieve. More about [Accounts](/content/documentation/api/accounts/index.html). Update an Account cURL TypeScript Python Ruby Go Java Kotlin PHP C# 1 2 3 4 5 6 7 ``` curl -X "PATCH" \ --url "${INCREASE_URL}/accounts/account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "name": "My renamed account" }' ``` 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 account = await client.accounts.update('account_in71c4amph0vgo2qllky'); console.log(account.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 ) account = client.accounts.update( account_id="account_in71c4amph0vgo2qllky", ) print(account.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 ) account = increase.accounts.update("account_in71c4amph0vgo2qllky") puts(account) ``` 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 ) account, err := client.Accounts.Update( context.TODO(), "account_in71c4amph0vgo2qllky", increase.AccountUpdateParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", account.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.accounts.Account; import com.increase.api.models.accounts.AccountUpdateParams; public final class Main { private Main() {} public static void main(String[] args) { IncreaseClient client = IncreaseOkHttpClient.fromEnv(); Account account = client.accounts().update("account_in71c4amph0vgo2qllky"); } } ``` 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.accounts.Account import com.increase.api.models.accounts.AccountUpdateParams fun main() { val client: IncreaseClient = IncreaseOkHttpClient.fromEnv() val account: Account = client.accounts().update("account_in71c4amph0vgo2qllky") } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 ``` accounts->update( 'account_in71c4amph0vgo2qllky', loan: ['creditLimit' => 0], name: 'My renamed account', ); var_dump($account); } 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.Accounts; IncreaseClient client = new(); AccountUpdateParams parameters = new() { AccountID = "account_in71c4amph0vgo2qllky" }; var account = await client.Accounts.Update(parameters); Console.WriteLine(account); ``` Parameters account\_id string Required The identifier of the Account to update. More about [Accounts](/content/documentation/api/accounts/index.html). loan dictionary The loan details for the account. Child attributes name string The new name of the Account. Between 1 and 200 characters Retrieve an Account Balance Retrieve the current and available balances for an account in minor units of the account’s currency. Learn more about [account balances](/content/documentation/balance/index.html). cURL TypeScript Python Ruby Go Java Kotlin PHP C# 1 2 3 ``` curl \ --url "${INCREASE_URL}/accounts/account_in71c4amph0vgo2qllky/balance" \ -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 balanceLookup = await client.accounts.balance('account_in71c4amph0vgo2qllky'); console.log(balanceLookup.account_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 ) balance_lookup = client.accounts.balance( account_id="account_in71c4amph0vgo2qllky", ) print(balance_lookup.account_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 ) balance_lookup = increase.accounts.balance("account_in71c4amph0vgo2qllky") puts(balance_lookup) ``` 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 ) balanceLookup, err := client.Accounts.Balance( context.TODO(), "account_in71c4amph0vgo2qllky", increase.AccountBalanceParams{}, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", balanceLookup.AccountID) } ``` 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.accounts.AccountBalanceParams; import com.increase.api.models.accounts.BalanceLookup; public final class Main { private Main() {} public static void main(String[] args) { IncreaseClient client = IncreaseOkHttpClient.fromEnv(); BalanceLookup balanceLookup = client.accounts().balance("account_in71c4amph0vgo2qllky"); } } ``` 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.accounts.AccountBalanceParams import com.increase.api.models.accounts.BalanceLookup fun main() { val client: IncreaseClient = IncreaseOkHttpClient.fromEnv() val balanceLookup: BalanceLookup = client.accounts().balance("account_in71c4amph0vgo2qllky") } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 ``` accounts->balance( 'account_in71c4amph0vgo2qllky', atTime: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'), ); var_dump($balanceLookup); } 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.Accounts; IncreaseClient client = new(); AccountBalanceParams parameters = new() { AccountID = "account_in71c4amph0vgo2qllky" }; var balanceLookup = await client.Accounts.Balance(parameters); Console.WriteLine(balanceLookup); ``` Returns a [Balance Lookup](/content/documentation/api#balance-lookup-object/index.html) object: 1 2 3 4 5 6 7 ``` { "account_id": "account_in71c4amph0vgo2qllky", "available_balance": 100, "current_balance": 100, "loan": null, "type": "balance_lookup" } ``` Parameters account\_id string Required The identifier of the Account to retrieve. More about [Accounts](/content/documentation/api/accounts/index.html). at\_time string The moment to query the balance at. If not set, returns the current balances. Close an Account cURL TypeScript Python Ruby Go Java Kotlin PHP C# 1 2 3 ``` curl -X "POST" \ --url "${INCREASE_URL}/accounts/account_in71c4amph0vgo2qllky/close" \ -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 account = await client.accounts.close('account_in71c4amph0vgo2qllky'); console.log(account.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 ) account = client.accounts.close( "account_in71c4amph0vgo2qllky", ) print(account.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 ) account = increase.accounts.close("account_in71c4amph0vgo2qllky") puts(account) ``` 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 ) account, err := client.Accounts.Close(context.TODO(), "account_in71c4amph0vgo2qllky") if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", account.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.accounts.Account; import com.increase.api.models.accounts.AccountCloseParams; public final class Main { private Main() {} public static void main(String[] args) { IncreaseClient client = IncreaseOkHttpClient.fromEnv(); Account account = client.accounts().close("account_in71c4amph0vgo2qllky"); } } ``` 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.accounts.Account import com.increase.api.models.accounts.AccountCloseParams fun main() { val client: IncreaseClient = IncreaseOkHttpClient.fromEnv() val account: Account = client.accounts().close("account_in71c4amph0vgo2qllky") } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 ``` accounts->close('account_in71c4amph0vgo2qllky'); var_dump($account); } 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.Accounts; IncreaseClient client = new(); AccountCloseParams parameters = new() { AccountID = "account_in71c4amph0vgo2qllky" }; var account = await client.Accounts.Close(parameters); Console.WriteLine(account); ``` Parameters account\_id string Required The identifier of the Account to close. The account must have a zero balance. More about [Accounts](/content/documentation/api/accounts/index.html). Sandbox: Create an account revenue payment Simulates an account revenue payment to your account. In production, this happens automatically on the first of each month. cURL TypeScript Python Ruby Go Java Kotlin PHP C# 1 2 3 4 5 6 7 8 ``` curl -X "POST" \ --url "${INCREASE_URL}/simulations/account_revenue_payments" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_id": "account_in71c4amph0vgo2qllky", "amount": 1000 }' ``` 1 2 3 4 5 6 7 8 9 10 11 12 ``` import Increase from 'increase'; const client = new Increase({ apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted }); const transaction = await client.simulations.accountRevenuePayments.create({ account_id: 'account_in71c4amph0vgo2qllky', amount: 1000, }); console.log(transaction.id); ``` 1 2 3 4 5 6 7 8 9 10 11 ``` import os from increase import Increase client = Increase( api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted ) transaction = client.simulations.account_revenue_payments.create( account_id="account_in71c4amph0vgo2qllky", amount=1000, ) print(transaction.id) ``` 1 2 3 4 5 6 7 8 9 10 11 12 ``` require "increase" increase = Increase::Client.new( api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted ) transaction = increase.simulations.account_revenue_payments.create( account_id: "account_in71c4amph0vgo2qllky", amount: 1000 ) puts(transaction) ``` 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 ``` 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 ) transaction, err := client.Simulations.AccountRevenuePayments.New(context.TODO(), increase.SimulationAccountRevenuePaymentNewParams{ AccountID: increase.F("account_in71c4amph0vgo2qllky"), Amount: increase.F(int64(1000)), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", transaction.ID) } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 ``` package com.increase.api.example; import com.increase.api.client.IncreaseClient; import com.increase.api.client.okhttp.IncreaseOkHttpClient; import com.increase.api.models.simulations.accountrevenuepayments.AccountRevenuePaymentCreateParams; import com.increase.api.models.transactions.Transaction; public final class Main { private Main() {} public static void main(String[] args) { IncreaseClient client = IncreaseOkHttpClient.fromEnv(); AccountRevenuePaymentCreateParams params = AccountRevenuePaymentCreateParams.builder() .accountId("account_in71c4amph0vgo2qllky") .amount(1000L) .build(); Transaction transaction = client.simulations().accountRevenuePayments().create(params); } } ``` 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.simulations.accountrevenuepayments.AccountRevenuePaymentCreateParams import com.increase.api.models.transactions.Transaction fun main() { val client: IncreaseClient = IncreaseOkHttpClient.fromEnv() val params: AccountRevenuePaymentCreateParams = AccountRevenuePaymentCreateParams.builder() .accountId("account_in71c4amph0vgo2qllky") .amount(1000L) .build() val transaction: Transaction = client.simulations().accountRevenuePayments().create(params) } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 ``` simulations->accountRevenuePayments->create( accountID: 'account_in71c4amph0vgo2qllky', amount: 1000, accruedOnAccountID: 'accrued_on_account_id', periodEnd: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'), periodStart: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'), ); var_dump($transaction); } catch (APIException $e) { echo $e->getMessage(); } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 ``` using System; using Increase.Api; using Increase.Api.Models.Simulations.AccountRevenuePayments; IncreaseClient client = new(); AccountRevenuePaymentCreateParams parameters = new() { AccountID = "account_in71c4amph0vgo2qllky", Amount = 1000, }; var transaction = await client.Simulations.AccountRevenuePayments.Create(parameters); Console.WriteLine(transaction); ``` Returns a [Transaction](/content/documentation/api#transaction-object/index.html) object: Inbound ACH transfer Outbound ACH transfer Returned outbound ACH transfer Inbound wire transfer Outbound wire transfer Card purchase Card refund Check deposit Interest payment Fee payment 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 ``` { "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "id": "transaction_uyrp7fld2ium70oa7oi", "route_id": "account_number_v18nkfqm6afpsrvy82b2", "route_type": "account_number", "source": { "category": "inbound_ach_transfer", "inbound_ach_transfer": { "addenda": null, "amount": 100, "originator_company_descriptive_date": null, "originator_company_discretionary_data": null, "originator_company_entry_description": "RESERVE", "originator_company_id": "0987654321", "originator_company_name": "BIG BANK", "receiver_id_number": "12345678900", "receiver_name": "IAN CREASE", "trace_number": "021000038461022", "transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev" } }, "type": "transaction" } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 ``` { "account_id": "account_in71c4amph0vgo2qllky", "amount": -100, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "id": "transaction_uyrp7fld2ium70oa7oi", "route_id": null, "route_type": null, "source": { "ach_transfer_intention": { "account_number": "987654321", "amount": 100, "routing_number": "101050001", "statement_descriptor": "INVOICE 2468", "transfer_id": "account_transfer_7k9qe1ysdgqztnt63l7n" }, "category": "ach_transfer_intention" }, "type": "transaction" } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 ``` { "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "id": "transaction_uyrp7fld2ium70oa7oi", "route_id": null, "route_type": null, "source": { "ach_transfer_return": { "addenda_information": null, "created_at": "2020-01-31T23:59:59Z", "raw_return_reason_code": "R01", "return_reason_code": "insufficient_fund", "trace_number": "111122223292834", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "transfer_id": "ach_transfer_uoxatyh3lt5evrsdvo7q" }, "category": "ach_transfer_return" }, "type": "transaction" } ``` 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 ``` { "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "id": "transaction_uyrp7fld2ium70oa7oi", "route_id": "account_number_v18nkfqm6afpsrvy82b2", "route_type": "account_number", "source": { "category": "inbound_wire_transfer", "inbound_wire_transfer": { "amount": 100, "creditor_address_line1": null, "creditor_address_line2": null, "creditor_address_line3": null, "creditor_name": null, "debtor_address_line1": null, "debtor_address_line2": null, "debtor_address_line3": null, "debtor_name": null, "description": "Inbound wire transfer", "end_to_end_identification": null, "input_message_accountability_data": null, "instructing_agent_routing_number": null, "instruction_identification": null, "purpose": null, "transfer_id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0", "unique_end_to_end_transaction_reference": null, "unstructured_remittance_information": null } }, "type": "transaction" } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 ``` { "account_id": "account_in71c4amph0vgo2qllky", "amount": -100, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "id": "transaction_uyrp7fld2ium70oa7oi", "route_id": null, "route_type": null, "source": { "category": "wire_transfer_intention", "wire_transfer_intention": { "account_number": "987654321", "amount": 100, "message_to_recipient": "HELLO", "routing_number": "101050001", "transfer_id": "wire_transfer_5akynk7dqsq25qwk9q2u" } }, "type": "transaction" } ``` 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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 ``` { "account_id": "account_in71c4amph0vgo2qllky", "amount": -100, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "id": "transaction_uyrp7fld2ium70oa7oi", "route_id": "card_oubs0hwk5rn6knuecxg2", "route_type": "card", "source": { "card_settlement": { "amount": 100, "card_authorization": null, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "cashback": null, "currency": "USD", "id": "card_settlement_khv5kfeu0vndj291omg6", "interchange": { "amount": "0.137465", "code": "271", "currency": "USD" }, "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_name": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network": "visa", "network_identifiers": { "acquirer_business_id": "69650702", "acquirer_reference_number": "83163715445437604865089", "authorization_identification_response": "ABC123", "transaction_id": "627199945183184" }, "pending_transaction_id": null, "presentment_amount": 100, "presentment_currency": "USD", "purchase_details": { "car_rental": null, "customer_reference_identifier": "51201", "local_tax_amount": null, "local_tax_currency": "usd", "lodging": { "check_in_date": "2023-07-20", "daily_room_rate_amount": 1000, "daily_room_rate_currency": "usd", "extra_charges": "restaurant", "folio_cash_advances_amount": 0, "folio_cash_advances_currency": "usd", "food_beverage_charges_amount": 0, "food_beverage_charges_currency": "usd", "no_show_indicator": "no_show", "prepaid_expenses_amount": 0, "prepaid_expenses_currency": "usd", "room_nights": 1, "total_room_tax_amount": 100, "total_room_tax_currency": "usd", "total_tax_amount": 100, "total_tax_currency": "usd" }, "national_tax_amount": null, "national_tax_currency": "usd", "purchase_identifier": "10203", "purchase_identifier_format": "order_number", "travel": null }, "scheme_fees": [\ {\ "amount": "0.137465",\ "created_at": "2020-01-31T23:59:59Z",\ "currency": "USD",\ "fee_type": "visa_corporate_acceptance_fee",\ "fixed_component": null,\ "variable_rate": "0.0002"\ }\ ], "surcharge": null, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "card_settlement" }, "category": "card_settlement" }, "type": "transaction" } ``` 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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 ``` { "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "id": "transaction_uyrp7fld2ium70oa7oi", "route_id": "card_oubs0hwk5rn6knuecxg2", "route_type": "card", "source": { "card_refund": { "amount": 100, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "cashback": null, "currency": "USD", "id": "card_refund_imgc2xwplh6t4r3gn16e", "interchange": { "amount": "0.137465", "code": "271", "currency": "USD" }, "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_name": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network_identifiers": { "acquirer_business_id": "69650702", "acquirer_reference_number": "83163715445437604865089", "authorization_identification_response": "ABC123", "transaction_id": "627199945183184" }, "presentment_amount": 100, "presentment_currency": "USD", "purchase_details": { "car_rental": null, "customer_reference_identifier": "51201", "local_tax_amount": null, "local_tax_currency": "usd", "lodging": { "check_in_date": "2023-07-20", "daily_room_rate_amount": 1000, "daily_room_rate_currency": "usd", "extra_charges": "restaurant", "folio_cash_advances_amount": 0, "folio_cash_advances_currency": "usd", "food_beverage_charges_amount": 0, "food_beverage_charges_currency": "usd", "no_show_indicator": "no_show", "prepaid_expenses_amount": 0, "prepaid_expenses_currency": "usd", "room_nights": 1, "total_room_tax_amount": 100, "total_room_tax_currency": "usd", "total_tax_amount": 100, "total_tax_currency": "usd" }, "national_tax_amount": null, "national_tax_currency": "usd", "purchase_identifier": "10203", "purchase_identifier_format": "order_number", "travel": null }, "scheme_fees": [\ {\ "amount": "0.137465",\ "created_at": "2020-01-31T23:59:59Z",\ "currency": "USD",\ "fee_type": "visa_corporate_acceptance_fee",\ "fixed_component": null,\ "variable_rate": "0.0002"\ }\ ], "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "card_refund" }, "category": "card_refund" }, "type": "transaction" } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 ``` { "account_id": "account_in71c4amph0vgo2qllky", "amount": 1000, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "id": "transaction_uyrp7fld2ium70oa7oi", "route_id": null, "route_type": null, "source": { "category": "check_deposit_acceptance", "check_deposit_acceptance": { "account_number": "987654321", "amount": 1000, "auxiliary_on_us": "101", "check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1", "currency": "USD", "routing_number": "101050001", "serial_number": null } }, "type": "transaction" } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 ``` { "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "Interest payment for 2025-06", "id": "transaction_uyrp7fld2ium70oa7oi", "route_id": null, "route_type": null, "source": { "category": "interest_payment", "interest_payment": { "accrued_on_account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "currency": "USD", "period_end": "2025-06-30T23:59:59+00:00", "period_start": "2025-06-01T00:00:00+00:00" } }, "type": "transaction" } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 ``` { "account_id": "account_in71c4amph0vgo2qllky", "amount": -100, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "id": "transaction_uyrp7fld2ium70oa7oi", "route_id": null, "route_type": null, "source": { "category": "fee_payment", "fee_payment": { "amount": 100, "currency": "USD", "fee_period_start": "2023-05-01", "program_id": "program_i2v2os4mwza1oetokh9i" } }, "type": "transaction" } ``` Parameters account\_id string Required The identifier of the Account the Account Revenue Payment should be paid to. More about [Accounts](/content/documentation/api/accounts/index.html). accrued\_on\_account\_id string The identifier of the Account the account revenue accrued on. Defaults to `account_id`. More about [Accounts](/content/documentation/api/accounts/index.html). amount integer Required The account revenue amount in cents. Must be positive. period\_end string The end of the account revenue period. If not provided, defaults to the current time. period\_start string The start of the account revenue period. If not provided, defaults to the current time. Sandbox: Create an interest payment Simulates an interest payment to your account. In production, this happens automatically on the first of each month. cURL TypeScript Python Ruby Go Java Kotlin PHP C# 1 2 3 4 5 6 7 8 ``` curl -X "POST" \ --url "${INCREASE_URL}/simulations/interest_payments" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_id": "account_in71c4amph0vgo2qllky", "amount": 1000 }' ``` 1 2 3 4 5 6 7 8 9 10 11 12 ``` import Increase from 'increase'; const client = new Increase({ apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted }); const transaction = await client.simulations.interestPayments.create({ account_id: 'account_in71c4amph0vgo2qllky', amount: 1000, }); console.log(transaction.id); ``` 1 2 3 4 5 6 7 8 9 10 11 ``` import os from increase import Increase client = Increase( api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted ) transaction = client.simulations.interest_payments.create( account_id="account_in71c4amph0vgo2qllky", amount=1000, ) print(transaction.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 ) transaction = increase.simulations.interest_payments.create(account_id: "account_in71c4amph0vgo2qllky", amount: 1000) puts(transaction) ``` 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 ``` 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 ) transaction, err := client.Simulations.InterestPayments.New(context.TODO(), increase.SimulationInterestPaymentNewParams{ AccountID: increase.F("account_in71c4amph0vgo2qllky"), Amount: increase.F(int64(1000)), }) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", transaction.ID) } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 ``` package com.increase.api.example; import com.increase.api.client.IncreaseClient; import com.increase.api.client.okhttp.IncreaseOkHttpClient; import com.increase.api.models.simulations.interestpayments.InterestPaymentCreateParams; import com.increase.api.models.transactions.Transaction; public final class Main { private Main() {} public static void main(String[] args) { IncreaseClient client = IncreaseOkHttpClient.fromEnv(); InterestPaymentCreateParams params = InterestPaymentCreateParams.builder() .accountId("account_in71c4amph0vgo2qllky") .amount(1000L) .build(); Transaction transaction = client.simulations().interestPayments().create(params); } } ``` 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.simulations.interestpayments.InterestPaymentCreateParams import com.increase.api.models.transactions.Transaction fun main() { val client: IncreaseClient = IncreaseOkHttpClient.fromEnv() val params: InterestPaymentCreateParams = InterestPaymentCreateParams.builder() .accountId("account_in71c4amph0vgo2qllky") .amount(1000L) .build() val transaction: Transaction = client.simulations().interestPayments().create(params) } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 ``` simulations->interestPayments->create( accountID: 'account_in71c4amph0vgo2qllky', amount: 1000, accruedOnAccountID: 'accrued_on_account_id', periodEnd: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'), periodStart: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'), ); var_dump($transaction); } catch (APIException $e) { echo $e->getMessage(); } ``` 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 ``` using System; using Increase.Api; using Increase.Api.Models.Simulations.InterestPayments; IncreaseClient client = new(); InterestPaymentCreateParams parameters = new() { AccountID = "account_in71c4amph0vgo2qllky", Amount = 1000, }; var transaction = await client.Simulations.InterestPayments.Create(parameters); Console.WriteLine(transaction); ``` Returns a [Transaction](/content/documentation/api#transaction-object/index.html) 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 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 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 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 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 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 Parameters account\_id string Required The identifier of the Account the Interest Payment should be paid to is for. More about [Accounts](/content/documentation/api/accounts/index.html). accrued\_on\_account\_id string The identifier of the Account the Interest accrued on. Defaults to `account_id`. More about [Accounts](/content/documentation/api/accounts/index.html). amount integer Required The interest amount in cents. Must be positive. period\_end string The end of the interest period. If not provided, defaults to the current time. period\_start string The start of the interest period. If not provided, defaults to the current time.