Return Envelopes
Return envelopes are pre-addressed, postage-ready envelopes mailed with a payment so the payee can return documents back to you. Envelope creation, deletion, PDF templates, PNG proofs, and billing attributes (envelope_type, postage_applied, cost_per_unit) are managed by CheckIssuing staff; per policy the API exposes read access to your own envelopes plus limited updates (name and description). Create and delete requests from API clients are refused with 403.
Endpoints
| Operation | Endpoint | Access |
|---|---|---|
| List Return Envelopes | POST /v1/return-envelopes/index | Client |
| Get Return Envelope By ID | POST /v1/return-envelopes/get/{id} | Client |
| Update A Return Envelope | POST /v1/return-envelopes/update/{id} | Client (name/description only) |
| Add A Return Envelope | POST /v1/return-envelopes/create | Staff only — 403 for API clients |
| Delete A Return Envelope | POST /v1/return-envelopes/delete/{id} | Staff only — 403 for API clients |
To attach a return envelope to a payment or document, pass return_envelope_id on the Add A Payment, Update A Payment, Add A Document, or Update A Document endpoints. Envelope assignment is validated against your own active envelopes.