Make offer to resolve dispute

Makes an offer to the other party to resolve a dispute, by ID. To make this call, the stage in the dispute lifecycle must be `INQUIRY`. If the customer accepts the offer, PayPal automatically makes a refund. Allowed offer_type values for the request is available in dispute details allowed response options object.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

In: header

Scope: https://uri.paypal.com/services/disputes/update-seller

Path Parameters

Header Parameters

Content-TypestringRequired

Content type of the request payload.

Match\w+\/[-+.\w]+Length1 <= length <= 255

Request Body

TypeScript Definitions

Use the request body type in TypeScript.

notestringRequired

The merchant's notes about the offer.

Match^(.|\r?\n)*$Length1 <= length <= 2000

offer_amountobject<money>Optional

The amount proposed to resolve the dispute.

return_shipping_addressobject<address_portable>OptionalDeprecated

The return address for the item. Required when the customer must return an item to the merchant for the MERCHANDISE_OR_SERVICE_NOT_AS_DESCRIBED dispute reason, especially if the refund amount is less than the dispute amount.

address_portable properties

10 properties

address_line_1stringOptional

The first line of the address. For example, number or street. For example, `173 Drury Lane`. Required for data entry and compliance and risk checks. Must contain the full address.

Length0 <= length <= 300

address_line_2stringOptional

The second line of the address. For example, suite or apartment number.

Length0 <= length <= 300

address_line_3stringOptional

The third line of the address, if needed. For example, a street complement for Brazil, direction text, such as `next to Walmart`, or a landmark in an Indian address.

Length0 <= length <= 100

admin_area_4stringOptional

The neighborhood, ward, or district. Smaller than `admin_area_level_3` or `sub_locality`. Value is:

The postal sorting code for Guernsey and many French territories, such as French Guiana.
The fine-grained administrative levels in China.

Length0 <= length <= 100

admin_area_3stringOptional

A sub-locality, suburb, neighborhood, or district. Smaller than `admin_area_level_2`. Value is:

Brazil. Suburb, bairro, or neighborhood.
India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

Length0 <= length <= 100

admin_area_2stringOptional

A city, town, or village. Smaller than `admin_area_level_1`.

Length0 <= length <= 120

admin_area_1stringOptional

The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, `CA` and not `California`. Value, by country, is:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

Length0 <= length <= 300

postal_codestringOptional

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

Length0 <= length <= 60

country_codestring<country_code>Required

The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

address_detailsobject<address_details>Optional

The non-portable additional address details that are sometimes needed for compliance, risk, or other scenarios where fine-grain address information might be needed. Not portable with common third party and open source. Redundant with core fields.
For example, `address_portable.address_line_1` is usually a combination of `address_details.street_number`, `street_name`, and `street_type`.

return_shipping_address_infoobject<return_shipping_address_info>Optional

Merchant provided information regarding return shipping address.

return_shipping_address_info properties

2 properties

save_to_profilebooleanOptional

The merchant's preference to save the return shipping address to their account profile.

addressobject<address_portable>Optional

address_portable properties

10 properties

address_line_1stringOptional

The first line of the address. For example, number or street. For example, `173 Drury Lane`. Required for data entry and compliance and risk checks. Must contain the full address.

Length0 <= length <= 300

address_line_2stringOptional

The second line of the address. For example, suite or apartment number.

Length0 <= length <= 300

address_line_3stringOptional

The third line of the address, if needed. For example, a street complement for Brazil, direction text, such as `next to Walmart`, or a landmark in an Indian address.

Length0 <= length <= 100

admin_area_4stringOptional

The neighborhood, ward, or district. Smaller than `admin_area_level_3` or `sub_locality`. Value is:

The postal sorting code for Guernsey and many French territories, such as French Guiana.
The fine-grained administrative levels in China.

Length0 <= length <= 100

admin_area_3stringOptional

A sub-locality, suburb, neighborhood, or district. Smaller than `admin_area_level_2`. Value is:

Brazil. Suburb, bairro, or neighborhood.
India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

Length0 <= length <= 100

admin_area_2stringOptional

A city, town, or village. Smaller than `admin_area_level_1`.

Length0 <= length <= 120

admin_area_1stringOptional

The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, `CA` and not `California`. Value, by country, is:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

Length0 <= length <= 300

