Account Numbers — Increase
Docs
Guides API Reference Changelog Search
Account Numbers
Guides\ \ Explanatory and how-to content API Reference\ \ Technical documentation Changelog\ \ Release notes Dashboard\ \ Manage your account Status\ \ Service status
API Reference
Overview
Overview Authorization and Testing OpenAPI SDKs OAuth Requests and Responses Object Lists Errors Idempotency Sandbox Simulations
Accounts
Overview The Account object List Accounts Create an Account Retrieve an Account Update an Account Retrieve an Account Balance Close an Account Sandbox: Create an account revenue payment Sandbox: Create an interest payment
Overview The Account Number object List Account Numbers Create an Account Number Retrieve an Account Number Update an Account Number
Overview The Account Transfer object List Account Transfers Create an Account Transfer Retrieve an Account Transfer Approve an Account Transfer Cancel an Account Transfer
Transactions
Overview The Transaction object List Transactions Retrieve a Transaction
Overview The Pending Transaction object List Pending Transactions Create a Pending Transaction Retrieve a Pending Transaction Release a user-initiated Pending Transaction Sandbox: Release an Inbound Funds Hold
Overview The Declined Transaction object List Declined Transactions Retrieve a Declined Transaction
Ach Transfers
Overview The ACH Transfer object List ACH Transfers Create an ACH Transfer Retrieve an ACH Transfer Approve an ACH Transfer Cancel a pending ACH Transfer Sandbox: Acknowledge an ACH Transfer Sandbox: Create a Notification of Change for an ACH Transfer Sandbox: Return an ACH Transfer Sandbox: Settle an ACH Transfer Sandbox: Submit an ACH Transfer
Overview The Inbound ACH Transfer object List Inbound ACH Transfers Retrieve an Inbound ACH Transfer Create a notification of change for an Inbound ACH Transfer Decline an Inbound ACH Transfer Return an Inbound ACH Transfer Sandbox: Create an Inbound ACH Transfer
Overview The ACH Prenotification object List ACH Prenotifications Create an ACH Prenotification Retrieve an ACH Prenotification
Check Transfers
Overview The Check Transfer object List Check Transfers Create a Check Transfer Retrieve a Check Transfer Approve a Check Transfer Cancel a pending Check Transfer Stop payment on a Check Transfer Sandbox: Mail a Check Transfer
Overview The Inbound Check Deposit object List Inbound Check Deposits Retrieve an Inbound Check Deposit Decline an Inbound Check Deposit Return an Inbound Check Deposit Sandbox: Create an Inbound Check Deposit Sandbox: Accept an Inbound Check Deposit Sandbox: Create an Inbound Check Deposit Adjustment
Overview The Physical Check Batch object Create a Physical Check Batch Cancel a Physical Check Batch Complete a Physical Check Batch
Real Time Payments Transfers
Overview The Real-Time Payments Transfer object List Real-Time Payments Transfers Create a Real-Time Payments Transfer Retrieve a Real-Time Payments Transfer Approve a Real-Time Payments Transfer Cancel a pending Real-Time Payments Transfer Sandbox: Complete a Real-Time Payments Transfer
Inbound Real-Time Payments Transfers
Overview The Inbound Real-Time Payments Transfer object List Inbound Real-Time Payments Transfers Retrieve an Inbound Real-Time Payments Transfer Sandbox: Create an Inbound Real-Time Payments Transfer
Real-Time Payments Requests for Payment
Overview The Real-Time Payments Request for Payment object List Real-Time Payments Requests for Payment Create a Real-Time Payments Request for Payment Retrieve a Real-Time Payments Request for Payment
Inbound Real-Time Payments Requests for Payment
Overview The Inbound Real-Time Payments Request for Payment object List Inbound Real-Time Payments Requests for Payment Retrieve an Inbound Real-Time Payments Request for Payment
Fednow Transfers
Overview The FedNow Transfer object List FedNow Transfers Create a FedNow Transfer Retrieve a FedNow Transfer Approve a FedNow Transfer Cancel a pending FedNow Transfer Sandbox: Complete a FedNow Transfer
Overview The Inbound FedNow Transfer object List Inbound FedNow Transfers Retrieve an Inbound FedNow Transfer Sandbox: Create an Inbound FedNow Transfer
Swift Transfers
Overview The Swift Transfer object List Swift Transfers Create a Swift Transfer Retrieve a Swift Transfer Approve a Swift Transfer Cancel a pending Swift Transfer
Wire Transfers
Overview The Wire Transfer object List Wire Transfers Create a Wire Transfer Retrieve a Wire Transfer Approve a Wire Transfer Cancel a pending Wire Transfer Sandbox: Reverse a Wire Transfer Sandbox: Submit a Wire Transfer
Overview The Inbound Wire Transfer object List Inbound Wire Transfers Retrieve an Inbound Wire Transfer Reverse an Inbound Wire Transfer Sandbox: Create an Inbound Wire Transfer
Overview The Wire Drawdown Request object List Wire Drawdown Requests Create a Wire Drawdown Request Retrieve a Wire Drawdown Request Sandbox: Refuse a Wire Drawdown Request Sandbox: Submit a Wire Drawdown Request
Inbound Wire Drawdown Requests
Overview The Inbound Wire Drawdown Request object List Inbound Wire Drawdown Requests Retrieve an Inbound Wire Drawdown Request Sandbox: Create an Inbound Wire Drawdown request
Card Transfers
Overview The Card Token object List Card Tokens Retrieve a Card Token Retrieve the capabilities of a Card Token Sandbox: Create a Card Token
Overview The Card Push Transfer object List Card Push Transfers Create a Card Push Transfer Retrieve a Card Push Transfer Approve a Card Push Transfer Cancel a pending Card Push Transfer
Overview The Card Validation object List Card Validations Create a Card Validation Retrieve a Card Validation
Check Deposits
Overview The Check Deposit object List Check Deposits Create a Check Deposit Retrieve a Check Deposit Sandbox: Adjust a Check Deposit Sandbox: Reject a Check Deposit Sandbox: Return a Check Deposit Sandbox: Submit a Check Deposit
Overview The Lockbox Address object List Lockbox Addresses Create a Lockbox Address Retrieve a Lockbox Address Update a Lockbox Address
Overview The Lockbox Recipient object List Lockbox Recipients Create a Lockbox Recipient Retrieve a Lockbox Recipient Update a Lockbox Recipient
Overview The Inbound Mail Item object List Inbound Mail Items Retrieve an Inbound Mail Item Action an Inbound Mail Item Sandbox: Create an Inbound Mail Item
Cards
Overview The Card object List Cards Create a Card Retrieve a Card Update a Card Create a Card details iframe Retrieve sensitive details for a Card Update a Card's PIN
Overview The Card Payment object List Card Payments Retrieve a Card Payment Sandbox: Create a Card Authentication attempt Sandbox: Create a Card Authentication Challenge attempt Sandbox: Create an initial Card Authentication Challenge Sandbox: Expire a Card Authorization Sandbox: Create a Card Authorization Sandbox: Create a Card Balance Inquiry Sandbox: Confirm the fuel pump amount for a Card Authorization Sandbox: Increment a Card Authorization Sandbox: Refund a card transaction Sandbox: Reverse a Card Authorization Sandbox: Settle a Card Authorization
Overview The Card Purchase Supplement object List Card Purchase Supplements Retrieve a Card Purchase Supplement Sandbox: Create a Card Purchase Supplement
Overview The Card Dispute object List Card Disputes Create a Card Dispute Retrieve a Card Dispute Submit a User Submission for a Card Dispute Withdraw a Card Dispute Sandbox: Advance the state of a Card Dispute
Overview The Physical Card object List Physical Cards Create a Physical Card Retrieve a Physical Card Update a Physical Card Sandbox: Advance the shipment status of a Physical Card Sandbox: Create a Physical Card Shipment Tracking Update
Overview The Digital Card Profile object List Card Profiles Create a Digital Card Profile Retrieve a Digital Card Profile Archive a Digital Card Profile Clones a Digital Card Profile
Overview The Physical Card Profile object List Physical Card Profiles Create a Physical Card Profile Retrieve a Card Profile Archive a Physical Card Profile Clone a Physical Card Profile
Overview The Digital Wallet Token object List Digital Wallet Tokens Retrieve a Digital Wallet Token Sandbox: Create a digital wallet token request
Compliance
Overview The Entity object List Entities Create an Entity Retrieve an Entity Update an Entity Archive an Entity Sandbox: Simulate validation of an Entity
Overview The Beneficial Owner object List Beneficial Owners Create a Beneficial Owner Retrieve a Beneficial Owner Update a Beneficial Owner Archive a Beneficial Owner
Overview The Supplemental Document object List Entity Supplemental Document Submissions Create a supplemental document for an Entity
Overview The Entity Onboarding Session object List Entity Onboarding Session Create an Entity Onboarding Session Retrieve an Entity Onboarding Session Expire an Entity Onboarding Session Sandbox: Submit an Entity Onboarding Session
Overview The Program object List Programs Retrieve a Program Sandbox: Create a Program
Events and Webhooks
Overview The Event object List Events Retrieve an Event
Overview The Event Subscription object List Event Subscriptions Create an Event Subscription Retrieve an Event Subscription Update an Event Subscription
Overview The Real-Time Decision object Retrieve a Real-Time Decision Action a Real-Time Decision
External Accounts
Overview The Routing Number object List Routing Numbers
Overview The External Account object List External Accounts Create an External Account Retrieve an External Account Update an External Account
Files and Exports
Overview The Account Statement object List Account Statements Retrieve an Account Statement Sandbox: Create an Account Statement
Overview The File object List Files Create a File Retrieve a File Get File Contents
Overview The File Link object Create a File Link
Overview The Export object List Exports Create an Export Retrieve an Export Sandbox: Generate a Tax Form Export
OAuth
Overview The Group object Retrieve Group details
Overview The OAuth Application object List OAuth Applications Retrieve an OAuth Application
Overview The OAuth Connection object List OAuth Connections Retrieve an OAuth Connection
Overview The OAuth Token object Create an OAuth Token
Intrafi
Overview The IntraFi Account Enrollment object List IntraFi Account Enrollments Enroll an account in the IntraFi deposit sweep network Get an IntraFi Account Enrollment Unenroll an account from IntraFi
Overview The IntraFi Balance object Get IntraFi balance
Overview The IntraFi Exclusion object List IntraFi Exclusions Create an IntraFi Exclusion Get an IntraFi Exclusion Archive an IntraFi Exclusion
Account Numbers
Copy for LLM
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
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
{
"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.
id
string
The Account Number identifier.
idempotency_key
string
Nullable
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
inbound_ach
dictionary
Properties related to how this Account Number handles inbound ACH transfers.
Child attributes
inbound_checks
dictionary
Properties related to how this Account Number should handle inbound check withdrawals.
Child attributes
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.
Possible values
type
string
A constant representing the object’s type. For this resource it will always be account_number.
List Account Numbers
cURL TypeScript Python Ruby Go Java Kotlin PHP C#
1
2
3
curl \
--url "${INCREASE_URL}/account_numbers" \
-H "Authorization: Bearer ${INCREASE_API_KEY}"
1
2
3
4
5
6
7
8
9
10
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
// Automatically fetches more pages as needed.
for await (const accountNumber of client.accountNumbers.list()) {
console.log(accountNumber.id);
}
1
2
3
4
5
6
7
8
9
import os
from increase import Increase
client = Increase(
api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted
)
page = client.account_numbers.list()
page = page.data[0]
print(page.id)
1
2
3
4
5
6
7
8
9
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
page = increase.account_numbers.list
puts(page)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
package main
import (
"context"
"fmt"
"os"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
)
page, err := client.AccountNumbers.List(context.TODO(), increase.AccountNumberListParams{})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", page)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.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();
}
}
1
2
3
4
5
6
7
8
9
10
11
12
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.accountnumbers.AccountNumberListPage
import com.increase.api.models.accountnumbers.AccountNumberListParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val page: AccountNumberListPage = client.accountNumbers().list()
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
<?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();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
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 :
1
2
3
4
5
6
7
8
{
"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.
Possible values
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.
Possible values
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
More parameters
Expand all
cursor
string
limit
integer
created_at.after
string
created_at.before
string
created_at.on_or_after
string
created_at.on_or_before
string
Create an Account Number
cURL TypeScript Python Ruby Go Java Kotlin PHP C#
1
2
3
4
5
6
7
8
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"
}'
1
2
3
4
5
6
7
8
9
10
11
12
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const accountNumber = await client.accountNumbers.create({
account_id: 'account_in71c4amph0vgo2qllky',
name: 'Rent payments',
});
console.log(accountNumber.id);
1
2
3
4
5
6
7
8
9
10
11
import os
from increase import Increase
client = Increase(
api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted
)
account_number = client.account_numbers.create(
account_id="account_in71c4amph0vgo2qllky",
name="Rent payments",
)
print(account_number.id)
1
2
3
4
5
6
7
8
9
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
account_number = increase.account_numbers.create(account_id: "account_in71c4amph0vgo2qllky", name: "Rent payments")
puts(account_number)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
package main
import (
"context"
"fmt"
"os"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
)
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)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.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);
}
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.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)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
<?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();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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.
Child attributes
inbound_checks
dictionary
Options related to how this Account Number should handle inbound check withdrawals.
Child attributes
name
string
Required
The name you choose for the Account Number.
Between 1 and 200 characters
Retrieve an Account Number
cURL TypeScript Python Ruby Go Java Kotlin PHP C#
1
2
3
curl \
--url "${INCREASE_URL}/account_numbers/account_number_v18nkfqm6afpsrvy82b2" \
-H "Authorization: Bearer ${INCREASE_API_KEY}"
1
2
3
4
5
6
7
8
9
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const accountNumber = await client.accountNumbers.retrieve('account_number_v18nkfqm6afpsrvy82b2');
console.log(accountNumber.id);
1
2
3
4
5
6
7
8
9
10
import os
from increase import Increase
client = Increase(
api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted
)
account_number = client.account_numbers.retrieve(
"account_number_v18nkfqm6afpsrvy82b2",
)
print(account_number.id)
1
2
3
4
5
6
7
8
9
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
account_number = increase.account_numbers.retrieve("account_number_v18nkfqm6afpsrvy82b2")
puts(account_number)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
package main
import (
"context"
"fmt"
"os"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
)
accountNumber, err := client.AccountNumbers.Get(context.TODO(), "account_number_v18nkfqm6afpsrvy82b2")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", accountNumber.ID)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.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");
}
}
1
2
3
4
5
6
7
8
9
10
11
12
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.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")
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
<?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();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
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 TypeScript Python Ruby Go Java Kotlin PHP C#
1
2
3
4
5
6
7
8
9
10
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"
}'
1
2
3
4
5
6
7
8
9
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const accountNumber = await client.accountNumbers.update('account_number_v18nkfqm6afpsrvy82b2');
console.log(accountNumber.id);
1
2
3
4
5
6
7
8
9
10
import os
from increase import Increase
client = Increase(
api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted
)
account_number = client.account_numbers.update(
account_number_id="account_number_v18nkfqm6afpsrvy82b2",
)
print(account_number.id)
1
2
3
4
5
6
7
8
9
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
account_number = increase.account_numbers.update("account_number_v18nkfqm6afpsrvy82b2")
puts(account_number)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
package main
import (
"context"
"fmt"
"os"
"github.com/Increase/increase-go"
"github.com/Increase/increase-go/option"
)
func main() {
client := increase.NewClient(
option.WithAPIKey(os.Getenv("INCREASE_API_KEY")), // This is the default and can be omitted
)
accountNumber, err := client.AccountNumbers.Update(
context.TODO(),
"account_number_v18nkfqm6afpsrvy82b2",
increase.AccountNumberUpdateParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", accountNumber.ID)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.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");
}
}
1
2
3
4
5
6
7
8
9
10
11
12
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.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")
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
<?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();
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
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.
Child attributes
inbound_checks
dictionary
Options related to how this Account Number should handle inbound check withdrawals.
Child attributes
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.
Possible values