postgrid_create_cheque
Generate and mail MICR-encoded checks via PostGrid. Preview details before confirming to schedule physical delivery.
Instructions
Print and mail a MICR-encoded check via PostGrid. Amount is specified in dollars and converted to cents internally. Call without confirmed=true to preview; call with confirmed=true to send.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| to | Yes | Recipient: contact ID or inline object as JSON string | |
| from | Yes | Sender: contact ID or inline object as JSON string | |
| memo | No | Check memo line (max 40 characters) | |
| amount | Yes | Check amount in dollars (e.g., 1500.00). Converted to cents internally. | |
| number | No | Check number (auto-increments if omitted) | |
| sendDate | No | Scheduled send date in YYYY-MM-DD format | |
| confirmed | No | Set to true to confirm and send. Without this, only a preview is returned. | |
| letterHTML | No | HTML content for an accompanying letter | |
| bankAccount | Yes | Bank account ID (e.g., 'bank_account_xxx') | |
| description | No | Internal description | |
| mailingClass | No | Mailing class: 'first_class' (default), 'standard_class' | |
| letterTemplate | No | Template ID for an accompanying letter |