API Reference

The Increase API is organized around REST. It has predictable resource-oriented URLs, accepts and returns JSON-encoded payloads, and uses standard HTTP response codes, authentication, and verbs.

 

While we're continually adding new features to the API, we're committed to doing so in a way that doesn't break existing integrations. You can read more in our versioning and backwards compatibility guide.

Authorization and Testing

The API accepts Bearer Authentication. When you sign up for an Increase account, we make you a pair of API keys: one for production and one for our sandbox environment in which no real money moves. You can create and revoke API keys from the dashboard and should securely store them using a secret management system.

Production API requests should be to https://api.increase.com and sandbox requests should be to https://sandbox.increase.com. We'll put these into environment variables to make our code examples easier to follow.

In the sandbox:
INCREASE_API_KEY="sandbox_key_1234567890" INCREASE_URL="https://sandbox.increase.com"
In production (you'll need to retrieve your API key from the dashboard):
INCREASE_API_KEY="secret_key_1234567890" INCREASE_URL="https://api.increase.com"
You can then make an API request like this using cURL:
curl --url "${INCREASE_URL}" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
OpenAPI

This reference also exists in OpenAPI 3 format. This spec is in beta and subject to change. If you find it useful, or have feedback, let us know!

Software Development Kits

Increase maintains open source SDKs for TypeScript, Python, Go, Java, and Kotlin. Check out the documentation here or read the source code on Github.

OAuth

If you're interested in building an application that connects to other Increase users' data, you can build an OAuth application. Learn more about this in our OAuth guide.

Requests and Responses

When making a POST request to the API, use a Content-Type of application/json and specify parameters via JSON in the request body:

When making a GET request to the API, you should specify parameters in the query string of the URL. Join nested parameters, such as timestamp-based filters, with a . – for example, created_at.before:

All responses from the API will have a Content-Type of application/json.

POST request
curl -X "POST" \ --url "${INCREASE_URL}/accounts" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H 'Content-Type: application/json' \ -d $'{ "name": "New Account!" }'
GET request
curl \ --url "${INCREASE_URL}/transactions?created_at.before=2022-01-15T06:34:23Z&created_at.after=2022-01-08T06:34:16Z" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Object Lists

List endpoints return a wrapper object with the data and a cursor. The API will return the next page of results if you submit the next_cursor as a query parameter with the name cursor. Any filter parameters passed to the original list request must be included if next_cursor is specified. The maximum (and default) page size is 100 objects. You can adjust it using the limit parameter.

{ "data": [], "next_cursor": "RWFzdGVyIGVnZw==" }
Errors

The API uses standard HTTP response codes to indicate the success or failure of requests. Codes in the 2xx range indicate success; codes in the 4xx and 5xx range indicate errors. Error objects conform to RFC 9457 and can be distinguished by their type attribute. Errors will always have the same shape.

Attributes
detail
string
Nullable

Additional information about this particular error.

status
string

The HTTP status code of the error is also included in the response body for easier debugging.

title
string

A human-readable string explaining the type of error.

type
enum

The type of error that occurred. This is a machine-readable enum.

{ "detail": "There's an insufficient balance in the account.", "status": "400", "title": "The action you specified can't be performed on the object in its current state.", "type": "invalid_operation_error" }
Idempotency

The API supports idempotency for safely retrying requests without accidentally performing the same operation twice. This is useful when an API call is disrupted in transit and you do not receive a response. For example, if a request to create an ACH Transfer does not respond due to a network connection error, you can retry the request with the same idempotency key to guarantee that no more than one transfer is created.

To perform an idempotent request, provide an additional, unique Idempotency-Key request header per intended request. POST endpoints also allow passing idempotency_key as a JSON parameter. Read more about Increase's idempotency keys.

curl -X "POST" \ --url "${INCREASE_URL}/accounts" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H 'Idempotency-Key: RANDOM_UUID' \ -H 'Content-Type: application/json' \ -d $'{ "name": "New Account!" }'
Sandbox Simulations

When building your application, you can use these APIs to simulate external effects. They can be helpful to quickly test events that might take several hours in the real world (like receiving a wire or ACH). These APIs will only work in the sandbox. If you have a sandbox Event Subscription configured, calling these APIs will also result in the appropriate webhooks being sent to your endpoint.

Accounts

Accounts are your bank accounts with Increase. They store money, receive transfers, and send payments. They earn interest and have depository insurance.

The Account object
{ "bank": "first_internet_bank", "closed_at": null, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "entity_id": "entity_n8y8tnk2p9339ti393yi", "id": "account_in71c4amph0vgo2qllky", "idempotency_key": null, "informational_entity_id": null, "interest_accrued": "0.01", "interest_accrued_at": "2020-01-31", "interest_rate": "0.055", "name": "My first account!", "program_id": "program_i2v2os4mwza1oetokh9i", "replacement": { "replaced_account_id": null, "replaced_by_account_id": null }, "status": "open", "type": "account" }
Attributes
bank
enum

The bank the Account is with.

closed_at
string
Nullable

The ISO 8601 time at which the Account was closed.

created_at
string

The ISO 8601 time at which the Account was created.

currency
enum

The ISO 4217 code for the Account currency.

entity_id
string
Nullable

The identifier for the Entity the Account belongs to.

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.

informational_entity_id
string
Nullable

The identifier of an Entity that, while not owning the Account, is associated with its activity.

interest_accrued
string

The interest accrued but not yet paid, expressed as a string containing a floating-point value.

interest_accrued_at
string
Nullable

The latest ISO 8601 date on which interest was accrued.

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

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.

status
enum

The status of the Account.

type
string

A constant representing the object's type. For this resource it will always be account.

List Accounts
curl \ --url "${INCREASE_URL}/accounts?entity_id=entity_n8y8tnk2p9339ti393yi" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

entity_id
string

Filter Accounts for those belonging to the specified Entity.

informational_entity_id
string

Filter Accounts for those belonging to the specified Entity as informational.

program_id
string

Filter Accounts for those in a specific Program.

status
enum

Filter Accounts for those with the specified status.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

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.

200 character maximum
Create an Account
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" }'
Parameters
entity_id
string

The identifier for the Entity that will own the Account.

informational_entity_id
string

The identifier of an Entity that, while not owning the Account, is associated with its activity. Its relationship to your group must be informational.

name
string
Required

The name you choose for the Account.

200 character maximum
program_id
string

The identifier for the Program that this Account falls under. Required if you operate more than one Program.

Retrieve an Account
curl \ --url "${INCREASE_URL}/accounts/account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
account_id
string
Required

The identifier of the Account to retrieve.

Update an Account
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" }'
Parameters
account_id
string
Required

The identifier of the Account to update.

name
string

The new name of the Account.

200 character maximum
Retrieve an Account Balance
curl \ --url "${INCREASE_URL}/accounts/account_in71c4amph0vgo2qllky/balance" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Returns a Balance Lookup object:
{ "account_id": "account_in71c4amph0vgo2qllky", "available_balance": 100, "current_balance": 100, "type": "balance_lookup" }
Parameters
account_id
string
Required

The identifier of the Account to retrieve.

at_time
string

The moment to query the balance at. If not set, returns the current balances.

Close an Account
curl -X "POST" \ --url "${INCREASE_URL}/accounts/account_in71c4amph0vgo2qllky/close" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
account_id
string
Required

The identifier of the Account to close. The account must have a zero balance.

Sandbox: Create an interest payment

Simulates an interest payment to your account. In production, this happens automatically on the first of each month.

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 }'
Returns a Transaction object:
{ "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" }
Parameters
account_id
string
Required

The identifier of the Account Number the Interest Payment is for.

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.

Account Numbers

Each account can have multiple account and routing numbers. We recommend that you use a set per vendor. This is similar to how you use different passwords for different websites. Account numbers can also be used to seamlessly reconcile inbound payments. Generating a unique account number per vendor ensures you always know the originator of an incoming payment.

The Account Number object
{ "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "created_at": "2020-01-31T23:59:59Z", "id": "account_number_v18nkfqm6afpsrvy82b2", "idempotency_key": null, "inbound_ach": { "debit_status": "blocked" }, "inbound_checks": { "status": "check_transfers_only" }, "name": "ACH", "replacement": { "replaced_account_number_id": null, "replaced_by_account_number_id": null }, "routing_number": "101050001", "status": "active", "type": "account_number" }
Attributes
account_id
string

The identifier for the account this Account Number belongs to.

account_number
string

The account number.

created_at
string

The ISO 8601 time at which the Account Number was created.

id
string

The Account Number 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.

inbound_ach
dictionary

Properties related to how this Account Number handles inbound ACH transfers.

inbound_checks
dictionary

Properties related to how this Account Number should handle inbound check withdrawals.

name
string

The name you choose for the Account Number.

routing_number
string

The American Bankers' Association (ABA) Routing Transit Number (RTN).

status
enum

This indicates if payments can be made to the Account Number.

type
string

A constant representing the object's type. For this resource it will always be account_number.

List Account Numbers
curl \ --url "${INCREASE_URL}/account_numbers" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

status
enum

The status to retrieve Account Numbers for.

ach_debit_status
enum

The ACH Debit status to retrieve Account Numbers for.

account_id
string

Filter Account Numbers to those belonging to the specified Account.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

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.

200 character maximum
Create an Account Number
curl -X "POST" \ --url "${INCREASE_URL}/account_numbers" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_id": "account_in71c4amph0vgo2qllky", "name": "Rent payments" }'
Parameters
account_id
string
Required

The Account the Account Number should belong to.

inbound_ach
dictionary

Options related to how this Account Number should handle inbound ACH transfers.

inbound_checks
dictionary

Options related to how this Account Number should handle inbound check withdrawals.

name
string
Required

The name you choose for the Account Number.

200 character maximum
Retrieve an Account Number
curl \ --url "${INCREASE_URL}/account_numbers/account_number_v18nkfqm6afpsrvy82b2" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
account_number_id
string
Required

The identifier of the Account Number to retrieve.

Update an Account Number
curl -X "PATCH" \ --url "${INCREASE_URL}/account_numbers/account_number_v18nkfqm6afpsrvy82b2" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "inbound_ach": { "debit_status": "blocked" }, "status": "disabled" }'
Parameters
account_number_id
string
Required

The identifier of the Account Number.

inbound_ach
dictionary

Options related to how this Account Number handles inbound ACH transfers.

inbound_checks
dictionary

Options related to how this Account Number should handle inbound check withdrawals.

name
string

The name you choose for the Account Number.

200 character maximum
status
enum

This indicates if transfers can be made to the Account Number.

Transactions

Transactions are the immutable additions and removals of money from your bank account. They're the equivalent of line items on your bank statement.

The Transaction object
{ "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" }
Attributes
account_id
string

The identifier for the Account the Transaction belongs to.

amount
integer

The Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.

created_at
string

The ISO 8601 date on which the Transaction occurred.

currency
enum

The ISO 4217 code for the Transaction's currency. This will match the currency on the Transaction's Account.

description
string

An informational message describing this transaction. Use the fields in source to get more detailed information. This field appears as the line-item on the statement.

id
string

The Transaction identifier.

route_id
string
Nullable

The identifier for the route this Transaction came through. Routes are things like cards and ACH details.

route_type
enum
Nullable

The type of the route this Transaction came through.

source
dictionary

This is an object giving more details on the network-level event that caused the Transaction. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.

type
string

A constant representing the object's type. For this resource it will always be transaction.

List Transactions
curl \ --url "${INCREASE_URL}/transactions" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Transactions for those belonging to the specified Account.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

category.in
array of strings

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

route_id
string

Filter Transactions for those belonging to the specified route. This could be a Card ID or an Account Number ID.

Retrieve a Transaction
curl \ --url "${INCREASE_URL}/transactions/transaction_uyrp7fld2ium70oa7oi" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
transaction_id
string
Required

The identifier of the Transaction to retrieve.

Pending Transactions

Pending Transactions are potential future additions and removals of money from your bank account.

The Pending Transaction object
{ "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "completed_at": null, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "id": "pending_transaction_k1sfetcau2qbvjbzgju4", "route_id": "card_oubs0hwk5rn6knuecxg2", "route_type": "card", "source": { "ach_transfer_instruction": { "amount": 100, "transfer_id": "ach_transfer_uoxatyh3lt5evrsdvo7q" }, "category": "ach_transfer_instruction" }, "status": "pending", "type": "pending_transaction" }
Attributes
account_id
string

The identifier for the account this Pending Transaction belongs to.

amount
integer

The Pending Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.

completed_at
string
Nullable

The ISO 8601 date on which the Pending Transaction was completed.

created_at
string

The ISO 8601 date on which the Pending Transaction occurred.

currency
enum

The ISO 4217 code for the Pending Transaction's currency. This will match the currency on the Pending Transaction's Account.

description
string

For a Pending Transaction related to a transfer, this is the description you provide. For a Pending Transaction related to a payment, this is the description the vendor provides.

id
string

The Pending Transaction identifier.

route_id
string
Nullable

The identifier for the route this Pending Transaction came through. Routes are things like cards and ACH details.

route_type
enum
Nullable

The type of the route this Pending Transaction came through.

source
dictionary

This is an object giving more details on the network-level event that caused the Pending Transaction. For example, for a card transaction this lists the merchant's industry and location.

status
enum

Whether the Pending Transaction has been confirmed and has an associated Transaction.

type
string

A constant representing the object's type. For this resource it will always be pending_transaction.

List Pending Transactions
curl \ --url "${INCREASE_URL}/pending_transactions" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter pending transactions to those belonging to the specified Account.

route_id
string

Filter pending transactions to those belonging to the specified Route.

category.in
array of strings

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

status.in
array of strings

Filter Pending Transactions for those with the specified status. By default only Pending Transactions in with status pending will be returned. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Retrieve a Pending Transaction
curl \ --url "${INCREASE_URL}/pending_transactions/pending_transaction_k1sfetcau2qbvjbzgju4" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
pending_transaction_id
string
Required

The identifier of the Pending Transaction.

Sandbox: Release an Inbound Funds Hold

This endpoint simulates immediately releasing an Inbound Funds Hold, which might be created as a result of e.g., an ACH debit.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/inbound_funds_holds/inbound_funds_hold_9vuasmywdo7xb3zt4071/release" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Returns a Inbound Funds Hold object:
{ "amount": 100, "automatically_releases_at": "2020-01-31T23:59:59Z", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "held_transaction_id": "transaction_uyrp7fld2ium70oa7oi", "id": "inbound_funds_hold_9vuasmywdo7xb3zt4071", "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "released_at": null, "status": "held", "type": "inbound_funds_hold" }
Parameters
inbound_funds_hold_id
string
Required

The inbound funds hold to release.

Declined Transactions

Declined Transactions are refused additions and removals of money from your bank account. For example, Declined Transactions are caused when your Account has an insufficient balance or your Limits are triggered.

The Declined Transaction object
{ "account_id": "account_in71c4amph0vgo2qllky", "amount": 1750, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "id": "declined_transaction_17jbn0yyhvkt4v4ooym8", "route_id": "account_number_v18nkfqm6afpsrvy82b2", "route_type": "account_number", "source": { "ach_decline": { "amount": 1750, "id": "ach_decline_72v1mcwxudctq56efipa", "inbound_ach_transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev", "originator_company_descriptive_date": null, "originator_company_discretionary_data": null, "originator_company_id": "0987654321", "originator_company_name": "BIG BANK", "reason": "insufficient_funds", "receiver_id_number": "12345678900", "receiver_name": "IAN CREASE", "trace_number": "021000038461022", "type": "ach_decline" }, "category": "ach_decline" }, "type": "declined_transaction" }
Attributes
account_id
string

The identifier for the Account the Declined Transaction belongs to.

amount
integer

The Declined Transaction amount in the minor unit of its currency. For dollars, for example, this is cents.

created_at
string

The ISO 8601 date on which the Transaction occurred.

currency
enum

The ISO 4217 code for the Declined Transaction's currency. This will match the currency on the Declined Transaction's Account.

description
string

This is the description the vendor provides.

id
string

The Declined Transaction identifier.

route_id
string
Nullable

The identifier for the route this Declined Transaction came through. Routes are things like cards and ACH details.

route_type
enum
Nullable

The type of the route this Declined Transaction came through.

source
dictionary

This is an object giving more details on the network-level event that caused the Declined Transaction. For example, for a card transaction this lists the merchant's industry and location. Note that for backwards compatibility reasons, additional undocumented keys may appear in this object. These should be treated as deprecated and will be removed in the future.

type
string

A constant representing the object's type. For this resource it will always be declined_transaction.

List Declined Transactions
curl \ --url "${INCREASE_URL}/declined_transactions" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Declined Transactions to ones belonging to the specified Account.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

route_id
string

Filter Declined Transactions to those belonging to the specified route.

category.in
array of strings

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

Retrieve a Declined Transaction
curl \ --url "${INCREASE_URL}/declined_transactions/declined_transaction_17jbn0yyhvkt4v4ooym8" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
declined_transaction_id
string
Required

The identifier of the Declined Transaction.

Account Transfers

Account transfers move funds between your own accounts at Increase.

The Account Transfer object
{ "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "approval": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null }, "cancellation": null, "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "currency": "USD", "description": "Move money into savings", "destination_account_id": "account_uf16sut2ct5bevmq3eh", "destination_transaction_id": "transaction_j3itv8dtk5o8pw3p1xj4", "id": "account_transfer_7k9qe1ysdgqztnt63l7n", "idempotency_key": null, "network": "account", "pending_transaction_id": null, "status": "complete", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "account_transfer" }
Attributes
account_id
string

The Account to which the transfer belongs.

amount
integer

The transfer amount in the minor unit of the destination account currency. For dollars, for example, this is cents.

approval
dictionary
Nullable

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

cancellation
dictionary
Nullable

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

created_at
string

The ISO 8601 date and time at which the transfer was created.

created_by
dictionary
Nullable

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

currency
enum

The ISO 4217 code for the destination account currency.

description
string

The description that will show on the transactions.

destination_account_id
string

The destination account's identifier.

destination_transaction_id
string
Nullable

The ID for the transaction receiving the transfer.

id
string

The account transfer's identifier.

idempotency_key
string
Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

network
string

The transfer's network.

pending_transaction_id
string
Nullable

The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.

status
enum

The lifecycle status of the transfer.

transaction_id
string
Nullable

The ID for the transaction funding the transfer.

type
string

A constant representing the object's type. For this resource it will always be account_transfer.

List Account Transfers
curl \ --url "${INCREASE_URL}/account_transfers?account_id=account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

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

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.

200 character maximum
created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Create an Account Transfer
curl -X "POST" \ --url "${INCREASE_URL}/account_transfers" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "description": "Creating liquidity", "destination_account_id": "account_uf16sut2ct5bevmq3eh" }'
Parameters
account_id
string
Required

The identifier for the account that will send the transfer.

amount
integer
Required

The transfer amount in the minor unit of the account currency. For dollars, for example, this is cents.

description
string
Required

The description you choose to give the transfer.

200 character maximum
destination_account_id
string
Required

The identifier for the account that will receive the transfer.

require_approval
boolean

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

Retrieve an Account Transfer
curl \ --url "${INCREASE_URL}/account_transfers/account_transfer_7k9qe1ysdgqztnt63l7n" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
account_transfer_id
string
Required

The identifier of the Account Transfer.

Approve an Account Transfer
curl -X "POST" \ --url "${INCREASE_URL}/account_transfers/account_transfer_7k9qe1ysdgqztnt63l7n/approve" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
account_transfer_id
string
Required

The identifier of the Account Transfer to approve.

Cancel an Account Transfer
curl -X "POST" \ --url "${INCREASE_URL}/account_transfers/account_transfer_7k9qe1ysdgqztnt63l7n/cancel" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
account_transfer_id
string
Required

The identifier of the pending Account Transfer to cancel.

Sandbox: Approve an Account Transfer

If your account is configured to require approval for each transfer, this endpoint simulates the approval of an Account Transfer. You can also approve sandbox Account Transfers in the dashboard. This transfer must first have a status of pending_approval.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/account_transfers/account_transfer_7k9qe1ysdgqztnt63l7n/complete" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
account_transfer_id
string
Required

The identifier of the Account Transfer you wish to complete.

ACH Transfers

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

The ACH Transfer object
{ "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "acknowledgement": { "acknowledged_at": "2020-01-31T23:59:59Z" }, "addenda": null, "amount": 100, "approval": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null }, "cancellation": null, "company_descriptive_date": null, "company_discretionary_data": null, "company_entry_description": null, "company_name": "National Phonograph Company", "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "currency": "USD", "destination_account_holder": "business", "effective_date": null, "external_account_id": "external_account_ukk55lr923a3ac0pp7iv", "funding": "checking", "id": "ach_transfer_uoxatyh3lt5evrsdvo7q", "idempotency_key": null, "inbound_funds_hold": null, "individual_id": null, "individual_name": "Ian Crease", "network": "ach", "notifications_of_change": [], "pending_transaction_id": null, "preferred_effective_date": { "date": null, "settlement_schedule": "same_day" }, "return": null, "routing_number": "101050001", "settlement": null, "standard_entry_class_code": "corporate_credit_or_debit", "statement_descriptor": "Statement descriptor", "status": "returned", "submission": { "effective_date": "2020-01-31", "expected_funds_settlement_at": "2020-02-03T13:30:00Z", "expected_settlement_schedule": "future_dated", "submitted_at": "2020-01-31T23:59:59Z", "trace_number": "058349238292834" }, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "ach_transfer" }
Attributes
account_id
string

The Account to which the transfer belongs.

account_number
string

The destination account number.

acknowledgement
dictionary
Nullable

After the transfer is acknowledged by FedACH, this will contain supplemental details. The Federal Reserve sends an acknowledgement message for each file that Increase submits.

addenda
dictionary
Nullable

Additional information that will be sent to the recipient.

amount
integer

The transfer amount in USD cents. A positive amount indicates a credit transfer pushing funds to the receiving account. A negative amount indicates a debit transfer pulling funds from the receiving account.

approval
dictionary
Nullable

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

cancellation
dictionary
Nullable

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

company_descriptive_date
string
Nullable

The description of the date of the transfer.

company_discretionary_data
string
Nullable

The data you chose to associate with the transfer.

company_entry_description
string
Nullable

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

company_name
string
Nullable

The name by which the recipient knows you.

created_at
string

The ISO 8601 date and time at which the transfer was created.

created_by
dictionary
Nullable

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

currency
enum

The ISO 4217 code for the transfer's currency. For ACH transfers this is always equal to usd.

destination_account_holder
enum

The type of entity that owns the account to which the ACH Transfer is being sent.

external_account_id
string
Nullable

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

funding
enum

The type of the account to which the transfer will be sent.

id
string

The ACH transfer's identifier.

idempotency_key
string
Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

inbound_funds_hold
dictionary
Nullable

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

individual_id
string
Nullable

Your identifier for the transfer recipient.

individual_name
string
Nullable

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

network
string

The transfer's network.

notifications_of_change
array

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

pending_transaction_id
string
Nullable

The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.

preferred_effective_date
dictionary

Configuration for how the effective date of the transfer will be set. This determines same-day vs future-dated settlement timing. If not set, defaults to a settlement_schedule of same_day. If set, exactly one of the child attributes must be set.

return
dictionary
Nullable

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

routing_number
string

The American Bankers' Association (ABA) Routing Transit Number (RTN).

settlement
dictionary
Nullable

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

standard_entry_class_code
enum

The Standard Entry Class (SEC) code to use for the transfer.

statement_descriptor
string

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

status
enum

The lifecycle status of the transfer.

submission
dictionary
Nullable

After the transfer is submitted to FedACH, this will contain supplemental details. Increase batches transfers and submits a file to the Federal Reserve roughly every 30 minutes. The Federal Reserve processes ACH transfers during weekdays according to their posted schedule.

transaction_id
string
Nullable

The ID for the transaction funding the transfer.

type
string

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

List ACH Transfers
curl \ --url "${INCREASE_URL}/ach_transfers?account_id=account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

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

external_account_id
string

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

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.

200 character maximum
created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

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

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

account_number
string

The account number for the destination account.

17 character maximum
addenda
dictionary

Additional information that will be sent to the recipient. This is included in the transfer data sent to the receiving bank.

amount
integer
Required

The transfer amount in USD cents. A positive amount originates a credit transfer pushing funds to the receiving account. A negative amount originates a debit transfer pulling funds from the receiving account.

company_descriptive_date
string

The description of the date of the transfer, usually in the format YYMMDD. This is included in the transfer data sent to the receiving bank.

6 character maximum
company_discretionary_data
string

The data you choose to associate with the transfer. This is included in the transfer data sent to the receiving bank.

20 character maximum
company_entry_description
string

A description of the transfer. This is included in the transfer data sent to the receiving bank.

10 character maximum
company_name
string

The name by which the recipient knows you. This is included in the transfer data sent to the receiving bank.

16 character maximum
destination_account_holder
enum

The type of entity that owns the account to which the ACH Transfer is being sent.

external_account_id
string

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

funding
enum

The type of the account to which the transfer will be sent.

individual_id
string

Your identifier for the transfer recipient.

15 character maximum
individual_name
string

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

22 character maximum
preferred_effective_date
dictionary

Configuration for how the effective date of the transfer will be set. This determines same-day vs future-dated settlement timing. If not set, defaults to a settlement_schedule of same_day. If set, exactly one of the child attributes must be set.

require_approval
boolean

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

routing_number
string

The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.

9 character maximum
standard_entry_class_code
enum

The Standard Entry Class (SEC) code to use for the transfer.

statement_descriptor
string
Required

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

200 character maximum
transaction_timing
enum

The timing of the transaction.

Retrieve an ACH Transfer
curl \ --url "${INCREASE_URL}/ach_transfers/ach_transfer_uoxatyh3lt5evrsdvo7q" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
ach_transfer_id
string
Required

The identifier of the ACH Transfer.

Approve an ACH Transfer

Approves an ACH Transfer in a pending_approval state.

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

The identifier of the ACH Transfer to approve.

Cancel a pending ACH Transfer

Cancels an ACH Transfer in a pending_approval state.

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

The identifier of the pending ACH Transfer to cancel.

Sandbox: Acknowledge an ACH Transfer

Simulates the acknowledgement of an ACH Transfer by the Federal Reserve. This transfer must first have a status of submitted . In production, the Federal Reserve generally acknowledges submitted ACH files within 30 minutes. Since sandbox ACH Transfers are not submitted to the Federal Reserve, this endpoint allows you to skip that delay and add the acknowledgment subresource to the ACH Transfer.

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

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

Sandbox: Create a Notification of Change for an ACH Transfer

Simulates receiving a Notification of Change for an ACH Transfer.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/ach_transfers/ach_transfer_uoxatyh3lt5evrsdvo7q/create_notification_of_change" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "change_code": "incorrect_routing_number", "corrected_data": "123456789" }'
Parameters
ach_transfer_id
string
Required

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

change_code
enum
Required

The reason for the notification of change.

corrected_data
string
Required

The corrected data for the notification of change (e.g., a new routing number).

200 character maximum
Sandbox: Return an ACH Transfer

Simulates the return of an ACH Transfer by the Federal Reserve due to an error condition. This will also create a Transaction to account for the returned funds. This transfer must first have a status of submitted.

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

The identifier of the ACH Transfer you wish to return.

reason
enum

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

Sandbox: Settle an ACH Transfer

Simulates the settlement of an ACH Transfer by the Federal Reserve. This transfer must first have a status of submitted. Without this simulation the transfer will eventually settle on its own following the same Federal Reserve timeline as in production.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/ach_transfers/ach_transfer_uoxatyh3lt5evrsdvo7q/settle" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
ach_transfer_id
string
Required

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

Sandbox: Submit an ACH Transfer

Simulates the submission of an ACH Transfer to the Federal Reserve. This transfer must first have a status of pending_approval or pending_submission. In production, Increase submits ACH Transfers to the Federal Reserve three times per day on weekdays. Since sandbox ACH Transfers are not submitted to the Federal Reserve, this endpoint allows you to skip that delay and transition the ACH Transfer to a status of submitted.

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

The identifier of the ACH Transfer you wish to submit.

ACH Prenotifications

ACH Prenotifications are one way you can verify account and routing numbers by Automated Clearing House (ACH).

The ACH Prenotification object
{ "account_number": "987654321", "addendum": null, "company_descriptive_date": null, "company_discretionary_data": null, "company_entry_description": null, "company_name": null, "created_at": "2020-01-31T23:59:59Z", "credit_debit_indicator": null, "effective_date": null, "id": "ach_prenotification_ubjf9qqsxl3obbcn1u34", "idempotency_key": null, "notifications_of_change": [], "prenotification_return": null, "routing_number": "101050001", "status": "submitted", "type": "ach_prenotification" }
Attributes
account_number
string

The destination account number.

addendum
string
Nullable

Additional information for the recipient.

company_descriptive_date
string
Nullable

The description of the date of the notification.

company_discretionary_data
string
Nullable

Optional data associated with the notification.

company_entry_description
string
Nullable

The description of the notification.

company_name
string
Nullable

The name by which you know the company.

created_at
string

The ISO 8601 date and time at which the prenotification was created.

credit_debit_indicator
enum
Nullable

If the notification is for a future credit or debit.

effective_date
string
Nullable

The effective date in ISO 8601 format.

id
string

The ACH Prenotification's identifier.

idempotency_key
string
Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

notifications_of_change
array

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

prenotification_return
dictionary
Nullable

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

routing_number
string

The American Bankers' Association (ABA) Routing Transit Number (RTN).

status
enum

The lifecycle status of the ACH Prenotification.

type
string

A constant representing the object's type. For this resource it will always be ach_prenotification.

List ACH Prenotifications
curl \ --url "${INCREASE_URL}/ach_prenotifications" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

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.

200 character maximum
created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Create an ACH Prenotification
curl -X "POST" \ --url "${INCREASE_URL}/ach_prenotifications" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "routing_number": "101050001" }'
Parameters
account_id
string
Required

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