postal_codestringOptional

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

Length0 <= length <= 60

country_codestring<country_code>Required

The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

address_detailsobject<address_details>Optional

invoice_idstringOptional

The merchant-provided ID of the invoice for the refund. This optional value maps the refund to an invoice ID in the merchant's system.

Match^.*$Length1 <= length <= 127

offer_typeenum<offer_type>Required

The merchant-proposed offer type for the dispute.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"REFUND"
"REFUND_WITH_RETURN"
"REFUND_WITH_REPLACEMENT"
"REPLACEMENT_WITHOUT_REFUND"

Response Body

`application/json`

curl -X POST "https://example.com/v1/customer/disputes/string/make-offer" \  -H "Content-Type: string" \  -H "Content-Type: application/json" \  -d '{    "note": "string",    "offer_type": "REFUND"  }'

{  "links": [    {      "href": "string",      "rel": "string",      "method": "GET",      "title": "string",      "mediaType": "string",      "encType": "application/json",      "schema": {        "additionalItems": {},        "dependencies": {},        "items": {},        "patternProperties": {},        "properties": {},        "allOf": [          {}        ],        "anyOf": [          {}        ],        "oneOf": [          {}        ],        "not": {},        "links": [          {}        ],        "fragmentResolution": "string",        "media": {          "type": "string",          "binaryEncoding": "string"        },        "pathStart": "http://example.com"      },      "targetSchema": {        "additionalItems": {},        "dependencies": {},        "items": {},        "patternProperties": {},        "properties": {},        "allOf": [          {}        ],        "anyOf": [          {}        ],        "oneOf": [          {}        ],        "not": {},        "links": [          {}        ],        "fragmentResolution": "string",        "media": {          "type": "string",          "binaryEncoding": "string"        },        "pathStart": "http://example.com"      }    }  ]}

Header Parameters

Content-TypestringRequired

Content type of the request payload.

Match\w+\/[-+.\w]+Length1 <= length <= 255

TypeScript Definitions

Use the request body type in TypeScript.

notestringRequired

The merchant's notes about the offer.

Match^(.|\r?\n)*$Length1 <= length <= 2000

offer_amountobject<money>Optional

The amount proposed to resolve the dispute.

return_shipping_addressobject<address_portable>OptionalDeprecated

address_portable properties

10 properties

address_line_1stringOptional

The first line of the address. For example, number or street. For example, `173 Drury Lane`. Required for data entry and compliance and risk checks. Must contain the full address.

Length0 <= length <= 300

address_line_2stringOptional

The second line of the address. For example, suite or apartment number.

Length0 <= length <= 300

address_line_3stringOptional

The third line of the address, if needed. For example, a street complement for Brazil, direction text, such as `next to Walmart`, or a landmark in an Indian address.

Length0 <= length <= 100

admin_area_4stringOptional

The neighborhood, ward, or district. Smaller than `admin_area_level_3` or `sub_locality`. Value is:

The postal sorting code for Guernsey and many French territories, such as French Guiana.
The fine-grained administrative levels in China.

Length0 <= length <= 100

admin_area_3stringOptional

A sub-locality, suburb, neighborhood, or district. Smaller than `admin_area_level_2`. Value is:

Brazil. Suburb, bairro, or neighborhood.
India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

Length0 <= length <= 100

admin_area_2stringOptional

A city, town, or village. Smaller than `admin_area_level_1`.

Length0 <= length <= 120

admin_area_1stringOptional

The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, `CA` and not `California`. Value, by country, is:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

Length0 <= length <= 300

postal_codestringOptional

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

Length0 <= length <= 60

country_codestring<country_code>Required

The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

address_detailsobject<address_details>Optional

return_shipping_address_infoobject<return_shipping_address_info>Optional

Merchant provided information regarding return shipping address.

return_shipping_address_info properties

2 properties

save_to_profilebooleanOptional

The merchant's preference to save the return shipping address to their account profile.

addressobject<address_portable>Optional

address_portable properties

10 properties

address_line_1stringOptional

The first line of the address. For example, number or street. For example, `173 Drury Lane`. Required for data entry and compliance and risk checks. Must contain the full address.

Length0 <= length <= 300

address_line_2stringOptional

The second line of the address. For example, suite or apartment number.

Length0 <= length <= 300

address_line_3stringOptional

