Physical Check Batches
Physical Check Batches are groups of checks that are mailed in the same parcel. Tracking updates are propagated to every related Check Transfer.
The Physical Check Batch 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
{
"created_at": "2020-01-31T23:59:59Z",
"id": "physical_check_batch_yzdwjhdbw0in6191whce",
"idempotency_key": null,
"mailing_address": {
"city": "New York",
"line1": "33 Liberty Street",
"line2": null,
"name": "Ian Crease",
"phone": null,
"postal_code": "10045",
"state": "NY"
},
"return_address": {
"city": "New York",
"line1": "33 Liberty Street",
"line2": null,
"name": "National Phonograph Company",
"phone": null,
"postal_code": "10045",
"state": "NY"
},
"shipping_method": "usps_first_class",
"status": "pending",
"type": "physical_check_batch"
}
Attributes
created_at
string
The ISO 8601 date and time at which the Physical Check Batch was created.
id
string
The Physical Check Batch’s 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.
mailing_address
dictionary
The mailing address of the parcel.
return_address
dictionary
The return address of the parcel.
shipping_method
enum
The shipping method for the parcel.
status
enum
The lifecycle status of the Physical Check Batch.
type
string
A constant representing the object’s type. For this resource it will always be physical_check_batch.
Create a Physical Check Batch
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
curl -X "POST" \
--url "${INCREASE_URL}/physical_check_batches" \
-H "Authorization: Bearer ${INCREASE_API_KEY}" \
-H "Content-Type: application/json" \
-d $'{
"mailing_address": {
"city": "New York",
"line1": "33 Liberty Street",
"name": "Ian Crease",
"postal_code": "10045",
"state": "NY"
},
"return_address": {
"city": "New York",
"line1": "33 Liberty Street",
"name": "National Phonograph Company",
"postal_code": "10045",
"state": "NY"
}
}'1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
import Increase from 'increase';
const client = new Increase({
apiKey: process.env['INCREASE_API_KEY'], // This is the default and can be omitted
});
const physicalCheckBatch = await client.physicalCheckBatches.create({
mailing_address: {
city: 'New York',
line1: '33 Liberty Street',
name: 'Ian Crease',
postal_code: '10045',
state: 'NY',
},
return_address: {
city: 'New York',
line1: '33 Liberty Street',
name: 'National Phonograph Company',
postal_code: '10045',
state: 'NY',
},
});
console.log(physicalCheckBatch.id);1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
import os
from increase import Increase
client = Increase(
api_key=os.environ.get("INCREASE_API_KEY"), # This is the default and can be omitted
)
physical_check_batch = client.physical_check_batches.create(
mailing_address={
"city": "New York",
"line1": "33 Liberty Street",
"name": "Ian Crease",
"postal_code": "10045",
"state": "NY",
},
return_address={
"city": "New York",
"line1": "33 Liberty Street",
"name": "National Phonograph Company",
"postal_code": "10045",
"state": "NY",
},
)
print(physical_check_batch.id)1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
require "increase"
increase = Increase::Client.new(
api_key: ENV["INCREASE_API_KEY"] # This is the default and can be omitted
)
physical_check_batch = increase.physical_check_batches.create(
mailing_address: {city: "New York", line1: "33 Liberty Street", name: "Ian Crease", postal_code: "10045", state: "NY"},
return_address: {
city: "New York",
line1: "33 Liberty Street",
name: "National Phonograph Company",
postal_code: "10045",
state: "NY"
}
)
puts(physical_check_batch)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
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
)
physicalCheckBatch, err := client.PhysicalCheckBatches.New(context.TODO(), increase.PhysicalCheckBatchNewParams{
MailingAddress: increase.F(increase.PhysicalCheckBatchNewParamsMailingAddress{
City: increase.F("New York"),
Line1: increase.F("33 Liberty Street"),
Name: increase.F("Ian Crease"),
PostalCode: increase.F("10045"),
State: increase.F("NY"),
}),
ReturnAddress: increase.F(increase.PhysicalCheckBatchNewParamsReturnAddress{
City: increase.F("New York"),
Line1: increase.F("33 Liberty Street"),
Name: increase.F("National Phonograph Company"),
PostalCode: increase.F("10045"),
State: increase.F("NY"),
}),
})
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", physicalCheckBatch.ID)
}
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
package com.increase.api.example;
import com.increase.api.client.IncreaseClient;
import com.increase.api.client.okhttp.IncreaseOkHttpClient;
import com.increase.api.models.physicalcheckbatches.PhysicalCheckBatch;
import com.increase.api.models.physicalcheckbatches.PhysicalCheckBatchCreateParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
PhysicalCheckBatchCreateParams params = PhysicalCheckBatchCreateParams.builder()
.mailingAddress(PhysicalCheckBatchCreateParams.MailingAddress.builder()
.city("New York")
.line1("33 Liberty Street")
.name("Ian Crease")
.postalCode("10045")
.state("NY")
.build())
.returnAddress(PhysicalCheckBatchCreateParams.ReturnAddress.builder()
.city("New York")
.line1("33 Liberty Street")
.name("National Phonograph Company")
.postalCode("10045")
.state("NY")
.build())
.build();
PhysicalCheckBatch physicalCheckBatch = client.physicalCheckBatches().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
package com.increase.api.example
import com.increase.api.client.IncreaseClient
import com.increase.api.client.okhttp.IncreaseOkHttpClient
import com.increase.api.models.physicalcheckbatches.PhysicalCheckBatch
import com.increase.api.models.physicalcheckbatches.PhysicalCheckBatchCreateParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val params: PhysicalCheckBatchCreateParams = PhysicalCheckBatchCreateParams.builder()
.mailingAddress(PhysicalCheckBatchCreateParams.MailingAddress.builder()
.city("New York")
.line1("33 Liberty Street")
.name("Ian Crease")
.postalCode("10045")
.state("NY")
.build())
.returnAddress(PhysicalCheckBatchCreateParams.ReturnAddress.builder()
.city("New York")
.line1("33 Liberty Street")
.name("National Phonograph Company")
.postalCode("10045")
.state("NY")
.build())
.build()
val physicalCheckBatch: PhysicalCheckBatch = client.physicalCheckBatches().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
30
31
32
33
34
35
36
<?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 {
$physicalCheckBatch = $client->physicalCheckBatches->create(
mailingAddress: [
'city' => 'New York',
'line1' => '33 Liberty Street',
'name' => 'Ian Crease',
'postalCode' => '10045',
'state' => 'NY',
'line2' => 'line2',
'phone' => 'x',
],
returnAddress: [
'city' => 'New York',
'line1' => '33 Liberty Street',
'name' => 'National Phonograph Company',
'postalCode' => '10045',
'state' => 'NY',
'line2' => 'line2',
'phone' => 'x',
],
shippingMethod: 'usps_first_class',
);
var_dump($physicalCheckBatch);
} catch (APIException $e) {
echo $e->getMessage();
}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
using System;
using Increase.Api;
using Increase.Api.Models.PhysicalCheckBatches;
IncreaseClient client = new();
PhysicalCheckBatchCreateParams parameters = new()
{
MailingAddress = new()
{
City = "New York",
Line1 = "33 Liberty Street",
Name = "Ian Crease",
PostalCode = "10045",
State = "NY",
Line2 = "line2",
Phone = "x",
},
ReturnAddress = new()
{
City = "New York",
Line1 = "33 Liberty Street",
Name = "National Phonograph Company",
PostalCode = "10045",
State = "NY",
Line2 = "line2",
Phone = "x",
},
};
var physicalCheckBatch = await client.PhysicalCheckBatches.Create(parameters);
Console.WriteLine(physicalCheckBatch);
Parameters
mailing_address
dictionary
Required
Details for where the parcel will be mailed.
return_address
dictionary
Required
Details for where the parcel should return if it is unable to be delivered.
shipping_method
enum
How to ship the batch.
usps_first_class Cancel a Physical Check Batch
Cancel a pending Physical Check Batch, which cancels all of its related checks.
1
2
3
curl -X "POST" \
--url "${INCREASE_URL}/physical_check_batches/physical_check_batch_yzdwjhdbw0in6191whce/cancel" \
-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 physicalCheckBatch = await client.physicalCheckBatches.cancel(
'physical_check_batch_yzdwjhdbw0in6191whce',
);
console.log(physicalCheckBatch.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
)
physical_check_batch = client.physical_check_batches.cancel(
"physical_check_batch_yzdwjhdbw0in6191whce",
)
print(physical_check_batch.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
)
physical_check_batch = increase.physical_check_batches.cancel("physical_check_batch_yzdwjhdbw0in6191whce")
puts(physical_check_batch)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
)
physicalCheckBatch, err := client.PhysicalCheckBatches.Cancel(context.TODO(), "physical_check_batch_yzdwjhdbw0in6191whce")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", physicalCheckBatch.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.physicalcheckbatches.PhysicalCheckBatch;
import com.increase.api.models.physicalcheckbatches.PhysicalCheckBatchCancelParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
PhysicalCheckBatch physicalCheckBatch = client.physicalCheckBatches().cancel("physical_check_batch_yzdwjhdbw0in6191whce");
}
}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.physicalcheckbatches.PhysicalCheckBatch
import com.increase.api.models.physicalcheckbatches.PhysicalCheckBatchCancelParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val physicalCheckBatch: PhysicalCheckBatch = client.physicalCheckBatches().cancel("physical_check_batch_yzdwjhdbw0in6191whce")
}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 {
$physicalCheckBatch = $client->physicalCheckBatches->cancel(
'physical_check_batch_yzdwjhdbw0in6191whce'
);
var_dump($physicalCheckBatch);
} 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.PhysicalCheckBatches;
IncreaseClient client = new();
PhysicalCheckBatchCancelParams parameters = new()
{
PhysicalCheckBatchID = "physical_check_batch_yzdwjhdbw0in6191whce"
};
var physicalCheckBatch = await client.PhysicalCheckBatches.Cancel(parameters);
Console.WriteLine(physicalCheckBatch);
Parameters
physical_check_batch_id
string
Required
The identifier of the pending Physical Check Batch to cancel.
More about Physical Check Batches.
Complete a Physical Check Batch
Completing a Physical Check Batch closes it to new Physical Checks and begins the process of printing and mailing it.
1
2
3
curl -X "POST" \
--url "${INCREASE_URL}/physical_check_batches/physical_check_batch_yzdwjhdbw0in6191whce/complete" \
-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 physicalCheckBatch = await client.physicalCheckBatches.complete(
'physical_check_batch_yzdwjhdbw0in6191whce',
);
console.log(physicalCheckBatch.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
)
physical_check_batch = client.physical_check_batches.complete(
"physical_check_batch_yzdwjhdbw0in6191whce",
)
print(physical_check_batch.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
)
physical_check_batch = increase.physical_check_batches.complete("physical_check_batch_yzdwjhdbw0in6191whce")
puts(physical_check_batch)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
)
physicalCheckBatch, err := client.PhysicalCheckBatches.Complete(context.TODO(), "physical_check_batch_yzdwjhdbw0in6191whce")
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", physicalCheckBatch.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.physicalcheckbatches.PhysicalCheckBatch;
import com.increase.api.models.physicalcheckbatches.PhysicalCheckBatchCompleteParams;
public final class Main {
private Main() {}
public static void main(String[] args) {
IncreaseClient client = IncreaseOkHttpClient.fromEnv();
PhysicalCheckBatch physicalCheckBatch = client.physicalCheckBatches().complete("physical_check_batch_yzdwjhdbw0in6191whce");
}
}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.physicalcheckbatches.PhysicalCheckBatch
import com.increase.api.models.physicalcheckbatches.PhysicalCheckBatchCompleteParams
fun main() {
val client: IncreaseClient = IncreaseOkHttpClient.fromEnv()
val physicalCheckBatch: PhysicalCheckBatch = client.physicalCheckBatches().complete("physical_check_batch_yzdwjhdbw0in6191whce")
}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 {
$physicalCheckBatch = $client->physicalCheckBatches->complete(
'physical_check_batch_yzdwjhdbw0in6191whce'
);
var_dump($physicalCheckBatch);
} 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.PhysicalCheckBatches;
IncreaseClient client = new();
PhysicalCheckBatchCompleteParams parameters = new()
{
PhysicalCheckBatchID = "physical_check_batch_yzdwjhdbw0in6191whce"
};
var physicalCheckBatch = await client.PhysicalCheckBatches.Complete(parameters);
Console.WriteLine(physicalCheckBatch);
Parameters
physical_check_batch_id
string
Required
The identifier of the Physical Check Batch to complete.
More about Physical Check Batches.