Accounts
Accounts are your bank accounts with Increase. They store money, receive transfers, and send payments. They earn interest and have depository insurance.
Events
Your application can listen to
webhooks
about this resource.
The events about Accounts will
have the categories "account.created" or "account.updated"
.
The Account object
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
{
"account_revenue_rate": null,
"bank": "first_internet_bank",
"closed_at": null,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"entity_id": "entity_n8y8tnk2p9339ti393yi",
"funding": "deposits",
"id": "account_in71c4amph0vgo2qllky",
"idempotency_key": null,
"informational_entity_id": null,
"interest_rate": "0.055",
"loan": null,
"name": "My first account!",
"program_id": "program_i2v2os4mwza1oetokh9i",
"status": "open",
"type": "account"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
{
"account_revenue_rate": null,
"bank": "first_internet_bank",
"closed_at": null,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"entity_id": "entity_n8y8tnk2p9339ti393yi",
"funding": "loan",
"id": "account_in71c4amph0vgo2qllky",
"idempotency_key": null,
"informational_entity_id": null,
"interest_rate": "0.055",
"loan": {
"credit_limit": 1000000,
"grace_period_days": 21,
"maturity_date": "2020-01-31",
"statement_day_of_month": 1,
"statement_payment_type": "balance"
},
"name": "My first account!",
"program_id": "program_i2v2os4mwza1oetokh9i",
"status": "open",
"type": "account"
}
Attributes
account_revenue_rate
string
Nullable
The account revenue rate currently being earned on the account, as a string containing a decimal number. For example, a 1% account revenue rate would be represented as “0.01”. Account revenue is a type of non-interest income accrued on the account.
bank
enum
The bank the Account is with.
closed_at
string
Nullable
The ISO 8601 time at which the Account was closed.
created_at
string
The ISO 8601 time at which the Account was created.
entity_id
string
The identifier for the Entity the Account belongs to.
funding
enum
Whether the Account is funded by a loan or by deposits.
id
string
The Account identifier.
idempotency_key
string
Nullable
The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about idempotency.
informational_entity_id
string
Nullable
The identifier of an Entity that, while not owning the Account, is associated with its activity.
interest_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”.
loan
dictionary
Nullable
The Account’s loan-related information, if the Account is a loan account.
name
string
The name you choose for the Account.
program_id
string
The identifier of the Program determining the compliance and commercial terms of this Account.
status
enum
The status of the Account.
type
string
A constant representing the object’s type. For this resource it will always be account.
List Accounts
1
2
3
curl \
--url "${INCREASE_URL}/accounts?entity_id=entity_n8y8tnk2p9339ti393yi" \
-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 account of client.accounts.list()) {
console.log(account.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.accounts.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.accounts.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.Accounts.List(context.TODO(), increase.AccountListParams{})
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.accounts.AccountListPage;
import com.increase.api.models.accounts.AccountListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
AccountListPage page = client.accounts().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.accounts.AccountListPage
import com.increase.api.models.accounts.AccountListParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val page: AccountListPage = client.accounts().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
30
<?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->accounts->list(
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',
entityID: 'entity_id',
idempotencyKey: 'x',
informationalEntityID: 'informational_entity_id',
limit: 1,
programID: 'program_id',
status: ['in' => ['closed']],
);
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.Accounts;
IncreaseClient client = new();
AccountListParams parameters = new();
var page = await client.Accounts.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 object */ },
{ /* Account object */ }
/* ... */
],
"next_cursor": "v57w5d",
}
Parameters
entity_id
string
Filter Accounts for those belonging to the specified Entity.
More about Entities.
informational_entity_id
string
Filter Accounts for those belonging to the specified Entity as informational.
More about Entities.
program_id
string
Filter Accounts for those in a specific Program.
More about Programs.
status.in
array of strings
Filter Accounts for those with the specified status. 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.
More parameters
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
1
2
3
4
5
6
7
8
9
curl -X "POST" \
--url "${INCREASE_URL}/accounts" \
-H "Authorization: Bearer ${INCREASE_API_KEY}" \
-H "Content-Type: application/json" \
-d $'{
"entity_id": "entity_n8y8tnk2p9339ti393yi",
"name": "New Account!",
"program_id": "program_i2v2os4mwza1oetokh9i"
}'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 account = await client.accounts.create({ name: 'New Account!' });
console.log(account.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 = client.accounts.create(
name="New Account!",
)
print(account.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 = increase.accounts.create(name: "New Account!")
puts(account)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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
)
account, err := client.Accounts.New(context.TODO(), increase.AccountNewParams{
Name: increase.F("New Account!"),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", account.ID)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.accounts.Account;
import com.increase.api.models.accounts.AccountCreateParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
AccountCreateParams params = AccountCreateParams.builder()
.name("New Account!")
.build();
Account account = client.accounts().create(params);
}
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.accounts.Account
import com.increase.api.models.accounts.AccountCreateParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val params: AccountCreateParams = AccountCreateParams.builder()
.name("New Account!")
.build()
val account: Account = client.accounts().create(params)
}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 {
$account = $client->accounts->create(
name: 'New Account!',
entityID: 'entity_n8y8tnk2p9339ti393yi',
funding: 'loan',
informationalEntityID: 'informational_entity_id',
loan: [
'creditLimit' => 0,
'gracePeriodDays' => 0,
'statementDayOfMonth' => 1,
'statementPaymentType' => 'balance',
'maturityDate' => '2019-12-27',
],
programID: 'program_i2v2os4mwza1oetokh9i',
);
var_dump($account);
} catch (APIException $e) {
echo $e->getMessage();
}1
2
3
4
5
6
7
8
9
10
11
using System;
using Increase.Api;
using Increase.Api.Models.Accounts;
IncreaseClient client = new();
AccountCreateParams parameters = new() { Name = "New Account!" };
var account = await client.Accounts.Create(parameters);
Console.WriteLine(account);
Parameters
entity_id
string
The identifier for the Entity that will own the Account.
More about Entities.
funding
enum
Whether the Account is funded by a loan or by deposits.
informational_entity_id
string
The identifier of an Entity that, while not owning the Account, is associated with its activity. This is generally the beneficiary of the funds.
More about Entities.
loan
dictionary
The loan details for the account.
name
string
Required
The name you choose for the Account.
Retrieve an Account
1
2
3
curl \
--url "${INCREASE_URL}/accounts/account_in71c4amph0vgo2qllky" \
-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 account = await client.accounts.retrieve('account_in71c4amph0vgo2qllky');
console.log(account.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 = client.accounts.retrieve(
"account_in71c4amph0vgo2qllky",
)
print(account.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 = increase.accounts.retrieve("account_in71c4amph0vgo2qllky")
puts(account)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
)
account, err := client.Accounts.Get(context.TODO(), "account_in71c4amph0vgo2qllky")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", account.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.accounts.Account;
import com.increase.api.models.accounts.AccountRetrieveParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
Account account = client.accounts().retrieve("account_in71c4amph0vgo2qllky");
}
}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.accounts.Account
import com.increase.api.models.accounts.AccountRetrieveParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val account: Account = client.accounts().retrieve("account_in71c4amph0vgo2qllky")
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<?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 {
$account = $client->accounts->retrieve('account_in71c4amph0vgo2qllky');
var_dump($account);
} 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.Accounts;
IncreaseClient client = new();
AccountRetrieveParams parameters = new()
{
AccountID = "account_in71c4amph0vgo2qllky"
};
var account = await client.Accounts.Retrieve(parameters);
Console.WriteLine(account);
Parameters
account_id
string
Required
The identifier of the Account to retrieve.
More about Accounts.
Update an Account
1
2
3
4
5
6
7
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"
}'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 account = await client.accounts.update('account_in71c4amph0vgo2qllky');
console.log(account.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 = client.accounts.update(
account_id="account_in71c4amph0vgo2qllky",
)
print(account.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 = increase.accounts.update("account_in71c4amph0vgo2qllky")
puts(account)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
)
account, err := client.Accounts.Update(
context.TODO(),
"account_in71c4amph0vgo2qllky",
increase.AccountUpdateParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", account.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.accounts.Account;
import com.increase.api.models.accounts.AccountUpdateParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
Account account = client.accounts().update("account_in71c4amph0vgo2qllky");
}
}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.accounts.Account
import com.increase.api.models.accounts.AccountUpdateParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val account: Account = client.accounts().update("account_in71c4amph0vgo2qllky")
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
<?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 {
$account = $client->accounts->update(
'account_in71c4amph0vgo2qllky',
loan: ['creditLimit' => 0],
name: 'My renamed account',
);
var_dump($account);
} 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.Accounts;
IncreaseClient client = new();
AccountUpdateParams parameters = new()
{
AccountID = "account_in71c4amph0vgo2qllky"
};
var account = await client.Accounts.Update(parameters);
Console.WriteLine(account);
Parameters
account_id
string
Required
The identifier of the Account to update.
More about Accounts.
loan
dictionary
The loan details for the account.
name
string
The new name of the Account.
Retrieve an Account Balance
Retrieve the current and available balances for an account in minor units of the account’s currency. Learn more about account balances.
1
2
3
curl \
--url "${INCREASE_URL}/accounts/account_in71c4amph0vgo2qllky/balance" \
-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 balanceLookup = await client.accounts.balance('account_in71c4amph0vgo2qllky');
console.log(balanceLookup.account_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
)
balance_lookup = client.accounts.balance(
account_id="account_in71c4amph0vgo2qllky",
)
print(balance_lookup.account_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
)
balance_lookup = increase.accounts.balance("account_in71c4amph0vgo2qllky")
puts(balance_lookup)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
)
balanceLookup, err := client.Accounts.Balance(
context.TODO(),
"account_in71c4amph0vgo2qllky",
increase.AccountBalanceParams{},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", balanceLookup.AccountID)
}
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.accounts.AccountBalanceParams;
import com.increase.api.models.accounts.BalanceLookup;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
BalanceLookup balanceLookup = client.accounts().balance("account_in71c4amph0vgo2qllky");
}
}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.accounts.AccountBalanceParams
import com.increase.api.models.accounts.BalanceLookup
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val balanceLookup: BalanceLookup = client.accounts().balance("account_in71c4amph0vgo2qllky")
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
<?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 {
$balanceLookup = $client->accounts->balance(
'account_in71c4amph0vgo2qllky',
atTime: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
);
var_dump($balanceLookup);
} 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.Accounts;
IncreaseClient client = new();
AccountBalanceParams parameters = new()
{
AccountID = "account_in71c4amph0vgo2qllky"
};
var balanceLookup = await client.Accounts.Balance(parameters);
Console.WriteLine(balanceLookup);
Returns a Balance Lookup
object:
1
2
3
4
5
6
7
{
"account_id": "account_in71c4amph0vgo2qllky",
"available_balance": 100,
"current_balance": 100,
"loan": null,
"type": "balance_lookup"
}
Parameters
account_id
string
Required
The identifier of the Account to retrieve.
More about Accounts.
at_time
string
The moment to query the balance at. If not set, returns the current balances.
Close an Account
1
2
3
curl -X "POST" \
--url "${INCREASE_URL}/accounts/account_in71c4amph0vgo2qllky/close" \
-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 account = await client.accounts.close('account_in71c4amph0vgo2qllky');
console.log(account.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 = client.accounts.close(
"account_in71c4amph0vgo2qllky",
)
print(account.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 = increase.accounts.close("account_in71c4amph0vgo2qllky")
puts(account)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
)
account, err := client.Accounts.Close(context.TODO(), "account_in71c4amph0vgo2qllky")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", account.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.accounts.Account;
import com.increase.api.models.accounts.AccountCloseParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
Account account = client.accounts().close("account_in71c4amph0vgo2qllky");
}
}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.accounts.Account
import com.increase.api.models.accounts.AccountCloseParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val account: Account = client.accounts().close("account_in71c4amph0vgo2qllky")
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
<?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 {
$account = $client->accounts->close('account_in71c4amph0vgo2qllky');
var_dump($account);
} 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.Accounts;
IncreaseClient client = new();
AccountCloseParams parameters = new()
{
AccountID = "account_in71c4amph0vgo2qllky"
};
var account = await client.Accounts.Close(parameters);
Console.WriteLine(account);
Parameters
account_id
string
Required
The identifier of the Account to close. The account must have a zero balance.
More about Accounts.
Sandbox: Create an account revenue payment
Simulates an account revenue payment to your account. In production, this happens automatically on the first of each month.
1
2
3
4
5
6
7
8
curl -X "POST" \
--url "${INCREASE_URL}/simulations/account_revenue_payments" \
-H "Authorization: Bearer ${INCREASE_API_KEY}" \
-H "Content-Type: application/json" \
-d $'{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": 1000
}'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 transaction = await client.simulations.accountRevenuePayments.create({
account_id: 'account_in71c4amph0vgo2qllky',
amount: 1000,
});
console.log(transaction.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
)
transaction = client.simulations.account_revenue_payments.create(
account_id="account_in71c4amph0vgo2qllky",
amount=1000,
)
print(transaction.id)1
2
3
4
5
6
7
8
9
10
11
12
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
transaction = increase.simulations.account_revenue_payments.create(
account_id: "account_in71c4amph0vgo2qllky",
amount: 1000
)
puts(transaction)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
)
transaction, err := client.Simulations.AccountRevenuePayments.New(context.TODO(), increase.SimulationAccountRevenuePaymentNewParams{
AccountID: increase.F("account_in71c4amph0vgo2qllky"),
Amount: increase.F(int64(1000)),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", transaction.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.simulations.accountrevenuepayments.AccountRevenuePaymentCreateParams;
import com.increase.api.models.transactions.Transaction;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
AccountRevenuePaymentCreateParams params = AccountRevenuePaymentCreateParams.builder()
.accountId("account_in71c4amph0vgo2qllky")
.amount(1000L)
.build();
Transaction transaction = client.simulations().accountRevenuePayments().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.simulations.accountrevenuepayments.AccountRevenuePaymentCreateParams
import com.increase.api.models.transactions.Transaction
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val params: AccountRevenuePaymentCreateParams = AccountRevenuePaymentCreateParams.builder()
.accountId("account_in71c4amph0vgo2qllky")
.amount(1000L)
.build()
val transaction: Transaction = client.simulations().accountRevenuePayments().create(params)
}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 {
$transaction = $client->simulations->accountRevenuePayments->create(
accountID: 'account_in71c4amph0vgo2qllky',
amount: 1000,
accruedOnAccountID: 'accrued_on_account_id',
periodEnd: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
periodStart: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
);
var_dump($transaction);
} 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.Simulations.AccountRevenuePayments;
IncreaseClient client = new();
AccountRevenuePaymentCreateParams parameters = new()
{
AccountID = "account_in71c4amph0vgo2qllky",
Amount = 1000,
};
var transaction = await client.Simulations.AccountRevenuePayments.Create(parameters);
Console.WriteLine(transaction);
Returns a Transaction
object:
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
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": 100,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "INVOICE 2468",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": "account_number_v18nkfqm6afpsrvy82b2",
"route_type": "account_number",
"source": {
"category": "inbound_ach_transfer",
"inbound_ach_transfer": {
"addenda": null,
"amount": 100,
"originator_company_descriptive_date": null,
"originator_company_discretionary_data": null,
"originator_company_entry_description": "RESERVE",
"originator_company_id": "0987654321",
"originator_company_name": "BIG BANK",
"receiver_id_number": "12345678900",
"receiver_name": "IAN CREASE",
"trace_number": "021000038461022",
"transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev"
}
},
"type": "transaction"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": -100,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "INVOICE 2468",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": null,
"route_type": null,
"source": {
"ach_transfer_intention": {
"account_number": "987654321",
"amount": 100,
"routing_number": "101050001",
"statement_descriptor": "INVOICE 2468",
"transfer_id": "account_transfer_7k9qe1ysdgqztnt63l7n"
},
"category": "ach_transfer_intention"
},
"type": "transaction"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": 100,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "INVOICE 2468",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": null,
"route_type": null,
"source": {
"ach_transfer_return": {
"addenda_information": null,
"created_at": "2020-01-31T23:59:59Z",
"raw_return_reason_code": "R01",
"return_reason_code": "insufficient_fund",
"trace_number": "111122223292834",
"transaction_id": "transaction_uyrp7fld2ium70oa7oi",
"transfer_id": "ach_transfer_uoxatyh3lt5evrsdvo7q"
},
"category": "ach_transfer_return"
},
"type": "transaction"
}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
30
31
32
33
34
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": 100,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "INVOICE 2468",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": "account_number_v18nkfqm6afpsrvy82b2",
"route_type": "account_number",
"source": {
"category": "inbound_wire_transfer",
"inbound_wire_transfer": {
"amount": 100,
"creditor_address_line1": null,
"creditor_address_line2": null,
"creditor_address_line3": null,
"creditor_name": null,
"debtor_address_line1": null,
"debtor_address_line2": null,
"debtor_address_line3": null,
"debtor_name": null,
"description": "Inbound wire transfer",
"end_to_end_identification": null,
"input_message_accountability_data": null,
"instructing_agent_routing_number": null,
"instruction_identification": null,
"purpose": null,
"transfer_id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0",
"unique_end_to_end_transaction_reference": null,
"unstructured_remittance_information": null
}
},
"type": "transaction"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": -100,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "INVOICE 2468",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": null,
"route_type": null,
"source": {
"category": "wire_transfer_intention",
"wire_transfer_intention": {
"account_number": "987654321",
"amount": 100,
"message_to_recipient": "HELLO",
"routing_number": "101050001",
"transfer_id": "wire_transfer_5akynk7dqsq25qwk9q2u"
}
},
"type": "transaction"
}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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": -100,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "INVOICE 2468",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": "card_oubs0hwk5rn6knuecxg2",
"route_type": "card",
"source": {
"card_settlement": {
"amount": 100,
"card_authorization": null,
"card_payment_id": "card_payment_nd3k2kacrqjli8482ave",
"cashback": null,
"currency": "USD",
"id": "card_settlement_khv5kfeu0vndj291omg6",
"interchange": {
"amount": "0.137465",
"code": "271",
"currency": "USD"
},
"merchant_acceptor_id": "5665270011000168",
"merchant_category_code": "5734",
"merchant_city": "New York",
"merchant_country": "US",
"merchant_name": "AMAZON.COM",
"merchant_postal_code": "10045",
"merchant_state": "NY",
"network": "visa",
"network_identifiers": {
"acquirer_business_id": "69650702",
"acquirer_reference_number": "83163715445437604865089",
"authorization_identification_response": "ABC123",
"transaction_id": "627199945183184"
},
"pending_transaction_id": null,
"presentment_amount": 100,
"presentment_currency": "USD",
"purchase_details": {
"car_rental": null,
"customer_reference_identifier": "51201",
"local_tax_amount": null,
"local_tax_currency": "usd",
"lodging": {
"check_in_date": "2023-07-20",
"daily_room_rate_amount": 1000,
"daily_room_rate_currency": "usd",
"extra_charges": "restaurant",
"folio_cash_advances_amount": 0,
"folio_cash_advances_currency": "usd",
"food_beverage_charges_amount": 0,
"food_beverage_charges_currency": "usd",
"no_show_indicator": "no_show",
"prepaid_expenses_amount": 0,
"prepaid_expenses_currency": "usd",
"room_nights": 1,
"total_room_tax_amount": 100,
"total_room_tax_currency": "usd",
"total_tax_amount": 100,
"total_tax_currency": "usd"
},
"national_tax_amount": null,
"national_tax_currency": "usd",
"purchase_identifier": "10203",
"purchase_identifier_format": "order_number",
"travel": null
},
"scheme_fees": [
{
"amount": "0.137465",
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"fee_type": "visa_corporate_acceptance_fee",
"fixed_component": null,
"variable_rate": "0.0002"
}
],
"surcharge": null,
"transaction_id": "transaction_uyrp7fld2ium70oa7oi",
"type": "card_settlement"
},
"category": "card_settlement"
},
"type": "transaction"
}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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": 100,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "INVOICE 2468",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": "card_oubs0hwk5rn6knuecxg2",
"route_type": "card",
"source": {
"card_refund": {
"amount": 100,
"card_payment_id": "card_payment_nd3k2kacrqjli8482ave",
"cashback": null,
"currency": "USD",
"id": "card_refund_imgc2xwplh6t4r3gn16e",
"interchange": {
"amount": "0.137465",
"code": "271",
"currency": "USD"
},
"merchant_acceptor_id": "5665270011000168",
"merchant_category_code": "5734",
"merchant_city": "New York",
"merchant_country": "US",
"merchant_name": "AMAZON.COM",
"merchant_postal_code": "10045",
"merchant_state": "NY",
"network_identifiers": {
"acquirer_business_id": "69650702",
"acquirer_reference_number": "83163715445437604865089",
"authorization_identification_response": "ABC123",
"transaction_id": "627199945183184"
},
"presentment_amount": 100,
"presentment_currency": "USD",
"purchase_details": {
"car_rental": null,
"customer_reference_identifier": "51201",
"local_tax_amount": null,
"local_tax_currency": "usd",
"lodging": {
"check_in_date": "2023-07-20",
"daily_room_rate_amount": 1000,
"daily_room_rate_currency": "usd",
"extra_charges": "restaurant",
"folio_cash_advances_amount": 0,
"folio_cash_advances_currency": "usd",
"food_beverage_charges_amount": 0,
"food_beverage_charges_currency": "usd",
"no_show_indicator": "no_show",
"prepaid_expenses_amount": 0,
"prepaid_expenses_currency": "usd",
"room_nights": 1,
"total_room_tax_amount": 100,
"total_room_tax_currency": "usd",
"total_tax_amount": 100,
"total_tax_currency": "usd"
},
"national_tax_amount": null,
"national_tax_currency": "usd",
"purchase_identifier": "10203",
"purchase_identifier_format": "order_number",
"travel": null
},
"scheme_fees": [
{
"amount": "0.137465",
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"fee_type": "visa_corporate_acceptance_fee",
"fixed_component": null,
"variable_rate": "0.0002"
}
],
"transaction_id": "transaction_uyrp7fld2ium70oa7oi",
"type": "card_refund"
},
"category": "card_refund"
},
"type": "transaction"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": 1000,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "INVOICE 2468",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": null,
"route_type": null,
"source": {
"category": "check_deposit_acceptance",
"check_deposit_acceptance": {
"account_number": "987654321",
"amount": 1000,
"auxiliary_on_us": "101",
"check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1",
"currency": "USD",
"routing_number": "101050001",
"serial_number": null
}
},
"type": "transaction"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": 100,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "Interest payment for 2025-06",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": null,
"route_type": null,
"source": {
"category": "interest_payment",
"interest_payment": {
"accrued_on_account_id": "account_in71c4amph0vgo2qllky",
"amount": 100,
"currency": "USD",
"period_end": "2025-06-30T23:59:59+00:00",
"period_start": "2025-06-01T00:00:00+00:00"
}
},
"type": "transaction"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": -100,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "INVOICE 2468",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": null,
"route_type": null,
"source": {
"category": "fee_payment",
"fee_payment": {
"amount": 100,
"currency": "USD",
"fee_period_start": "2023-05-01",
"fee_statement_id": "fee_statement_lz33v0d7pnxwkptrdwq4",
"program_id": "program_i2v2os4mwza1oetokh9i"
}
},
"type": "transaction"
}
Parameters
account_id
string
Required
The identifier of the Account the Account Revenue Payment should be paid to.
More about Accounts.
accrued_on_account_id
string
The identifier of the Account the account revenue accrued on. Defaults to account_id.
More about Accounts.
amount
integer
Required
The account revenue amount in cents. Must be positive.
period_end
string
The end of the account revenue period. If not provided, defaults to the current time.
period_start
string
The start of the account revenue period. If not provided, defaults to the current time.
Sandbox: Create an interest payment
Simulates an interest payment to your account. In production, this happens automatically on the first of each month.
1
2
3
4
5
6
7
8
curl -X "POST" \
--url "${INCREASE_URL}/simulations/interest_payments" \
-H "Authorization: Bearer ${INCREASE_API_KEY}" \
-H "Content-Type: application/json" \
-d $'{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": 1000
}'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 transaction = await client.simulations.interestPayments.create({
account_id: 'account_in71c4amph0vgo2qllky',
amount: 1000,
});
console.log(transaction.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
)
transaction = client.simulations.interest_payments.create(
account_id="account_in71c4amph0vgo2qllky",
amount=1000,
)
print(transaction.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
)
transaction = increase.simulations.interest_payments.create(account_id: "account_in71c4amph0vgo2qllky", amount: 1000)
puts(transaction)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
)
transaction, err := client.Simulations.InterestPayments.New(context.TODO(), increase.SimulationInterestPaymentNewParams{
AccountID: increase.F("account_in71c4amph0vgo2qllky"),
Amount: increase.F(int64(1000)),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", transaction.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.simulations.interestpayments.InterestPaymentCreateParams;
import com.increase.api.models.transactions.Transaction;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
InterestPaymentCreateParams params = InterestPaymentCreateParams.builder()
.accountId("account_in71c4amph0vgo2qllky")
.amount(1000L)
.build();
Transaction transaction = client.simulations().interestPayments().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.simulations.interestpayments.InterestPaymentCreateParams
import com.increase.api.models.transactions.Transaction
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val params: InterestPaymentCreateParams = InterestPaymentCreateParams.builder()
.accountId("account_in71c4amph0vgo2qllky")
.amount(1000L)
.build()
val transaction: Transaction = client.simulations().interestPayments().create(params)
}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 {
$transaction = $client->simulations->interestPayments->create(
accountID: 'account_in71c4amph0vgo2qllky',
amount: 1000,
accruedOnAccountID: 'accrued_on_account_id',
periodEnd: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
periodStart: new \DateTimeImmutable('2019-12-27T18:11:19.117Z'),
);
var_dump($transaction);
} 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.Simulations.InterestPayments;
IncreaseClient client = new();
InterestPaymentCreateParams parameters = new()
{
AccountID = "account_in71c4amph0vgo2qllky",
Amount = 1000,
};
var transaction = await client.Simulations.InterestPayments.Create(parameters);
Console.WriteLine(transaction);
Returns a Transaction
object:
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
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": 100,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "INVOICE 2468",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": "account_number_v18nkfqm6afpsrvy82b2",
"route_type": "account_number",
"source": {
"category": "inbound_ach_transfer",
"inbound_ach_transfer": {
"addenda": null,
"amount": 100,
"originator_company_descriptive_date": null,
"originator_company_discretionary_data": null,
"originator_company_entry_description": "RESERVE",
"originator_company_id": "0987654321",
"originator_company_name": "BIG BANK",
"receiver_id_number": "12345678900",
"receiver_name": "IAN CREASE",
"trace_number": "021000038461022",
"transfer_id": "inbound_ach_transfer_tdrwqr3fq9gnnq49odev"
}
},
"type": "transaction"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": -100,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "INVOICE 2468",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": null,
"route_type": null,
"source": {
"ach_transfer_intention": {
"account_number": "987654321",
"amount": 100,
"routing_number": "101050001",
"statement_descriptor": "INVOICE 2468",
"transfer_id": "account_transfer_7k9qe1ysdgqztnt63l7n"
},
"category": "ach_transfer_intention"
},
"type": "transaction"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": 100,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "INVOICE 2468",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": null,
"route_type": null,
"source": {
"ach_transfer_return": {
"addenda_information": null,
"created_at": "2020-01-31T23:59:59Z",
"raw_return_reason_code": "R01",
"return_reason_code": "insufficient_fund",
"trace_number": "111122223292834",
"transaction_id": "transaction_uyrp7fld2ium70oa7oi",
"transfer_id": "ach_transfer_uoxatyh3lt5evrsdvo7q"
},
"category": "ach_transfer_return"
},
"type": "transaction"
}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
30
31
32
33
34
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": 100,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "INVOICE 2468",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": "account_number_v18nkfqm6afpsrvy82b2",
"route_type": "account_number",
"source": {
"category": "inbound_wire_transfer",
"inbound_wire_transfer": {
"amount": 100,
"creditor_address_line1": null,
"creditor_address_line2": null,
"creditor_address_line3": null,
"creditor_name": null,
"debtor_address_line1": null,
"debtor_address_line2": null,
"debtor_address_line3": null,
"debtor_name": null,
"description": "Inbound wire transfer",
"end_to_end_identification": null,
"input_message_accountability_data": null,
"instructing_agent_routing_number": null,
"instruction_identification": null,
"purpose": null,
"transfer_id": "inbound_wire_transfer_f228m6bmhtcxjco9pwp0",
"unique_end_to_end_transaction_reference": null,
"unstructured_remittance_information": null
}
},
"type": "transaction"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": -100,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "INVOICE 2468",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": null,
"route_type": null,
"source": {
"category": "wire_transfer_intention",
"wire_transfer_intention": {
"account_number": "987654321",
"amount": 100,
"message_to_recipient": "HELLO",
"routing_number": "101050001",
"transfer_id": "wire_transfer_5akynk7dqsq25qwk9q2u"
}
},
"type": "transaction"
}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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": -100,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "INVOICE 2468",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": "card_oubs0hwk5rn6knuecxg2",
"route_type": "card",
"source": {
"card_settlement": {
"amount": 100,
"card_authorization": null,
"card_payment_id": "card_payment_nd3k2kacrqjli8482ave",
"cashback": null,
"currency": "USD",
"id": "card_settlement_khv5kfeu0vndj291omg6",
"interchange": {
"amount": "0.137465",
"code": "271",
"currency": "USD"
},
"merchant_acceptor_id": "5665270011000168",
"merchant_category_code": "5734",
"merchant_city": "New York",
"merchant_country": "US",
"merchant_name": "AMAZON.COM",
"merchant_postal_code": "10045",
"merchant_state": "NY",
"network": "visa",
"network_identifiers": {
"acquirer_business_id": "69650702",
"acquirer_reference_number": "83163715445437604865089",
"authorization_identification_response": "ABC123",
"transaction_id": "627199945183184"
},
"pending_transaction_id": null,
"presentment_amount": 100,
"presentment_currency": "USD",
"purchase_details": {
"car_rental": null,
"customer_reference_identifier": "51201",
"local_tax_amount": null,
"local_tax_currency": "usd",
"lodging": {
"check_in_date": "2023-07-20",
"daily_room_rate_amount": 1000,
"daily_room_rate_currency": "usd",
"extra_charges": "restaurant",
"folio_cash_advances_amount": 0,
"folio_cash_advances_currency": "usd",
"food_beverage_charges_amount": 0,
"food_beverage_charges_currency": "usd",
"no_show_indicator": "no_show",
"prepaid_expenses_amount": 0,
"prepaid_expenses_currency": "usd",
"room_nights": 1,
"total_room_tax_amount": 100,
"total_room_tax_currency": "usd",
"total_tax_amount": 100,
"total_tax_currency": "usd"
},
"national_tax_amount": null,
"national_tax_currency": "usd",
"purchase_identifier": "10203",
"purchase_identifier_format": "order_number",
"travel": null
},
"scheme_fees": [
{
"amount": "0.137465",
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"fee_type": "visa_corporate_acceptance_fee",
"fixed_component": null,
"variable_rate": "0.0002"
}
],
"surcharge": null,
"transaction_id": "transaction_uyrp7fld2ium70oa7oi",
"type": "card_settlement"
},
"category": "card_settlement"
},
"type": "transaction"
}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
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": 100,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "INVOICE 2468",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": "card_oubs0hwk5rn6knuecxg2",
"route_type": "card",
"source": {
"card_refund": {
"amount": 100,
"card_payment_id": "card_payment_nd3k2kacrqjli8482ave",
"cashback": null,
"currency": "USD",
"id": "card_refund_imgc2xwplh6t4r3gn16e",
"interchange": {
"amount": "0.137465",
"code": "271",
"currency": "USD"
},
"merchant_acceptor_id": "5665270011000168",
"merchant_category_code": "5734",
"merchant_city": "New York",
"merchant_country": "US",
"merchant_name": "AMAZON.COM",
"merchant_postal_code": "10045",
"merchant_state": "NY",
"network_identifiers": {
"acquirer_business_id": "69650702",
"acquirer_reference_number": "83163715445437604865089",
"authorization_identification_response": "ABC123",
"transaction_id": "627199945183184"
},
"presentment_amount": 100,
"presentment_currency": "USD",
"purchase_details": {
"car_rental": null,
"customer_reference_identifier": "51201",
"local_tax_amount": null,
"local_tax_currency": "usd",
"lodging": {
"check_in_date": "2023-07-20",
"daily_room_rate_amount": 1000,
"daily_room_rate_currency": "usd",
"extra_charges": "restaurant",
"folio_cash_advances_amount": 0,
"folio_cash_advances_currency": "usd",
"food_beverage_charges_amount": 0,
"food_beverage_charges_currency": "usd",
"no_show_indicator": "no_show",
"prepaid_expenses_amount": 0,
"prepaid_expenses_currency": "usd",
"room_nights": 1,
"total_room_tax_amount": 100,
"total_room_tax_currency": "usd",
"total_tax_amount": 100,
"total_tax_currency": "usd"
},
"national_tax_amount": null,
"national_tax_currency": "usd",
"purchase_identifier": "10203",
"purchase_identifier_format": "order_number",
"travel": null
},
"scheme_fees": [
{
"amount": "0.137465",
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"fee_type": "visa_corporate_acceptance_fee",
"fixed_component": null,
"variable_rate": "0.0002"
}
],
"transaction_id": "transaction_uyrp7fld2ium70oa7oi",
"type": "card_refund"
},
"category": "card_refund"
},
"type": "transaction"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": 1000,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "INVOICE 2468",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": null,
"route_type": null,
"source": {
"category": "check_deposit_acceptance",
"check_deposit_acceptance": {
"account_number": "987654321",
"amount": 1000,
"auxiliary_on_us": "101",
"check_deposit_id": "check_deposit_f06n9gpg7sxn8t19lfc1",
"currency": "USD",
"routing_number": "101050001",
"serial_number": null
}
},
"type": "transaction"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": 100,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "Interest payment for 2025-06",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": null,
"route_type": null,
"source": {
"category": "interest_payment",
"interest_payment": {
"accrued_on_account_id": "account_in71c4amph0vgo2qllky",
"amount": 100,
"currency": "USD",
"period_end": "2025-06-30T23:59:59+00:00",
"period_start": "2025-06-01T00:00:00+00:00"
}
},
"type": "transaction"
}1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
{
"account_id": "account_in71c4amph0vgo2qllky",
"amount": -100,
"created_at": "2020-01-31T23:59:59Z",
"currency": "USD",
"description": "INVOICE 2468",
"id": "transaction_uyrp7fld2ium70oa7oi",
"route_id": null,
"route_type": null,
"source": {
"category": "fee_payment",
"fee_payment": {
"amount": 100,
"currency": "USD",
"fee_period_start": "2023-05-01",
"fee_statement_id": "fee_statement_lz33v0d7pnxwkptrdwq4",
"program_id": "program_i2v2os4mwza1oetokh9i"
}
},
"type": "transaction"
}
Parameters
account_id
string
Required
The identifier of the Account the Interest Payment should be paid to is for.
More about Accounts.
accrued_on_account_id
string
The identifier of the Account the Interest accrued on. Defaults to account_id.
More about Accounts.
amount
integer
Required
The interest amount in cents. Must be positive.
period_end
string
The end of the interest period. If not provided, defaults to the current time.
period_start
string
The start of the interest period. If not provided, defaults to the current time.