account_number
string
Required

The account number for the destination account.

200 character maximum
addendum
string

Additional information that will be sent to the recipient.

80 character maximum
company_descriptive_date
string

The description of the date of the transfer.

6 character maximum
company_discretionary_data
string

The data you choose to associate with the transfer.

20 character maximum
company_entry_description
string

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

10 character maximum
company_name
string

The name by which the recipient knows you.

16 character maximum
credit_debit_indicator
enum

Whether the Prenotification is for a future debit or credit.

effective_date
string

The transfer effective date in ISO 8601 format.

individual_id
string

Your identifier for the transfer recipient.

22 character maximum
individual_name
string

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

22 character maximum
routing_number
string
Required

The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.

9 character maximum
standard_entry_class_code
enum

The Standard Entry Class (SEC) code to use for the ACH Prenotification.

Retrieve an ACH Prenotification
curl \ --url "${INCREASE_URL}/ach_prenotifications/ach_prenotification_ubjf9qqsxl3obbcn1u34" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
ach_prenotification_id
string
Required

The identifier of the ACH Prenotification to retrieve.

Inbound ACH Transfers

An Inbound ACH Transfer is an ACH transfer initiated outside of Increase to your account.

The Inbound ACH Transfer object
{ "acceptance": { "accepted_at": "2020-01-31T23:59:59Z", "transaction_id": "transaction_uyrp7fld2ium70oa7oi" }, "account_id": "account_in71c4amph0vgo2qllky", "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "addenda": null, "amount": 100, "automatically_resolves_at": "2020-01-31T23:59:59Z", "decline": null, "direction": "credit", "effective_date": "2023-04-02", "expected_settlement_schedule": "same_day", "id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev", "international_addenda": null, "notification_of_change": null, "originator_company_descriptive_date": "230401", "originator_company_discretionary_data": "WEB AUTOPAY", "originator_company_entry_description": "INVOICE 2468", "originator_company_id": "0987654321", "originator_company_name": "PAYROLL COMPANY", "originator_routing_number": "101050001", "receiver_id_number": null, "receiver_name": "Ian Crease", "standard_entry_class_code": "internet_initiated", "status": "accepted", "trace_number": "021000038461022", "transfer_return": null, "type": "inbound_ach_transfer" }
Attributes
acceptance
dictionary
Nullable

If your transfer is accepted, this will contain details of the acceptance.

account_id
string

The Account to which the transfer belongs.

account_number_id
string

The identifier of the Account Number to which this transfer was sent.

addenda
dictionary
Nullable

Additional information sent from the originator.

amount
integer

The transfer amount in USD cents.

automatically_resolves_at
string

The time at which the transfer will be automatically resolved.

decline
dictionary
Nullable

If your transfer is declined, this will contain details of the decline.

direction
enum

The direction of the transfer.

effective_date
string

The effective date of the transfer. This is sent by the sending bank and is a factor in determining funds availability.

expected_settlement_schedule
enum

The settlement schedule the transfer is expected to follow.

id
string

The inbound ACH transfer's identifier.

international_addenda
dictionary
Nullable

If the Inbound ACH Transfer has a Standard Entry Class Code of IAT, this will contain fields pertaining to the International ACH Transaction.

notification_of_change
dictionary
Nullable

If you initiate a notification of change in response to the transfer, this will contain its details.

originator_company_descriptive_date
string
Nullable

The descriptive date of the transfer.

originator_company_discretionary_data
string
Nullable

The additional information included with the transfer.

originator_company_entry_description
string

The description of the transfer.

originator_company_id
string

The id of the company that initiated the transfer.

originator_company_name
string

The name of the company that initiated the transfer.

originator_routing_number
string

The American Banking Association (ABA) routing number of the bank originating the transfer.

receiver_id_number
string
Nullable

The id of the receiver of the transfer.

receiver_name
string
Nullable

The name of the receiver of the transfer.

standard_entry_class_code
enum

The Standard Entry Class (SEC) code of the transfer.

status
enum

The status of the transfer.

trace_number
string

The trace number of the transfer.

transfer_return
dictionary
Nullable

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

type
string

A constant representing the object's type. For this resource it will always be inbound_ach_transfer.

List Inbound ACH Transfers
curl \ --url "${INCREASE_URL}/inbound_ach_transfers?account_id=account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Inbound ACH Tranfers to ones belonging to the specified Account.

account_number_id
string

Filter Inbound ACH Tranfers to ones belonging to the specified Account Number.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

status
enum

Filter Inbound ACH Transfers to those with the specified status.

Retrieve an Inbound ACH Transfer
curl \ --url "${INCREASE_URL}/inbound_ach_transfers/inbound_ach_transfer_tdrwqr3fq9gnnq49odev" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
inbound_ach_transfer_id
string
Required

The identifier of the Inbound ACH Transfer to get details for.

Create a notification of change for an Inbound ACH Transfer
curl -X "POST" \ --url "${INCREASE_URL}/inbound_ach_transfers/inbound_ach_transfer_tdrwqr3fq9gnnq49odev/create_notification_of_change" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "updated_account_number": "987654321", "updated_routing_number": "101050001" }'
Parameters
inbound_ach_transfer_id
string
Required

The identifier of the Inbound ACH Transfer for which to create a notification of change.

updated_account_number
string

The updated account number to send in the notification of change.

200 character maximum
updated_routing_number
string

The updated routing number to send in the notification of change.

200 character maximum
Decline an Inbound ACH Transfer
curl -X "POST" \ --url "${INCREASE_URL}/inbound_ach_transfers/inbound_ach_transfer_tdrwqr3fq9gnnq49odev/decline" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "reason": "payment_stopped" }'
Parameters
inbound_ach_transfer_id
string
Required

The identifier of the Inbound ACH Transfer to decline.

reason
enum

The reason why this transfer will be returned. If this parameter is unset, the return codes will be payment_stopped for debits and credit_entry_refused_by_receiver for credits.

Return an Inbound ACH Transfer
curl -X "POST" \ --url "${INCREASE_URL}/inbound_ach_transfers/inbound_ach_transfer_tdrwqr3fq9gnnq49odev/transfer_return" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "reason": "payment_stopped" }'
Parameters
inbound_ach_transfer_id
string
Required

The identifier of the Inbound ACH Transfer to return to the originating financial institution.

reason
enum
Required

The reason why this transfer will be returned. The most usual return codes are payment_stopped for debits and credit_entry_refused_by_receiver for credits.

Sandbox: Create an Inbound ACH Transfer

Simulates an inbound ACH transfer to your account. This imitates initiating a transfer to an Increase account from a different financial institution. The transfer may be either a credit or a debit depending on if the amount is positive or negative. The result of calling this API will contain the created transfer. You can pass a resolve_at parameter to allow for a window to action on the Inbound ACH Transfer. Alternatively, if you don't pass the resolve_at parameter the result will contain either a Transaction or a Declined Transaction depending on whether or not the transfer is allowed.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/inbound_ach_transfers" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 1000 }'
Parameters
account_number_id
string
Required

The identifier of the Account Number the inbound ACH Transfer is for.

amount
integer
Required

The transfer amount in cents. A positive amount originates a credit transfer pushing funds to the receiving account. A negative amount originates a debit transfer pulling funds from the receiving account.

company_descriptive_date
string

The description of the date of the transfer.

6 character maximum
company_discretionary_data
string

Data associated with the transfer set by the sender.

20 character maximum
company_entry_description
string

The description of the transfer set by the sender.

10 character maximum
company_id
string

The sender's company ID.

15 character maximum
company_name
string

The name of the sender.

16 character maximum
receiver_id_number
string

The ID of the receiver of the transfer.

200 character maximum
receiver_name
string

The name of the receiver of the transfer.

200 character maximum
resolve_at
string

The time at which the transfer should be resolved. If not provided will resolve immediately.

standard_entry_class_code
enum

The standard entry class code for the transfer.

Wire Transfers

Wire transfers move funds between your Increase account and any other account accessible by Fedwire.

The Wire Transfer object
{ "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "amount": 100, "approval": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null }, "beneficiary_address_line1": null, "beneficiary_address_line2": null, "beneficiary_address_line3": null, "beneficiary_name": null, "cancellation": null, "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "currency": "USD", "external_account_id": "external_account_ukk55lr923a3ac0pp7iv", "id": "wire_transfer_5akynk7dqsq25qwk9q2u", "idempotency_key": null, "message_to_recipient": "Message to recipient", "network": "wire", "originator_address_line1": null, "originator_address_line2": null, "originator_address_line3": null, "originator_name": null, "pending_transaction_id": null, "reversal": null, "routing_number": "101050001", "source_account_number_id": null, "status": "complete", "submission": null, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "wire_transfer" }
Attributes
account_id
string

The Account to which the transfer belongs.

account_number
string

The destination account number.

amount
integer

The transfer amount in USD cents.

approval
dictionary
Nullable

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

beneficiary_address_line1
string
Nullable

The beneficiary's address line 1.

beneficiary_address_line2
string
Nullable

The beneficiary's address line 2.

beneficiary_address_line3
string
Nullable

The beneficiary's address line 3.

beneficiary_name
string
Nullable

The beneficiary's name.

cancellation
dictionary
Nullable

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

created_at
string

The ISO 8601 date and time at which the transfer was created.

created_by
dictionary
Nullable

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

currency
enum

The ISO 4217 code for the transfer's currency. For wire transfers this is always equal to usd.

external_account_id
string
Nullable

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

id
string

The wire transfer's identifier.

idempotency_key
string
Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

message_to_recipient
string
Nullable

The message that will show on the recipient's bank statement.

network
string

The transfer's network.

originator_address_line1
string
Nullable

The originator's address line 1.

originator_address_line2
string
Nullable

The originator's address line 2.

originator_address_line3
string
Nullable

The originator's address line 3.

originator_name
string
Nullable

The originator's name.

pending_transaction_id
string
Nullable

The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.

reversal
dictionary
Nullable

If your transfer is reversed, this will contain details of the reversal.

routing_number
string

The American Bankers' Association (ABA) Routing Transit Number (RTN).

source_account_number_id
string
Nullable

The Account Number that was passed to the wire's recipient.

status
enum

The lifecycle status of the transfer.

submission
dictionary
Nullable

After the transfer is submitted to Fedwire, this will contain supplemental details.

transaction_id
string
Nullable

The ID for the transaction funding the transfer.

type
string

A constant representing the object's type. For this resource it will always be wire_transfer.

Sandbox: Reverse a Wire Transfer

Simulates the reversal of a Wire Transfer by the Federal Reserve due to error conditions. This will also create a Transaction to account for the returned funds. This Wire Transfer must first have a status of complete.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/wire_transfers/wire_transfer_5akynk7dqsq25qwk9q2u/reverse" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
wire_transfer_id
string
Required

The identifier of the Wire Transfer you wish to reverse.

Sandbox: Submit a Wire Transfer

Simulates the submission of a Wire Transfer to the Federal Reserve. This transfer must first have a status of pending_approval or pending_creating.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/wire_transfers/wire_transfer_5akynk7dqsq25qwk9q2u/submit" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
wire_transfer_id
string
Required

The identifier of the Wire Transfer you wish to submit.

List Wire Transfers
curl \ --url "${INCREASE_URL}/wire_transfers?account_id=account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Wire Transfers to those belonging to the specified Account.

external_account_id
string

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

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.

200 character maximum
created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Create a Wire Transfer
curl -X "POST" \ --url "${INCREASE_URL}/wire_transfers" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "amount": 100, "beneficiary_address_line1": "33 Liberty Street", "beneficiary_address_line2": "New York", "beneficiary_address_line3": "NY 10045", "beneficiary_name": "Ian Crease", "message_to_recipient": "New account transfer", "routing_number": "101050001" }'
Parameters
account_id
string
Required

The identifier for the account that will send the transfer.

account_number
string

The account number for the destination account.

34 character maximum
amount
integer
Required

The transfer amount in USD cents.

beneficiary_address_line1
string

The beneficiary's address line 1.

35 character maximum
beneficiary_address_line2
string

The beneficiary's address line 2.

35 character maximum
beneficiary_address_line3
string

The beneficiary's address line 3.

35 character maximum
beneficiary_name
string
Required

The beneficiary's name.

35 character maximum
external_account_id
string

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

message_to_recipient
string
Required

The message that will show on the recipient's bank statement.

140 character maximum
originator_address_line1
string

The originator's address line 1. This is only necessary if you're transferring from a commingled account. Otherwise, we'll use the associated entity's details.

35 character maximum
originator_address_line2
string

The originator's address line 2. This is only necessary if you're transferring from a commingled account. Otherwise, we'll use the associated entity's details.

35 character maximum
originator_address_line3
string

The originator's address line 3. This is only necessary if you're transferring from a commingled account. Otherwise, we'll use the associated entity's details.

35 character maximum
originator_name
string

The originator's name. This is only necessary if you're transferring from a commingled account. Otherwise, we'll use the associated entity's details.

35 character maximum
require_approval
boolean

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

routing_number
string

The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.

9 character maximum
source_account_number_id
string

The ID of an Account Number that will be passed to the wire's recipient

Retrieve a Wire Transfer
curl \ --url "${INCREASE_URL}/wire_transfers/wire_transfer_5akynk7dqsq25qwk9q2u" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
wire_transfer_id
string
Required

The identifier of the Wire Transfer.

Approve a Wire Transfer
curl -X "POST" \ --url "${INCREASE_URL}/wire_transfers/wire_transfer_5akynk7dqsq25qwk9q2u/approve" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
wire_transfer_id
string
Required

The identifier of the Wire Transfer to approve.

Cancel a pending Wire Transfer
curl -X "POST" \ --url "${INCREASE_URL}/wire_transfers/wire_transfer_5akynk7dqsq25qwk9q2u/cancel" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
wire_transfer_id
string
Required

The identifier of the pending Wire Transfer to cancel.

