Sections

Business Platforms and marketplaces Enterprise

Help

FAQs Account help Technical support API Status

APIs & SDKs

JavaScript SDK React SDK REST API Server SDKs Codes Webhook events iOS Android

Refund Details

The refund details.

allowed_refund_amountobject<money>Optional

The maximum refundable amount.

money properties

2 properties

currency_codestring<currency_code>Required

The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Formatppaas_common_currency_code_v2Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

transactionsobject<refund_transaction>[]Optional

An array of refund transactions associated with the dispute.

Items1 <= length <= 100

refund_transaction properties

3 properties

idstringOptional

The ID of the transaction for the refund or recovery.

Match^[A-Za-z0-9]+$Length1 <= length <= 255

gross_amountobject<money>Optional

The gross amount of the refund.

money properties

2 properties

currency_codestring<currency_code>Required

The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Formatppaas_common_currency_code_v2Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

create_timestring<date_time>Optional

The date and time of the refund in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

Back to top

Refund Details

The refund details.

allowed_refund_amountobject<money>Optional

The maximum refundable amount.

money properties

2 properties

currency_codestring<currency_code>Required

The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Formatppaas_common_currency_code_v2Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

transactionsobject<refund_transaction>[]Optional

An array of refund transactions associated with the dispute.

Items1 <= length <= 100

refund_transaction properties

3 properties

idstringOptional

The ID of the transaction for the refund or recovery.

Match^[A-Za-z0-9]+$Length1 <= length <= 255

gross_amountobject<money>Optional

The gross amount of the refund.

money properties

2 properties

currency_codestring<currency_code>Required

The [three-character ISO-4217 currency code](/api/rest/reference/currency-codes/) that identifies the currency.

Formatppaas_common_currency_code_v2Length3 <= length <= 3

valuestringRequired

The value, which might be:

An integer for currencies like `JPY` that are not typically fractional.
A decimal fraction for currencies like `TND` that are subdivided into thousandths.

For the required number of decimal places for a currency code, see [Currency Codes](/api/rest/reference/currency-codes/).

Match^((-?[0-9]+)|(-?([0-9]+)?[.][0-9]+))$Length0 <= length <= 32

create_timestring<date_time>Optional

The date and time of the refund in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). For example, *`yyyy`*-*`MM`*-*`dd`*`T`*`HH`*:*`mm`*:*`ss`*.*`SSS`*`Z`.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])[T,t]([0-1][0-9]|2[0-3]):[0-5][0-9]:([0-5][0-9]|60)([.][0-9]+)?([Zz]|[+-][0-9]{2}:[0-9]{2})$Formatppaas_date_time_v3Length20 <= length <= 64

Refund Details

money properties

refund_transaction properties

money properties

Back to top

On this page

On this page

Refund Details

money properties

refund_transaction properties

money properties

Back to top

On this page

Refund Details

money properties

refund_transaction properties

money properties

Back to top

On this page

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 Details

money properties

refund_transaction properties

money properties

Back to top

On this page