Checkbook Checks
A Checkbook Check is a single check within a Checkbook.
The Checkbook Check object
1
2
3
4
5
6
7
8
{
"check_number": 1,
"checkbook_id": "checkbook_7iudxhxum6vlkcjxmi8y",
"created_at": "2020-01-31T23:59:59Z",
"id": "checkbook_check_klgh3z50guf6jcnfhibb",
"status": "pending_deposit",
"type": "checkbook_check"
}Attributes
check_number
integer
The check number printed on the check.
checkbook_id
string
The identifier of the Checkbook the check belongs to.
created_at
string
The ISO 8601 date and time at which the Checkbook Check was created.
id
string
The Checkbook Check’s identifier.
status
enum
The status of the Checkbook Check.
type
string
A constant representing the object’s type. For this resource it will always be checkbook_check.
List Checkbook Checks
1
2
3
curl \
--url "${INCREASE_URL}/checkbook_checks" \
-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 checkbookCheck of client.checkbookChecks.list()) {
console.log(checkbookCheck.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.checkbook_checks.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.checkbook_checks.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.CheckbookChecks.List(context.TODO(), increase.CheckbookCheckListParams{})
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.checkbookchecks.CheckbookCheckListPage;
import com.increase.api.models.checkbookchecks.CheckbookCheckListParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
CheckbookCheckListPage page = client.checkbookChecks().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.checkbookchecks.CheckbookCheckListPage
import com.increase.api.models.checkbookchecks.CheckbookCheckListParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val page: CheckbookCheckListPage = client.checkbookChecks().list()
}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 {
$page = $client->checkbookChecks->list(
accountNumberID: 'account_number_id',
checkNumber: 0,
checkbookID: 'checkbook_id',
cursor: 'cursor',
limit: 1,
);
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.CheckbookChecks;
IncreaseClient client = new();
CheckbookCheckListParams parameters = new();
var page = await client.CheckbookChecks.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": [
{ /* Checkbook Check object */ },
{ /* Checkbook Check object */ }
/* ... */
],
"next_cursor": "v57w5d",
}Parameters
checkbook_id
string
Filter Checkbook Checks to those belonging to the specified Checkbook.
account_number_id
string
Filter Checkbook Checks to those drawn on the specified Account Number.
check_number
integer
Filter Checkbook Checks to the one with the specified check number.
More parameters
Retrieve a Checkbook Check
1
2
3
curl \
--url "${INCREASE_URL}/checkbook_checks/checkbook_check_klgh3z50guf6jcnfhibb" \
-H "Authorization: Bearer ${INCREASE_API_KEY}"1
2
3
4
5
6
7
8
9
10
11
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const checkbookCheck = await client.checkbookChecks.retrieve(
'checkbook_check_klgh3z50guf6jcnfhibb',
);
console.log(checkbookCheck.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
)
checkbook_check = client.checkbook_checks.retrieve(
"checkbook_check_klgh3z50guf6jcnfhibb",
)
print(checkbook_check.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
)
checkbook_check = increase.checkbook_checks.retrieve("checkbook_check_klgh3z50guf6jcnfhibb")
puts(checkbook_check)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
)
checkbookCheck, err := client.CheckbookChecks.Get(context.TODO(), "checkbook_check_klgh3z50guf6jcnfhibb")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", checkbookCheck.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.checkbookchecks.CheckbookCheck;
import com.increase.api.models.checkbookchecks.CheckbookCheckRetrieveParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
CheckbookCheck checkbookCheck = client.checkbookChecks().retrieve("checkbook_check_klgh3z50guf6jcnfhibb");
}
}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.checkbookchecks.CheckbookCheck
import com.increase.api.models.checkbookchecks.CheckbookCheckRetrieveParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val checkbookCheck: CheckbookCheck = client.checkbookChecks().retrieve("checkbook_check_klgh3z50guf6jcnfhibb")
}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 {
$checkbookCheck = $client->checkbookChecks->retrieve(
'checkbook_check_klgh3z50guf6jcnfhibb'
);
var_dump($checkbookCheck);
} 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.CheckbookChecks;
IncreaseClient client = new();
CheckbookCheckRetrieveParams parameters = new()
{
CheckbookCheckID = "checkbook_check_klgh3z50guf6jcnfhibb"
};
var checkbookCheck = await client.CheckbookChecks.Retrieve(parameters);
Console.WriteLine(checkbookCheck);Parameters
checkbook_check_id
string
Required
The identifier of the Checkbook Check.
Stop a Checkbook Check
Stop a Checkbook Check. A stopped check cannot be deposited.
1
2
3
curl -X "POST" \
--url "${INCREASE_URL}/checkbook_checks/checkbook_check_klgh3z50guf6jcnfhibb/stop" \
-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 checkbookCheck = await client.checkbookChecks.stop('checkbook_check_klgh3z50guf6jcnfhibb');
console.log(checkbookCheck.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
)
checkbook_check = client.checkbook_checks.stop(
"checkbook_check_klgh3z50guf6jcnfhibb",
)
print(checkbook_check.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
)
checkbook_check = increase.checkbook_checks.stop("checkbook_check_klgh3z50guf6jcnfhibb")
puts(checkbook_check)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
)
checkbookCheck, err := client.CheckbookChecks.Stop(context.TODO(), "checkbook_check_klgh3z50guf6jcnfhibb")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", checkbookCheck.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.checkbookchecks.CheckbookCheck;
import com.increase.api.models.checkbookchecks.CheckbookCheckStopParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
CheckbookCheck checkbookCheck = client.checkbookChecks().stop("checkbook_check_klgh3z50guf6jcnfhibb");
}
}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.checkbookchecks.CheckbookCheck
import com.increase.api.models.checkbookchecks.CheckbookCheckStopParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val checkbookCheck: CheckbookCheck = client.checkbookChecks().stop("checkbook_check_klgh3z50guf6jcnfhibb")
}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 {
$checkbookCheck = $client->checkbookChecks->stop(
'checkbook_check_klgh3z50guf6jcnfhibb'
);
var_dump($checkbookCheck);
} 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.CheckbookChecks;
IncreaseClient client = new();
CheckbookCheckStopParams parameters = new()
{
CheckbookCheckID = "checkbook_check_klgh3z50guf6jcnfhibb"
};
var checkbookCheck = await client.CheckbookChecks.Stop(parameters);
Console.WriteLine(checkbookCheck);Parameters
checkbook_check_id
string
Required
The identifier of the Checkbook Check to stop.