Inbound Wire Transfers

An Inbound Wire Transfer is a wire transfer initiated outside of Increase to your account.

The Inbound Wire Transfer object
{ "account_id": "account_in71c4amph0vgo2qllky", "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 100, "beneficiary_address_line1": null, "beneficiary_address_line2": null, "beneficiary_address_line3": null, "beneficiary_name": null, "beneficiary_reference": null, "description": "Inbound wire transfer", "id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0", "input_message_accountability_data": null, "originator_address_line1": null, "originator_address_line2": null, "originator_address_line3": null, "originator_name": null, "originator_routing_number": null, "originator_to_beneficiary_information": null, "originator_to_beneficiary_information_line1": null, "originator_to_beneficiary_information_line2": null, "originator_to_beneficiary_information_line3": null, "originator_to_beneficiary_information_line4": null, "sender_reference": null, "status": "accepted", "type": "inbound_wire_transfer" }
Attributes
account_id
string

The Account to which the transfer belongs.

account_number_id
string

The identifier of the Account Number to which this transfer was sent.

amount
integer

The amount in USD cents.

beneficiary_address_line1
string
Nullable

A free-form address field set by the sender.

beneficiary_address_line2
string
Nullable

A free-form address field set by the sender.

beneficiary_address_line3
string
Nullable

A free-form address field set by the sender.

beneficiary_name
string
Nullable

A name set by the sender.

beneficiary_reference
string
Nullable

A free-form reference string set by the sender, to help identify the transfer.

description
string

An Increase-constructed description of the transfer.

id
string

The inbound wire transfer's identifier.

input_message_accountability_data
string
Nullable

A unique identifier available to the originating and receiving banks, commonly abbreviated as IMAD. It is created when the wire is submitted to the Fedwire service and is helpful when debugging wires with the originating bank.

originator_address_line1
string
Nullable

The address of the wire originator, set by the sending bank.

originator_address_line2
string
Nullable

The address of the wire originator, set by the sending bank.

originator_address_line3
string
Nullable

The address of the wire originator, set by the sending bank.

originator_name
string
Nullable

The originator of the wire, set by the sending bank.

originator_routing_number
string
Nullable

The American Banking Association (ABA) routing number of the bank originating the transfer.

originator_to_beneficiary_information
string
Nullable

An Increase-created concatenation of the Originator-to-Beneficiary lines.

originator_to_beneficiary_information_line1
string
Nullable

A free-form message set by the wire originator.

originator_to_beneficiary_information_line2
string
Nullable

A free-form message set by the wire originator.

originator_to_beneficiary_information_line3
string
Nullable

A free-form message set by the wire originator.

originator_to_beneficiary_information_line4
string
Nullable

A free-form message set by the wire originator.

sender_reference
string
Nullable

The sending bank's reference number for the wire transfer.

status
enum

The status of the transfer.

type
string

A constant representing the object's type. For this resource it will always be inbound_wire_transfer.

List Inbound Wire Transfers
curl \ --url "${INCREASE_URL}/inbound_wire_transfers?account_id=account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Inbound Wire Tranfers to ones belonging to the specified Account.

account_number_id
string

Filter Inbound Wire Tranfers to ones belonging to the specified Account Number.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

status
enum

Filter Inbound Wire Transfers to those with the specified status.

Retrieve an Inbound Wire Transfer
curl \ --url "${INCREASE_URL}/inbound_wire_transfers/inbound_wire_transfer_f228m6bmhtcxjco9pwp0" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
inbound_wire_transfer_id
string
Required

The identifier of the Inbound Wire Transfer to get details for.

Sandbox: Create an Inbound Wire Transfer

Simulates an Inbound Wire Transfer to your account.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/inbound_wire_transfers" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 1000 }'
Parameters
account_number_id
string
Required

The identifier of the Account Number the inbound Wire Transfer is for.

amount
integer
Required

The transfer amount in cents. Must be positive.

beneficiary_address_line1
string

The sending bank will set beneficiary_address_line1 in production. You can simulate any value here.

200 character maximum
beneficiary_address_line2
string

The sending bank will set beneficiary_address_line2 in production. You can simulate any value here.

200 character maximum
beneficiary_address_line3
string

The sending bank will set beneficiary_address_line3 in production. You can simulate any value here.

200 character maximum
beneficiary_name
string

The sending bank will set beneficiary_name in production. You can simulate any value here.

200 character maximum
beneficiary_reference
string

The sending bank will set beneficiary_reference in production. You can simulate any value here.

200 character maximum
originator_address_line1
string

The sending bank will set originator_address_line1 in production. You can simulate any value here.

200 character maximum
originator_address_line2
string

The sending bank will set originator_address_line2 in production. You can simulate any value here.

200 character maximum
originator_address_line3
string

The sending bank will set originator_address_line3 in production. You can simulate any value here.

200 character maximum
originator_name
string

The sending bank will set originator_name in production. You can simulate any value here.

200 character maximum
originator_routing_number
string

The sending bank will set originator_routing_number in production. You can simulate any value here.

200 character maximum
originator_to_beneficiary_information_line1
string

The sending bank will set originator_to_beneficiary_information_line1 in production. You can simulate any value here.

200 character maximum
originator_to_beneficiary_information_line2
string

The sending bank will set originator_to_beneficiary_information_line2 in production. You can simulate any value here.

200 character maximum
originator_to_beneficiary_information_line3
string

The sending bank will set originator_to_beneficiary_information_line3 in production. You can simulate any value here.

200 character maximum
originator_to_beneficiary_information_line4
string

The sending bank will set originator_to_beneficiary_information_line4 in production. You can simulate any value here.

200 character maximum
sender_reference
string

The sending bank will set sender_reference in production. You can simulate any value here.

200 character maximum
Wire Drawdown Requests

Wire drawdown requests enable you to request that someone else send you a wire. This feature is in beta; reach out to support@increase.com to learn more.

The Wire Drawdown Request object
{ "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 10000, "currency": "USD", "fulfillment_inbound_wire_transfer_id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0", "id": "wire_drawdown_request_q6lmocus3glo0lr2bfv3", "idempotency_key": null, "message_to_recipient": "Invoice 29582", "originator_address_line1": null, "originator_address_line2": null, "originator_address_line3": null, "originator_name": null, "recipient_account_number": "987654321", "recipient_address_line1": "33 Liberty Street", "recipient_address_line2": "New York, NY, 10045", "recipient_address_line3": null, "recipient_name": "Ian Crease", "recipient_routing_number": "101050001", "status": "fulfilled", "submission": { "input_message_accountability_data": "20220118MMQFMP0P000003" }, "type": "wire_drawdown_request" }
Attributes
account_number_id
string

The Account Number to which the recipient of this request is being requested to send funds.

amount
integer

The amount being requested in cents.

currency
string

The ISO 4217 code for the amount being requested. Will always be "USD".

fulfillment_inbound_wire_transfer_id
string
Nullable

If the recipient fulfills the drawdown request by sending funds, then this will be the identifier of the corresponding Transaction.

id
string

The Wire drawdown request 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.

message_to_recipient
string

The message the recipient will see as part of the drawdown request.

originator_address_line1
string
Nullable

The originator's address line 1.

originator_address_line2
string
Nullable

The originator's address line 2.

originator_address_line3
string
Nullable

The originator's address line 3.

originator_name
string
Nullable

The originator's name.

recipient_account_number
string

The drawdown request's recipient's account number.

recipient_address_line1
string
Nullable

Line 1 of the drawdown request's recipient's address.

recipient_address_line2
string
Nullable

Line 2 of the drawdown request's recipient's address.

recipient_address_line3
string
Nullable

Line 3 of the drawdown request's recipient's address.

recipient_name
string
Nullable

The drawdown request's recipient's name.

recipient_routing_number
string

The drawdown request's recipient's routing number.

status
enum

The lifecycle status of the drawdown request.

submission
dictionary
Nullable

After the drawdown request is submitted to Fedwire, this will contain supplemental details.

type
string

A constant representing the object's type. For this resource it will always be wire_drawdown_request.

List Wire Drawdown Requests
curl \ --url "${INCREASE_URL}/wire_drawdown_requests" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

status
enum

Filter Wire Drawdown Requests for those with the specified status.

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.

200 character maximum
Create a Wire Drawdown Request
curl -X "POST" \ --url "${INCREASE_URL}/wire_drawdown_requests" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 10000, "message_to_recipient": "Invoice 29582", "recipient_account_number": "987654321", "recipient_address_line1": "33 Liberty Street", "recipient_address_line2": "New York, NY, 10045", "recipient_name": "Ian Crease", "recipient_routing_number": "101050001" }'
Parameters
account_number_id
string
Required

The Account Number to which the recipient should send funds.

amount
integer
Required

The amount requested from the recipient, in USD cents.

message_to_recipient
string
Required

A message the recipient will see as part of the request.

140 character maximum
originator_address_line1
string

The drawdown request originator's address line 1. This is only necessary if you're requesting a payment to a commingled account. Otherwise, we'll use the associated entity's details.

35 character maximum
originator_address_line2
string

The drawdown request originator's address line 2. This is only necessary if you're requesting a payment to a commingled account. Otherwise, we'll use the associated entity's details.

35 character maximum
originator_address_line3
string

The drawdown request originator's address line 3. This is only necessary if you're requesting a payment to a commingled account. Otherwise, we'll use the associated entity's details.

35 character maximum
originator_name
string

The drawdown request originator's name. This is only necessary if you're requesting a payment to a commingled account. Otherwise, we'll use the associated entity's details.

35 character maximum
recipient_account_number
string
Required

The drawdown request's recipient's account number.

34 character maximum
recipient_address_line1
string

Line 1 of the drawdown request's recipient's address.

35 character maximum
recipient_address_line2
string

Line 2 of the drawdown request's recipient's address.

35 character maximum
recipient_address_line3
string

Line 3 of the drawdown request's recipient's address.

35 character maximum
recipient_name
string
Required

The drawdown request's recipient's name.

35 character maximum
recipient_routing_number
string
Required

The drawdown request's recipient's routing number.

9 character maximum
Retrieve a Wire Drawdown Request
curl \ --url "${INCREASE_URL}/wire_drawdown_requests/wire_drawdown_request_q6lmocus3glo0lr2bfv3" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
wire_drawdown_request_id
string
Required

The identifier of the Wire Drawdown Request to retrieve.

Inbound Wire Drawdown Requests

Inbound wire drawdown requests are requests from someone else to send them a wire. This feature is in beta; reach out to support@increase.com to learn more.

The Inbound Wire Drawdown Request object
{ "amount": 10000, "beneficiary_account_number": "987654321", "beneficiary_address_line1": "33 Liberty Street", "beneficiary_address_line2": "New York, NY, 10045", "beneficiary_address_line3": null, "beneficiary_name": "Ian Crease", "beneficiary_routing_number": "101050001", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "id": "inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e", "message_to_recipient": "Invoice 29582", "originator_account_number": "987654321", "originator_address_line1": "33 Liberty Street", "originator_address_line2": "New York, NY, 10045", "originator_address_line3": null, "originator_name": "Ian Crease", "originator_routing_number": "101050001", "originator_to_beneficiary_information_line1": null, "originator_to_beneficiary_information_line2": null, "originator_to_beneficiary_information_line3": null, "originator_to_beneficiary_information_line4": null, "recipient_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "type": "inbound_wire_drawdown_request" }
Attributes
amount
integer

The amount being requested in cents.

beneficiary_account_number
string

The drawdown request's beneficiary's account number.

beneficiary_address_line1
string
Nullable

Line 1 of the drawdown request's beneficiary's address.

beneficiary_address_line2
string
Nullable

Line 2 of the drawdown request's beneficiary's address.

beneficiary_address_line3
string
Nullable

Line 3 of the drawdown request's beneficiary's address.

beneficiary_name
string
Nullable

The drawdown request's beneficiary's name.

beneficiary_routing_number
string

The drawdown request's beneficiary's routing number.

created_at
string

The ISO 8601 date and time at which the inbound wire drawdown requested was created.

currency
string

The ISO 4217 code for the amount being requested. Will always be "USD".

id
string

The Wire drawdown request identifier.

message_to_recipient
string
Nullable

A message from the drawdown request's originator.

originator_account_number
string

The drawdown request's originator's account number.

originator_address_line1
string
Nullable

Line 1 of the drawdown request's originator's address.

originator_address_line2
string
Nullable

Line 2 of the drawdown request's originator's address.

originator_address_line3
string
Nullable

Line 3 of the drawdown request's originator's address.

originator_name
string
Nullable

The drawdown request's originator's name.

originator_routing_number
string

The drawdown request's originator's routing number.

originator_to_beneficiary_information_line1
string
Nullable

Line 1 of the information conveyed from the originator of the message to the beneficiary.

originator_to_beneficiary_information_line2
string
Nullable

Line 2 of the information conveyed from the originator of the message to the beneficiary.

originator_to_beneficiary_information_line3
string
Nullable

Line 3 of the information conveyed from the originator of the message to the beneficiary.

originator_to_beneficiary_information_line4
string
Nullable

Line 4 of the information conveyed from the originator of the message to the beneficiary.

recipient_account_number_id
string

The Account Number from which the recipient of this request is being requested to send funds.

type
string

A constant representing the object's type. For this resource it will always be inbound_wire_drawdown_request.

List Inbound Wire Drawdown Requests
curl \ --url "${INCREASE_URL}/inbound_wire_drawdown_requests" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

Retrieve an Inbound Wire Drawdown Request
curl \ --url "${INCREASE_URL}/inbound_wire_drawdown_requests/inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
inbound_wire_drawdown_request_id
string
Required

The identifier of the Inbound Wire Drawdown Request to retrieve.

Sandbox: Create an Inbound Wire Drawdown request

Simulates receiving an Inbound Wire Drawdown Request.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/inbound_wire_drawdown_requests" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "amount": 10000, "beneficiary_account_number": "987654321", "beneficiary_address_line1": "33 Liberty Street", "beneficiary_address_line2": "New York, NY, 10045", "beneficiary_name": "Ian Crease", "beneficiary_routing_number": "101050001", "currency": "USD", "message_to_recipient": "Invoice 29582", "originator_account_number": "987654321", "originator_address_line1": "33 Liberty Street", "originator_address_line2": "New York, NY, 10045", "originator_name": "Ian Crease", "originator_routing_number": "101050001", "recipient_account_number_id": "account_number_v18nkfqm6afpsrvy82b2" }'
Parameters
amount
integer
Required

The amount being requested in cents.

beneficiary_account_number
string
Required

The drawdown request's beneficiary's account number.

200 character maximum
beneficiary_address_line1
string

Line 1 of the drawdown request's beneficiary's address.

35 character maximum
beneficiary_address_line2
string

Line 2 of the drawdown request's beneficiary's address.

35 character maximum
beneficiary_address_line3
string

Line 3 of the drawdown request's beneficiary's address.

35 character maximum
beneficiary_name
string

The drawdown request's beneficiary's name.

35 character maximum
beneficiary_routing_number
string
Required

The drawdown request's beneficiary's routing number.

200 character maximum
currency
string
Required

The ISO 4217 code for the amount being requested. Will always be "USD".

200 character maximum
message_to_recipient
string
Required

A message from the drawdown request's originator.

140 character maximum
originator_account_number
string
Required

The drawdown request's originator's account number.

200 character maximum
originator_address_line1
string

Line 1 of the drawdown request's originator's address.

35 character maximum
originator_address_line2
string

Line 2 of the drawdown request's originator's address.

35 character maximum
originator_address_line3
string

Line 3 of the drawdown request's originator's address.

35 character maximum
originator_name
string

The drawdown request's originator's name.

35 character maximum
originator_routing_number
string
Required

The drawdown request's originator's routing number.

200 character maximum
originator_to_beneficiary_information_line1
string

Line 1 of the information conveyed from the originator of the message to the beneficiary.

35 character maximum
originator_to_beneficiary_information_line2
string

Line 2 of the information conveyed from the originator of the message to the beneficiary.

35 character maximum
originator_to_beneficiary_information_line3
string

Line 3 of the information conveyed from the originator of the message to the beneficiary.

35 character maximum
originator_to_beneficiary_information_line4
string

Line 4 of the information conveyed from the originator of the message to the beneficiary.

35 character maximum
recipient_account_number_id
string
Required

The Account Number to which the recipient of this request is being requested to send funds from.

Check Transfers

Check Transfers move funds from your Increase account by mailing a physical check.

The Check Transfer object
{ "account_id": "account_in71c4amph0vgo2qllky", "account_number": "987654321", "amount": 1000, "approval": null, "approved_inbound_check_deposit_id": "inbound_check_deposit_zoshvqybq0cjjm31mra", "cancellation": null, "check_number": "123", "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "currency": "USD", "deposit": null, "fulfillment_method": "physical_check", "id": "check_transfer_30b43acfu9vw8fyc4f5", "idempotency_key": null, "mailing": { "image_id": null, "mailed_at": "2020-01-31T23:59:59Z" }, "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "physical_check": { "mailing_address": { "city": "New York", "line1": "33 Liberty Street", "line2": null, "name": "Ian Crease", "postal_code": "10045", "state": "NY" }, "memo": "Invoice 29582", "note": null, "recipient_name": "Ian Crease", "return_address": { "city": "New York", "line1": "33 Liberty Street", "line2": null, "name": "Ian Crease", "postal_code": "10045", "state": "NY" }, "signature_text": null, "signer_name": null, "tracking_updates": [] }, "routing_number": "101050001", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "status": "mailed", "stop_payment_request": null, "submission": { "submitted_at": "2020-01-31T23:59:59Z" }, "third_party": null, "type": "check_transfer" }
Attributes
account_id
string

The identifier of the Account from which funds will be transferred.

account_number
string

The account number printed on the check.

amount
integer

The transfer amount in USD cents.

approval
dictionary
Nullable

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

approved_inbound_check_deposit_id
string
Nullable

If the Check Transfer was successfully deposited, this will contain the identifier of the Inbound Check Deposit object with details of the deposit.

cancellation
dictionary
Nullable

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

check_number
string

The check number printed on the check.

created_at
string

The ISO 8601 date and time at which the transfer was created.

created_by
dictionary
Nullable

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

currency
enum

The ISO 4217 code for the check's currency.

fulfillment_method
enum

Whether Increase will print and mail the check or if you will do it yourself.

id
string

The Check transfer's identifier.

idempotency_key
string
Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

mailing
dictionary
Nullable

If the check has been mailed by Increase, this will contain details of the shipment.

pending_transaction_id
string
Nullable

The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.

physical_check
dictionary
Nullable

Details relating to the physical check that Increase will print and mail. Will be present if and only if fulfillment_method is equal to physical_check.

routing_number
string

The routing number printed on the check.

source_account_number_id
string
Nullable

The identifier of the Account Number from which to send the transfer and print on the check.

status
enum

The lifecycle status of the transfer.

stop_payment_request
dictionary
Nullable

After a stop-payment is requested on the check, this will contain supplemental details.

submission
dictionary
Nullable

After the transfer is submitted, this will contain supplemental details.

third_party
dictionary
Nullable

Details relating to the custom fulfillment you will perform. Will be present if and only if fulfillment_method is equal to third_party.

type
string

A constant representing the object's type. For this resource it will always be check_transfer.

List Check Transfers
curl \ --url "${INCREASE_URL}/check_transfers?account_id=account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

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

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.

200 character maximum
created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Create a Check Transfer
curl -X "POST" \ --url "${INCREASE_URL}/check_transfers" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_id": "account_in71c4amph0vgo2qllky", "amount": 1000, "fulfillment_method": "physical_check", "physical_check": { "mailing_address": { "city": "New York", "line1": "33 Liberty Street", "name": "Ian Crease", "postal_code": "10045", "state": "NY" }, "memo": "Check payment", "recipient_name": "Ian Crease", "return_address": null, "signature_text": "Ian Crease" }, "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2" }'
Parameters
account_id
string
Required

The identifier for the account that will send the transfer.

amount
integer
Required

The transfer amount in USD cents.

fulfillment_method
enum

Whether Increase will print and mail the check or if you will do it yourself.

physical_check
dictionary

Details relating to the physical check that Increase will print and mail. This is required if fulfillment_method is equal to physical_check. It must not be included if any other fulfillment_method is provided.

require_approval
boolean

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

source_account_number_id
string
Required

The identifier of the Account Number from which to send the transfer and print on the check.

third_party
dictionary

Details relating to the custom fulfillment you will perform. This is required if fulfillment_method is equal to third_party. It must not be included if any other fulfillment_method is provided.

Retrieve a Check Transfer
curl \ --url "${INCREASE_URL}/check_transfers/check_transfer_30b43acfu9vw8fyc4f5" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
check_transfer_id
string
Required

The identifier of the Check Transfer.

Approve a Check Transfer
curl -X "POST" \ --url "${INCREASE_URL}/check_transfers/check_transfer_30b43acfu9vw8fyc4f5/approve" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
check_transfer_id
string
Required

The identifier of the Check Transfer to approve.

Cancel a pending Check Transfer
curl -X "POST" \ --url "${INCREASE_URL}/check_transfers/check_transfer_30b43acfu9vw8fyc4f5/cancel" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
check_transfer_id
string
Required

The identifier of the pending Check Transfer to cancel.

Request a stop payment on a Check Transfer
curl -X "POST" \ --url "${INCREASE_URL}/check_transfers/check_transfer_30b43acfu9vw8fyc4f5/stop_payment" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "reason": "mail_delivery_failed" }'
Parameters
check_transfer_id
string
Required

The identifier of the Check Transfer.

reason
enum

The reason why this transfer should be stopped.

Sandbox: Mail a Check Transfer

Simulates the mailing of a Check Transfer, which happens periodically throughout the day in production but can be sped up in sandbox. This transfer must first have a status of pending_approval or pending_submission.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/check_transfers/check_transfer_30b43acfu9vw8fyc4f5/mail" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
check_transfer_id
string
Required

The identifier of the Check Transfer you wish to mail.

Inbound Check Deposits

Inbound Check Deposits are records of third-parties attempting to deposit checks against your account.

The Inbound Check Deposit object
{ "accepted_at": "2020-01-31T23:59:59Z", "account_id": "account_in71c4amph0vgo2qllky", "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "adjustments": [], "amount": 1000, "back_image_file_id": "file_makxrc67oh9l6sg7w9yc", "bank_of_first_deposit_routing_number": "101050001", "check_number": "123", "check_transfer_id": "check_transfer_30b43acfu9vw8fyc4f5", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "declined_at": null, "declined_transaction_id": null, "deposit_return": null, "front_image_file_id": "file_makxrc67oh9l6sg7w9yc", "id": "inbound_check_deposit_zoshvqybq0cjjm31mra", "payee_name_analysis": "name_matches", "status": "accepted", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "inbound_check_deposit" }
Attributes
accepted_at
string
Nullable

If the Inbound Check Deposit was accepted, the ISO 8601 date and time at which this took place.

account_id
string

The Account the check is being deposited against.

account_number_id
string
Nullable

The Account Number the check is being deposited against.

adjustments
array

If the deposit or the return was adjusted by the sending institution, this will contain details of the adjustments.

amount
integer

The deposited amount in USD cents.

back_image_file_id
string
Nullable

The ID for the File containing the image of the back of the check.

bank_of_first_deposit_routing_number
string
Nullable

The American Bankers' Association (ABA) Routing Transit Number (RTN) for the bank depositing this check. In some rare cases, this is not transmitted via Check21 and the value will be null.

check_number
string
Nullable

The check number printed on the check being deposited.

check_transfer_id
string
Nullable

If this deposit is for an existing Check Transfer, the identifier of that Check Transfer.

created_at
string

The ISO 8601 date and time at which the deposit was attempted.

currency
enum

The ISO 4217 code for the deposit.

declined_at
string
Nullable

If the Inbound Check Deposit was declined, the ISO 8601 date and time at which this took place.

declined_transaction_id
string
Nullable

If the deposit attempt has been rejected, the identifier of the Declined Transaction object created as a result of the failed deposit.

deposit_return
dictionary
Nullable

If you requested a return of this deposit, this will contain details of the return.

front_image_file_id
string
Nullable

The ID for the File containing the image of the front of the check.

id
string

The deposit's identifier.

payee_name_analysis
enum

Whether the details on the check match the recipient name of the check transfer. This is an optional feature, contact sales to enable.

status
enum

The status of the Inbound Check Deposit.

transaction_id
string
Nullable

If the deposit attempt has been accepted, the identifier of the Transaction object created as a result of the successful deposit.

type
string

A constant representing the object's type. For this resource it will always be inbound_check_deposit.

List Inbound Check Deposits
curl \ --url "${INCREASE_URL}/inbound_check_deposits" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Inbound Check Deposits to those belonging to the specified Account.

check_transfer_id
string

Filter Inbound Check Deposits to those belonging to the specified Check Transfer.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Retrieve an Inbound Check Deposit
curl \ --url "${INCREASE_URL}/inbound_check_deposits/inbound_check_deposit_zoshvqybq0cjjm31mra" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
inbound_check_deposit_id
string
Required

The identifier of the Inbound Check Deposit to get details for.

Decline an Inbound Check Deposit
curl -X "POST" \ --url "${INCREASE_URL}/inbound_check_deposits/inbound_check_deposit_zoshvqybq0cjjm31mra/decline" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
inbound_check_deposit_id
string
Required

The identifier of the Inbound Check Deposit to decline.

Return an Inbound Check Deposit
curl -X "POST" \ --url "${INCREASE_URL}/inbound_check_deposits/inbound_check_deposit_zoshvqybq0cjjm31mra/return" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "reason": "altered_or_fictitious" }'
Parameters
inbound_check_deposit_id
string
Required

The identifier of the Inbound Check Deposit to return.

reason
enum
Required

The reason to return the Inbound Check Deposit.

Sandbox: Create an Inbound Check Deposit

Simulates an Inbound Check Deposit against your account. This imitates someone depositing a check at their bank that was issued from your account. It may or may not be associated with a Check Transfer. Increase will evaluate the Check Deposit as we would in production and either create a Transaction or a Declined Transaction as a result. You can inspect the resulting Inbound Check Deposit object to see the result.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/inbound_check_deposits" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 1000, "check_number": "1234567890" }'
Parameters
account_number_id
string
Required

The identifier of the Account Number the Inbound Check Deposit will be against.

amount
integer
Required

The check amount in cents.

check_number
string
Required

The check number on the check to be deposited.

10 character maximum
Real-Time Payments Transfers

Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network.

The Real-Time Payments Transfer object
{ "account_id": "account_in71c4amph0vgo2qllky", "acknowledgement": { "acknowledged_at": "2020-01-31T23:59:59Z" }, "amount": 100, "approval": null, "cancellation": null, "created_at": "2020-01-31T23:59:59Z", "created_by": { "category": "user", "user": { "email": "user@example.com" } }, "creditor_name": "Ian Crease", "currency": "USD", "debtor_name": null, "destination_account_number": "987654321", "destination_routing_number": "101050001", "external_account_id": null, "id": "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq", "idempotency_key": null, "pending_transaction_id": null, "rejection": null, "remittance_information": "Invoice 29582", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "status": "complete", "submission": { "submitted_at": "2020-01-31T23:59:59Z", "transaction_identification": "20220501234567891T1BSLZO01745013025" }, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "real_time_payments_transfer", "ultimate_creditor_name": null, "ultimate_debtor_name": null }
Attributes
account_id
string

The Account from which the transfer was sent.

acknowledgement
dictionary
Nullable

If the transfer is acknowledged by the recipient bank, this will contain supplemental details.

amount
integer

The transfer amount in USD cents.

approval
dictionary
Nullable

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

cancellation
dictionary
Nullable

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

created_at
string

The ISO 8601 date and time at which the transfer was created.

created_by
dictionary
Nullable

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

creditor_name
string

The name of the transfer's recipient. This is set by the sender when creating the transfer.

currency
enum

The ISO 4217 code for the transfer's currency. For real-time payments transfers this is always equal to USD.

debtor_name
string
Nullable

The name of the transfer's sender. If not provided, defaults to the name of the account's entity.

destination_account_number
string

The destination account number.

destination_routing_number
string

The destination American Bankers' Association (ABA) Routing Transit Number (RTN).

external_account_id
string
Nullable

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

id
string

The Real-Time Payments Transfer's identifier.

idempotency_key
string
Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

pending_transaction_id
string
Nullable

The ID for the pending transaction representing the transfer. A pending transaction is created when the transfer requires approval by someone else in your organization.

rejection
dictionary
Nullable

If the transfer is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.

remittance_information
string

Unstructured information that will show on the recipient's bank statement.

source_account_number_id
string

The Account Number the recipient will see as having sent the transfer.

status
enum

The lifecycle status of the transfer.

submission
dictionary
Nullable

After the transfer is submitted to Real-Time Payments, this will contain supplemental details.

transaction_id
string
Nullable

The Transaction funding the transfer once it is complete.

type
string

A constant representing the object's type. For this resource it will always be real_time_payments_transfer.

ultimate_creditor_name
string
Nullable

The name of the ultimate recipient of the transfer. Set this if the creditor is an intermediary receiving the payment for someone else.

ultimate_debtor_name
string
Nullable

The name of the ultimate sender of the transfer. Set this if the funds are being sent on behalf of someone who is not the account holder at Increase.

List Real-Time Payments Transfers
curl \ --url "${INCREASE_URL}/real_time_payments_transfers?account_id=account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Real-Time Payments Transfers to those belonging to the specified Account.

external_account_id
string

Filter Real-Time Payments Transfers to those made to the specified External Account.

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.

200 character maximum
created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Create a Real-Time Payments Transfer
curl -X "POST" \ --url "${INCREASE_URL}/real_time_payments_transfers" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "amount": 100, "creditor_name": "Ian Crease", "destination_account_number": "987654321", "destination_routing_number": "101050001", "remittance_information": "Invoice 29582", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2" }'
Parameters
amount
integer
Required

The transfer amount in USD cents. For Real-Time Payments transfers, must be positive.

creditor_name
string
Required

The name of the transfer's recipient.

140 character maximum
debtor_name
string

The name of the transfer's sender. If not provided, defaults to the name of the account's entity.

140 character maximum
destination_account_number
string

The destination account number.

34 character maximum
destination_routing_number
string

The destination American Bankers' Association (ABA) Routing Transit Number (RTN).

9 character maximum
external_account_id
string

The ID of an External Account to initiate a transfer to. If this parameter is provided, destination_account_number and destination_routing_number must be absent.

remittance_information
string
Required

Unstructured information that will show on the recipient's bank statement.

140 character maximum
require_approval
boolean

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

source_account_number_id
string
Required

The identifier of the Account Number from which to send the transfer.

ultimate_creditor_name
string

The name of the ultimate recipient of the transfer. Set this if the creditor is an intermediary receiving the payment for someone else.

140 character maximum
ultimate_debtor_name
string

The name of the ultimate sender of the transfer. Set this if the funds are being sent on behalf of someone who is not the account holder at Increase.

140 character maximum
Retrieve a Real-Time Payments Transfer
curl \ --url "${INCREASE_URL}/real_time_payments_transfers/real_time_payments_transfer_iyuhl5kdn7ssmup83mvq" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
real_time_payments_transfer_id
string
Required

The identifier of the Real-Time Payments Transfer.

Sandbox: Complete a Real-Time Payments Transfer

Simulates submission of a Real-Time Payments Transfer and handling the response from the destination financial institution. This transfer must first have a status of pending_submission.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/real_time_payments_transfers/real_time_payments_transfer_iyuhl5kdn7ssmup83mvq/complete" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{}'
Parameters
real_time_payments_transfer_id
string
Required

The identifier of the Real-Time Payments Transfer you wish to complete.

rejection
dictionary

If set, the simulation will reject the transfer.

Inbound Real-Time Payments Transfers

An Inbound Real-Time Payments Transfer is a Real-Time Payments transfer initiated outside of Increase to your account.

The Inbound Real-Time Payments Transfer object
{ "account_id": "account_in71c4amph0vgo2qllky", "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 100, "confirmation": { "confirmed_at": "2020-01-31T23:59:59Z", "transaction_id": "transaction_uyrp7fld2ium70oa7oi" }, "created_at": "2020-01-31T23:59:59Z", "creditor_name": "Ian Crease", "currency": "USD", "debtor_account_number": "987654321", "debtor_name": "National Phonograph Company", "debtor_routing_number": "101050001", "decline": null, "id": "inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr", "remittance_information": "Invoice 29582", "status": "confirmed", "transaction_identification": "20220501234567891T1BSLZO01745013025", "type": "inbound_real_time_payments_transfer" }
Attributes
account_id
string

The Account to which the transfer was sent.

account_number_id
string

The identifier of the Account Number to which this transfer was sent.

amount
integer

The amount in USD cents.

confirmation
dictionary
Nullable

If your transfer is confirmed, this will contain details of the confirmation.

created_at
string

The ISO 8601 date and time at which the transfer was created.

creditor_name
string

The name the sender of the transfer specified as the recipient of the transfer.

currency
enum

The ISO 4217 code of the transfer's currency. This will always be "USD" for a Real-Time Payments transfer.

debtor_account_number
string

The account number of the account that sent the transfer.

debtor_name
string

The name provided by the sender of the transfer.

debtor_routing_number
string

The routing number of the account that sent the transfer.

decline
dictionary
Nullable

If your transfer is declined, this will contain details of the decline.

id
string

The inbound Real-Time Payments transfer's identifier.

remittance_information
string
Nullable

Additional information included with the transfer.

status
enum

The lifecycle status of the transfer.

transaction_identification
string

The Real-Time Payments network identification of the transfer.

type
string

A constant representing the object's type. For this resource it will always be inbound_real_time_payments_transfer.

List Inbound Real-Time Payments Transfers
curl \ --url "${INCREASE_URL}/inbound_real_time_payments_transfers?account_id=account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Inbound Real-Time Payments Transfers to those belonging to the specified Account.

account_number_id
string

Filter Inbound Real-Time Payments Transfers to ones belonging to the specified Account Number.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Retrieve an Inbound Real-Time Payments Transfer
curl \ --url "${INCREASE_URL}/inbound_real_time_payments_transfers/inbound_real_time_payments_transfer_63hlz498vcxg644hcrzr" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
inbound_real_time_payments_transfer_id
string
Required

The identifier of the Inbound Real-Time Payments Transfer to get details for.

Sandbox: Create an Inbound Real-Time Payments Transfer

Simulates an Inbound Real-Time Payments Transfer to your account. Real-Time Payments are a beta feature.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/inbound_real_time_payments_transfers" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "amount": 1000, "request_for_payment_id": "real_time_payments_request_for_payment_28kcliz1oevcnqyn9qp7" }'
Parameters
account_number_id
string
Required

The identifier of the Account Number the inbound Real-Time Payments Transfer is for.

amount
integer
Required

The transfer amount in USD cents. Must be positive.

debtor_account_number
string

The account number of the account that sent the transfer.

200 character maximum
debtor_name
string

The name provided by the sender of the transfer.

200 character maximum
debtor_routing_number
string

The routing number of the account that sent the transfer.

9 character maximum
remittance_information
string

Additional information included with the transfer.

140 character maximum
request_for_payment_id
string

The identifier of a pending Request for Payment that this transfer will fulfill.

Check Deposits

Check Deposits allow you to deposit images of paper checks into your account.

The Check Deposit object
{ "account_id": "account_in71c4amph0vgo2qllky", "amount": 1000, "back_image_file_id": null, "created_at": "2020-01-31T23:59:59Z", "deposit_acceptance": null, "deposit_rejection": null, "deposit_return": null, "deposit_submission": null, "description": null, "front_image_file_id": "file_makxrc67oh9l6sg7w9yc", "id": "check_deposit_f06n9gpg7sxn8t19lfc1", "idempotency_key": null, "inbound_funds_hold": null, "inbound_mail_item_id": null, "lockbox_id": null, "status": "submitted", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "check_deposit" }
Attributes
account_id
string

The Account the check was deposited into.

amount
integer

The deposited amount in USD cents.

back_image_file_id
string
Nullable

The ID for the File containing the image of the back of the check.

created_at
string

The ISO 8601 date and time at which the transfer was created.

deposit_acceptance
dictionary
Nullable

If your deposit is successfully parsed and accepted by Increase, this will contain details of the parsed check.

deposit_rejection
dictionary
Nullable

If your deposit is rejected by Increase, this will contain details as to why it was rejected.

deposit_return
dictionary
Nullable

If your deposit is returned, this will contain details as to why it was returned.

deposit_submission
dictionary
Nullable

After the check is parsed, it is submitted to the Check21 network for processing. This will contain details of the submission.

description
string
Nullable

The description of the Check Deposit, for display purposes only.

front_image_file_id
string

The ID for the File containing the image of the front of the check.

id
string

The deposit's identifier.

idempotency_key
string
Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

inbound_funds_hold
dictionary
Nullable

Increase will sometimes hold the funds for Check Deposits. If funds are held, this sub-object will contain details of the hold.

inbound_mail_item_id
string
Nullable

If the Check Deposit was the result of an Inbound Mail Item, this will contain the identifier of the Inbound Mail Item.

lockbox_id
string
Nullable

If the Check Deposit was the result of an Inbound Mail Item, this will contain the identifier of the Lockbox that received it.

status
enum

The status of the Check Deposit.

transaction_id
string
Nullable

The ID for the Transaction created by the deposit.

type
string

A constant representing the object's type. For this resource it will always be check_deposit.

List Check Deposits
curl \ --url "${INCREASE_URL}/check_deposits?account_id=account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Check Deposits to those belonging to the specified Account.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

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.

200 character maximum
Create a Check Deposit
curl -X "POST" \ --url "${INCREASE_URL}/check_deposits" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_id": "account_in71c4amph0vgo2qllky", "amount": 1000, "back_image_file_id": "file_26khfk98mzfz90a11oqx", "description": "Vendor payment", "front_image_file_id": "file_hkv175ovmc2tb2v2zbrm" }'
Parameters
account_id
string
Required

The identifier for the Account to deposit the check in.

amount
integer
Required

The deposit amount in USD cents.

back_image_file_id
string
Required

The File containing the check's back image.

description
string

The description you choose to give the Check Deposit, for display purposes only.

200 character maximum
front_image_file_id
string
Required

The File containing the check's front image.

Retrieve a Check Deposit
curl \ --url "${INCREASE_URL}/check_deposits/check_deposit_instruction_q2shv7x9qhevfm71kor8" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
check_deposit_id
string
Required

The identifier of the Check Deposit to retrieve.

Sandbox: Reject a Check Deposit

Simulates the rejection of a Check Deposit by Increase due to factors like poor image quality. This Check Deposit must first have a status of pending.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/check_deposits/check_deposit_f06n9gpg7sxn8t19lfc1/reject" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
check_deposit_id
string
Required

The identifier of the Check Deposit you wish to reject.

Sandbox: Return a Check Deposit

Simulates the return of a Check Deposit. This Check Deposit must first have a status of submitted.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/check_deposits/check_deposit_f06n9gpg7sxn8t19lfc1/return" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
check_deposit_id
string
Required

The identifier of the Check Deposit you wish to return.

Sandbox: Submit a Check Deposit

Simulates the submission of a Check Deposit to the Federal Reserve. This Check Deposit must first have a status of pending.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/check_deposits/check_deposit_f06n9gpg7sxn8t19lfc1/submit" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
check_deposit_id
string
Required

The identifier of the Check Deposit you wish to submit.

Lockboxes

Lockboxes are physical locations that can receive mail containing paper checks. Increase will automatically create a Check Deposit for checks received this way.

The Lockbox object
{ "account_id": "account_in71c4amph0vgo2qllky", "address": { "city": "San Francisco", "line1": "1234 Market St", "line2": "Ste 567", "postal_code": "94114", "recipient": "Company Inc. ATTN: VRE6P", "state": "CA" }, "created_at": "2020-01-31T23:59:59Z", "description": "Lockbox 1", "id": "lockbox_3xt21ok13q19advds4t5", "idempotency_key": null, "recipient_name": "Company Inc.", "status": "active", "type": "lockbox" }
Attributes
account_id
string

The identifier for the Account checks sent to this lockbox will be deposited into.

address
dictionary

The mailing address for the Lockbox.

created_at
string

The ISO 8601 time at which the Lockbox was created.

description
string
Nullable

The description you choose for the Lockbox.

id
string

The Lockbox 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.

recipient_name
string
Nullable

The recipient name you choose for the Lockbox.

status
enum

This indicates if mail can be sent to this address.

type
string

A constant representing the object's type. For this resource it will always be lockbox.

List Lockboxes
curl \ --url "${INCREASE_URL}/lockboxes" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Lockboxes to those associated with the provided Account.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

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.

200 character maximum
Create a Lockbox
curl -X "POST" \ --url "${INCREASE_URL}/lockboxes" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_id": "account_in71c4amph0vgo2qllky", "description": "Rent payments" }'
Parameters
account_id
string
Required

The Account checks sent to this Lockbox should be deposited into.

description
string

The description you choose for the Lockbox, for display purposes.

200 character maximum
recipient_name
string

The name of the recipient that will receive mail at this location.

200 character maximum
Retrieve a Lockbox
curl \ --url "${INCREASE_URL}/lockboxes/lockbox_3xt21ok13q19advds4t5" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
lockbox_id
string
Required

The identifier of the Lockbox to retrieve.

Update a Lockbox
curl -X "PATCH" \ --url "${INCREASE_URL}/lockboxes/lockbox_3xt21ok13q19advds4t5" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "status": "inactive" }'
Parameters
lockbox_id
string
Required

The identifier of the Lockbox.

description
string

The description you choose for the Lockbox.

200 character maximum
recipient_name
string

The recipient name you choose for the Lockbox.

200 character maximum
status
enum

This indicates if checks can be sent to the Lockbox.

Inbound Mail Items

Inbound Mail Items represent pieces of physical mail delivered to a Lockbox.

The Inbound Mail Item object
{ "created_at": "2020-01-31T23:59:59Z", "file_id": "file_makxrc67oh9l6sg7w9yc", "id": "inbound_mail_item_q6rrg7mmqpplx80zceev", "lockbox_id": "lockbox_3xt21ok13q19advds4t5", "recipient_name": "Ian Crease", "rejection_reason": null, "status": "processed", "type": "inbound_mail_item" }
Attributes
created_at
string

The ISO 8601 time at which the Inbound Mail Item was created.

file_id
string

The identifier for the File containing the scanned contents of the mail item.

id
string

The Inbound Mail Item identifier.

lockbox_id
string
Nullable

The identifier for the Lockbox that received this mail item. For mail items that could not be processed due to an invalid address, this will be null.

recipient_name
string
Nullable

The recipient name as written on the mail item.

rejection_reason
enum
Nullable

If the mail item has been rejected, why it was rejected.

status
enum

If the mail item has been processed.

type
string

A constant representing the object's type. For this resource it will always be inbound_mail_item.

List Inbound Mail Items
curl \ --url "${INCREASE_URL}/inbound_mail_items" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

lockbox_id
string

Filter Inbound Mail Items to ones sent to the provided Lockbox.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Retrieve an Inbound Mail Item
curl \ --url "${INCREASE_URL}/inbound_mail_items/inbound_mail_item_q6rrg7mmqpplx80zceev" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
inbound_mail_item_id
string
Required

The identifier of the Inbound Mail Item to retrieve.

Sandbox: Create an Inbound Mail Item

Simulates an inbound mail item to your account, as if someone had mailed a physical check to one of your account's Lockboxes.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/inbound_mail_items" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "amount": 1000, "lockbox_id": "lockbox_3xt21ok13q19advds4t5" }'
Parameters
amount
integer
Required

The amount of the check to be simulated, in cents.

contents_file_id
string

The file containing the PDF contents. If not present, a default check image file will be used.

lockbox_id
string
Required

The identifier of the Lockbox to simulate inbound mail to.

Cards

Cards are commercial credit cards. They'll immediately work for online purchases after you create them. All cards maintain a credit limit of 100% of the Account’s available balance at the time of transaction. Funds are deducted from the Account upon transaction settlement.

The Card object
{ "account_id": "account_in71c4amph0vgo2qllky", "billing_address": { "city": "New York", "line1": "33 Liberty Street", "line2": null, "postal_code": "10045", "state": "NY" }, "created_at": "2020-01-31T23:59:59Z", "description": "Office Expenses", "digital_wallet": { "digital_card_profile_id": "digital_card_profile_s3puplu90f04xhcwkiga", "email": "user@example.com", "phone": "+16505046304" }, "entity_id": null, "expiration_month": 11, "expiration_year": 2028, "id": "card_oubs0hwk5rn6knuecxg2", "idempotency_key": null, "last4": "4242", "replacement": { "replaced_by_card_id": null, "replaced_card_id": null }, "status": "active", "type": "card" }
Attributes
account_id
string

The identifier for the account this card belongs to.

billing_address
dictionary

The Card's billing address.

created_at
string

The ISO 8601 date and time at which the Card was created.

description
string
Nullable

The card's description for display purposes.

digital_wallet
dictionary
Nullable

The contact information used in the two-factor steps for digital wallet card creation. At least one field must be present to complete the digital wallet steps.

entity_id
string
Nullable

The identifier for the entity associated with this card.

expiration_month
integer

The month the card expires in M format (e.g., August is 8).

expiration_year
integer

The year the card expires in YYYY format (e.g., 2025).

id
string

The card 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.

last4
string

The last 4 digits of the Card's Primary Account Number.

status
enum

This indicates if payments can be made with the card.

type
string

A constant representing the object's type. For this resource it will always be card.

List Cards
curl \ --url "${INCREASE_URL}/cards?account_id=account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Cards to ones belonging to the specified Account.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

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.

200 character maximum
Create a Card
curl -X "POST" \ --url "${INCREASE_URL}/cards" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_id": "account_in71c4amph0vgo2qllky", "description": "Card for Ian Crease" }'
Parameters
account_id
string
Required

The Account the card should belong to.

billing_address
dictionary

The card's billing address.

description
string

The description you choose to give the card.

200 character maximum
digital_wallet
dictionary

The contact information used in the two-factor steps for digital wallet card creation. To add the card to a digital wallet, you may supply an email or phone number with this request. Otherwise, subscribe and then action a Real Time Decision with the category digital_wallet_token_requested or digital_wallet_authentication_requested.

entity_id
string

The Entity the card belongs to. You only need to supply this in rare situations when the card is not for the Account holder.

Retrieve a Card
curl \ --url "${INCREASE_URL}/cards/card_oubs0hwk5rn6knuecxg2" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
card_id
string
Required

The identifier of the Card.

Update a Card
curl -X "PATCH" \ --url "${INCREASE_URL}/cards/card_oubs0hwk5rn6knuecxg2" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "description": "New description" }'
Parameters
card_id
string
Required

