This endpoint allows you to create a box containing up to 100 cheques.
A Box is mailed to a single destination.

To create a box. You must specify:

  • to: The recipient (contact or contact ID)
  • from: The sender (contact or contact ID)
  • cheques: An array of cheques to go in the box

For each cheque You must specify:

  • to: The recipient (contact or contact ID)
  • from: The sender (contact or contact ID)
  • bankAccount: The bank account ID
  • amount: The amount to be sent
  • number: The cheque number
Log in to see full request history
timestatususer agent
Retrieving recent requests…
LoadingLoading…
Body Params

The details of the box to create.

object

These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template exactly as they are case-sensitive. Note that these do not apply to PDFs uploaded with the order.

string

An optional string describing this resource. Will be visible in the API and the dashboard.

object

See the section on Metadata.

date-time

This order will transition from ready to printing on the day after this date. You can use this parameter to schedule orders for a future date.

string

The mailing class of this order. If not provided, automatically set to first_class.

required

The recipient of this order. You can either supply the contact information inline here or provide a contact ID. PostGrid will automatically deduplicate contacts regardless of whether you provide the information inline here or call the contact creation endpoint.

required

The 'from' (sender) of the entire box. Accepts inline ContactCreate or a contactID.

array of objects
required
length ≤ 100

The cheques to be mailed in the box. Only 100 cheques can be included in a box at a time.

cheques*
Responses

Language
Credentials
Click Try It! to start a request and see the response here! Or choose an example:
application/json