Cancel only when safely possible

Request only an intended cancellation. Provider confirmation may be required after submission. Returns the updated order; inspect paymentStatus for authorization cancellation or refund progress. A lost response must be resolved by reading this order before another mutation.

post/api/orders/{id}/cancel

Request

  • Base URL: https://postedly.com
  • URL: https://postedly.com/api/orders/{id}/cancel
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Response

Updated order after confirmed cancellation; refund may still be pending.

idstring uuid required
servicestring required

Recorded service; historical orders can retain a service no longer offered.

amountCentsinteger required

Amount in integer US cents; never a floating-point dollar amount.

refundedCentsinteger required

Amount in integer US cents; never a floating-point dollar amount.

currency'usd' required

Order storage uses lowercase usd; quote responses use uppercase USD.

paymentStatus'checkout_pending' | 'authorized' | 'paid' | 'failed' | 'cancelled' | 'refund_pending' | 'refunded' required

Separate from fulfillment. authorized is a hold, used for fax before capture following confirmed transmission. paid does not mean sent or delivered. refund_pending is not a completed refund.

fulfillmentStatus'awaiting_payment' | 'queued' | 'submitting' | 'submission_unknown' | 'submitted' | 'processing' | 'sent' | 'delivered' | 'failed' | 'cancelled' required

Recorded provider progression. submission_unknown requires reconciliation, never a blind resend. Fax delivered means all approved pages were confirmed by the receiving machine, not that a person read them. Postal statuses reflect available provider milestones.

createdAtstring date-time required
updatedAtstring date-time required
receiptEmailstring email

The immutable verified receipt destination; distinct from the quoted postal sender.

optionsobject required
checkoutUrlstring uri nullable

Present only while paymentStatus is checkout_pending; may be null if checkout creation has not completed. Private URL, not payment evidence.

canCancelboolean required

True for awaiting_payment or queued. Advisory snapshot; a cancellation race may still return 409.

evidenceobject

Optional provider-specific evidence. Fields vary by channel; do not assume a tracking number or proof of a recipient reading the item.

Changes

No recorded changes to this operation across all 1 revision of this API.