The card identifier.

billing_address
dictionary

The card's updated billing address.

description
string

The description you choose to give the card.

200 character maximum
digital_wallet
dictionary

The contact information used in the two-factor steps for digital wallet card creation. At least one field must be present to complete the digital wallet steps.

entity_id
string

The Entity the card belongs to. You only need to supply this in rare situations when the card is not for the Account holder.

status
enum

The status to update the Card with.

Retrieve sensitive details for a Card
curl \ --url "${INCREASE_URL}/cards/card_oubs0hwk5rn6knuecxg2/details" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Returns a Card Details object:
{ "card_id": "card_oubs0hwk5rn6knuecxg2", "expiration_month": 7, "expiration_year": 2025, "primary_account_number": "4242424242424242", "type": "card_details", "verification_code": "123" }
Parameters
card_id
string
Required

The identifier of the Card to retrieve details for.

Card Payments

Card Payments group together interactions related to a single card payment, such as an authorization and its corresponding settlement.

The Card Payment object
{ "account_id": "account_in71c4amph0vgo2qllky", "card_id": "card_oubs0hwk5rn6knuecxg2", "created_at": "2020-01-31T23:59:59Z", "digital_wallet_token_id": null, "elements": [ { "card_authorization": { "actioner": "increase", "amount": 100, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "currency": "USD", "digital_wallet_token_id": null, "direction": "settlement", "expires_at": "2020-01-31T23:59:59Z", "id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network_details": { "category": "visa", "visa": { "electronic_commerce_indicator": "secure_electronic_commerce", "point_of_service_entry_mode": "manual", "stand_in_processing_reason": null } }, "network_identifiers": { "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "network_risk_score": 10, "pending_transaction_id": null, "physical_card_id": null, "presentment_amount": 100, "presentment_currency": "USD", "processing_category": "purchase", "real_time_decision_id": null, "terminal_id": "RCN5VNXS", "type": "card_authorization", "verification": { "card_verification_code": { "result": "match" }, "cardholder_address": { "actual_line1": "33 Liberty Street", "actual_postal_code": "94131", "provided_line1": "33 Liberty Street", "provided_postal_code": "94132", "result": "postal_code_no_match_address_match" } } }, "category": "card_authorization", "created_at": "2020-01-31T23:59:59Z" }, { "card_reversal": { "card_authorization_id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "currency": "USD", "id": "card_reversal_8vr9qy60cgf5d0slpb68", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network": "visa", "network_identifiers": { "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "reversal_amount": 20, "reversal_reason": "reversed_by_customer", "terminal_id": "RCN5VNXS", "type": "card_reversal", "updated_authorization_amount": 80 }, "category": "card_reversal", "created_at": "2020-01-31T23:59:59Z" }, { "card_increment": { "actioner": "increase", "amount": 20, "card_authorization_id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "currency": "USD", "id": "card_increment_6ztayc58j1od0rpebp3e", "network": "visa", "network_identifiers": { "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "network_risk_score": 10, "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "real_time_decision_id": null, "type": "card_increment", "updated_authorization_amount": 120 }, "category": "card_increment", "created_at": "2020-01-31T23:59:59Z" }, { "card_settlement": { "amount": 100, "card_authorization": null, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "cashback": null, "currency": "USD", "id": "card_settlement_khv5kfeu0vndj291omg6", "interchange": { "amount": "0.137465", "code": "271", "currency": "USD" }, "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_name": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network_identifiers": { "acquirer_business_id": "69650702", "acquirer_reference_number": "83163715445437604865089", "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": [], "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "card_settlement" }, "category": "card_settlement", "created_at": "2020-01-31T23:59:59Z" } ], "id": "card_payment_nd3k2kacrqjli8482ave", "physical_card_id": null, "state": { "authorized_amount": 100, "fuel_confirmed_amount": 0, "incremented_amount": 20, "reversed_amount": 20, "settled_amount": 100 }, "type": "card_payment" }
Attributes
account_id
string

The identifier for the Account the Transaction belongs to.

card_id
string

The Card identifier for this payment.

created_at
string

The ISO 8601 time at which the Card Payment was created.

digital_wallet_token_id
string
Nullable

The Digital Wallet Token identifier for this payment.

elements
array

The interactions related to this card payment.

id
string

The Card Payment identifier.

physical_card_id
string
Nullable

The Physical Card identifier for this payment.

state
dictionary

The summarized state of this card payment.

type
string

A constant representing the object's type. For this resource it will always be card_payment.

List Card Payments
curl \ --url "${INCREASE_URL}/card_payments?account_id=account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Card Payments to ones belonging to the specified Account.

card_id
string

Filter Card Payments to ones belonging to the specified Card.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Retrieve a Card Payment
curl \ --url "${INCREASE_URL}/card_payments/card_payment_nd3k2kacrqjli8482ave" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
card_payment_id
string
Required

The identifier of the Card Payment.

Sandbox: Expire a Card Authorization

Simulates expiring a Card Authorization immediately.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/card_authorization_expirations" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "card_payment_id": "card_payment_nd3k2kacrqjli8482ave" }'
Parameters
card_payment_id
string
Required

The identifier of the Card Payment to expire.

Sandbox: Create a Card Authorization

Simulates a purchase authorization on a Card. Depending on the balance available to the card and the amount submitted, the authorization activity will result in a Pending Transaction of type card_authorization or a Declined Transaction of type card_decline. You can pass either a Card id or a Digital Wallet Token id to simulate the two different ways purchases can be made.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/card_authorizations" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "amount": 1000, "card_id": "card_oubs0hwk5rn6knuecxg2", "event_subscription_id": "event_subscription_001dzz0r20rcdxgb013zqb8m04g", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_state": "NY" }'
Returns a Inbound Card Authorization Simulation Result object:
{ "declined_transaction": null, "pending_transaction": { "account_id": "account_in71c4amph0vgo2qllky", "amount": 100, "completed_at": null, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "description": "INVOICE 2468", "id": "pending_transaction_k1sfetcau2qbvjbzgju4", "route_id": "card_oubs0hwk5rn6knuecxg2", "route_type": "card", "source": { "card_authorization": { "actioner": "increase", "amount": 100, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "currency": "USD", "digital_wallet_token_id": null, "direction": "settlement", "expires_at": "2020-01-31T23:59:59Z", "id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network_details": { "category": "visa", "visa": { "electronic_commerce_indicator": "secure_electronic_commerce", "point_of_service_entry_mode": "manual", "stand_in_processing_reason": null } }, "network_identifiers": { "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "network_risk_score": 10, "pending_transaction_id": null, "physical_card_id": null, "presentment_amount": 100, "presentment_currency": "USD", "processing_category": "purchase", "real_time_decision_id": null, "terminal_id": "RCN5VNXS", "type": "card_authorization", "verification": { "card_verification_code": { "result": "match" }, "cardholder_address": { "actual_line1": "33 Liberty Street", "actual_postal_code": "94131", "provided_line1": "33 Liberty Street", "provided_postal_code": "94132", "result": "postal_code_no_match_address_match" } } }, "category": "card_authorization" }, "status": "pending", "type": "pending_transaction" }, "type": "inbound_card_authorization_simulation_result" }
Parameters
amount
integer
Required

The authorization amount in cents.

authenticated_card_payment_id
string

The identifier of a Card Payment with a card_authentication if you want to simulate an authenticated authorization.

card_id
string

The identifier of the Card to be authorized.

decline_reason
enum

Forces a card decline with a specific reason. No real time decision will be sent.

digital_wallet_token_id
string

The identifier of the Digital Wallet Token to be authorized.

direction
enum

The direction describes the direction the funds will move, either from the cardholder to the merchant or from the merchant to the cardholder.

event_subscription_id
string

The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes.

merchant_acceptor_id
string

The merchant identifier (commonly abbreviated as MID) of the merchant the card is transacting with.

200 character maximum
merchant_category_code
string

The Merchant Category Code (commonly abbreviated as MCC) of the merchant the card is transacting with.

200 character maximum
merchant_city
string

The city the merchant resides in.

200 character maximum
merchant_country
string

The country the merchant resides in.

200 character maximum
merchant_descriptor
string

The merchant descriptor of the merchant the card is transacting with.

200 character maximum
merchant_state
string

The state the merchant resides in.

200 character maximum
physical_card_id
string

The identifier of the Physical Card to be authorized.

terminal_id
string

The terminal identifier (commonly abbreviated as TID) of the terminal the card is transacting with.

200 character maximum
Sandbox: Confirm the fuel pump amount for a Card Authorization

Simulates the fuel confirmation of an authorization by a card acquirer. This happens asynchronously right after a fuel pump transaction is completed. A fuel confirmation can only happen once per authorization.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/card_fuel_confirmations" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "amount": 5000, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave" }'
Parameters
amount
integer
Required

The amount of the fuel_confirmation in minor units in the card authorization's currency.

card_payment_id
string
Required

The identifier of the Card Payment to create a fuel_confirmation on.

Sandbox: Increment a Card Authorization

Simulates the increment of an authorization by a card acquirer. An authorization can be incremented multiple times.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/card_increments" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "amount": 500, "card_payment_id": "card_payment_nd3k2kacrqjli8482ave" }'
Parameters
amount
integer
Required

The amount of the increment in minor units in the card authorization's currency.

card_payment_id
string
Required

The identifier of the Card Payment to create a increment on.

event_subscription_id
string

The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes.

Sandbox: Refund a card transaction

Simulates refunding a card transaction. The full value of the original sandbox transaction is refunded.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/card_refunds" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "transaction_id": "transaction_uyrp7fld2ium70oa7oi" }'
Returns a Transaction object:
{ "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" }
Parameters
transaction_id
string
Required

The identifier for the Transaction to refund. The Transaction's source must have a category of card_settlement.

Sandbox: Reverse a Card Authorization

Simulates the reversal of an authorization by a card acquirer. An authorization can be partially reversed multiple times, up until the total authorized amount. Marks the pending transaction as complete if the authorization is fully reversed.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/card_reversals" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "card_payment_id": "card_payment_nd3k2kacrqjli8482ave" }'
Parameters
amount
integer

The amount of the reversal in minor units in the card authorization's currency. This defaults to the authorization amount.

card_payment_id
string
Required

The identifier of the Card Payment to create a reversal on.

Sandbox: Settle a Card Authorization

Simulates the settlement of an authorization by a card acquirer. After a card authorization is created, the merchant will eventually send a settlement. This simulates that event, which may occur many days after the purchase in production. The amount settled can be different from the amount originally authorized, for example, when adding a tip to a restaurant bill.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/card_settlements" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "card_id": "card_oubs0hwk5rn6knuecxg2", "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4" }'
Returns a Transaction object:
{ "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" }
Parameters
amount
integer

The amount to be settled. This defaults to the amount of the Pending Transaction being settled.

card_id
string
Required

The identifier of the Card to create a settlement on.

pending_transaction_id
string
Required

The identifier of the Pending Transaction for the Card Authorization you wish to settle.

Card Purchase Supplements

Additional information about a card purchase (e.g., settlement or refund), such as level 3 line item data.

The Card Purchase Supplement object
{ "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "created_at": "2020-01-31T23:59:59Z", "id": "card_purchase_supplement_ijuc45iym4jchnh2sfk3", "invoice": { "discount_amount": 100, "discount_currency": "USD", "discount_treatment_code": null, "duty_tax_amount": 200, "duty_tax_currency": "USD", "order_date": "2023-07-20", "shipping_amount": 300, "shipping_currency": "USD", "shipping_destination_country_code": "US", "shipping_destination_postal_code": "10045", "shipping_source_postal_code": "10045", "shipping_tax_amount": 400, "shipping_tax_currency": "USD", "shipping_tax_rate": "0.2", "tax_treatments": null, "unique_value_added_tax_invoice_reference": "12302" }, "line_items": [ { "detail_indicator": "normal", "discount_amount": null, "discount_currency": null, "discount_treatment_code": null, "id": "card_purchase_supplement_invoice_line_item_nf9760lz0apqy5retmqh", "item_commodity_code": "001", "item_descriptor": "Coffee", "item_quantity": "1.0", "product_code": "101", "sales_tax_amount": null, "sales_tax_currency": null, "sales_tax_rate": null, "total_amount": 500, "total_amount_currency": "USD", "unit_cost": "5.0", "unit_cost_currency": "USD", "unit_of_measure_code": "NMB" } ], "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "type": "card_purchase_supplement" }
Attributes
card_payment_id
string
Nullable

The ID of the Card Payment this transaction belongs to.

id
string

The Card Purchase Supplement identifier.

invoice
dictionary
Nullable

Invoice-level information about the payment.

line_items
array
Nullable

Line item information, such as individual products purchased.

transaction_id
string

The ID of the transaction.

type
string

A constant representing the object's type. For this resource it will always be card_purchase_supplement.

List Card Purchase Supplements
curl \ --url "${INCREASE_URL}/card_purchase_supplements?card_payment_id=card_payment_nd3k2kacrqjli8482ave" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

card_payment_id
string

Filter Card Purchase Supplements to ones belonging to the specified Card Payment.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Retrieve a Card Purchase Supplement
curl \ --url "${INCREASE_URL}/card_purchase_supplements/card_purchase_supplement_ijuc45iym4jchnh2sfk3" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
card_purchase_supplement_id
string
Required

The identifier of the Card Purchase Supplement.

Card Disputes

If unauthorized activity occurs on a card, you can create a Card Dispute and we'll return the funds if appropriate.

The Card Dispute object
{ "acceptance": null, "amount": null, "created_at": "2020-01-31T23:59:59Z", "disputed_transaction_id": "transaction_uyrp7fld2ium70oa7oi", "explanation": "Unauthorized recurring purchase", "id": "card_dispute_h9sc95nbl1cgltpp7men", "idempotency_key": null, "loss": null, "rejection": null, "status": "pending_reviewing", "type": "card_dispute", "win": null }
Attributes
acceptance
dictionary
Nullable

If the Card Dispute's status is accepted, this will contain details of the successful dispute.

amount
integer
Nullable

The amount of the dispute, if provided, or the transaction amount otherwise.

created_at
string

The ISO 8601 date and time at which the Card Dispute was created.

disputed_transaction_id
string

The identifier of the Transaction that was disputed.

explanation
string

Why you disputed the Transaction in question.

id
string

The Card Dispute 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.

loss
dictionary
Nullable

If the Card Dispute's status is lost, this will contain details of the lost dispute.

rejection
dictionary
Nullable

If the Card Dispute's status is rejected, this will contain details of the unsuccessful dispute.

status
enum

The results of the Dispute investigation.

type
string

A constant representing the object's type. For this resource it will always be card_dispute.

win
dictionary
Nullable

If the Card Dispute's status is won, this will contain details of the won dispute.

List Card Disputes
curl \ --url "${INCREASE_URL}/card_disputes" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

status.in
array of strings

Filter Card Disputes for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

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.

200 character maximum
Create a Card Dispute
curl -X "POST" \ --url "${INCREASE_URL}/card_disputes" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "disputed_transaction_id": "transaction_uyrp7fld2ium70oa7oi", "explanation": "Unauthorized recurring transaction." }'
Parameters
amount
integer

The monetary amount of the part of the transaction that is being disputed. This is optional and will default to the full amount of the transaction if not provided. If provided, the amount must be less than or equal to the amount of the transaction.

disputed_transaction_id
string
Required

The Transaction you wish to dispute. This Transaction must have a source_type of card_settlement.

explanation
string
Required

Why you are disputing this Transaction.

2000 character maximum
Retrieve a Card Dispute
curl \ --url "${INCREASE_URL}/card_disputes/card_dispute_h9sc95nbl1cgltpp7men" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
card_dispute_id
string
Required

The identifier of the Card Dispute.

Sandbox: Advance the state of a Card Dispute

After a Card Dispute is created in production, the dispute will be reviewed. Since no review happens in sandbox, this endpoint simulates moving a Card Dispute into a rejected or accepted state. A Card Dispute can only be actioned one time and must have a status of pending_reviewing.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/card_disputes/card_dispute_h9sc95nbl1cgltpp7men/action" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "explanation": "This was a valid recurring transaction", "status": "rejected" }'
Parameters
card_dispute_id
string
Required

The dispute you would like to action.

explanation
string

Why the dispute was rejected. Not required for accepting disputes.

200 character maximum
status
enum
Required

The status to move the dispute to.

Physical Cards

Custom physical Visa cards that are shipped to your customers. The artwork is configurable by a connected Card Profile. The same Card can be used for multiple Physical Cards. Printing cards incurs a fee. Please contact support@increase.com for pricing!

The Physical Card object
{ "card_id": "card_oubs0hwk5rn6knuecxg2", "cardholder": { "first_name": "Ian", "last_name": "Crease" }, "created_at": "2020-01-31T23:59:59Z", "id": "physical_card_ode8duyq5v2ynhjoharl", "idempotency_key": null, "physical_card_profile_id": "physical_card_profile_m534d5rn9qyy9ufqxoec", "shipment": { "address": { "city": "New York", "line1": "33 Liberty Street", "line2": "Unit 2", "line3": null, "name": "Ian Crease", "postal_code": "10045", "state": "NY" }, "method": "usps", "status": "pending", "tracking": null }, "status": "active", "type": "physical_card" }
Attributes
card_id
string

The identifier for the Card this Physical Card represents.

cardholder
dictionary

Details about the cardholder, as it appears on the printed card.

created_at
string

The ISO 8601 date and time at which the Physical Card was created.

id
string

The physical card 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.

physical_card_profile_id
string
Nullable

The Physical Card Profile used for this Physical Card.

shipment
dictionary

The details used to ship this physical card.

status
enum

The status of the Physical Card.

type
string

A constant representing the object's type. For this resource it will always be physical_card.

List Physical Cards
curl \ --url "${INCREASE_URL}/physical_cards?card_id=card_oubs0hwk5rn6knuecxg2" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

card_id
string

Filter Physical Cards to ones belonging to the specified Card.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

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.

200 character maximum
Create a Physical Card
curl -X "POST" \ --url "${INCREASE_URL}/physical_cards" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "card_id": "card_oubs0hwk5rn6knuecxg2", "cardholder": { "first_name": "Ian", "last_name": "Crease" }, "shipment": { "address": { "city": "New York", "line1": "33 Liberty Street", "line2": "Unit 2", "name": "Ian Crease", "postal_code": "10045", "state": "NY" }, "method": "usps" } }'
Parameters
card_id
string
Required

The underlying card representing this physical card.

cardholder
dictionary
Required

Details about the cardholder, as it will appear on the physical card.

physical_card_profile_id
string

The physical card profile to use for this physical card. The latest default physical card profile will be used if not provided.

shipment
dictionary
Required

The details used to ship this physical card.

Retrieve a Physical Card
curl \ --url "${INCREASE_URL}/physical_cards/physical_card_ode8duyq5v2ynhjoharl" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
physical_card_id
string
Required

The identifier of the Physical Card.

Update a Physical Card
curl -X "PATCH" \ --url "${INCREASE_URL}/physical_cards/physical_card_ode8duyq5v2ynhjoharl" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "status": "disabled" }'
Parameters
physical_card_id
string
Required

The Physical Card identifier.

status
enum
Required

The status to update the Physical Card to.

Sandbox: Advance the shipment status of a Physical Card

This endpoint allows you to simulate advancing the shipment status of a Physical Card, to simulate e.g., that a physical card was attempted shipped but then failed delivery.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/physical_cards/physical_card_ode8duyq5v2ynhjoharl/advance_shipment" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "shipment_status": "shipped" }'
Parameters
physical_card_id
string
Required

The Physical Card you would like to action.

shipment_status
enum
Required

The shipment status to move the Physical Card to.

Digital Card Profiles

This contains artwork and metadata relating to a Card's appearance in digital wallet apps like Apple Pay and Google Pay. For more information, see our guide on digital card artwork.

The Digital Card Profile object
{ "app_icon_file_id": "file_makxrc67oh9l6sg7w9yc", "background_image_file_id": "file_makxrc67oh9l6sg7w9yc", "card_description": "Black Card", "contact_email": "user@example.com", "contact_phone": "+18882988865", "contact_website": "https://example.com", "created_at": "2020-01-31T23:59:59Z", "deprecated_card_profile_id": null, "description": "Corporate logo Apple Pay Card", "id": "digital_card_profile_s3puplu90f04xhcwkiga", "idempotency_key": null, "is_default": false, "issuer_name": "National Phonograph Company", "status": "active", "text_color": { "blue": 230, "green": 255, "red": 189 }, "type": "digital_card_profile" }
Attributes
app_icon_file_id
string

The identifier of the File containing the card's icon image.

background_image_file_id
string

The identifier of the File containing the card's front image.

card_description
string

A user-facing description for the card itself.

contact_email
string
Nullable

An email address the user can contact to receive support for their card.

contact_phone
string
Nullable

A phone number the user can contact to receive support for their card.

contact_website
string
Nullable

A website the user can visit to view and receive support for their card.

created_at
string

The ISO 8601 date and time at which the Card Dispute was created.

description
string

A description you can use to identify the Card Profile.

id
string

The Card Profile 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.

issuer_name
string

A user-facing description for whoever is issuing the card.

status
enum

The status of the Card Profile.

text_color
dictionary

The Card's text color, specified as an RGB triple.

type
string

A constant representing the object's type. For this resource it will always be digital_card_profile.

List Card Profiles
curl \ --url "${INCREASE_URL}/digital_card_profiles" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

status.in
array of strings

Filter Digital Card Profiles for those with the specified digital wallet status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

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.

200 character maximum
Create a Digital Card Profile
curl -X "POST" \ --url "${INCREASE_URL}/digital_card_profiles" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "app_icon_file_id": "file_8zxqkwlh43wo144u8yec", "background_image_file_id": "file_1ai913suu1zfn1pdetru", "card_description": "MyBank Signature Card", "contact_email": "user@example.com", "contact_phone": "+18885551212", "contact_website": "https://example.com", "description": "My Card Profile", "issuer_name": "MyBank", "text_color": { "blue": 59, "green": 43, "red": 26 } }'
Parameters
app_icon_file_id
string
Required

The identifier of the File containing the card's icon image.

background_image_file_id
string
Required

The identifier of the File containing the card's front image.

card_description
string
Required

A user-facing description for the card itself.

32 character maximum
contact_email
string

An email address the user can contact to receive support for their card.

32 character maximum
contact_phone
string

A phone number the user can contact to receive support for their card.

32 character maximum
contact_website
string

A website the user can visit to view and receive support for their card.

description
string
Required

A description you can use to identify the Card Profile.

200 character maximum
issuer_name
string
Required

A user-facing description for whoever is issuing the card.

32 character maximum
text_color
dictionary

The Card's text color, specified as an RGB triple. The default is white.

Retrieve a Digital Card Profile
curl \ --url "${INCREASE_URL}/digital_card_profiles/digital_card_profile_s3puplu90f04xhcwkiga" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
digital_card_profile_id
string
Required

The identifier of the Digital Card Profile.

Archive a Digital Card Profile
curl -X "POST" \ --url "${INCREASE_URL}/digital_card_profiles/digital_card_profile_s3puplu90f04xhcwkiga/archive" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
digital_card_profile_id
string
Required

The identifier of the Digital Card Profile to archive.

Clones a Digital Card Profile
curl -X "POST" \ --url "${INCREASE_URL}/digital_card_profiles/digital_card_profile_s3puplu90f04xhcwkiga/clone" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "background_image_file_id": "file_1ai913suu1zfn1pdetru" }'
Parameters
digital_card_profile_id
string
Required

The identifier of the Digital Card Profile to clone.

app_icon_file_id
string

The identifier of the File containing the card's icon image.

background_image_file_id
string

The identifier of the File containing the card's front image.

card_description
string

A user-facing description for the card itself.

32 character maximum
contact_email
string

An email address the user can contact to receive support for their card.

32 character maximum
contact_phone
string

A phone number the user can contact to receive support for their card.

32 character maximum
contact_website
string

A website the user can visit to view and receive support for their card.

description
string

A description you can use to identify the Card Profile.

200 character maximum
issuer_name
string

A user-facing description for whoever is issuing the card.

32 character maximum
text_color
dictionary

The Card's text color, specified as an RGB triple. The default is white.

Physical Card Profiles

This contains artwork and metadata relating to a Physical Card's appearance. For more information, see our guide on physical card artwork.

The Physical Card Profile object
{ "back_image_file_id": "file_makxrc67oh9l6sg7w9yc", "carrier_image_file_id": "file_makxrc67oh9l6sg7w9yc", "contact_phone": "+16505046304", "created_at": "2020-01-31T23:59:59Z", "creator": "user", "deprecated_card_profile_id": null, "description": "Corporate logo card", "front_image_file_id": "file_makxrc67oh9l6sg7w9yc", "front_text": null, "id": "physical_card_profile_m534d5rn9qyy9ufqxoec", "idempotency_key": null, "is_default": false, "status": "active", "type": "physical_card_profile" }
Attributes
back_image_file_id
string
Nullable

The identifier of the File containing the physical card's back image.

carrier_image_file_id
string
Nullable

The identifier of the File containing the physical card's carrier image.

contact_phone
string
Nullable

A phone number the user can contact to receive support for their card.

created_at
string

The ISO 8601 date and time at which the Card Dispute was created.

creator
enum

The creator of this Physical Card Profile.

description
string

A description you can use to identify the Physical Card Profile.

front_image_file_id
string
Nullable

The identifier of the File containing the physical card's front image.

id
string

The Card Profile 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.

is_default
boolean

Whether this Physical Card Profile is the default for all cards in its Increase group.

status
enum

The status of the Physical Card Profile.

type
string

A constant representing the object's type. For this resource it will always be physical_card_profile.

List Physical Card Profiles
curl \ --url "${INCREASE_URL}/physical_card_profiles" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

status.in
array of strings

Filter Physical Card Profiles for those with the specified statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

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.

200 character maximum
Create a Physical Card Profile
curl -X "POST" \ --url "${INCREASE_URL}/physical_card_profiles" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "carrier_image_file_id": "file_h6v7mtipe119os47ehlu", "contact_phone": "+16505046304", "description": "My Card Profile", "front_image_file_id": "file_o6aex13wm1jcc36sgcj1" }'
Parameters
carrier_image_file_id
string
Required

The identifier of the File containing the physical card's carrier image.

contact_phone
string
Required

A phone number the user can contact to receive support for their card.

32 character maximum
description
string
Required

A description you can use to identify the Card Profile.

200 character maximum
front_image_file_id
string
Required

The identifier of the File containing the physical card's front image.

Retrieve a Card Profile
curl \ --url "${INCREASE_URL}/physical_card_profiles/physical_card_profile_m534d5rn9qyy9ufqxoec" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
physical_card_profile_id
string
Required

The identifier of the Card Profile.

Archive a Physical Card Profile
curl -X "POST" \ --url "${INCREASE_URL}/physical_card_profiles/physical_card_profile_m534d5rn9qyy9ufqxoec/archive" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
physical_card_profile_id
string
Required

The identifier of the Physical Card Profile to archive.

Clone a Physical Card Profile
curl -X "POST" \ --url "${INCREASE_URL}/physical_card_profiles/physical_card_profile_m534d5rn9qyy9ufqxoec/clone" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "front_image_file_id": "file_o6aex13wm1jcc36sgcj1" }'
Parameters
physical_card_profile_id
string
Required

The identifier of the Physical Card Profile to clone.

carrier_image_file_id
string

The identifier of the File containing the physical card's carrier image.

contact_phone
string

A phone number the user can contact to receive support for their card.

32 character maximum
description
string

A description you can use to identify the Card Profile.

200 character maximum
front_image_file_id
string

The identifier of the File containing the physical card's front image.

front_text
dictionary

Text printed on the front of the card. Reach out to support@increase.com for more information.

Digital Wallet Tokens

A Digital Wallet Token is created when a user adds a Card to their Apple Pay or Google Pay app. The Digital Wallet Token can be used for purchases just like a Card.

The Digital Wallet Token object
{ "card_id": "card_oubs0hwk5rn6knuecxg2", "created_at": "2020-01-31T23:59:59Z", "id": "digital_wallet_token_izi62go3h51p369jrie0", "status": "active", "token_requestor": "apple_pay", "type": "digital_wallet_token" }
Attributes
card_id
string

The identifier for the Card this Digital Wallet Token belongs to.

created_at
string

The ISO 8601 date and time at which the Card was created.

id
string

The Digital Wallet Token identifier.

status
enum

This indicates if payments can be made with the Digital Wallet Token.

token_requestor
enum

The digital wallet app being used.

type
string

A constant representing the object's type. For this resource it will always be digital_wallet_token.

List Digital Wallet Tokens
curl \ --url "${INCREASE_URL}/digital_wallet_tokens?card_id=card_oubs0hwk5rn6knuecxg2" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

card_id
string

Filter Digital Wallet Tokens to ones belonging to the specified Card.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Retrieve a Digital Wallet Token
curl \ --url "${INCREASE_URL}/digital_wallet_tokens/digital_wallet_token_izi62go3h51p369jrie0" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
digital_wallet_token_id
string
Required

The identifier of the Digital Wallet Token.

Sandbox: Create a digital wallet token request

Simulates a user attempting add a Card to a digital wallet such as Apple Pay.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/digital_wallet_token_requests" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "card_id": "card_oubs0hwk5rn6knuecxg2" }'
Returns a Inbound Digital Wallet Token Request Simulation Result object:
{ "decline_reason": null, "digital_wallet_token_id": "digital_wallet_token_izi62go3h51p369jrie0", "type": "inbound_digital_wallet_token_request_simulation_result" }
Parameters
card_id
string
Required

The identifier of the Card to be authorized.

Entities

Entities are the legal entities that own accounts. They can be people, corporations, partnerships, government authorities, or trusts.

The Entity object
{ "corporation": { "address": { "city": "New York", "line1": "33 Liberty Street", "line2": null, "state": "NY", "zip": "10045" }, "beneficial_owners": [ { "beneficial_owner_id": "entity_setup_beneficial_owner_submission_vgkyk7dj5eb4sfhdbkx7", "company_title": "CEO", "individual": { "address": { "city": "New York", "line1": "33 Liberty Street", "line2": null, "state": "NY", "zip": "10045" }, "date_of_birth": "1970-01-31", "identification": { "country": "US", "method": "social_security_number", "number_last4": "1120" }, "name": "Ian Crease" }, "prong": "control" } ], "incorporation_state": "NY", "industry_code": null, "name": "National Phonograph Company", "tax_identifier": "602214076", "website": "https://example.com" }, "created_at": "2020-01-31T23:59:59Z", "description": null, "details_confirmed_at": null, "government_authority": null, "id": "entity_n8y8tnk2p9339ti393yi", "idempotency_key": null, "joint": null, "natural_person": null, "status": "active", "structure": "corporation", "supplemental_documents": [ { "created_at": "2020-01-31T23:59:59Z", "entity_id": "entity_n8y8tnk2p9339ti393yi", "file_id": "file_makxrc67oh9l6sg7w9yc", "idempotency_key": null, "type": "entity_supplemental_document" } ], "third_party_verification": null, "trust": null, "type": "entity" }
Attributes
corporation
dictionary
Nullable

Details of the corporation entity. Will be present if structure is equal to corporation.

created_at
string

The ISO 8601 time at which the Entity was created.

description
string
Nullable

The entity's description for display purposes.

details_confirmed_at
string
Nullable

The ISO 8601 time at which the Entity's details were most recently confirmed.

government_authority
dictionary
Nullable

Details of the government authority entity. Will be present if structure is equal to government_authority.

id
string

The entity's identifier.

idempotency_key
string
Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

joint
dictionary
Nullable

Details of the joint entity. Will be present if structure is equal to joint.

natural_person
dictionary
Nullable

Details of the natural person entity. Will be present if structure is equal to natural_person.

status
enum

The status of the entity.

structure
enum

The entity's legal structure.

supplemental_documents
array

Additional documentation associated with the entity. This is limited to the first 10 documents for an entity. If an entity has more than 10 documents, use the GET /entity_supplemental_documents list endpoint to retrieve them.

third_party_verification
dictionary
Nullable

A reference to data stored in a third-party verification service. Your integration may or may not use this field.

trust
dictionary
Nullable

Details of the trust entity. Will be present if structure is equal to trust.

type
string

A constant representing the object's type. For this resource it will always be entity.

List Entities
curl \ --url "${INCREASE_URL}/entities" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

status.in
array of strings

Filter Entities for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

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.

200 character maximum
Create an Entity
curl -X "POST" \ --url "${INCREASE_URL}/entities" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "corporation": { "address": { "city": "New York", "line1": "33 Liberty Street", "state": "NY", "zip": "10045" }, "beneficial_owners": [ { "company_title": "CEO", "individual": { "address": { "city": "New York", "line1": "33 Liberty Street", "state": "NY", "zip": "10045" }, "date_of_birth": "1970-01-31", "identification": { "method": "social_security_number", "number": "078051120" }, "name": "Ian Crease" }, "prongs": [ "control" ] } ], "incorporation_state": "NY", "name": "National Phonograph Company", "tax_identifier": "602214076", "website": "https://example.com" }, "structure": "corporation", "supplemental_documents": [ { "file_id": "file_makxrc67oh9l6sg7w9yc" } ] }'
Parameters
corporation
dictionary

Details of the corporation entity to create. Required if structure is equal to corporation.

description
string

The description you choose to give the entity.

200 character maximum
government_authority
dictionary

Details of the Government Authority entity to create. Required if structure is equal to Government Authority.

joint
dictionary

Details of the joint entity to create. Required if structure is equal to joint.

natural_person
dictionary

Details of the natural person entity to create. Required if structure is equal to natural_person. Natural people entities should be submitted with social_security_number or individual_taxpayer_identification_number identification methods.

structure
enum
Required

The type of Entity to create.

supplemental_documents
array

Additional documentation associated with the entity.

third_party_verification
dictionary

A reference to data stored in a third-party verification service. Your integration may or may not use this field.

trust
dictionary

Details of the trust entity to create. Required if structure is equal to trust.

Retrieve an Entity
curl \ --url "${INCREASE_URL}/entities/entity_n8y8tnk2p9339ti393yi" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
entity_id
string
Required

The identifier of the Entity to retrieve.

Archive an Entity
curl -X "POST" \ --url "${INCREASE_URL}/entities/entity_n8y8tnk2p9339ti393yi/archive" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
entity_id
string
Required

The identifier of the Entity to archive. Any accounts associated with an entity must be closed before the entity can be archived.

Archive a beneficial owner for a corporate Entity
curl -X "POST" \ --url "${INCREASE_URL}/entities/entity_n8y8tnk2p9339ti393yi/archive_beneficial_owner" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "beneficial_owner_id": "entity_setup_beneficial_owner_submission_vgkyk7dj5eb4sfhdbkx7" }'
Parameters
entity_id
string
Required

