Ramp: Preview how an address and memo are truncated when printed on a check — request body — body
Preview how an address and memo are truncated when printed on a check: request body, field body. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Preview how an address and memo are truncated when printed on a check — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Request body for POST /developer/v1/payments/check-preview. Additional keys: not allowed |
address_line_1 | string | Required within parent | Primary address line of the recipient. Minimum length: 1 |
address_line_2 | JSON | Optional | |
address_line_2 (anyOf 1) | string | Alternative | Secondary address line of the recipient. Default: null |
address_line_2 (anyOf 2) | null | Alternative | |
city | string | Required within parent | City of the recipient. Minimum length: 1 |
entity_id | JSON | Optional | |
entity_id (anyOf 1) | string | Alternative | Unique identifier of the entity that would pay. Required when the business has multiple entities, because the entity name is printed in the check memo. Default: null Format: uuid |
entity_id (anyOf 2) | null | Alternative | |
external_invoice_number | JSON | Optional | |
external_invoice_number (anyOf 1) | string | Alternative | The invoice number that would be printed in the check memo. Default: null |
external_invoice_number (anyOf 2) | null | Alternative | |
owner_name | string | Required within parent | Name of the recipient the check is mailed to. Minimum length: 1 |
postal_code | string | Required within parent | Postal or ZIP code of the recipient. Minimum length: 1 |
secondary_owner_line | JSON | Optional | |
secondary_owner_line (anyOf 1) | string | Alternative | Additional recipient line, such as a care-of name. Default: null |
secondary_owner_line (anyOf 2) | null | Alternative | |
state | string | Required within parent | State or province of the recipient. Minimum length: 1 |