increase-test
POST/physical_check_batches

Create a physical check batch

Creates a physical check batch for checks mailed together in one parcel. Provide both the mailing and return addresses; choose shipping_method to use USPS First-Class or FedEx Overnight shipping.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

3 body fields

Physical check batch shipping details, including the parcel's destination and return addresses.

mailing_addressobjectrequired
Details for where the parcel will be mailed.
return_addressobjectrequired
Details for where the parcel should return if it is unable to be delivered.
shipping_methodstringoptional
How to ship the batch.
Allowed:usps_first_classfedex_overnightDefault:usps_first_class

3 status codes
200Returns the created physical check batch with its identifier, status, shipping method, mailing address, and return address.
created_atstringrequired
The [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date and time at which the Physical Check Batch was created.
idstringrequired
The Physical Check Batch's identifier.
idempotency_keystringrequired
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](https://increase.com/documentation/idempotency-keys).
mailing_addressobjectrequired
The mailing address of the parcel.
return_addressobjectrequired
The return address of the parcel.
shipping_methodstringrequired
The shipping method for the parcel.
Allowed:usps_first_classfedex_overnight
statusstringrequired
The lifecycle status of the Physical Check Batch.
Allowed:pendingcompletedcanceledrequires_attention
typestringrequired
A constant representing the object's type. For this resource it will always be `physical_check_batch`.
Allowed:physical_check_batch
4XXReturned when the request is invalid or cannot be processed.
5XXReturned when the service encounters an internal error.

Error handling

mailing_address and return_address are required, and each must include name, line1, city, state, and postal_code. Address names, lines, and cities must be 1–35 characters; state must be 2 characters, and postal_code must match a 5-digit or ZIP+4 format. shipping_method must be usps_first_class or fedex_overnight and defaults to usps_first_class when omitted.