View as Markdown
API Spec (JSON)
API Spec (YAML)
Compact modeHides field descriptions and other prose for a more compact, scannable view of the API reference.Deprecation notice: TheVoids, or cancels, an order, by ID. You can only void orders that are either in the/v1/paymentsendpoint is deprecated. Use the/v2/paymentsendpoint instead. For details, see PayPal Checkout Basic Integration.
PENDING or AUTHORIZED states or those in the CAPTURED state that are not fully captured.Oauth 2.0 authentication
In: header
Scope: https://api.paypal.com/v1/payments/.*
application/json
application/json
curl -X POST "https://example.com/v1/payments/orders/string/do-void"{ "id": "string", "amount": { "currency": "string", "total": "string", "details": { "subtotal": "string", "shipping": "string", "tax": "string", "handling_fee": "string", "shipping_discount": "string", "insurance": "string", "gift_wrap": "string" } }, "payment_mode": "INSTANT_TRANSFER", "state": "PENDING", "reason_code": "PAYER_SHIPPING_UNCONFIRMED", "pending_reason": "payer_shipping_unconfirmed", "protection_eligibility": "ELIGIBLE", "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE", "parent_payment": "string", "fmf_details": { "filter_type": "ACCEPT", "filter_id": "AVS_NO_MATCH", "name": "string", "description": "string" }, "create_time": "2019-08-24T14:15:22Z", "update_time": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "method": "GET" } ]}