| from |
Object |
Must either be an address ID or an inline object with correct address parameters. |
|
| to |
Object |
Must either be an address ID or an inline object with correct address parameters. |
|
| bankAccount |
String |
|
|
| amount |
Double |
The payment amount to be sent in US dollars. |
|
| logo |
String |
Accepts a remote URL or local file upload to an image to print (in grayscale) in the upper-left corner of your check. |
[optional] |
| checkBottom |
String |
The artwork to use on the bottom of the check page. Notes: - HTML merge variables should not include delimiting whitespace. - PDF, PNG, and JPGs must be sized at 8.5"x11" at 300 DPI, while supplied HTML will be rendered and trimmed to fit on a 8.5"x11" page. - The check bottom will always be printed in black & white. - Must conform to this template. Need more help? Consult our HTML examples. |
[optional] |
| attachment |
String |
A document to include with the check. |
[optional] |
| description |
String |
An internal description that identifies this resource. Must be no longer than 255 characters. |
[optional] |
| metadata |
Map<String, String> |
Use metadata to store custom information for tagging and labeling back to your internal systems. Must be an object with up to 20 key-value pairs. Keys must be at most 40 characters and values must be at most 500 characters. Neither can contain the characters `"` and `\`. i.e. '{"customer_id" : "NEWYORK2015"}' Nested objects are not supported. See Metadata for more information. |
[optional] |
| mergeVariables |
Object |
You can input a merge variable payload object to your template to render dynamic content. For example, if you have a template like: `{{variable_name}}`, pass in `{"variable_name": "Harry"}` to render `Harry`. `merge_variables` must be an object. Any type of value is accepted as long as the object is valid JSON; you can use `strings`, `numbers`, `booleans`, `arrays`, `objects`, or `null`. The max length of the object is 25,000 characters. If you call `JSON.stringify` on your object, it can be no longer than 25,000 characters. Your variable names cannot contain any whitespace or any of the following special characters: `!`, `"`, `#`, `%`, `&`, `'`, `(`, `)`, `*`, `+`, `,`, `/`, `;`, `<`, `=`, `>`, `@`, `[`, `\`, `]`, `^`, `` ` ``, `{`, ` |
`, `}`, `~`. More instructions can be found in our guide to using html and merge variables. Depending on your Merge Variable strictness setting, if you define variables in your HTML but do not pass them here, you will either receive an error or the variable will render as an empty string. |
| sendDate |
OffsetDateTime |
A timestamp in ISO 8601 format which specifies a date after the current time and up to 180 days in the future to send the letter off for production. Setting a send date overrides the default cancellation window applied to the mailpiece. Until the `send_date` has passed, the mailpiece can be canceled. If a date in the format `2017-11-01` is passed, it will evaluate to midnight UTC of that date (`2017-11-01T00:00:00.000Z`). If a datetime is passed, that exact time will be used. A `send_date` passed with no time zone will default to UTC, while a `send_date` passed with a time zone will be converted to UTC. |
[optional] |
| mailType |
MailTypeEnum |
Checks must be sent `usps_first_class` |
[optional] |
| memo |
String |
Text to include on the memo line of the check. |
[optional] |
| checkNumber |
Integer |
An integer that designates the check number. |
[optional] |
| message |
String |
Max of 400 characters to be included at the bottom of the check page. |
[optional] |
| billingGroupId |
String |
An optional string with the billing group ID to tag your usage with. Is used for billing purposes. Requires special activation to use. See Billing Group API for more information. |
[optional] |