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

{
  "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.

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

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"
    }
  }'

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.

Defaults to usps_first_class

Cancel a Physical Check Batch

Cancel a pending Physical Check Batch, which cancels all of its related checks.

curl -X "POST" \
  --url "${INCREASE_URL}/physical_check_batches/physical_check_batch_yzdwjhdbw0in6191whce/cancel" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

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.

curl -X "POST" \
  --url "${INCREASE_URL}/physical_check_batches/physical_check_batch_yzdwjhdbw0in6191whce/complete" \
  -H "Authorization: Bearer ${INCREASE_API_KEY}"

Parameters

physical_check_batch_id

string

Required

The identifier of the Physical Check Batch to complete.

More about Physical Check Batches.