Void authorized payment

POST/v2/payments/authorizations/{authorization_id}/void

Use it in a workflow

Add a step and choose the PayPal connector.
Pick the Void authorized payment action (under Payments).
Fill in the fields below, then reference the result from later steps as {{voidAuthorizedPayment.response.data}}.

Request

Path parameters

authorization_idstringrequired

The PayPal-generated ID for the authorized payment to void.

Headers

Authorizationstring

Holds authorization information for external API calls.

PayPal-Auth-Assertionstring

Header for an API client-provided JWT assertion that identifies the merchant. Establishing the consent to act-on-behalf of a merchant is a prerequisite for using this header.

PayPal-Request-Idstring

A unique ID identifying the request header for idempotency purposes.

Preferstring

The preferred server response upon successful completion of the request. Value is:<ul><li><code>return=minimal</code>. The server returns a minimal response to optimize communication between the API caller and the server. A minimal response includes the <code>id</code>, <code>status</code> and HATEOAS links.</li><li><code>return=representation</code>. The server returns a complete resource representation, including the current state of the resource.</li></ul>

Default "return=minimal"

Response

Returns 200 with an object. Read it in later steps with {{voidAuthorizedPayment.response.data.<field>}}.

Need more? See the PayPal guide for connection setup and behaviour shared by every action.

Was this page helpful?