Re-authorize payment

Deprecation notice: The /v1/payments endpoint is deprecated. Use the /v2/payments endpoint instead. For details, see PayPal Checkout Basic Integration.

Re-authorizes a PayPal account payment, by authorization ID. To ensure that funds are still available, re-authorize a payment after the initial three-day honor period. Supports only the amount request parameter. You can re-authorize a payment only once from four to 29 days after three-day honor period for the original authorization expires. If 30 days have passed from the original authorization, you must create a new authorization instead. A re-authorized payment itself has a new three-day honor period. You can re-authorize a transaction once for up to 115% of the originally authorized amount, not to exceed an increase of $75 USD.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

In: header

Scope: https://api.paypal.com/v1/payments/.*

Path Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amountobject<amount>Required

The amount being authorized.

amount properties

3 properties

currencystringRequired

The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/). PayPal does not support all currencies.

totalstringRequired

The total amount charged to the payee by the payer. For refunds, represents the amount that the payee refunds to the original payer. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.
For currencies like `JPY` do not support decimals.

detailsobject<Payment Amount Details>Optional

The additional details about the payment amount.

Note: For an order authorization or capture, you cannot include the amount details object.

Payment Amount Details properties

7 properties

subtotalstringOptional

The subtotal amount for the items. If the request includes line items, this property is **required**. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the subtotal parameter.

shippingstringOptional

The shipping fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the shipping parameter.

taxstringOptional

The tax. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the tax parameter.

handling_feestringOptional

The handling fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Supported for the PayPal payment method only.

Note: For an order authorization or capture, you cannot include the handling_fee parameter.

shipping_discountstringOptional

The shipping fee discount. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Supported for the PayPal payment method only.

Note: For an order authorization or capture, you cannot include the shipping_discount parameter.

insurancestringOptional

The insurance fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Supported only for the PayPal payment method.

Note: For an order authorization or capture, you cannot include the insurance parameter.

gift_wrapstringOptional

The gift wrap fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the gift_wrap parameter.

fmf_detailsobject<fmf_details>Optional

The Fraud Management Filter (FMF) details that are applied to the payment that result in an accept, deny, or pending action. Returned in a payment response only if the merchant has enabled FMF in the profile settings and one of the fraud filters was triggered based on those settings. For more information, see [Fraud Management Filters Summary](/docs/classic/fmf/integration-guide/FMFSummary/).

processor_responseobject<processor_response>Optional

The processor-provided response codes that describe the submitted payment. Supported only when the `payment_method` is `credit_card`.

Response Body

`application/json`

curl -X POST "https://example.com/v1/payments/authorization/string/reauthorize" \  -H "Content-Type: application/json" \  -d '{    "amount": {      "currency": "string",      "total": "string"    }  }'

{  "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": "AUTHORIZATION",  "pending_reason": "AUTHORIZATION",  "protection_eligibility": "ELIGIBLE",  "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE",  "fmf_details": {    "filter_type": "ACCEPT",    "filter_id": "AVS_NO_MATCH",    "name": "string",    "description": "string"  },  "parent_payment": "string",  "processor_response": {    "response_code": "stri",    "avs_code": "s",    "cvv_code": "s",    "advice_code": "01_NEW_ACCOUNT_INFORMATION",    "eci_submitted": "string",    "vpas": "string"  },  "valid_until": "2019-08-24T14:15:22Z",  "create_time": "2019-08-24T14:15:22Z",  "update_time": "2019-08-24T14:15:22Z",  "receipt_id": "string",  "links": [    {      "href": "string",      "rel": "string",      "method": "GET"    }  ]}

Deprecation notice: The /v1/payments endpoint is deprecated. Use the /v2/payments endpoint instead. For details, see PayPal Checkout Basic Integration.

Path Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amountobject<amount>Required

The amount being authorized.

amount properties

3 properties

currencystringRequired

The [three-character ISO-4217 currency code](/docs/integration/direct/rest/currency-codes/). PayPal does not support all currencies.

totalstringRequired

The total amount charged to the payee by the payer. For refunds, represents the amount that the payee refunds to the original payer. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.
For currencies like `JPY` do not support decimals.

detailsobject<Payment Amount Details>Optional

The additional details about the payment amount.

Note: For an order authorization or capture, you cannot include the amount details object.

Payment Amount Details properties

7 properties

subtotalstringOptional

The subtotal amount for the items. If the request includes line items, this property is **required**. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the subtotal parameter.

shippingstringOptional

The shipping fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the shipping parameter.

taxstringOptional

The tax. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the tax parameter.

handling_feestringOptional

The handling fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Supported for the PayPal payment method only.

Note: For an order authorization or capture, you cannot include the handling_fee parameter.

shipping_discountstringOptional

The shipping fee discount. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Supported for the PayPal payment method only.

Note: For an order authorization or capture, you cannot include the shipping_discount parameter.

insurancestringOptional

The insurance fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Supported only for the PayPal payment method.

Note: For an order authorization or capture, you cannot include the insurance parameter.

gift_wrapstringOptional

The gift wrap fee. Maximum length is 10 characters, which includes:

Seven digits before the decimal point.
The decimal point.
Two digits after the decimal point.

Note: For an order authorization or capture, you cannot include the gift_wrap parameter.

fmf_detailsobject<fmf_details>Optional

processor_responseobject<processor_response>Optional

The processor-provided response codes that describe the submitted payment. Supported only when the `payment_method` is `credit_card`.

curl -X POST "https://example.com/v1/payments/authorization/string/reauthorize" \ -H "Content-Type: application/json" \ -d '{ "amount": { "currency": "string", "total": "string" } }'

{ "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": "AUTHORIZATION", "pending_reason": "AUTHORIZATION", "protection_eligibility": "ELIGIBLE", "protection_eligibility_type": "ITEM_NOT_RECEIVED_ELIGIBLE", "fmf_details": { "filter_type": "ACCEPT", "filter_id": "AVS_NO_MATCH", "name": "string", "description": "string" }, "parent_payment": "string", "processor_response": { "response_code": "stri", "avs_code": "s", "cvv_code": "s", "advice_code": "01_NEW_ACCOUNT_INFORMATION", "eci_submitted": "string", "vpas": "string" }, "valid_until": "2019-08-24T14:15:22Z", "create_time": "2019-08-24T14:15:22Z", "update_time": "2019-08-24T14:15:22Z", "receipt_id": "string", "links": [ { "href": "string", "rel": "string", "method": "GET" } ]}

Authorization

Path Parameters

Request Body

amount properties

Payment Amount Details properties

Response Body

`application/json`

`application/json`

On this page

On this page

On this page

Re-authorize payment

Authorization

Path Parameters

Request Body

amount properties

Payment Amount Details properties

Response Body

`application/json`

`application/json`

On this page

On this page

Re-authorize payment

amount properties

Payment Amount Details properties

201application/json

defaultapplication/json

On this page

On this page

On this page

We currently use cookies to improve and customize your experience on our site. If you accept, we’ll also use marketing cookies to show you personalized ads. Manage your cookies and learn more.

Re-authorize payment

amount properties

Payment Amount Details properties

201application/json

defaultapplication/json

On this page

On this page

`application/json`

`application/json`

`application/json`

`application/json`