The third line of the address, if needed. For example, a street complement for Brazil, direction text, such as `next to Walmart`, or a landmark in an Indian address.

Length0 <= length <= 100

admin_area_4stringOptional

The neighborhood, ward, or district. Smaller than `admin_area_level_3` or `sub_locality`. Value is:

The postal sorting code for Guernsey and many French territories, such as French Guiana.
The fine-grained administrative levels in China.

Length0 <= length <= 100

admin_area_3stringOptional

A sub-locality, suburb, neighborhood, or district. Smaller than `admin_area_level_2`. Value is:

Brazil. Suburb, bairro, or neighborhood.
India. Sub-locality or district. Street name information is not always available but a sub-locality or district can be a very small area.

Length0 <= length <= 100

admin_area_2stringOptional

A city, town, or village. Smaller than `admin_area_level_1`.

Length0 <= length <= 120

admin_area_1stringOptional

The highest level sub-division in a country, which is usually a province, state, or ISO-3166-2 subdivision. Format for postal delivery. For example, `CA` and not `California`. Value, by country, is:

UK. A county.
US. A state.
Canada. A province.
Japan. A prefecture.
Switzerland. A kanton.

Length0 <= length <= 300

postal_codestringOptional

The postal code, which is the zip code or equivalent. Typically required for countries with a postal code or an equivalent. See [postal code](https://en.wikipedia.org/wiki/Postal_code).

Length0 <= length <= 60

country_codestring<country_code>Required

The [two-character ISO 3166-1 code](/api/rest/reference/country-codes/) that identifies the country or region.

Note: The country code for Great Britain is GB and not UK as used in the top-level domain names for that country. Use the `C2` country code for China worldwide for comparable uncontrolled price (CUP) method, bank card, and cross-border transactions.

Match^([A-Z]{2}|C2)$Formatppaas_common_country_code_v2Length2 <= length <= 2

address_detailsobject<address_details>Optional

invoice_idstringOptional

The merchant-provided ID of the invoice for the refund. This optional value maps the refund to an invoice ID in the merchant's system.

Match^.*$Length1 <= length <= 127

offer_typeenum<offer_type>Required

The merchant-proposed offer type for the dispute.

Match^[0-9A-Z_]+$Length1 <= length <= 255

Allowed values

"REFUND"
"REFUND_WITH_RETURN"
"REFUND_WITH_REPLACEMENT"
"REPLACEMENT_WITHOUT_REFUND"

curl -X POST "https://example.com/v1/customer/disputes/string/make-offer" \ -H "Content-Type: string" \ -H "Content-Type: application/json" \ -d '{ "note": "string", "offer_type": "REFUND" }'

{ "links": [ { "href": "string", "rel": "string", "method": "GET", "title": "string", "mediaType": "string", "encType": "application/json", "schema": { "additionalItems": {}, "dependencies": {}, "items": {}, "patternProperties": {}, "properties": {}, "allOf": [ {} ], "anyOf": [ {} ], "oneOf": [ {} ], "not": {}, "links": [ {} ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" }, "targetSchema": { "additionalItems": {}, "dependencies": {}, "items": {}, "patternProperties": {}, "properties": {}, "allOf": [ {} ], "anyOf": [ {} ], "oneOf": [ {} ], "not": {}, "links": [ {} ], "fragmentResolution": "string", "media": { "type": "string", "binaryEncoding": "string" }, "pathStart": "http://example.com" } } ]}

Authorization

Path Parameters

Header Parameters

Request Body

money properties

address_portable properties

address_details properties

return_shipping_address_info properties

address_portable properties

address_details properties

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

On this page

On this page

On this page

Make offer to resolve dispute

Authorization

Path Parameters

Header Parameters

Request Body

money properties

address_portable properties

address_details properties

return_shipping_address_info properties

address_portable properties

address_details properties

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

On this page

On this page

Make offer to resolve dispute

money properties

address_portable properties

address_details properties

return_shipping_address_info properties

address_portable properties

address_details properties

200application/json

400application/json

422application/json

500application/json

defaultapplication/json

On this page

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

Make offer to resolve dispute

money properties

address_portable properties

address_details properties

return_shipping_address_info properties

address_portable properties

address_details properties

200application/json

400application/json

422application/json

500application/json

defaultapplication/json

On this page

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`