The identifier of the Entity associated with the Beneficial Owner that is being archived.

beneficial_owner_id
string
Required

The identifying details of anyone controlling or owning 25% or more of the corporation.

Confirm an Entity's details are correct

Depending on your program, you may be required to re-confirm an Entity's details on a recurring basis. After making any required updates, call this endpoint to record that your user confirmed their details.

curl -X "POST" \ --url "${INCREASE_URL}/entities/entity_n8y8tnk2p9339ti393yi/confirm" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{}'
Parameters
entity_id
string
Required

The identifier of the Entity to confirm the details of.

confirmed_at
string

When your user confirmed the Entity's details. If not provided, the current time will be used.

Create a beneficial owner for a corporate Entity
curl -X "POST" \ --url "${INCREASE_URL}/entities/entity_n8y8tnk2p9339ti393yi/create_beneficial_owner" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "beneficial_owner": { "company_title": "CEO", "individual": { "address": { "city": "New York", "line1": "33 Liberty Street", "state": "NY", "zip": "10045" }, "date_of_birth": "1970-01-31", "identification": { "method": "social_security_number", "number": "078051120" }, "name": "Ian Crease" }, "prongs": [ "control" ] } }'
Parameters
entity_id
string
Required

The identifier of the Entity to associate with the new Beneficial Owner.

