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.

Events

Your application can listen to webhooks about this resource. The events about Account Numbers will have the categories "account_number.created" or "account_number.updated" .

The Account Number object

{
  "account_id": "account_in71c4amph0vgo2qllky",
  "account_number": "987654321",
  "created_at": "2020-01-31T23:59:59Z",
  "id": "account_number_v18nkfqm6afpsrvy82b2",
  "idempotency_key": null,
  "inbound_ach": {
    "debit_status": "blocked"
  },
  "inbound_checks": {
    "status": "check_transfers_only"
  },
  "name": "ACH",
  "routing_number": "101050001",
  "status": "active",
  "type": "account_number"
}

Attributes

account_id

string

The identifier for the account this Account Number belongs to.

More about Accounts.

account_number

string

The account number.

created_at

string

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

string

The Account Number identifier.

idempotency_key

string

Nullable

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

inbound_ach

dictionary

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

inbound_checks

dictionary

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

name

string

The name you choose for the Account Number.

routing_number

string

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

status

enum

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

type

string

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

List Account Numbers

curl \
  --url "${INCREASE_URL}/account_numbers" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

import Increase from 'increase';

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

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

import os
from increase import Increase

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

require "increase"

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

page = increase.account_numbers.list

puts(page)

package main

import (
	"context"
	"fmt"
	"os"

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

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

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.accountnumbers.AccountNumberListPage;
import com.increase.api.models.accountnumbers.AccountNumberListParams;

public final class Main {
    private Main() {}

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

        AccountNumberListPage page = client.accountNumbers().list();
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.accountnumbers.AccountNumberListPage
import com.increase.api.models.accountnumbers.AccountNumberListParams

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

    val page: AccountNumberListPage = client.accountNumbers().list()
}

<?php

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

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

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

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

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

using System;
using Increase.Api;
using Increase.Api.Models.AccountNumbers;

IncreaseClient client = new();

AccountNumberListParams parameters = new();

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

Returns a list response :

{
  "data": [
    { /* Account Number object */ },
    { /* Account Number object */ }
    /* ... */
  ],
  "next_cursor": "v57w5d",
}

Parameters

status.in

array of strings

The status to retrieve Account Numbers for. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

ach_debit_status.in

array of strings

The ACH Debit status to retrieve Account Numbers for. For GET requests, this should be encoded as a comma-delimited string, such as ?in=one,two,three.

account_id

string

Filter Account Numbers to those belonging to the specified Account.

More about Accounts.

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.

Between 1 and 200 characters

cursor

string

limit

integer

created_at.after

string

created_at.before

string

created_at.on_or_after

string

created_at.on_or_before

string

Create an Account 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"
  }'

import Increase from 'increase';

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

const accountNumber = await client.accountNumbers.create({
  account_id: 'account_in71c4amph0vgo2qllky',
  name: 'Rent payments',
});

