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 7807 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!" }'
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.

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.

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.

source_id
string

Filter pending transactions to those caused by the specified source.

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.

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.

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, "individual_id": null, "individual_name": "Ian Crease", "network": "ach", "notifications_of_change": [], "pending_transaction_id": null, "return": null, "routing_number": "101050001", "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", "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.

effective_date
string
Nullable

The transfer effective date in ISO 8601 format.

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.

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.

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

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

effective_date
string

The transfer effective date in ISO 8601 format.

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

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", "id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev", "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", "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.

id
string

The inbound ACH transfer's identifier.

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.

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.

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}"
Parameters
inbound_ach_transfer_id
string
Required

The identifier of the Inbound ACH Transfer to decline.

Create a notification of change for an Inbound ACH Transfer
curl -X "POST" \ --url "${INCREASE_URL}/inbound_ach_transfers/inbound_ach_transfer_tdrwqr3fq9gnnq49odev/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
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.

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_financial_institution_address_line1": null, "beneficiary_financial_institution_address_line2": null, "beneficiary_financial_institution_address_line3": null, "beneficiary_financial_institution_identifier": null, "beneficiary_financial_institution_identifier_type": null, "beneficiary_financial_institution_name": 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", "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).

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.

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

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.

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_transaction_id": "transaction_uyrp7fld2ium70oa7oi", "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_transaction_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 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.

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" }, "signer_name": null }, "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": { "city": "New York", "line1": "33 Liberty Street", "name": "Ian Crease", "postal_code": "10045", "state": "NY" } }, "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 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.

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", "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, "front_image_file_id": "file_makxrc67oh9l6sg7w9yc", "id": "inbound_check_deposit_zoshvqybq0cjjm31mra", "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.

amount
integer

The deposited amount in the minor unit of the destination account currency. For dollars, for example, this is 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.

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.

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.

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

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.

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", "currency": "USD", "deposit_acceptance": null, "deposit_rejection": null, "deposit_return": null, "deposit_submission": null, "front_image_file_id": "file_makxrc67oh9l6sg7w9yc", "id": "check_deposit_f06n9gpg7sxn8t19lfc1", "idempotency_key": null, "inbound_mail_item_id": null, "mailing_address_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 the minor unit of the destination account currency. For dollars, for example, this is 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.

currency
enum

The ISO 4217 code for the deposit.

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.

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.

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", "currency": "USD", "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 the minor unit of the account currency. For dollars, for example, this is cents.

back_image_file_id
string
Required

The File containing the check's back image.

currency
string
Required

The currency to use for the deposit.

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.

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", "elements": [ { "category": "card_authorization", "card_authorization": { "id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "merchant_acceptor_id": "5665270011000168", "merchant_descriptor": "AMAZON.COM", "merchant_category_code": "5734", "merchant_city": "New York", "merchant_country": "US", "digital_wallet_token_id": null, "physical_card_id": null, "verification": { "cardholder_address": { "provided_postal_code": "94132", "provided_line1": "33 Liberty Street", "actual_postal_code": "94131", "actual_line1": "33 Liberty Street", "result": "postal_code_no_match_address_match" }, "card_verification_code": { "result": "match" } }, "network_identifiers": { "transaction_id": "627199945183184", "trace_number": "487941", "retrieval_reference_number": "785867080153" }, "network_risk_score": 10, "network_details": { "category": "visa", "visa": { "electronic_commerce_indicator": "secure_electronic_commerce", "point_of_service_entry_mode": "manual" } }, "amount": 100, "presentment_amount": 100, "presentment_currency": "USD", "currency": "USD", "direction": "settlement", "actioner": "increase", "processing_category": "purchase", "expires_at": "2020-01-31T23:59:59Z", "real_time_decision_id": null, "pending_transaction_id": null, "type": "card_authorization" }, "created_at": "2020-01-31T23:59:59Z" }, { "category": "card_reversal", "card_reversal": { "id": "card_reversal_8vr9qy60cgf5d0slpb68", "reversal_amount": 20, "updated_authorization_amount": 80, "currency": "USD", "card_authorization_id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "network": "visa", "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "network_identifiers": { "transaction_id": "627199945183184", "trace_number": "487941", "retrieval_reference_number": "785867080153" }, "type": "card_reversal" }, "created_at": "2020-01-31T23:59:59Z" }, { "category": "card_increment", "card_increment": { "id": "card_increment_6ztayc58j1od0rpebp3e", "amount": 20, "updated_authorization_amount": 120, "currency": "USD", "card_authorization_id": "card_authorization_6iqxap6ivd0fo5eu3i8x", "network": "visa", "actioner": "increase", "real_time_decision_id": null, "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "network_risk_score": 10, "network_identifiers": { "transaction_id": "627199945183184", "trace_number": "487941", "retrieval_reference_number": "785867080153" }, "type": "card_increment" }, "created_at": "2020-01-31T23:59:59Z" }, { "category": "card_settlement", "card_settlement": { "id": "card_settlement_khv5kfeu0vndj291omg6", "card_payment_id": "card_payment_nd3k2kacrqjli8482ave", "card_authorization": null, "amount": 100, "currency": "USD", "presentment_amount": 100, "presentment_currency": "USD", "merchant_acceptor_id": "5665270011000168", "merchant_city": "New York", "merchant_state": "NY", "merchant_country": "US", "merchant_name": "AMAZON.COM", "merchant_category_code": "5734", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "pending_transaction_id": null, "purchase_details": { "purchase_identifier": "10203", "purchase_identifier_format": "order_number", "customer_reference_identifier": "51201", "local_tax_amount": null, "local_tax_currency": "usd", "national_tax_amount": null, "national_tax_currency": "usd", "car_rental": null, "lodging": { "no_show_indicator": "no_show", "extra_charges": "restaurant", "check_in_date": "2023-07-20", "daily_room_rate_amount": 1000, "daily_room_rate_currency": "usd", "total_tax_amount": 100, "total_tax_currency": "usd", "prepaid_expenses_amount": 0, "prepaid_expenses_currency": "usd", "food_beverage_charges_amount": 0, "food_beverage_charges_currency": "usd", "folio_cash_advances_amount": 0, "folio_cash_advances_currency": "usd", "room_nights": 1, "total_room_tax_amount": 100, "total_room_tax_currency": "usd" }, "travel": null }, "network_identifiers": { "transaction_id": "627199945183184", "acquirer_reference_number": "83163715445437604865089", "acquirer_business_id": "69650702" }, "type": "card_settlement" }, "created_at": "2020-01-31T23:59:59Z" } ], "id": "card_payment_nd3k2kacrqjli8482ave", "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.

elements
array

The interactions related to this card payment.

id
string

The Card Payment identifier.

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.

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": [ { "item_commodity_code": "001", "item_descriptor": "Coffee", "product_code": "101", "item_quantity": "1.0", "unit_of_measure_code": "NMB", "unit_cost": "5.0", "unit_cost_currency": "USD", "sales_tax_amount": null, "sales_tax_currency": null, "sales_tax_rate": null, "discount_amount": null, "discount_currency": null, "discount_treatment_code": null, "total_amount": 500, "total_amount_currency": "USD", "detail_indicator": "normal" } ], "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, "created_at": "2020-01-31T23:59:59Z", "disputed_transaction_id": "transaction_uyrp7fld2ium70oa7oi", "explanation": "Unauthorized recurring purchase", "id": "card_dispute_h9sc95nbl1cgltpp7men", "idempotency_key": null, "rejection": null, "status": "pending_reviewing", "type": "card_dispute" }
Attributes
acceptance
dictionary
Nullable

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

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.

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.

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

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.

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.