beneficial_owner
dictionary
Required

The identifying details of anyone controlling or owning 25% or more of the corporation.

Update a Natural Person or Corporation's address
curl -X "POST" \ --url "${INCREASE_URL}/entities/entity_n8y8tnk2p9339ti393yi/update_address" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "address": { "city": "New York", "line1": "33 Liberty Street", "line2": "Unit 2", "state": "NY", "zip": "10045" } }'
Parameters
entity_id
string
Required

The identifier of the Entity whose address is being updated.

address
dictionary
Required

The entity's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.

Update the address for a beneficial owner belonging to a corporate Entity
curl -X "POST" \ --url "${INCREASE_URL}/entities/entity_n8y8tnk2p9339ti393yi/update_beneficial_owner_address" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "address": { "city": "New York", "line1": "33 Liberty Street", "line2": "Unit 2", "state": "NY", "zip": "10045" }, "beneficial_owner_id": "entity_setup_beneficial_owner_submission_vgkyk7dj5eb4sfhdbkx7" }'
Parameters
entity_id
string
Required

The identifier of the Entity associated with the Beneficial Owner whose address is being updated.

address
dictionary
Required

The individual's physical address. Mail receiving locations like PO Boxes and PMB's are disallowed.

beneficial_owner_id
string
Required

The identifying details of anyone controlling or owning 25% or more of the corporation.

Update the industry code for a corporate Entity
curl -X "POST" \ --url "${INCREASE_URL}/entities/entity_n8y8tnk2p9339ti393yi/update_industry_code" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "industry_code": "5132" }'
Parameters
entity_id
string
Required

The identifier of the Entity to update. This endpoint only accepts corporation entities.

industry_code
string
Required

The North American Industry Classification System (NAICS) code for the corporation's primary line of business. This is a number, like 5132 for Software Publishers. A full list of classification codes is available here.

200 character maximum
Supplemental Documents

Supplemental Documents are uploaded files connected to an Entity during onboarding.

The Supplemental Document object
{ "created_at": "2020-01-31T23:59:59Z", "entity_id": "entity_n8y8tnk2p9339ti393yi", "file_id": "file_makxrc67oh9l6sg7w9yc", "idempotency_key": null, "type": "entity_supplemental_document" }
Attributes
created_at
string

The ISO 8601 time at which the Supplemental Document was created.

entity_id
string

The Entity the supplemental document is attached to.

file_id
string

The File containing the document.

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.

type
string

A constant representing the object's type. For this resource it will always be entity_supplemental_document.

List Entity Supplemental Document Submissions
curl \ --url "${INCREASE_URL}/entity_supplemental_documents?entity_id=entity_n8y8tnk2p9339ti393yi" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

entity_id
string
Required

The identifier of the Entity to list supplemental documents for.

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.

200 character maximum
Create a supplemental document for an Entity
curl -X "POST" \ --url "${INCREASE_URL}/entity_supplemental_documents" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "entity_id": "entity_n8y8tnk2p9339ti393yi", "file_id": "file_makxrc67oh9l6sg7w9yc" }'
Parameters
entity_id
string
Required

The identifier of the Entity to associate with the supplemental document.

file_id
string
Required

The identifier of the File containing the document.

Programs

Programs determine the compliance and commercial terms of Accounts. By default, you have a Commercial Banking program for managing your own funds. If you are lending or managing funds on behalf of your customers, or otherwise engaged in regulated activity, we will work together to create additional Programs for you.

The Program object
{ "bank": "first_internet_bank", "billing_account_id": null, "created_at": "2020-01-31T23:59:59Z", "default_digital_card_profile_id": null, "id": "program_i2v2os4mwza1oetokh9i", "interest_rate": "0.01", "name": "Commercial Banking", "type": "program", "updated_at": "2020-01-31T23:59:59Z" }
Attributes
bank
enum

The Bank the Program is with.

billing_account_id
string
Nullable

The Program billing account.

created_at
string

The ISO 8601 time at which the Program was created.

default_digital_card_profile_id
string
Nullable

The default configuration for digital cards attached to this Program.

id
string

The Program identifier.

interest_rate
string

The Interest Rate currently being earned on the accounts in this program, as a string containing a decimal number. For example, a 1% interest rate would be represented as "0.01".

name
string

The name of the Program.

type
string

A constant representing the object's type. For this resource it will always be program.

updated_at
string

The ISO 8601 time at which the Program was last updated.

List Programs
curl \ --url "${INCREASE_URL}/programs" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