console.log(accountNumber.id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
account_number = client.account_numbers.create(
    account_id="account_in71c4amph0vgo2qllky",
    name="Rent payments",
)
print(account_number.id)

require "increase"

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

account_number = increase.account_numbers.create(account_id: "account_in71c4amph0vgo2qllky", name: "Rent payments")

puts(account_number)

package main

import (
	"context"
	"fmt"
	"os"

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

func main() {
	client := increase.NewClient(
		option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
	)
	accountNumber, err := client.AccountNumbers.New(context.TODO(), increase.AccountNumberNewParams{
		AccountID: increase.F("account_in71c4amph0vgo2qllky"),
		Name:      increase.F("Rent payments"),
	})
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", accountNumber.ID)
}

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.accountnumbers.AccountNumber;
import com.increase.api.models.accountnumbers.AccountNumberCreateParams;

public final class Main {
    private Main() {}

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

        AccountNumberCreateParams params = AccountNumberCreateParams.builder()
            .accountId("account_in71c4amph0vgo2qllky")
            .name("Rent payments")
            .build();
        AccountNumber accountNumber = client.accountNumbers().create(params);
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.accountnumbers.AccountNumber
import com.increase.api.models.accountnumbers.AccountNumberCreateParams

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

    val params: AccountNumberCreateParams = AccountNumberCreateParams.builder()
        .accountId("account_in71c4amph0vgo2qllky")
        .name("Rent payments")
        .build()
    val accountNumber: AccountNumber = client.accountNumbers().create(params)
}

<?php

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

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

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

try {
  $accountNumber = $client->accountNumbers->create(
    accountID: 'account_in71c4amph0vgo2qllky',
    name: 'Rent payments',
    inboundACH: ['debitStatus' => 'allowed'],
    inboundChecks: ['status' => 'allowed'],
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.AccountNumbers;

IncreaseClient client = new();

AccountNumberCreateParams parameters = new()
{
    AccountID = "account_in71c4amph0vgo2qllky",
    Name = "Rent payments",
};

var accountNumber = await client.AccountNumbers.Create(parameters);

Console.WriteLine(accountNumber);

Parameters

account_id

string

Required

The Account the Account Number should belong to.

More about Accounts.

inbound_ach

dictionary

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

inbound_checks

dictionary

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

name

string

Required

The name you choose for the Account Number.

Between 1 and 200 characters

Retrieve an Account Number

curl \
  --url "${INCREASE_URL}/account_numbers/account_number_v18nkfqm6afpsrvy82b2" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

import Increase from 'increase';

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

const accountNumber = await client.accountNumbers.retrieve('account_number_v18nkfqm6afpsrvy82b2');

console.log(accountNumber.id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
account_number = client.account_numbers.retrieve(
    "account_number_v18nkfqm6afpsrvy82b2",
)
print(account_number.id)

require "increase"

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

account_number = increase.account_numbers.retrieve("account_number_v18nkfqm6afpsrvy82b2")

puts(account_number)

package main

import (
	"context"
	"fmt"
	"os"

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

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

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.accountnumbers.AccountNumber;
import com.increase.api.models.accountnumbers.AccountNumberRetrieveParams;

public final class Main {
    private Main() {}

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

        AccountNumber accountNumber = client.accountNumbers().retrieve("account_number_v18nkfqm6afpsrvy82b2");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.accountnumbers.AccountNumber
import com.increase.api.models.accountnumbers.AccountNumberRetrieveParams

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

    val accountNumber: AccountNumber = client.accountNumbers().retrieve("account_number_v18nkfqm6afpsrvy82b2")
}

<?php

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

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

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

try {
  $accountNumber = $client->accountNumbers->retrieve(
    'account_number_v18nkfqm6afpsrvy82b2'
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.AccountNumbers;

IncreaseClient client = new();

AccountNumberRetrieveParams parameters = new()
{
    AccountNumberID = "account_number_v18nkfqm6afpsrvy82b2"
};

var accountNumber = await client.AccountNumbers.Retrieve(parameters);

Console.WriteLine(accountNumber);

Parameters

account_number_id

string

Required

The identifier of the Account Number to retrieve.

More about Account Numbers.

Update an Account Number

curl -X "PATCH" \
  --url "${INCREASE_URL}/account_numbers/account_number_v18nkfqm6afpsrvy82b2" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d $'{
    "inbound_ach": {
      "debit_status": "blocked"
    },
    "status": "disabled"
  }'

import Increase from 'increase';

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

const accountNumber = await client.accountNumbers.update('account_number_v18nkfqm6afpsrvy82b2');

console.log(accountNumber.id);

import os
from increase import Increase

client = Increase(
    api_key=os.environ.get("INCREASE_API_KEY"),  # This is the default and can be omitted
)
account_number = client.account_numbers.update(
    account_number_id="account_number_v18nkfqm6afpsrvy82b2",
)
print(account_number.id)

require "increase"

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

account_number = increase.account_numbers.update("account_number_v18nkfqm6afpsrvy82b2")

puts(account_number)

package main

import (
	"context"
	"fmt"
	"os"

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

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

package com.increase.api.example;

import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.accountnumbers.AccountNumber;
import com.increase.api.models.accountnumbers.AccountNumberUpdateParams;

public final class Main {
    private Main() {}

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

        AccountNumber accountNumber = client.accountNumbers().update("account_number_v18nkfqm6afpsrvy82b2");
    }
}

package com.increase.api.example

import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.accountnumbers.AccountNumber
import com.increase.api.models.accountnumbers.AccountNumberUpdateParams

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

    val accountNumber: AccountNumber = client.accountNumbers().update("account_number_v18nkfqm6afpsrvy82b2")
}

<?php

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

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

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

try {
  $accountNumber = $client->accountNumbers->update(
    'account_number_v18nkfqm6afpsrvy82b2',
    inboundACH: ['debitStatus' => 'blocked'],
    inboundChecks: ['status' => 'allowed'],
    name: 'x',
    status: 'disabled',
  );

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

using System;
using Increase.Api;
using Increase.Api.Models.AccountNumbers;

IncreaseClient client = new();

AccountNumberUpdateParams parameters = new()
{
    AccountNumberID = "account_number_v18nkfqm6afpsrvy82b2"
};

var accountNumber = await client.AccountNumbers.Update(parameters);

Console.WriteLine(accountNumber);

Parameters

account_number_id

string

Required

The identifier of the Account Number.

More about Account Numbers.

inbound_ach

dictionary

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

inbound_checks

dictionary

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

name

string

The name you choose for the Account Number.

Between 1 and 200 characters

status

enum

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