Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been fully captured.
OAuth 2.0 authentication
An API-caller-provided JSON Web Token (JWT) assertion that identifies the merchant. For details, see PayPal-Auth-Assertion.
Note:For three party transactions in which a partner is managing the API calls on behalf of a merchant, the partner must identify the merchant using either a PayPal-Auth-Assertion header or an access token with target_subject.
The server stores keys for 45 days.
The preferred server response upon successful completion of the request. Value is:
return=minimal. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the id, status and HATEOAS links.return=representation. The server returns a complete resource representation, including the current state of the resource.The PayPal-generated ID for the authorized payment to void.
A successful request returns the HTTP 200 OK status code and a JSON response body that shows authorization details. This response is returned when the Prefer header is set to return=representation.
The authorized payment transaction.
The status for the authorized payment.
CREATED, CAPTURED, DENIED, PARTIALLY_CAPTURED, VOIDED, PENDING The details of the authorized order pending status.
The PayPal-generated ID for the authorized payment.
The amount for this authorized payment.
The API caller-provided external invoice number for this order. Appears in both the payer's transaction history and the emails that the payer receives.
The API caller-provided external ID. Used to reconcile API caller-initiated transactions with PayPal transactions. Appears in transaction and settlement reports.
255Reference values used by the card network to identify a transaction.
The level of protection offered as defined by PayPal Seller Protection for Merchants.
The date and time when the authorized payment expires, in Internet date and time format.
20 - 64An array of related HATEOAS links.
The date and time when the transaction occurred, in Internet date and time format.
20 - 64The date and time when the transaction was last updated, in Internet date and time format.
20 - 64An object that provides supplementary/additional data related to a payment transaction.
The details associated with the merchant for this transaction.