Retrieve a Program
curl \ --url "${INCREASE_URL}/programs/program_i2v2os4mwza1oetokh9i" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
program_id
string
Required

The identifier of the Program to retrieve.

Sandbox: Create a Program

Simulates a Program being created in your group. By default, your group has one program called Commercial Banking. Note that when your group operates more than one program, program_id is a required field when creating accounts.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/programs" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "name": "For Benefit Of" }'
Parameters
name
string
Required

The name of the program being added.

200 character maximum
Proof of Authorization Requests

A request for proof of authorization for one or more ACH debit transfers.

The Proof of Authorization Request object
{ "ach_transfers": [ { "id": "ach_transfer_uoxatyh3lt5evrsdvo7q" } ], "created_at": "2020-01-31T23:59:59Z", "due_on": "2020-01-31T23:59:59Z", "id": "proof_of_authorization_request_iwp8no25h3rjvil6ad3b", "type": "proof_of_authorization_request", "updated_at": "2020-01-31T23:59:59Z" }
Attributes
ach_transfers
array

The ACH Transfers associated with the request.

created_at
string

The time the Proof of Authorization Request was created.

due_on
string

The time the Proof of Authorization Request is due.

id
string

The Proof of Authorization Request identifier.

type
string

A constant representing the object's type. For this resource it will always be proof_of_authorization_request.

updated_at
string

The time the Proof of Authorization Request was last updated.

List Proof of Authorization Requests
curl \ --url "${INCREASE_URL}/proof_of_authorization_requests" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Retrieve a Proof of Authorization Request
curl \ --url "${INCREASE_URL}/proof_of_authorization_requests/proof_of_authorization_request_iwp8no25h3rjvil6ad3b" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
proof_of_authorization_request_id
string
Required

The identifier of the Proof of Authorization Request.

Proof of Authorization Request Submissions

Information submitted in response to a proof of authorization request. Per Nacha's guidance on proof of authorization, the originator must ensure that the authorization complies with applicable legal requirements, is readily identifiable as an authorization, and has clear and readily understandable terms.

The Proof of Authorization Request Submission object
{ "authorization_terms": "I agree to the terms.", "authorized_at": "2020-01-31T23:59:59Z", "authorizer_company": "National Phonograph Company", "authorizer_email": "user@example.com", "authorizer_ip_address": "123.45.67.89", "authorizer_name": "Ian Crease", "created_at": "2020-01-31T23:59:59Z", "customer_has_been_offboarded": false, "id": "proof_of_authorization_request_submission_uqhqroiley7n0097vizn", "idempotency_key": null, "proof_of_authorization_request_id": "proof_of_authorization_request_iwp8no25h3rjvil6ad3b", "status": "pending_review", "type": "proof_of_authorization_request_submission", "updated_at": "2020-01-31T23:59:59Z", "validated_account_ownership_via_credential": false, "validated_account_ownership_with_account_statement": false, "validated_account_ownership_with_microdeposit": true }
Attributes
authorization_terms
string

Terms of authorization.

authorized_at
string

Time of authorization.

authorizer_company
string
Nullable

Company of the authorizer.

authorizer_email
string
Nullable

Email of the authorizer.

authorizer_ip_address
string
Nullable

IP address of the authorizer.

authorizer_name
string
Nullable

Name of the authorizer.

created_at
string

The time the Proof of Authorization Request Submission was created.

customer_has_been_offboarded
boolean
Nullable

Whether the customer has been offboarded.

id
string

The Proof of Authorization Request Submission 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.

proof_of_authorization_request_id
string

ID of the proof of authorization request.

status
enum

Status of the proof of authorization request submission.

type
string

A constant representing the object's type. For this resource it will always be proof_of_authorization_request_submission.

updated_at
string

The time the Proof of Authorization Request Submission was last updated.

validated_account_ownership_via_credential
boolean
Nullable

Whether account ownership was validated via credential (for instance, Plaid).

validated_account_ownership_with_account_statement
boolean
Nullable

Whether account ownership was validated with an account statement.

validated_account_ownership_with_microdeposit
boolean
Nullable

Whether account ownership was validated with microdeposit.

List Proof of Authorization Request Submissions
curl \ --url "${INCREASE_URL}/proof_of_authorization_request_submissions?proof_of_authorization_request_id=proof_of_authorization_request_iwp8no25h3rjvil6ad3b" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

proof_of_authorization_request_id
string

ID of the proof of authorization request.

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.

200 character maximum
Submit Proof of Authorization
curl -X "POST" \ --url "${INCREASE_URL}/proof_of_authorization_request_submissions" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "authorization_terms": "I agree to the terms of service.", "authorized_at": "2020-01-31T23:59:59Z", "authorizer_company": "National Phonograph Company", "authorizer_email": "user@example.com", "authorizer_name": "Ian Crease", "customer_has_been_offboarded": true, "proof_of_authorization_request_id": "proof_of_authorization_request_iwp8no25h3rjvil6ad3b", "validated_account_ownership_via_credential": true, "validated_account_ownership_with_account_statement": true, "validated_account_ownership_with_microdeposit": true }'
Parameters
authorization_terms
string
Required

Terms of authorization.

2048 character maximum
authorized_at
string
Required

Time of authorization.

authorizer_company
string

Company of the authorizer.

200 character maximum
authorizer_email
string
Required

Email of the authorizer.

200 character maximum
authorizer_ip_address
string

IP address of the authorizer.

200 character maximum
authorizer_name
string
Required

Name of the authorizer.

200 character maximum
customer_has_been_offboarded
boolean
Required

Whether the customer has been offboarded or suspended.

proof_of_authorization_request_id
string
Required

ID of the proof of authorization request.

validated_account_ownership_via_credential
boolean
Required

Whether the account ownership was validated via credential (e.g. Plaid).

validated_account_ownership_with_account_statement
boolean
Required

Whether the account ownership was validated with an account statement.

validated_account_ownership_with_microdeposit
boolean
Required

Whether the account ownership was validated with a microdeposit.

Retrieve a Proof of Authorization Request Submission
curl \ --url "${INCREASE_URL}/proof_of_authorization_request_submissions/proof_of_authorization_request_submission_uqhqroiley7n0097vizn" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
proof_of_authorization_request_submission_id
string
Required

The identifier of the Proof of Authorization Request Submission.

Events

Events are records of things that happened to objects at Increase. Events are accessible via the List Events endpoint and can be delivered to your application via webhooks. For more information, see our webhooks guide.

The Event object
{ "associated_object_id": "account_in71c4amph0vgo2qllky", "associated_object_type": "account", "category": "account.created", "created_at": "2020-01-31T23:59:59Z", "id": "event_001dzz0r20rzr4zrhrr1364hy80", "type": "event" }
Attributes
associated_object_id
string

The identifier of the object that generated this Event.

associated_object_type
string

The type of the object that generated this Event.

category
enum

The category of the Event. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.

created_at
string

The time the Event was created.

id
string

The Event identifier.

type
string

A constant representing the object's type. For this resource it will always be event.

List Events
curl \ --url "${INCREASE_URL}/events" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

category.in
array of strings

Filter Events for those with the specified category or categories. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

associated_object_id
string

Filter Events to those belonging to the object with the provided identifier.

Retrieve an Event
curl \ --url "${INCREASE_URL}/events/event_001dzz0r20rzr4zrhrr1364hy80" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
event_id
string
Required

The identifier of the Event.

Event Subscriptions

Webhooks are event notifications we send to you by HTTPS POST requests. Event Subscriptions are how you configure your application to listen for them. You can create an Event Subscription through your developer dashboard or the API. For more information, see our webhooks guide.

The Event Subscription object
{ "created_at": "2020-01-31T23:59:59Z", "id": "event_subscription_001dzz0r20rcdxgb013zqb8m04g", "idempotency_key": null, "oauth_connection_id": null, "selected_event_category": null, "status": "active", "type": "event_subscription", "url": "https://website.com/webhooks" }
Attributes
created_at
string

The time the event subscription was created.

id
string

The event subscription 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.

oauth_connection_id
string
Nullable

If specified, this subscription will only receive webhooks for Events associated with this OAuth Connection.

selected_event_category
enum
Nullable

If specified, this subscription will only receive webhooks for Events with the specified category.

status
enum

This indicates if we'll send notifications to this subscription.

type
string

A constant representing the object's type. For this resource it will always be event_subscription.

url
string

The webhook url where we'll send notifications.

List Event Subscriptions
curl \ --url "${INCREASE_URL}/event_subscriptions" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

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.

200 character maximum
Create an Event Subscription
curl -X "POST" \ --url "${INCREASE_URL}/event_subscriptions" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "url": "https://website.com/webhooks" }'
Parameters
oauth_connection_id
string

If specified, this subscription will only receive webhooks for Events associated with the specified OAuth Connection.

selected_event_category
enum

If specified, this subscription will only receive webhooks for Events with the specified category.

shared_secret
string

The key that will be used to sign webhooks. If no value is passed, a random string will be used as default.

100 character maximum
url
string
Required

The URL you'd like us to send webhooks to.

Retrieve an Event Subscription
curl \ --url "${INCREASE_URL}/event_subscriptions/event_subscription_001dzz0r20rcdxgb013zqb8m04g" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
event_subscription_id
string
Required

The identifier of the Event Subscription.

Update an Event Subscription
curl -X "PATCH" \ --url "${INCREASE_URL}/event_subscriptions/event_subscription_001dzz0r20rcdxgb013zqb8m04g" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{}'
Parameters
event_subscription_id
string
Required

The identifier of the Event Subscription.

status
enum

The status to update the Event Subscription with.

Real-Time Decisions

Real Time Decisions are created when your application needs to take action in real-time to some event such as a card authorization. For more information, see our Real-Time Decisions guide.

The Real-Time Decision object
{ "card_authentication": null, "card_authentication_challenge": null, "card_authorization": { "account_id": "account_in71c4amph0vgo2qllky", "card_id": "card_oubs0hwk5rn6knuecxg2", "decision": "approve", "digital_wallet_token_id": null, "direction": "settlement", "merchant_acceptor_id": "5665270011000168", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "merchant_descriptor": "AMAZON.COM", "merchant_postal_code": "10045", "merchant_state": "NY", "network_details": { "category": "visa", "visa": { "electronic_commerce_indicator": "secure_electronic_commerce", "point_of_service_entry_mode": "manual", "stand_in_processing_reason": null } }, "network_identifiers": { "retrieval_reference_number": "785867080153", "trace_number": "487941", "transaction_id": "627199945183184" }, "network_risk_score": 10, "physical_card_id": null, "presentment_amount": 100, "presentment_currency": "USD", "processing_category": "purchase", "request_details": { "category": "initial_authorization", "incremental_authorization": null, "initial_authorization": {} }, "settlement_amount": 100, "settlement_currency": "USD", "terminal_id": "RCN5VNXS", "upcoming_card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "verification": { "card_verification_code": { "result": "match" }, "cardholder_address": { "actual_line1": "33 Liberty Street", "actual_postal_code": "94131", "provided_line1": "33 Liberty Street", "provided_postal_code": "94132", "result": "postal_code_no_match_address_match" } } }, "category": "card_authorization_requested", "created_at": "2020-01-31T23:59:59Z", "digital_wallet_authentication": null, "digital_wallet_token": null, "id": "real_time_decision_j76n2e810ezcg3zh5qtn", "status": "pending", "timeout_at": "2020-01-31T23:59:59Z", "type": "real_time_decision" }
Attributes
card_authentication
dictionary
Nullable

Fields related to a 3DS authentication attempt.

card_authentication_challenge
dictionary
Nullable

Fields related to a 3DS authentication attempt.

card_authorization
dictionary
Nullable

Fields related to a card authorization.

category
enum

The category of the Real-Time Decision.

created_at
string

The ISO 8601 date and time at which the Real-Time Decision was created.

digital_wallet_authentication
dictionary
Nullable

Fields related to a digital wallet authentication attempt.

digital_wallet_token
dictionary
Nullable

Fields related to a digital wallet token provisioning attempt.

id
string

The Real-Time Decision identifier.

status
enum

The status of the Real-Time Decision.

timeout_at
string

The ISO 8601 date and time at which your application can no longer respond to the Real-Time Decision.

type
string

A constant representing the object's type. For this resource it will always be real_time_decision.

Retrieve a Real-Time Decision
curl \ --url "${INCREASE_URL}/real_time_decisions/real_time_decision_j76n2e810ezcg3zh5qtn" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
real_time_decision_id
string
Required

The identifier of the Real-Time Decision.

Action a Real-Time Decision
curl -X "POST" \ --url "${INCREASE_URL}/real_time_decisions/real_time_decision_j76n2e810ezcg3zh5qtn/action" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "card_authorization": { "decision": "approve" } }'
Parameters
real_time_decision_id
string
Required

The identifier of the Real-Time Decision.

card_authentication
dictionary

If the Real-Time Decision relates to a 3DS card authentication attempt, this object contains your response to the authentication.

card_authentication_challenge
dictionary

If the Real-Time Decision relates to 3DS card authentication challenge delivery, this object contains your response.

card_authorization
dictionary

If the Real-Time Decision relates to a card authorization attempt, this object contains your response to the authorization.

digital_wallet_authentication
dictionary

If the Real-Time Decision relates to a digital wallet authentication attempt, this object contains your response to the authentication.

digital_wallet_token
dictionary

If the Real-Time Decision relates to a digital wallet token provisioning attempt, this object contains your response to the attempt.

Routing Numbers

Routing numbers are used to identify your bank in a financial transaction.

The Routing Number object
{ "ach_transfers": "supported", "name": "Chase", "real_time_payments_transfers": "supported", "routing_number": "021000021", "type": "routing_number", "wire_transfers": "supported" }
Attributes
ach_transfers
enum

This routing number's support for ACH Transfers.

name
string

The name of the financial institution belonging to a routing number.

real_time_payments_transfers
enum

This routing number's support for Real-Time Payments Transfers.

routing_number
string

The nine digit routing number identifier.

type
string

A constant representing the object's type. For this resource it will always be routing_number.

wire_transfers
enum

This routing number's support for Wire Transfers.

List Routing Numbers

You can use this API to confirm if a routing number is valid, such as when a user is providing you with bank account details. Since routing numbers uniquely identify a bank, this will always return 0 or 1 entry. In Sandbox, the only valid routing number for this method is 110000000.

curl \ --url "${INCREASE_URL}/routing_numbers?routing_number=021000021" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

routing_number
string
Required

Filter financial institutions by routing number.

9 character maximum
External Accounts

External Accounts represent accounts at financial institutions other than Increase. You can use this API to store their details for reuse.

The External Account object
{ "account_holder": "business", "account_number": "987654321", "created_at": "2020-01-31T23:59:59Z", "description": "Landlord", "funding": "checking", "id": "external_account_ukk55lr923a3ac0pp7iv", "idempotency_key": null, "routing_number": "101050001", "status": "active", "type": "external_account", "verification_status": "verified" }
Attributes
account_holder
enum

The type of entity that owns the External Account.

account_number
string

The destination account number.

created_at
string

The ISO 8601 date and time at which the External Account was created.

description
string

The External Account's description for display purposes.

funding
enum

The type of the account to which the transfer will be sent.

id
string

The External Account's identifier.

idempotency_key
string
Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

routing_number
string

The American Bankers' Association (ABA) Routing Transit Number (RTN).

status
enum

The External Account's status.

type
string

A constant representing the object's type. For this resource it will always be external_account.

verification_status
enum

If you have verified ownership of the External Account.

List External Accounts
curl \ --url "${INCREASE_URL}/external_accounts" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

status.in
array of strings

Filter External Accounts for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

routing_number
string

Filter External Accounts to those with the specified Routing Number.

9 character maximum
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.

200 character maximum
Create an External Account
curl -X "POST" \ --url "${INCREASE_URL}/external_accounts" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_holder": "business", "account_number": "987654321", "description": "Landlord", "routing_number": "101050001" }'
Parameters
account_holder
enum

The type of entity that owns the External Account.

account_number
string
Required

The account number for the destination account.

17 character maximum
description
string
Required

The name you choose for the Account.

200 character maximum
funding
enum

The type of the destination account. Defaults to checking.

routing_number
string
Required

The American Bankers' Association (ABA) Routing Transit Number (RTN) for the destination account.

9 character maximum
Retrieve an External Account
curl \ --url "${INCREASE_URL}/external_accounts/external_account_ukk55lr923a3ac0pp7iv" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
external_account_id
string
Required

The identifier of the External Account.

Update an External Account
curl -X "PATCH" \ --url "${INCREASE_URL}/external_accounts/external_account_ukk55lr923a3ac0pp7iv" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "description": "New description" }'
Parameters
external_account_id
string
Required

The external account identifier.

account_holder
enum

The type of entity that owns the External Account.

description
string

The description you choose to give the external account.

200 character maximum
funding
enum

The funding type of the External Account.

status
enum

The status of the External Account.

Account Statements

Account Statements are generated monthly for every active Account. You can access the statement's data via the API or retrieve a PDF with its details via its associated File.

The Account Statement object
{ "account_id": "account_in71c4amph0vgo2qllky", "created_at": "2020-01-31T23:59:59Z", "ending_balance": 100, "file_id": "file_makxrc67oh9l6sg7w9yc", "id": "account_statement_lkc03a4skm2k7f38vj15", "starting_balance": 0, "statement_period_end": "2020-01-31T23:59:59Z", "statement_period_start": "2020-01-31T23:59:59Z", "type": "account_statement" }
Attributes
account_id
string

The identifier for the Account this Account Statement belongs to.

created_at
string

The ISO 8601 time at which the Account Statement was created.

ending_balance
integer

The Account's balance at the start of its statement period.

file_id
string

The identifier of the File containing a PDF of the statement.

id
string

The Account Statement identifier.

starting_balance
integer

The Account's balance at the start of its statement period.

statement_period_end
string

The ISO 8601 time representing the end of the period the Account Statement covers.

statement_period_start
string

The ISO 8601 time representing the start of the period the Account Statement covers.

type
string

A constant representing the object's type. For this resource it will always be account_statement.

List Account Statements
curl \ --url "${INCREASE_URL}/account_statements?account_id=account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Account Statements to those belonging to the specified Account.

statement_period_start.after
string

Return results after this ISO 8601 timestamp.

statement_period_start.before
string

Return results before this ISO 8601 timestamp.

statement_period_start.on_or_after
string

Return results on or after this ISO 8601 timestamp.

statement_period_start.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Retrieve an Account Statement
curl \ --url "${INCREASE_URL}/account_statements/account_statement_lkc03a4skm2k7f38vj15" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
account_statement_id
string
Required

The identifier of the Account Statement to retrieve.

Sandbox: Create an Account Statement

Simulates an Account Statement being created for an account. In production, Account Statements are generated once per month.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/account_statements" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_id": "account_in71c4amph0vgo2qllky" }'
Parameters
account_id
string
Required

The identifier of the Account the statement is for.

Files

Files are objects that represent a file hosted on Increase's servers. The file may have been uploaded by you (for example, when uploading a check image) or it may have been created by Increase (for example, an autogenerated statement PDF).

The File object
{ "created_at": "2020-01-31T23:59:59Z", "description": "2022-05 statement for checking account", "direction": "from_increase", "download_url": "https://api.increase.com/files/file_makxrc67oh9l6sg7w9yc/download", "filename": "statement.pdf", "id": "file_makxrc67oh9l6sg7w9yc", "idempotency_key": null, "mime_type": "application/pdf", "purpose": "increase_statement", "type": "file" }
Attributes
created_at
string

The time the File was created.

description
string
Nullable

A description of the File.

direction
enum

Whether the File was generated by Increase or by you and sent to Increase.

download_url
string
Nullable

A URL from where the File can be downloaded at this point in time. The location of this URL may change over time.

filename
string
Nullable

The filename that was provided upon upload or generated by Increase.

id
string

The File's identifier.

idempotency_key
string
Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

mime_type
string

The MIME type of the file.

purpose
enum

What the File will be used for. We may add additional possible values for this enum over time; your application should be able to handle such additions gracefully.

type
string

A constant representing the object's type. For this resource it will always be file.

List Files
curl \ --url "${INCREASE_URL}/files" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

purpose.in
array of strings

Filter Files for those with the specified purpose or purposes. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

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.

200 character maximum
Create a File

To upload a file to Increase, you'll need to send a request of Content-Type multipart/form-data. The request should contain the file you would like to upload, as well as the parameters for creating a file.

curl -X "POST" \ --url "${INCREASE_URL}/files" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: multipart/form-data" \ -F file="@tax_form.pdf" \ -F purpose=check_image_front
Parameters
description
string

The description you choose to give the File.

200 character maximum
file
string
Required

The file contents. This should follow the specifications of RFC 7578 which defines file transfers for the multipart/form-data protocol.

purpose
enum
Required

What the File will be used for in Increase's systems.

Retrieve a File
curl \ --url "${INCREASE_URL}/files/file_makxrc67oh9l6sg7w9yc" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
file_id
string
Required

The identifier of the File.

Documents

Increase generates certain documents / forms automatically for your application; they can be listed here.

The Document object
{ "category": "form_1099_int", "created_at": "2020-01-31T23:59:59Z", "entity_id": "entity_n8y8tnk2p9339ti393yi", "file_id": "file_makxrc67oh9l6sg7w9yc", "id": "document_qjtqc6s4c14ve2q89izm", "type": "document" }
Attributes
category
enum

The type of document.

created_at
string

The ISO 8601 time at which the Document was created.

entity_id
string
Nullable

The identifier of the Entity the document was generated for.

file_id
string

The identifier of the File containing the Document's contents.

id
string

The Document identifier.

type
string

A constant representing the object's type. For this resource it will always be document.

List Documents
curl \ --url "${INCREASE_URL}/documents" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

entity_id
string

Filter Documents to ones belonging to the specified Entity.

category.in
array of strings

Filter Documents for those with the specified category or categories. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Retrieve a Document
curl \ --url "${INCREASE_URL}/documents/document_qjtqc6s4c14ve2q89izm" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
document_id
string
Required

