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", "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "entity_id": "entity_n8y8tnk2p9339ti393yi", "informational_entity_id": null, "id": "account_in71c4amph0vgo2qllky", "interest_accrued": "0.01", "interest_accrued_at": "2020-01-31", "interest_rate": "0.055", "name": "My first account!", "status": "open", "replacement": { "replaced_account_id": null, "replaced_by_account_id": null }, "type": "account", "idempotency_key": null }
Attributes
bank
enum

The bank the Account is with.

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.

informational_entity_id
string
Nullable

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

id
string

The Account identifier.

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.

status
enum

The status of the Account.

type
string

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

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.

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", "program_id": "program_i2v2os4mwza1oetokh9i", "name": "New Account!" }'
Parameters
entity_id
string

The identifier for the Entity that will own the Account.

program_id
string

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

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

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", "current_balance": 100, "available_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", "id": "account_number_v18nkfqm6afpsrvy82b2", "created_at": "2020-01-31T23:59:59Z", "name": "ACH", "routing_number": "101050001", "status": "active", "inbound_ach": { "debit_status": "blocked" }, "inbound_checks": { "status": "check_transfers_only" }, "replacement": { "replaced_account_number_id": null, "replaced_by_account_number_id": null }, "idempotency_key": null, "type": "account_number" }
Attributes
account_id
string

The identifier for the account this Account Number belongs to.

account_number
string

The account number.

id
string

The Account Number identifier.

created_at
string

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

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.

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.

idempotency_key
string
Nullable

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

type
string

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

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.

name
string
Required

The name you choose for the Account Number.

200 character maximum
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.

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
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 $'{ "status": "disabled", "inbound_ach": { "debit_status": "blocked" } }'
Parameters
account_number_id
string
Required

The identifier of the Account Number.

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.

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.

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.

Account Statements

Account Statements are generated monthly for every active Account. You can access the statement's data via the API or retrieve a PDF with its details via its associated File.

The Account Statement object
{ "id": "account_statement_lkc03a4skm2k7f38vj15", "account_id": "account_in71c4amph0vgo2qllky", "created_at": "2020-01-31T23:59:59Z", "file_id": "file_makxrc67oh9l6sg7w9yc", "statement_period_start": "2020-01-31T23:59:59Z", "statement_period_end": "2020-01-31T23:59:59Z", "starting_balance": 0, "ending_balance": 100, "type": "account_statement" }
Attributes
id
string

The Account Statement identifier.

account_id
string

The identifier for the Account this Account Statement belongs to.

created_at
string

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

file_id
string

The identifier of the File containing a PDF of the statement.

statement_period_start
string

The ISO 8601 time representing the start of the period the Account Statement covers.

statement_period_end
string

The ISO 8601 time representing the end of the period the Account Statement covers.

starting_balance
integer

The Account's balance at the start of its statement period.

ending_balance
integer

The Account's balance at the start of its statement period.

type
string

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

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

Return the page of entries after this one.

limit
integer

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

account_id
string

Filter Account Statements to those belonging to the specified Account.

statement_period_start.after
string

Return results after this ISO 8601 timestamp.

statement_period_start.before
string

Return results before this ISO 8601 timestamp.

statement_period_start.on_or_after
string

Return results on or after this ISO 8601 timestamp.

statement_period_start.on_or_before
string

Return results on or before this ISO 8601 timestamp.

Retrieve an Account Statement
curl \ --url "${INCREASE_URL}/account_statements/account_statement_lkc03a4skm2k7f38vj15" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
account_statement_id
string
Required

