Reauthorize authorized payment

Reauthorizes an authorized PayPal account payment, by ID. To ensure that funds are still available, reauthorize a payment after its initial three-day honor period expires. Within the 29-day authorization period, you can issue multiple re-authorizations after the honor period expires.

If 30 days have transpired since the date of the original authorization, you must create an authorized payment instead of reauthorizing the original authorized payment.

A reauthorized payment itself has a new honor period of three days.

You can reauthorize an authorized payment from 4 to 29 days after the 3-day honor period. The allowed amount depends on context and geography, for example in US it is up to 115% of the original authorized amount, not to exceed an increase of $75 USD.

Supports only the `amount` request parameter.

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 reauthorize.

Match^[\S\s]*$

Length0 <= length <= 2147483647

Header Parameters

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize" \  -H "PayPal-Request-Id: 17e81d06-77ab-11e8-adc0-fa71639ebebc" \  -H "Prefer: return=representation" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \  -H "PayPal-Auth-Assertion: eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9" \  -H "Content-Type: application/json" \  -d '{    "amount": {      "value": "10.99",      "currency_code": "USD"    }  }'

{
  "id": "8AA831015G517922L",
  "status": "CREATED",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/8AA831015G517922L"
    },
    {
      "rel": "capture",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/8AA831015G517922L/capture"
    },
    {
      "rel": "void",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/8AA831015G517922L/void"
    },
    {
      "rel": "reauthorize",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/8AA831015G517922L/reauthorize"
    }
  ]
}

{
  "id": "8AA831015G517922L",
  "status": "CREATED",
  "links": [
    {
      "rel": "self",
      "method": "GET",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/8AA831015G517922L"
    },
    {
      "rel": "capture",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/8AA831015G517922L/capture"
    },
    {
      "rel": "void",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/8AA831015G517922L/void"
    },
    {
      "rel": "reauthorize",
      "method": "POST",
      "href": "https://api-m.paypal.com/v2/payments/authorizations/8AA831015G517922L/reauthorize"
    }
  ]
}

{
  "name": "INVALID_REQUEST",
  "message": "Request is not well-formed, syntactically incorrect, or violates schema.",
  "debug_id": "90bff07028f7f",
  "details": [
    {
      "field": "/amount/value",
      "value": "123456789012345678901234567890123",
      "issue": "INVALID_STRING_MAX_LENGTH",
      "description": "the value of a field is too long.",
      "location": "body"
    }
  ]
}

{
  "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": "UNPROCESSABLE_ENTITY",
  "message": "The requested action could not be performed, semantically incorrect, or failed business validation.",
  "debug_id": "90bff07028f7f",
  "details": [
    {
      "issue": "AUTH_CURRENCY_MISMATCH",
      "description": "The currency specified during reauthorization should be the same as the currency specified in the original authorization. Please check the currency of the authorization for which you are trying to reauthorize and try again."
    }
  ],
  "links": [
    {
      "href": "https://developer.paypal.com/docs/api/payments/v2/#error-AUTH_CURRENCY_MISMATCH",
      "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

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

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount?

curl -X POST "https://api-m.paypal.com/v2/payments/authorizations/0VF52814937998046/reauthorize" \ -H "PayPal-Request-Id: 17e81d06-77ab-11e8-adc0-fa71639ebebc" \ -H "Prefer: return=representation" \ -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \ -H "PayPal-Auth-Assertion: eyJhbGciOiJub25lIn0.eyJlbWFpbCI6Im15QGVtYWlsLmNvbSJ9" \ -H "Content-Type: application/json" \ -d '{ "amount": { "value": "10.99", "currency_code": "USD" } }'

{ "id": "8AA831015G517922L", "status": "CREATED", "links": [ { "rel": "self", "method": "GET", "href": "https://api-m.paypal.com/v2/payments/authorizations/8AA831015G517922L" }, { "rel": "capture", "method": "POST", "href": "https://api-m.paypal.com/v2/payments/authorizations/8AA831015G517922L/capture" }, { "rel": "void", "method": "POST", "href": "https://api-m.paypal.com/v2/payments/authorizations/8AA831015G517922L/void" }, { "rel": "reauthorize", "method": "POST", "href": "https://api-m.paypal.com/v2/payments/authorizations/8AA831015G517922L/reauthorize" } ] }

{ "name": "INVALID_REQUEST", "message": "Request is not well-formed, syntactically incorrect, or violates schema.", "debug_id": "90bff07028f7f", "details": [ { "field": "/amount/value", "value": "123456789012345678901234567890123", "issue": "INVALID_STRING_MAX_LENGTH", "description": "the value of a field is too long.", "location": "body" } ] }

{ "name": "UNPROCESSABLE_ENTITY", "message": "The requested action could not be performed, semantically incorrect, or failed business validation.", "debug_id": "90bff07028f7f", "details": [ { "issue": "AUTH_CURRENCY_MISMATCH", "description": "The currency specified during reauthorization should be the same as the currency specified in the original authorization. Please check the currency of the authorization for which you are trying to reauthorize and try again." } ], "links": [ { "href": "https://developer.paypal.com/docs/api/payments/v2/#error-AUTH_CURRENCY_MISMATCH", "rel": "information_link" } ] }

Reauthorize authorized payment

200application/json

201application/json

400application/json

401application/json

403application/json

404application/json

422application/json

500application/json

defaultapplication/json