Refund Request

The refund request.

Schema Information

Type:object

Properties

amount

Type: object

The refund amount. Includes both the amount to refund to the payer and the fee amount to refund to the payee.

currencyrequired

Type: string

The three-character ISO-4217 currency code. PayPal does not support all currencies.

totalrequired

Type: string

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.

details

Type: object

The additional details about the payment amount.

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

subtotal

Type: string

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.

shipping

Type: string

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.

tax

Type: string

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_fee

Type: string

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_discount

Type: string

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.

insurance

Type: string

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_wrap

Type: string

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.

description

Type: string

Max length: 255

The refund description. Value is a string of single-byte alphanumeric characters.

reason

Type: string

Max length: 30

The refund reason description.

invoice_number

Type: string

Max length: 127

The invoice number that tracks this payment. Value is a string of single-byte alphanumeric characters.

Properties

amount

Type: object

The refund amount. Includes both the amount to refund to the payer and the fee amount to refund to the payee.

currencyrequired

Type: string

The three-character ISO-4217 currency code. PayPal does not support all currencies.

totalrequired

Type: string

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.

details

Type: object

The additional details about the payment amount.

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

subtotal

Type: string

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.

shipping

Type: string

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.

tax

Type: string

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_fee

Type: string

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_discount

Type: string

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.

insurance

Type: string

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_wrap

Type: string

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.

description

Type: string

Max length: 255

The refund description. Value is a string of single-byte alphanumeric characters.

reason

Type: string

Max length: 30

The refund reason description.

invoice_number

Type: string

Max length: 127

The invoice number that tracks this payment. Value is a string of single-byte alphanumeric characters.

Refund Request

Schema Information

Properties

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

Refund Request

Schema Information

Properties