The identifier of the Account Statement to retrieve.

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, "currency": "USD", "created_at": "2020-01-31T23:59:59Z", "description": "INVOICE 2468", "id": "transaction_uyrp7fld2ium70oa7oi", "route_id": "account_number_v18nkfqm6afpsrvy82b2", "route_type": "account_number", "source": { "category": "inbound_ach_transfer", "inbound_ach_transfer": { "amount": 100, "originator_company_name": "BIG BANK", "originator_company_descriptive_date": null, "originator_company_discretionary_data": null, "originator_company_entry_description": "RESERVE", "originator_company_id": "0987654321", "receiver_id_number": "12345678900", "receiver_name": "IAN CREASE", "trace_number": "021000038461022", "transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev", "addenda": null } }, "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.

currency
enum

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

created_at
string

The ISO 8601 date on which the Transaction occurred.

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, "currency": "USD", "completed_at": null, "created_at": "2020-01-31T23:59:59Z", "description": "INVOICE 2468", "id": "pending_transaction_k1sfetcau2qbvjbzgju4", "route_id": "card_oubs0hwk5rn6knuecxg2", "route_type": "card", "source": { "category": "ach_transfer_instruction", "ach_transfer_instruction": { "amount": 100, "transfer_id": "ach_transfer_uoxatyh3lt5evrsdvo7q" } }, "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.

currency
enum

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

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.

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, "currency": "USD", "created_at": "2020-01-31T23:59:59Z", "description": "INVOICE 2468", "id": "declined_transaction_17jbn0yyhvkt4v4ooym8", "route_id": "account_number_v18nkfqm6afpsrvy82b2", "route_type": "account_number", "source": { "category": "ach_decline", "ach_decline": { "id": "ach_decline_72v1mcwxudctq56efipa", "amount": 1750, "originator_company_name": "BIG BANK", "originator_company_descriptive_date": null, "originator_company_discretionary_data": null, "originator_company_id": "0987654321", "reason": "insufficient_funds", "receiver_id_number": "12345678900", "receiver_name": "IAN CREASE", "trace_number": "021000038461022", "type": "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.

currency
enum

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

created_at
string

The ISO 8601 date on which the Transaction occurred.

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
{ "id": "account_transfer_7k9qe1ysdgqztnt63l7n", "amount": 100, "account_id": "account_in71c4amph0vgo2qllky", "currency": "USD", "destination_account_id": "account_uf16sut2ct5bevmq3eh", "destination_transaction_id": "transaction_j3itv8dtk5o8pw3p1xj4", "created_at": "2020-01-31T23:59:59Z", "description": "Move money into savings", "network": "account", "status": "complete", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "pending_transaction_id": null, "approval": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null }, "cancellation": null, "idempotency_key": null, "type": "account_transfer" }
Attributes
id
string

The account transfer's identifier.

amount
integer

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

account_id
string

The Account to which the transfer belongs.

currency
enum

The ISO 4217 code for the destination account currency.

destination_account_id
string

The destination account's identifier.

destination_transaction_id
string
Nullable

The ID for the transaction receiving the transfer.

created_at
string

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

description
string

The description that will show on the transactions.

network
string

The transfer's network.

status
enum

The lifecycle status of the transfer.

transaction_id
string
Nullable

The ID for the transaction funding the transfer.

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.

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.

idempotency_key
string
Nullable

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

type
string

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

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.

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.

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", "addenda": null, "amount": 100, "currency": "USD", "approval": { "approved_at": "2020-01-31T23:59:59Z", "approved_by": null }, "cancellation": null, "created_at": "2020-01-31T23:59:59Z", "destination_account_holder": "business", "external_account_id": "external_account_ukk55lr923a3ac0pp7iv", "id": "ach_transfer_uoxatyh3lt5evrsdvo7q", "network": "ach", "notifications_of_change": [], "return": null, "routing_number": "101050001", "statement_descriptor": "Statement descriptor", "status": "returned", "submission": { "trace_number": "058349238292834", "submitted_at": "2020-01-31T23:59:59Z", "expected_funds_settlement_at": "2020-02-03T13:30:00Z", "effective_date": "2020-01-31" }, "acknowledgement": { "acknowledged_at": "2020-01-31T23:59:59Z" }, "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "pending_transaction_id": null, "company_descriptive_date": null, "company_discretionary_data": null, "company_entry_description": null, "company_name": "National Phonograph Company", "funding": "checking", "individual_id": null, "individual_name": "Ian Crease", "effective_date": null, "standard_entry_class_code": "corporate_credit_or_debit", "idempotency_key": null, "type": "ach_transfer" }
Attributes
account_id
string

