INincrease

Sandbox: Mail a Checkbook

Changed on

Simulates the mailing of a Checkbook, which happens periodically throughout the day in production but can be sped up in sandbox. This Checkbook must have a status of pending_submission or pending_mailing.

post/simulations/checkbooks/{checkbook_id}/mail

Request

Path parameters

checkbook_idstring required

The identifier of the Checkbook you wish to mail.

Response

Checkbook

account_number_idstring required

The identifier of the Account Number the Checkbook is attached to.

created_atstring date-time required

The ISO 8601 date and time at which the Checkbook was created.

idstring required

The Checkbook's identifier.

idempotency_keystring nullable required

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.

status'pending_submission' | 'pending_mailing' | 'mailed' | 'stopped' required

The lifecycle status of the Checkbook.

style'three_ring_binder' | 'folder' required

The physical format of the Checkbook.

type'checkbook' required

A constant representing the object's type. For this resource it will always be checkbook.

Example response

{
  "account_number_id": "account_number_v18nkfqm6afpsrvy82b2",
  "created_at": "2020-01-31T23:59:59Z",
  "id": "checkbook_7iudxhxum6vlkcjxmi8y",
  "idempotency_key": null,
  "mailing_address": {
    "city": "New York",
    "line1": "33 Liberty Street",
    "line2": null,
    "name": "Ian Crease",
    "postal_code": "10045",
    "state": "NY"
  },
  "payer": [
    {
      "contents": "National Phonograph Company"
    },
    {
      "contents": "33 Liberty Street"
    },
    {
      "contents": "New York, NY 10045"
    }
  ],
  "return_address": {
    "city": "San Francisco",
    "line1": "244 Kearny St",
    "line2": "Floor 8",
    "name": "Undeliverable Mail",
    "postal_code": "94108",
    "state": "CA"
  },
  "status": "mailed",
  "style": "three_ring_binder",
  "tracking_updates": [
    {
      "category": "in_transit",
      "country": "US",
      "created_at": "2020-01-31T23:59:59Z",
      "postal_code": "10045"
    },
    {
      "category": "delivered",
      "country": "US",
      "created_at": "2020-01-31T23:59:59Z",
      "postal_code": "10045"
    }
  ],
  "type": "checkbook"
}

Changes