Void authorized payment

Voids, or cancels, an authorized payment, by ID. You cannot void an authorized payment that has been fully captured.

Authorization

AuthorizationBearer <token>

OAuth 2.0 authentication

FlowClient CredentialsToken URLhttps://api-m.paypal.com/v1/oauth2/tokenInheader

Scopes

Permission to do non-real time payments like capture on authorizationhttps://uri.paypal.com/services/payments/payment/authcapture

Path Parameters

authorization_id*string

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

Match^[\S\s]*$

Length0 <= length <= 2147483647

Header Parameters

Authorization?Schema Object for standard headers

Holds authorization information for external API calls.

Match^.*$

Length1 <= length <= 16000

PayPal-Auth-Assertion?string

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.

Match^.*$

Length1 <= length <= 10000

PayPal-Request-Id?string

A unique ID identifying the request header for idempotency purposes.

Match^.*$

Length1 <= length <= 10000

Prefer?string

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.

Default"return=minimal"

Match^[\S\s]*$

Length0 <= length <= 2147483647

Response Body

`application/json`

Callbacks

curl -X POST "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \  -H "PayPal-Auth-Assertion: eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9" \  -H "PayPal-Request-Id: 17e81d06-77ab-11e8-adc0-fa71639ebebc"

{
  "id": "5C908745JK343851U",
  "status": "VOIDED",
  "amount": {
    "currency_code": "USD",
    "value": "100.00"
  },
  "invoice_id": "OrderInvoice-10_10_2024_12_06_00_pm",
  "seller_protection": {
    "status": "ELIGIBLE",
    "dispute_categories": [
      "ITEM_NOT_RECEIVED",
      "UNAUTHORIZED_TRANSACTION"
    ]
  },
  "expiration_time": "2024-11-08T09:06:03-08:00",
  "create_time": "2024-10-10T10:06:03-07:00",
  "update_time": "2024-10-10T10:06:19-07:00",
  "links": [
    {
      "href": "https://api.paypal.com/v2/payments/authorizations/5C908745JK343851U",
      "rel": "self",
      "method": "GET"
    }
  ]
}

Empty

{
  "name": "AUTHENTICATION_FAILURE",
  "debug_id": "b1d1f06c7246c",
  "message": "Authentication failed due to missing Authorization header, or invalid authentication credentials."
}

{
  "name": "NOT_AUTHORIZED",
  "debug_id": "b1d1f06c7246c",
  "message": "Authorization failed due to insufficient permissions."
}

{
  "name": "RESOURCE_NOT_FOUND",
  "debug_id": "b1d1f06c7246c",
  "message": "The specified resource does not exist."
}

{
  "name": "RESOURCE_CONFLICT",
  "debug_id": "b1d1f06c7246c",
  "message": "The server has detected a conflict while processing this request.",
  "details": [
    {
      "issue": "PREVIOUS_REQUEST_IN_PROGRESS",
      "description": "A previous request on this resource is currently in progress. Please wait for sometime and try again. It is best to space out the initial and the subsequent request(s) to avoid receiving this error."
    }
  ]
}

{
  "name": "UNPROCESSABLE_ENTITY",
  "message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
  "debug_id": "a7b0de7cb97ad",
  "details": [
    {
      "issue": "PREVIOUSLY_CAPTURED",
      "description": "Authorization has been previously captured and cannot be voided."
    }
  ],
  "links": [
    {
      "href": "https://developer.paypal.com/docs/api/payments/v2/#error-PREVIOUSLY_CAPTURED",
      "rel": "information_link"
    }
  ]
}

{
  "name": "INTERNAL_SERVER_ERROR",
  "debug_id": "b1d1f06c7246c",
  "message": "An internal server error has occurred."
}

{
  "name": "INTERNAL_SERVER_ERROR",
  "debug_id": "b1d1f06c7246c",
  "message": "An internal server error has occurred."
}

Header Parameters

Authorization?Schema Object for standard headers

Holds authorization information for external API calls.

Match^.*$

Length1 <= length <= 16000

PayPal-Auth-Assertion?string

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.

Match^.*$

Length1 <= length <= 10000

PayPal-Request-Id?string

A unique ID identifying the request header for idempotency purposes.

Match^.*$

Length1 <= length <= 10000

Prefer?string

Default"return=minimal"

Match^[\S\s]*$

Length0 <= length <= 2147483647

curl -X POST "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/void" \ -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \ -H "PayPal-Auth-Assertion: eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9" \ -H "PayPal-Request-Id: 17e81d06-77ab-11e8-adc0-fa71639ebebc"

{ "id": "5C908745JK343851U", "status": "VOIDED", "amount": { "currency_code": "USD", "value": "100.00" }, "invoice_id": "OrderInvoice-10_10_2024_12_06_00_pm", "seller_protection": { "status": "ELIGIBLE", "dispute_categories": [ "ITEM_NOT_RECEIVED", "UNAUTHORIZED_TRANSACTION" ] }, "expiration_time": "2024-11-08T09:06:03-08:00", "create_time": "2024-10-10T10:06:03-07:00", "update_time": "2024-10-10T10:06:19-07:00", "links": [ { "href": "https://api.paypal.com/v2/payments/authorizations/5C908745JK343851U", "rel": "self", "method": "GET" } ] }

{ "name": "RESOURCE_CONFLICT", "debug_id": "b1d1f06c7246c", "message": "The server has detected a conflict while processing this request.", "details": [ { "issue": "PREVIOUS_REQUEST_IN_PROGRESS", "description": "A previous request on this resource is currently in progress. Please wait for sometime and try again. It is best to space out the initial and the subsequent request(s) to avoid receiving this error." } ] }

{ "name": "UNPROCESSABLE_ENTITY", "message": "The requested action could not be performed, semantically incorrect, or failed business validation.", "debug_id": "a7b0de7cb97ad", "details": [ { "issue": "PREVIOUSLY_CAPTURED", "description": "Authorization has been previously captured and cannot be voided." } ], "links": [ { "href": "https://developer.paypal.com/docs/api/payments/v2/#error-PREVIOUSLY_CAPTURED", "rel": "information_link" } ] }

Void authorized payment

200application/json

204

401application/json

403application/json

404application/json

409application/json

422application/json

500application/json

defaultapplication/json

authorizations/{$request.path.authorization_id}/void

On this page

If you accept cookies, we’ll use them to improve and customize your experience and enable our partners to show you personalized PayPal ads when you visit other sites. Manage cookies and learn more

Void authorized payment

200application/json

204

401application/json

403application/json

404application/json

409application/json

422application/json

500application/json

defaultapplication/json

authorizations/{$request.path.authorization_id}/void

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`