The identifier of the Document to retrieve.

Sandbox: Create a tax document

Simulates an tax document being created for an account.

curl -X "POST" \ --url "${INCREASE_URL}/simulations/documents" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_id": "account_in71c4amph0vgo2qllky" }'
Parameters
account_id
string
Required

The identifier of the Account the tax document is for.

Exports

Exports are batch summaries of your Increase data. You can make them from the API or dashboard. Since they can take a while, they are generated asynchronously. We send a webhook when they are ready. For more information, please read our Exports documentation.

The Export object
{ "category": "transaction_csv", "created_at": "2020-01-31T23:59:59Z", "file_download_url": "https://example.com/file", "file_id": "file_makxrc67oh9l6sg7w9yc", "id": "export_8s4m48qz3bclzje0zwh9", "idempotency_key": null, "status": "complete", "type": "export" }
Attributes
category
enum

The category of the Export. We may add additional possible values for this enum over time; your application should be able to handle that gracefully.

created_at
string

The time the Export was created.

file_download_url
string
Nullable

A URL at which the Export's file can be downloaded. This will be present when the Export's status transitions to complete.

file_id
string
Nullable

The File containing the contents of the Export. This will be present when the Export's status transitions to complete.

id
string

The Export 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.

status
enum

The status of the Export.

type
string

A constant representing the object's type. For this resource it will always be export.

List Exports
curl \ --url "${INCREASE_URL}/exports" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

category.in
array of strings

Filter Exports for those with the specified category or categories. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

status.in
array of strings

Filter Exports for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

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.

200 character maximum
Create an Export
curl -X "POST" \ --url "${INCREASE_URL}/exports" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "category": "transaction_csv", "transaction_csv": { "account_id": "account_in71c4amph0vgo2qllky" } }'
Parameters
account_statement_ofx
dictionary

Options for the created export. Required if category is equal to account_statement_ofx.

balance_csv
dictionary

Options for the created export. Required if category is equal to balance_csv.

bookkeeping_account_balance_csv
dictionary

Options for the created export. Required if category is equal to bookkeeping_account_balance_csv.

category
enum
Required

The type of Export to create.

entity_csv
dictionary

Options for the created export. Required if category is equal to entity_csv.

transaction_csv
dictionary

Options for the created export. Required if category is equal to transaction_csv.

vendor_csv
dictionary

Options for the created export. Required if category is equal to vendor_csv.

Retrieve an Export
curl \ --url "${INCREASE_URL}/exports/export_8s4m48qz3bclzje0zwh9" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
export_id
string
Required

The identifier of the Export to retrieve.

Bookkeeping Accounts

Accounts are T-accounts. They can store accounting entries. Your compliance setup might require annotating money movements using this API. Learn more in our guide to Bookkeeping.

The Bookkeeping Account object
{ "account_id": null, "compliance_category": "customer_balance", "entity_id": "entity_n8y8tnk2p9339ti393yi", "id": "bookkeeping_account_e37p1f1iuocw5intf35v", "idempotency_key": null, "name": "John Doe Balance", "type": "bookkeeping_account" }
Attributes
account_id
string
Nullable

The API Account associated with this bookkeeping account.

compliance_category
enum
Nullable

The compliance category of the account.

entity_id
string
Nullable

The Entity associated with this bookkeeping account.

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.

name
string

The name you choose for the account.

type
string

A constant representing the object's type. For this resource it will always be bookkeeping_account.

List Bookkeeping Accounts
curl \ --url "${INCREASE_URL}/bookkeeping_accounts" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

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.

200 character maximum
Create a Bookkeeping Account
curl -X "POST" \ --url "${INCREASE_URL}/bookkeeping_accounts" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "name": "New Account!" }'
Parameters
account_id
string

The entity, if compliance_category is commingled_cash.

compliance_category
enum

The account compliance category.

entity_id
string

The entity, if compliance_category is customer_balance.

name
string
Required

The name you choose for the account.

200 character maximum
Update a Bookkeeping Account
curl -X "PATCH" \ --url "${INCREASE_URL}/bookkeeping_accounts/bookkeeping_account_e37p1f1iuocw5intf35v" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "name": "Deprecated Account" }'
Parameters
bookkeeping_account_id
string
Required

The bookkeeping account you would like to update.

name
string
Required

The name you choose for the account.

200 character maximum
Retrieve a Bookkeeping Account Balance
curl \ --url "${INCREASE_URL}/bookkeeping_accounts/bookkeeping_account_e37p1f1iuocw5intf35v/balance" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Returns a Bookkeeping Balance Lookup object:
{ "balance": 100, "bookkeeping_account_id": "bookkeeping_account_e37p1f1iuocw5intf35v", "type": "bookkeeping_balance_lookup" }
Parameters
bookkeeping_account_id
string
Required

The identifier of the Bookkeeping Account to retrieve.

at_time
string

The moment to query the balance at. If not set, returns the current balances.

Bookkeeping Entry Sets

Entry Sets are accounting entries that are transactionally applied. Your compliance setup might require annotating money movements using this API. Learn more in our guide to Bookkeeping.

The Bookkeeping Entry Set object
{ "created_at": "2023-02-11T02:11:59Z", "date": "2020-01-31T23:59:59Z", "entries": [ { "account_id": "bookkeeping_account_e37p1f1iuocw5intf35v", "amount": 1750, "id": "bookkeeping_entry_ctjpajsj3ks2blx10375" }, { "account_id": "bookkeeping_account_e37p1f1iuocw5intf35v", "amount": -1750, "id": "bookkeeping_entry_ctjpajsj3ks2blx10375" } ], "id": "bookkeeping_entry_set_n80c6wr2p8gtc6p4ingf", "idempotency_key": null, "transaction_id": null, "type": "bookkeeping_entry_set" }
Attributes
created_at
string

When the entry set was created.

date
string

The timestamp of the entry set.

entries
array

The entries.

id
string

The entry set 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.

transaction_id
string
Nullable

The transaction identifier, if any.

type
string

A constant representing the object's type. For this resource it will always be bookkeeping_entry_set.

List Bookkeeping Entry Sets
curl \ --url "${INCREASE_URL}/bookkeeping_entry_sets" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

transaction_id
string

Filter to the Bookkeeping Entry Set that maps to this Transaction.

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.

200 character maximum
Create a Bookkeeping Entry Set
curl -X "POST" \ --url "${INCREASE_URL}/bookkeeping_entry_sets" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "date": "2020-01-31T23:59:59Z", "entries": [ { "account_id": "bookkeeping_account_9husfpw68pzmve9dvvc7", "amount": 100 }, { "account_id": "bookkeeping_account_t2obldz1rcu15zr54umg", "amount": -100 } ], "transaction_id": "transaction_uyrp7fld2ium70oa7oi" }'
Parameters
date
string

The date of the transaction. Optional if transaction_id is provided, in which case we use the date of that transaction. Required otherwise.

entries
array
Required

The bookkeeping entries.

transaction_id
string

The identifier of the Transaction related to this entry set, if any.

Retrieve a Bookkeeping Entry Set
curl \ --url "${INCREASE_URL}/bookkeeping_entry_sets/bookkeeping_entry_set_n80c6wr2p8gtc6p4ingf" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
bookkeeping_entry_set_id
string
Required

The identifier of the Bookkeeping Entry Set.

Bookkeeping Entries

Entries are T-account entries recording debits and credits. Your compliance setup might require annotating money movements using this API. Learn more in our guide to Bookkeeping.

The Bookkeeping Entry object
{ "account_id": "bookkeeping_account_e37p1f1iuocw5intf35v", "amount": 1750, "created_at": "2020-01-31T23:59:59Z", "entry_set_id": "bookkeeping_entry_set_n80c6wr2p8gtc6p4ingf", "id": "bookkeeping_entry_ctjpajsj3ks2blx10375", "type": "bookkeeping_entry" }
Attributes
account_id
string

The identifier for the Account the Entry belongs to.

amount
integer

The Entry amount in the minor unit of its currency. For dollars, for example, this is cents.

created_at
string

When the entry set was created.

entry_set_id
string

The identifier for the Account the Entry belongs to.

id
string

The entry identifier.

type
string

A constant representing the object's type. For this resource it will always be bookkeeping_entry.

List Bookkeeping Entries
curl \ --url "${INCREASE_URL}/bookkeeping_entries?account_id=bookkeeping_account_e37p1f1iuocw5intf35v" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

The identifier for the Bookkeeping Account to filter by.

Retrieve a Bookkeeping Entry
curl \ --url "${INCREASE_URL}/bookkeeping_entries/bookkeeping_entry_ctjpajsj3ks2blx10375" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
bookkeeping_entry_id
string
Required

The identifier of the Bookkeeping Entry.

Groups

Groups represent organizations using Increase. You can retrieve information about your own organization via the API, or (more commonly) OAuth platforms can retrieve information about the organizations that have granted them access.

The Group object
{ "ach_debit_status": "disabled", "activation_status": "activated", "created_at": "2020-01-31T23:59:59Z", "id": "group_1g4mhziu6kvrs3vz35um", "type": "group" }
Attributes
ach_debit_status
enum

If the Group is allowed to create ACH debits.

activation_status
enum

If the Group is activated or not.

created_at
string

The ISO 8601 time at which the Group was created.

id
string

The Group identifier.

type
string

A constant representing the object's type. For this resource it will always be group.

Retrieve Group details

Returns details for the currently authenticated Group.

curl \ --url "${INCREASE_URL}/groups/current" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
OAuth Connections

When a user authorizes your OAuth application, an OAuth Connection object is created. Learn more about OAuth here.

The OAuth Connection object
{ "created_at": "2020-01-31T23:59:59Z", "deleted_at": null, "group_id": "group_1g4mhziu6kvrs3vz35um", "id": "connection_dauknoksyr4wilz4e6my", "status": "active", "type": "oauth_connection" }
Attributes
created_at
string

The ISO 8601 timestamp when the OAuth Connection was created.

deleted_at
string
Nullable

The ISO 8601 timestamp when the OAuth Connection was deleted.

group_id
string

The identifier of the Group that has authorized your OAuth application.

id
string

The OAuth Connection's identifier.

status
enum

Whether the connection is active.

type
string

A constant representing the object's type. For this resource it will always be oauth_connection.

List OAuth Connections
curl \ --url "${INCREASE_URL}/oauth_connections" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

status.in
array of strings

Filter to OAuth Connections by their status. By default, return only the active ones. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

Retrieve an OAuth Connection
curl \ --url "${INCREASE_URL}/oauth_connections/connection_dauknoksyr4wilz4e6my" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
oauth_connection_id
string
Required

The identifier of the OAuth Connection.

OAuth Tokens

A token that is returned to your application when a user completes the OAuth flow and may be used to authenticate requests. Learn more about OAuth here.

The OAuth Token object
{ "access_token": "12345", "token_type": "bearer", "type": "oauth_token" }
Attributes
access_token
string

You may use this token in place of an API key to make OAuth requests on a user's behalf.

token_type
string

The type of OAuth token.

type
string

A constant representing the object's type. For this resource it will always be oauth_token.

Create an OAuth Token
curl -X "POST" \ --url "${INCREASE_URL}/oauth/tokens" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "client_id": "12345", "client_secret": "supersecret", "code": "123", "grant_type": "authorization_code" }'
Parameters
client_id
string

The public identifier for your application.

200 character maximum
client_secret
string

The secret that confirms you own the application. This is redundent given that the request is made with your API key but it's a required component of OAuth 2.0.

200 character maximum
code
string

The authorization code generated by the user and given to you as a query parameter.

200 character maximum
grant_type
enum
Required

The credential you request in exchange for the code. In Production, this is always authorization_code. In Sandbox, you can pass either enum value.

production_token
string

The production token you want to exchange for a sandbox token. This is only available in Sandbox. Set grant_type to production_token to use this parameter.

200 character maximum
IntraFi Account Enrollments

IntraFi is a network of financial institutions that allows Increase users to sweep funds to multiple banks, in addition to Increase's main bank partners. This enables accounts to become eligible for additional Federal Deposit Insurance Corporation (FDIC) insurance. An IntraFi Account Enrollment object represents the status of an account in the network. Sweeping an account to IntraFi doesn't affect funds availability.

The IntraFi Account Enrollment object
{ "account_id": "account_in71c4amph0vgo2qllky", "id": "intrafi_account_enrollment_w8l97znzreopkwf2tg75", "idempotency_key": null, "intrafi_id": "01234abcd", "status": "pending_enrolling", "type": "intrafi_account_enrollment" }
Attributes
account_id
string

The identifier of the Increase Account being swept into the network.

id
string

The identifier of this enrollment at IntraFi.

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.

intrafi_id
string

The identifier of the account in IntraFi's system. This identifier will be printed on any IntraFi statements or documents.

status
enum

The status of the account in the network. An account takes about one business day to go from pending_enrolling to enrolled.

type
string

A constant representing the object's type. For this resource it will always be intrafi_account_enrollment.

List IntraFi Account Enrollments
curl \ --url "${INCREASE_URL}/intrafi_account_enrollments?account_id=account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter IntraFi Account Enrollments to the one belonging to an account.

status.in
array of strings

Filter IntraFi Account Enrollments for those with the specified status or statuses. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

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.

200 character maximum
Enroll an account in the IntraFi deposit sweep network
curl -X "POST" \ --url "${INCREASE_URL}/intrafi_account_enrollments" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "account_id": "account_in71c4amph0vgo2qllky", "email_address": "user@example.com" }'
Parameters
account_id
string
Required

The identifier for the account to be added to IntraFi.

email_address
string
Required

The contact email for the account owner, to be shared with IntraFi.

200 character maximum
Get an IntraFi Account Enrollment
curl \ --url "${INCREASE_URL}/intrafi_account_enrollments/intrafi_account_enrollment_w8l97znzreopkwf2tg75" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
intrafi_account_enrollment_id
string
Required

The identifier of the IntraFi Account Enrollment to retrieve.

Unenroll an account from IntraFi
curl -X "POST" \ --url "${INCREASE_URL}/intrafi_account_enrollments/intrafi_account_enrollment_w8l97znzreopkwf2tg75/unenroll" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
intrafi_account_enrollment_id
string
Required

The Identifier of the IntraFi Account Enrollment to remove from IntraFi.

IntraFi Balances

When using IntraFi, each account's balance over the standard FDIC insurance amount are swept to various other institutions. Funds are rebalanced across banks as needed once per business day.

The IntraFi Balance object
{ "balances": [ { "balance": 1750, "bank": "Example Bank", "bank_location": { "city": "New York", "state": "NY" }, "fdic_certificate_number": "314159", "id": "intrafi_detailed_balance_qp4v28t1htqu5lsp0rz8" } ], "currency": "USD", "effective_date": "2020-01-31", "id": "intrafi_balance_8lgtn3pz0ktekaekw29t", "total_balance": 1750, "type": "intrafi_balance" }
Attributes
balances
array

Each entry represents a balance held at a different bank. IntraFi separates the total balance across many participating banks in the network.

currency
enum

The ISO 4217 code for the account currency.

effective_date
string

The date this balance reflects.

id
string

The identifier of this balance.

total_balance
integer

The total balance, in minor units of currency. Increase reports this balance to IntraFi daily.

type
string

A constant representing the object's type. For this resource it will always be intrafi_balance.

Get IntraFi balances by bank
curl \ --url "${INCREASE_URL}/intrafi_balances/account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
account_id
string
Required

The identifier of the Account to get balances for.

IntraFi Exclusions

Certain institutions may be excluded per Entity when sweeping funds into the IntraFi network. This is useful when an Entity already has deposits at a particular bank, and does not want to sweep additional funds to it. It may take 5 business days for an exclusion to be processed.

The IntraFi Exclusion object
{ "bank_name": "Example Bank", "entity_id": "entity_n8y8tnk2p9339ti393yi", "excluded_at": "2020-02-01T23:59:59+00:00", "fdic_certificate_number": "314159", "id": "intrafi_exclusion_ygfqduuzpau3jqof6jyh", "idempotency_key": null, "status": "completed", "submitted_at": "2020-01-31T23:59:59Z", "type": "intrafi_exclusion" }
Attributes
bank_name
string

The name of the excluded institution.

entity_id
string

The entity for which this institution is excluded.

excluded_at
string
Nullable

When this was exclusion was confirmed by IntraFi.

fdic_certificate_number
string
Nullable

The Federal Deposit Insurance Corporation's certificate number for the institution.

id
string

The identifier of this exclusion request.

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.

status
enum

The status of the exclusion request.

submitted_at
string
Nullable

When this was exclusion was submitted to IntraFi by Increase.

type
string

A constant representing the object's type. For this resource it will always be intrafi_exclusion.

List IntraFi Exclusions
curl \ --url "${INCREASE_URL}/intrafi_exclusions?entity_id=entity_n8y8tnk2p9339ti393yi" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

entity_id
string

Filter IntraFi Exclusions for those belonging to the specified Entity.

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.

200 character maximum
Create an IntraFi Exclusion
curl -X "POST" \ --url "${INCREASE_URL}/intrafi_exclusions" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "bank_name": "Example Bank", "entity_id": "entity_n8y8tnk2p9339ti393yi" }'
Parameters
bank_name
string
Required

The name of the financial institution to be excluded.

200 character maximum
entity_id
string
Required

The identifier of the Entity whose deposits will be excluded.

Get an IntraFi Exclusion
curl \ --url "${INCREASE_URL}/intrafi_exclusions/account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
intrafi_exclusion_id
string
Required

The identifier of the IntraFi Exclusion to retrieve.

Archive an IntraFi Exclusion
curl -X "POST" \ --url "${INCREASE_URL}/intrafi_exclusions/intrafi_exclusion_ygfqduuzpau3jqof6jyh/archive" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
intrafi_exclusion_id
string
Required

The identifier of the IntraFi Exclusion request to archive. It may take 5 business days for an exclusion removal to be processed. Removing an exclusion does not guarantee that funds will be swept to the previously-excluded bank.

Real-Time Payments Request for Payments

Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network. A request for payment is a request to the receiver to send funds to your account. The permitted uses of Requests For Payment are limited by the Real-Time Payments network to business-to-business payments and transfers between two accounts at different banks owned by the same individual. Please contact support@increase.com to enable this API for your team.

The Real-Time Payments Request for Payment object
{ "amount": 100, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "debtor_name": "Ian Crease", "destination_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "expires_at": "2025-12-31", "fulfillment_transaction_id": null, "id": "real_time_payments_request_for_payment_28kcliz1oevcnqyn9qp7", "idempotency_key": null, "refusal": null, "rejection": null, "remittance_information": "Invoice 29582", "source_account_number": "987654321", "source_routing_number": "101050001", "status": "pending_response", "submission": null, "type": "real_time_payments_request_for_payment" }
Attributes
amount
integer

The transfer amount in USD cents.

created_at
string

The ISO 8601 date and time at which the request for payment was created.

currency
enum

The ISO 4217 code for the transfer's currency. For real-time payments transfers this is always equal to USD.

debtor_name
string

The name of the recipient the sender is requesting a transfer from.

destination_account_number_id
string

The Account Number in which a successful transfer will arrive.

expires_at
string

The expiration time for this request, in UTC. The requestee will not be able to pay after this date.

fulfillment_transaction_id
string
Nullable

The transaction that fulfilled this request.

id
string

The Real-Time Payments Request for Payment's identifier.

idempotency_key
string
Nullable

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

refusal
dictionary
Nullable

If the request for payment is refused by the destination financial institution or the receiving customer, this will contain supplemental details.

rejection
dictionary
Nullable

If the request for payment is rejected by Real-Time Payments or the destination financial institution, this will contain supplemental details.

remittance_information
string

Unstructured information that will show on the recipient's bank statement.

source_account_number
string

The account number the request is sent to.

source_routing_number
string

The receiver's American Bankers' Association (ABA) Routing Transit Number (RTN).

status
enum

The lifecycle status of the request for payment.

submission
dictionary
Nullable

After the request for payment is submitted to Real-Time Payments, this will contain supplemental details.

type
string

A constant representing the object's type. For this resource it will always be real_time_payments_request_for_payment.

List Real-Time Payments Request for Payments
curl \ --url "${INCREASE_URL}/real_time_payments_request_for_payments?account_id=account_in71c4amph0vgo2qllky" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
cursor
string

Return the page of entries after this one.

limit
integer

Limit the size of the list that is returned. The default (and maximum) is 100 objects.

account_id
string

Filter Real-Time Payments Request for Payments to those destined to the specified Account.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

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.

200 character maximum
Create a Real-Time Payments Request for Payment
curl -X "POST" \ --url "${INCREASE_URL}/real_time_payments_request_for_payments" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "amount": 100, "debtor": { "address": { "country": "US", "street_name": "Liberty Street" }, "name": "Ian Crease" }, "destination_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "expires_at": "2025-12-31", "remittance_information": "Invoice 29582", "source_account_number": "987654321", "source_routing_number": "101050001" }'
Parameters
amount
integer
Required

The requested amount in USD cents. Must be positive.

debtor
dictionary
Required

Details of the person being requested to pay.

destination_account_number_id
string
Required

The identifier of the Account Number where the funds will land.

expires_at
string
Required

The expiration time for this request, in UTC. The requestee will not be able to pay after this date.

remittance_information
string
Required

Unstructured information that will show on the requestee's bank statement.

140 character maximum
source_account_number
string
Required

The account number the funds will be requested from.

34 character maximum
source_routing_number
string
Required

The requestee's American Bankers' Association (ABA) Routing Transit Number (RTN).

9 character maximum
Retrieve a Real-Time Payments Request for Payment
curl \ --url "${INCREASE_URL}/real_time_payments_request_for_payments/real_time_payments_transfer_iyuhl5kdn7ssmup83mvq" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
request_for_payment_id
string
Required

The identifier of the Real-Time Payments Request for Payment.