The Account to which the transfer belongs.

account_number
string

The destination account number.

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.

currency
enum

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

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.

destination_account_holder
enum

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

external_account_id
string
Nullable

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

id
string

The ACH transfer's identifier.

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.

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

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.

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.

transaction_id
string
Nullable

The ID for the transaction funding the transfer.

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.

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.

funding
enum

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

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.

effective_date
string
Nullable

The transfer effective date in ISO 8601 format.

standard_entry_class_code
enum

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

idempotency_key
string
Nullable

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

type
string

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

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

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.

Inbound ACH Transfers

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

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

The inbound ACH transfer's identifier.

amount
integer

The transfer amount in USD cents.

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.

direction
enum

The direction of the transfer.

status
enum

The status of the transfer.

originator_company_name
string

The name of the company that initiated the transfer.

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

trace_number
string

The trace number of the transfer.

automatically_resolves_at
string

The time at which the transfer will be automatically resolved.

addenda
dictionary
Nullable

Additional information sent from the originator.

acceptance
dictionary
Nullable

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

decline
dictionary
Nullable

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

transfer_return
dictionary
Nullable

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

notification_of_change
dictionary
Nullable

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

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.

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.

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
Wire Transfers

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

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

The wire transfer's identifier.

message_to_recipient
string
Nullable

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

amount
integer

The transfer amount in USD cents.

currency
enum

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

account_number
string

The destination account number.

beneficiary_name
string
Nullable

The beneficiary's name.

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.

originator_name
string
Nullable

The originator's name.

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.

account_id
string

The Account to which the transfer belongs.

external_account_id
string
Nullable

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

routing_number
string

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

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.

reversal
dictionary
Nullable

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

created_at
string

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

network
string

The transfer's network.

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.

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.

idempotency_key
string
Nullable

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

type
string

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

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", "routing_number": "101050001", "amount": 100, "message_to_recipient": "New account transfer", "beneficiary_name": "Ian Crease", "beneficiary_address_line1": "33 Liberty Street", "beneficiary_address_line2": "New York", "beneficiary_address_line3": "NY 10045" }'
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
routing_number
string

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

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

amount
integer
Required

The transfer amount in cents.

message_to_recipient
string
Required

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

140 character maximum
beneficiary_name
string
Required

The beneficiary's name.

