Refund sale

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

Refunds a sale, by ID. For a full refund, do not include the amount object in the JSON request body. For a partial refund, include an amount object in the JSON request body.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

In: header

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

Path Parameters

sale_id*string

The ID of the sale transaction to refund.

Header Parameters

PayPal-Request-Id?string

The server stores keys for 30 days.

Lengthlength <= 78

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://api-m.sandbox.paypal.com/v1/payments/sale/string/refund" \  -H "Content-Type: application/json" \  -d '{    "amount": {      "total": "100.00",      "currency": "USD"    },    "invoice_number": "INV-7654321"  }'

{
  "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"
    }
  },
  "state": "pending",
  "reason": "string",
  "sale_id": "string",
  "capture_id": "string",
  "parent_payment": "string",
  "description": "string",
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ],
  "custom": "string",
  "invoice_number": "string",
  "refund_from_transaction_fee": {
    "currency": "string",
    "value": "string"
  },
  "refund_from_received_amount": {
    "currency": "string",
    "value": "string"
  },
  "total_refunded_amount": {
    "currency": "string",
    "value": "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"
    }
  },
  "state": "pending",
  "reason": "string",
  "sale_id": "string",
  "capture_id": "string",
  "parent_payment": "string",
  "description": "string",
  "create_time": "2019-08-24T14:15:22Z",
  "update_time": "2019-08-24T14:15:22Z",
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ],
  "custom": "string",
  "invoice_number": "string",
  "refund_from_transaction_fee": {
    "currency": "string",
    "value": "string"
  },
  "refund_from_received_amount": {
    "currency": "string",
    "value": "string"
  },
  "total_refunded_amount": {
    "currency": "string",
    "value": "string"
  }
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "information_link": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "information_link": "string",
  "details": [
    {
      "field": "string",
      "value": "string",
      "location": "body",
      "issue": "string",
      "description": "string"
    }
  ],
  "links": [
    {
      "href": "string",
      "rel": "string",
      "method": "GET"
    }
  ]
}

Header Parameters

PayPal-Request-Id?string

The server stores keys for 30 days.

Lengthlength <= 78

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

amount?

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

description?string

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

Lengthlength <= 255

reason?string

The refund reason description.

Lengthlength <= 30

invoice_number?string

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

Lengthlength <= 127

curl -X POST "https://api-m.sandbox.paypal.com/v1/payments/sale/string/refund" \ -H "Content-Type: application/json" \ -d '{ "amount": { "total": "100.00", "currency": "USD" }, "invoice_number": "INV-7654321" }'

{ "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" } }, "state": "pending", "reason": "string", "sale_id": "string", "capture_id": "string", "parent_payment": "string", "description": "string", "create_time": "2019-08-24T14:15:22Z", "update_time": "2019-08-24T14:15:22Z", "links": [ { "href": "string", "rel": "string", "method": "GET" } ], "custom": "string", "invoice_number": "string", "refund_from_transaction_fee": { "currency": "string", "value": "string" }, "refund_from_received_amount": { "currency": "string", "value": "string" }, "total_refunded_amount": { "currency": "string", "value": "string" } }

{ "name": "string", "message": "string", "debug_id": "string", "information_link": "string", "details": [ { "field": "string", "value": "string", "location": "body", "issue": "string", "description": "string" } ], "links": [ { "href": "string", "rel": "string", "method": "GET" } ] }

Refund sale

200application/json

201application/json

409application/json

defaultapplication/json

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 sale

200application/json

201application/json

409application/json

defaultapplication/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`