Ramp: Preview how an address and memo are truncated when printed on a check
Ramp payment.postPaymentCheckPreviewResource: arguments, response, policy and SDK examples.
← Payment operations · Get started
Operation ramp.post_payment_check_preview_resource
Provider route: POST /developer/v1/payments/check-preview. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/ramp with npm, or alter-sdk-ramp with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { RampIntegration } from "@alter-ai/ramp";
async function execute(input: Parameters<RampIntegration["payment"]["postPaymentCheckPreviewResource"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new RampIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.payment.postPaymentCheckPreviewResource(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_ramp import RampIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = RampIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.payment.post_payment_check_preview_resource(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Required within parent | Expand Preview how an address and memo are truncated when printed on a check — request body — body |
Referenced models: Preview how an address and memo are truncated when printed on a check — request body — body
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Preview how an address and memo are truncated when printed on a check — response body |
Referenced models: Preview how an address and memo are truncated when printed on a check — response body
Schemas
Section titled “Schemas”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 |
Preview how an address and memo are truncated when printed on a check — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A physical check's recipient address and memo as they would be printed. |
address | Model | Required within parent | Expand Preview how an address and memo are truncated when printed on a check — response body — address The recipient address as it would be printed. |
memo | string | Required within parent | The memo line as it would be printed. |
Referenced models: Preview how an address and memo are truncated when printed on a check — response body — address
Preview how an address and memo are truncated when printed on a check — response body — address
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | An address as it would be printed on a physical check. |
address_line_1 | string | Required within parent | First delivery line as it would be printed. |
address_line_2 | string | Required within parent | Second delivery line as it would be printed. Empty when the address fits on one line. |
city | string | Required within parent | City as it would be printed. |
owner_name | string | Required within parent | Recipient name as it would be printed. |
postal_code | string | Required within parent | Postal code as it would be printed. |
state | JSON | Required within parent | |
state (anyOf 1) | string | Alternative | Two-letter state abbreviation as it would be printed, or null when the state could not be resolved. |
state (anyOf 2) | null | Alternative |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: ramp.post_payment_check_preview_resource. Catalog operation: post_payment_check_preview_resource. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["payments:read"]