35 character maximum
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
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
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
require_approval
boolean

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

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.

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
{ "id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0", "amount": 100, "account_id": "account_in71c4amph0vgo2qllky", "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "status": "accepted", "beneficiary_address_line1": null, "beneficiary_address_line2": null, "beneficiary_address_line3": null, "beneficiary_name": null, "beneficiary_reference": null, "description": "Inbound wire transfer", "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_line1": null, "originator_to_beneficiary_information_line2": null, "originator_to_beneficiary_information_line3": null, "originator_to_beneficiary_information_line4": null, "originator_to_beneficiary_information": null, "type": "inbound_wire_transfer" }
Attributes
id
string

The inbound wire transfer's identifier.

amount
integer

The amount in USD cents.

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.

status
enum

The status of the transfer.

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.

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

originator_to_beneficiary_information
string
Nullable

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

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
{ "type": "wire_drawdown_request", "id": "wire_drawdown_request_q6lmocus3glo0lr2bfv3", "account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "recipient_account_number": "987654321", "recipient_routing_number": "101050001", "amount": 10000, "currency": "USD", "message_to_recipient": "Invoice 29582", "recipient_name": "Ian Crease", "recipient_address_line1": "33 Liberty Street", "recipient_address_line2": "New York, NY, 10045", "recipient_address_line3": null, "originator_name": null, "originator_address_line1": null, "originator_address_line2": null, "originator_address_line3": null, "submission": { "input_message_accountability_data": "20220118MMQFMP0P000003" }, "fulfillment_transaction_id": "transaction_uyrp7fld2ium70oa7oi", "status": "fulfilled", "idempotency_key": null }
Attributes
type
string

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

id
string

The Wire drawdown request identifier.

account_number_id
string

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

recipient_account_number
string

The drawdown request's recipient's account number.

recipient_routing_number
string

The drawdown request's recipient's routing number.

amount
integer

The amount being requested in cents.

currency
string

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

message_to_recipient
string

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

recipient_name
string
Nullable

The drawdown request's recipient's name.

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.

originator_name
string
Nullable

The originator's name.

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.

submission
dictionary
Nullable

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

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.

status
enum

The lifecycle status of the drawdown request.

idempotency_key
string
Nullable

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

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_routing_number": "101050001", "recipient_name": "Ian Crease", "recipient_address_line1": "33 Liberty Street", "recipient_address_line2": "New York, NY, 10045" }'
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
recipient_account_number
string
Required

The drawdown request's recipient's account number.

34 character maximum
recipient_routing_number
string
Required

The drawdown request's recipient's routing number.

9 character maximum
recipient_name
string
Required

The drawdown request's recipient's name.

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

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
{ "type": "inbound_wire_drawdown_request", "id": "inbound_wire_drawdown_request_u5a92ikqhz1ytphn799e", "recipient_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "originator_account_number": "987654321", "originator_routing_number": "101050001", "beneficiary_account_number": "987654321", "beneficiary_routing_number": "101050001", "amount": 10000, "currency": "USD", "message_to_recipient": "Invoice 29582", "originator_to_beneficiary_information_line1": null, "originator_to_beneficiary_information_line2": null, "originator_to_beneficiary_information_line3": null, "originator_to_beneficiary_information_line4": null, "originator_name": "Ian Crease", "originator_address_line1": "33 Liberty Street", "originator_address_line2": "New York, NY, 10045", "originator_address_line3": null, "beneficiary_name": "Ian Crease", "beneficiary_address_line1": "33 Liberty Street", "beneficiary_address_line2": "New York, NY, 10045", "beneficiary_address_line3": null }
Attributes
type
string

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

id
string

The Wire drawdown request identifier.

recipient_account_number_id
string

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

originator_account_number
string

The drawdown request's originator's account number.

originator_routing_number
string

The drawdown request's originator's routing number.

beneficiary_account_number
string

The drawdown request's beneficiary's account number.

beneficiary_routing_number
string

The drawdown request's beneficiary's routing number.

amount
integer

The amount being requested in cents.

currency
string

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

message_to_recipient
string
Nullable

A message from the drawdown request's originator.

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.

originator_name
string
Nullable

The drawdown request's originator's name.

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.

beneficiary_name
string
Nullable

The drawdown request's beneficiary's name.

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.

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", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "account_number": "987654321", "routing_number": "101050001", "check_number": "123", "fulfillment_method": "physical_check", "physical_check": { "memo": "Invoice 29582", "note": null, "recipient_name": "Ian Crease", "mailing_address": { "name": "Ian Crease", "line1": "33 Liberty Street", "line2": null, "city": "New York", "state": "NY", "postal_code": "10045" }, "return_address": { "name": "Ian Crease", "line1": "33 Liberty Street", "line2": null, "city": "New York", "state": "NY", "postal_code": "10045" } }, "amount": 1000, "created_at": "2020-01-31T23:59:59Z", "currency": "USD", "approval": null, "cancellation": null, "id": "check_transfer_30b43acfu9vw8fyc4f5", "mailing": { "mailed_at": "2020-01-31T23:59:59Z", "image_id": null }, "pending_transaction_id": "pending_transaction_k1sfetcau2qbvjbzgju4", "status": "mailed", "submission": { "submitted_at": "2020-01-31T23:59:59Z" }, "stop_payment_request": null, "deposit": { "deposited_at": "2020-01-31T23:59:59Z", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "front_image_file_id": "file_makxrc67oh9l6sg7w9yc", "back_image_file_id": "file_makxrc67oh9l6sg7w9yc", "bank_of_first_deposit_routing_number": null, "transfer_id": "check_transfer_30b43acfu9vw8fyc4f5", "type": "check_transfer_deposit" }, "idempotency_key": null, "type": "check_transfer" }
Attributes
account_id
string

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

source_account_number_id
string
Nullable

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

account_number
string

The account number printed on the check.

routing_number
string

The routing number printed on the check.

check_number
string

The check number printed on the check.

fulfillment_method
enum

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

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.

amount
integer

The transfer amount in USD cents.

created_at
string

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

currency
enum

The ISO 4217 code for the check's currency.

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.

id
string

The Check transfer's identifier.

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.

status
enum

The lifecycle status of the transfer.

submission
dictionary
Nullable

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

stop_payment_request
dictionary
Nullable

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

deposit
dictionary
Nullable

After a check transfer is deposited, this will contain supplemental details.

idempotency_key
string
Nullable

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

type
string

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

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", "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "fulfillment_method": "physical_check", "physical_check": { "recipient_name": "Ian Crease", "memo": "Check payment", "mailing_address": { "name": "Ian Crease", "line1": "33 Liberty Street", "city": "New York", "state": "NY", "postal_code": "10045" }, "return_address": { "name": "Ian Crease", "line1": "33 Liberty Street", "city": "New York", "state": "NY", "postal_code": "10045" } }, "amount": 1000 }'
Parameters
account_id
string
Required

The identifier for the account that will send the transfer.

source_account_number_id
string
Required

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

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.

amount
integer
Required

The transfer amount in cents.

require_approval
boolean

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

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.

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.

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
{ "type": "real_time_payments_transfer", "id": "real_time_payments_transfer_iyuhl5kdn7ssmup83mvq", "approval": null, "cancellation": null, "status": "complete", "created_at": "2020-01-31T23:59:59Z", "account_id": "account_in71c4amph0vgo2qllky", "external_account_id": null, "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "ultimate_creditor_name": null, "ultimate_debtor_name": null, "debtor_name": null, "creditor_name": "Ian Crease", "remittance_information": "Invoice 29582", "amount": 100, "currency": "USD", "destination_account_number": "987654321", "destination_routing_number": "101050001", "transaction_id": "transaction_uyrp7fld2ium70oa7oi", "pending_transaction_id": null, "submission": { "submitted_at": "2020-01-31T23:59:59Z", "transaction_identification": "20220501234567891T1BSLZO01745013025" }, "rejection": null, "idempotency_key": null }
Attributes
type
string

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

id
string

The Real-Time Payments Transfer's identifier.

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.

status
enum

The lifecycle status of the transfer.

created_at
string

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

account_id
string

The Account from which the transfer was sent.

external_account_id
string
Nullable

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

source_account_number_id
string

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

ultimate_creditor_name
string
Nullable

The name of the party on whose behalf the creditor is receiving the payment.

ultimate_debtor_name
string
Nullable

The name of the the party on whose behalf the debtor is instructing the payment.

debtor_name
string
Nullable

The name of the transfer's sender. If not provided, the account's entity name will be used.

creditor_name
string

The name of the transfer's recipient as provided by the sender.

remittance_information
string

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

amount
integer

The transfer amount in USD cents.

currency
enum

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

destination_account_number
string

The destination account number.

destination_routing_number
string

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

transaction_id
string
Nullable

The Transaction funding the transfer once it is complete.

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.

submission
dictionary
Nullable

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

rejection
dictionary
Nullable

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

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.

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 $'{ "source_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "destination_account_number": "987654321", "destination_routing_number": "101050001", "amount": 100, "creditor_name": "Ian Crease", "remittance_information": "Invoice 29582" }'
Parameters
source_account_number_id
string
Required

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

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.

amount
integer
Required

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

ultimate_debtor_name
string

The name of the the party on whose behalf the debtor is instructing the payment.

140 character maximum
ultimate_creditor_name
string

The name of the party on whose behalf the creditor is receiving the payment.

140 character maximum
debtor_name
string

The name of the transfer's sender. If not provided, the account's entity name will be used.

140 character maximum
creditor_name
string
Required

The name of the transfer's recipient.

140 character maximum
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.

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.

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.

Real-Time Payments Request for Payments

Real-Time Payments transfers move funds, within seconds, between your Increase account and any other account on the Real-Time Payments network. A request for payment is a request to the receiver to send funds to your account. The permitted uses of Requests For Payment are limited by the Real-Time Payments network to business-to-business payments and transfers between two accounts at different banks owned by the same individual. Please contact support@increase.com to enable this API for your team.

The Real-Time Payments Request for Payment object
{ "type": "real_time_payments_request_for_payment", "id": "real_time_payments_request_for_payment_28kcliz1oevcnqyn9qp7", "status": "pending_response", "created_at": "2020-01-31T23:59:59Z", "destination_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "debtor_name": "Ian Crease", "remittance_information": "Invoice 29582", "expires_at": "2025-12-31", "amount": 100, "currency": "USD", "source_account_number": "987654321", "source_routing_number": "101050001", "fulfillment_transaction_id": null, "submission": null, "rejection": null, "refusal": null, "idempotency_key": null }
Attributes
type
string

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

id
string

The Real-Time Payments Request for Payment's identifier.

status
enum

The lifecycle status of the request for payment.

created_at
string

The ISO 8601 date and time at which the request for payment was created.

destination_account_number_id
string

The Account Number in which a successful transfer will arrive.

debtor_name
string

The name of the recipient the sender is requesting a transfer from.

remittance_information
string

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

expires_at
string

The expiration time for this request, in UTC. The requestee will not be able to pay after this date.

amount
integer

The transfer amount in USD cents.

currency
enum

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

source_account_number
string

The account number the request is sent to.

source_routing_number
string

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

fulfillment_transaction_id
string
Nullable

The transaction that fulfilled this request.

submission
dictionary
Nullable

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

rejection
dictionary
Nullable

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

refusal
dictionary
Nullable

If the request for payment is refused by the destination financial institution or the receiving customer, this will contain supplemental details.

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.

Create a Real-Time Payments Request for Payment
curl -X "POST" \ --url "${INCREASE_URL}/real_time_payments_request_for_payments" \ -H "Authorization: Bearer ${INCREASE_API_KEY}" \ -H "Content-Type: application/json" \ -d $'{ "destination_account_number_id": "account_number_v18nkfqm6afpsrvy82b2", "source_account_number": "987654321", "source_routing_number": "101050001", "amount": 100, "debtor": { "name": "Ian Crease", "address": { "street_name": "Liberty Street", "country": "US" } }, "remittance_information": "Invoice 29582", "expires_at": "2025-12-31" }'
Parameters
destination_account_number_id
string
Required

The identifier of the Account Number where the funds will land.

source_account_number
string
Required

The account number the funds will be requested from.

34 character maximum
source_routing_number
string
Required

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

9 character maximum
amount
integer
Required

The requested amount in USD cents. Must be positive.

debtor
dictionary
Required

Details of the person being requested to pay.

remittance_information
string
Required

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

140 character maximum
expires_at
string
Required

The expiration time for this request, in UTC. The requestee will not be able to pay after this date.

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

Return the page of entries after this one.

limit
integer

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

account_id
string

Filter Real-Time Payments Request for Payments to those destined to the specified Account.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

idempotency_key
string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

200 character maximum
Retrieve a Real-Time Payments Request for Payment
curl \ --url "${INCREASE_URL}/real_time_payments_request_for_payments/real_time_payments_transfer_iyuhl5kdn7ssmup83mvq" \ -H "Authorization: Bearer ${INCREASE_API_KEY}"
Parameters
request_for_payment_id
string
Required

The identifier of the Real-Time Payments Request for Payment.

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

The card identifier.

account_id
string

The identifier for the account this card belongs to.

entity_id
string
Nullable

The identifier for the entity associated with this card.

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.

last4
string

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

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

status
enum

This indicates if payments can be made with the card.

billing_address
dictionary

The Card's billing address.

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.

idempotency_key
string
Nullable

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

type
string

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

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.

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.

description
string

The description you choose to give the card.

200 character maximum
billing_address
dictionary

The card's billing address.

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.

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
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", "primary_account_number": "4242424242424242", "expiration_month": 7, "expiration_year": 2025, "verification_code": "123", "type": "card_details" }
Parameters
card_id
string
Required

The identifier of the Card to retrieve details for.

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.

description
string

The description you choose to give the card.

200 character maximum
status
enum

The status to update the Card with.

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.

billing_address
dictionary

The card's updated billing address.

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.

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.

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
{ "id": "card_payment_nd3k2kacrqjli8482ave", "created_at": "2020-01-31T23:59:59Z", "account_id": "account_in71c4amph0vgo2qllky", "card_id": "card_oubs0hwk5rn6knuecxg2", "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_details": { "category": "visa", "visa": { "electronic_commerce_indicator": "secure_electronic_commerce", "point_of_service_entry_mode": "manual" } }, "amount": 100, "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_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" } ], "state": { "authorized_amount": 100, "incremented_amount": 20, "reversed_amount": 20, "fuel_confirmed_amount": 0, "settled_amount": 100 }, "type": "card_payment" }
Attributes
id
string

The Card Payment identifier.

created_at
string

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

account_id
string

The identifier for the Account the Transaction belongs to.

card_id
string

The Card identifier for this payment.

elements
array

The interactions related to this card payment.

state
dictionary

The summarized state of this card payment.

type
string

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

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

Return the page of entries after this one.

limit
integer

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

account_id
string

Filter Card Payments to ones belonging to the specified Account.

card_id
string

Filter Card Payments to ones belonging to the specified Card.

created_at.after
string

Return results after this ISO 8601 timestamp.

created_at.before
string

Return results before this ISO 8601 timestamp.

created_at.on_or_after
string

Return results on or after this ISO 8601 timestamp.

created_at.on_or_before
string

Return results on or before this ISO 8601 timestamp.

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

The identifier of the Card Payment.

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
{ "id": "card_dispute_h9sc95nbl1cgltpp7men", "explanation": "Unauthorized recurring purchase", "status": "pending_reviewing", "created_at": "2020-01-31T23:59:59Z", "disputed_transaction_id": "transaction_uyrp7fld2ium70oa7oi", "acceptance": null, "rejection": null, "type": "card_dispute", "idempotency_key": null }
Attributes
id
string

The Card Dispute identifier.

explanation
string

Why you disputed the Transaction in question.

status
enum

The results of the Dispute investigation.

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.

acceptance
dictionary
Nullable

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

rejection
dictionary
Nullable

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

type
string

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

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.

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.

200 character maximum
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
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
{ "id": "physical_card_ode8duyq5v2ynhjoharl", "card_id": "card_oubs0hwk5rn6knuecxg2", "card_profile_id": "card_profile_cox5y73lob2eqly18piy", "physical_card_profile_id": "physical_card_profile_m534d5rn9qyy9ufqxoec", "created_at": "2020-01-31T23:59:59Z", "status": "active", "cardholder": { "first_name": "Ian", "last_name": "Crease" }, "shipment": { "method": "usps", "status": "pending", "tracking": null, "address": { "name": "Ian Crease", "line1": "33 Liberty Street", "line2": "Unit 2", "line3": null, "city": "New York", "state": "NY", "postal_code": "10045" } }, "idempotency_key": null, "type": "physical_card" }
Attributes
id
string

The physical card identifier.

card_id
string

The identifier for the Card this Physical Card represents.

card_profile_id
string
Nullable

The Card Profile used for this Physical Card.

physical_card_profile_id
string
Nullable

The Physical Card Profile used for this Physical Card.

created_at
string

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

status
enum

The status of the Physical Card.

cardholder
dictionary
Nullable

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

shipment
dictionary

The details used to ship this physical card.

idempotency_key
string
Nullable

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

type
string

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

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": { "method": "usps", "address": { "name": "Ian Crease", "line1": "33 Liberty Street", "line2": "Unit 2", "city": "New York", "postal_code": "10045", "state": "NY" } } }'
Parameters
card_id
string
Required

The underlying card representing this 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.

cardholder
dictionary
Required

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

shipment
dictionary
Required

The details used to ship this 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
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.

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.

Digital Card Profiles

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

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

The Card Profile identifier.

created_at
string

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

status
enum

The status of the Card Profile.

description
string

A description you can use to identify the Card Profile.

is_default
boolean

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

text_color
dictionary

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

issuer_name
string

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

card_description
string

A user-facing description for the card itself.

contact_website
string
Nullable

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

contact_email
string
Nullable

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

contact_phone
string
Nullable

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

background_image_file_id
string

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

app_icon_file_id
string

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

type
string

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

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.

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

A description you can use to identify the Card Profile.

200 character maximum
text_color
dictionary

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

issuer_name
string
Required

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

32 character maximum
card_description
string
Required

A user-facing description for the card itself.

32 character maximum
contact_website
string

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

contact_email
string

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

32 character maximum
contact_phone
string

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

32 character maximum
background_image_file_id
string
Required

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

app_icon_file_id
string
Required

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

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

Return the page of entries after this one.

limit
integer

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

status.in
array of strings

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

idempotency_key
string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

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

The identifier of the Digital Card Profile.

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

The identifier of the Digital Card Profile to archive.

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

The identifier of the Digital Card Profile to clone.

description
string

A description you can use to identify the Card Profile.

200 character maximum
text_color
dictionary

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

issuer_name
string

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

32 character maximum
card_description
string

A user-facing description for the card itself.

32 character maximum
contact_website
string

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

contact_email
string

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

32 character maximum
contact_phone
string

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

32 character maximum
background_image_file_id
string

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

app_icon_file_id
string

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

Physical Card Profiles

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

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

The Card Profile identifier.

created_at
string

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

status
enum

The status of the Physical Card Profile.

description
string

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

is_default
boolean

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

creator
enum

The creator of this Physical Card Profile.

contact_phone
string
Nullable

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

front_image_file_id
string
Nullable

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

back_image_file_id
string
Nullable

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

carrier_image_file_id
string
Nullable

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

type
string

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

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.

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

A description you can use to identify the Card Profile.

200 character maximum
contact_phone
string
Required

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

32 character maximum
front_image_file_id
string
Required

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

carrier_image_file_id
string
Required

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

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

Return the page of entries after this one.

limit
integer

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

status.in
array of strings

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

idempotency_key
string

Filter records to the one with the specified idempotency_key you chose for that object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.

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

The identifier of the Card Profile.

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

The identifier of the Physical Card Profile to archive.

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

The identifier of the Physical Card Profile to clone.

description
string

A description you can use to identify the Card Profile.

200 character maximum
contact_phone
string

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

32 character maximum
front_image_file_id
string

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

carrier_image_file_id
string

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

front_text
dictionary

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

Digital Wallet Tokens

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

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

The Digital Wallet Token identifier.

card_id
string

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

created_at
string

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