Pay a prepared order with MPP
postalform.pay_orderGet an MPP challenge or pay an existing MPP PDF, letter, workflow-form order, or bulk letter campaign after buyer approval. Use the order_id returned by any draft tool with payment_protocol=mpp or by create_machine_order. When switching from create_machine_order, omit the credential first to get this payment endpoint’s challenge. Review the preview or campaign_url, recipient count and total. No document or addresses are resubmitted. Without payment_authorization this only returns a challenge; with it, this can pay and send real mail. Reuse the same order_id on retries and follow the returned payment status.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| order_id | Yes | ||
| payment_authorization | No | Buyer-approved MPP Authorization header, usually Payment ... . Omit to retrieve the challenge. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| bulk | No | ||
| view | Yes | ||
| status | Yes | ||
| is_paid | Yes | ||
| paid_at | Yes | ||
| payment | No | ||
| currency | Yes | ||
| endpoint | Yes | ||
| order_id | Yes | ||
| protocol | Yes | ||
| next_step | No | ||
| price_usd | Yes | ||
| page_count | No | ||
| request_id | Yes | ||
| status_url | No | ||
| next_action | No | ||
| preview_url | No | ||
| campaign_url | No | ||
| checkout_url | No | ||
| postcard_size | Yes | ||
| mailpiece_type | Yes | ||
| payment_status | Yes | ||
| payment_options | No | ||
| order_complete_url | Yes | ||
| payment_status_label | Yes | ||
| payment_status_description | Yes |