Record refund for invoice

Records a refund for the invoice. If all payments are refunded, the invoice is marked as `REFUNDED`. Otherwise, the invoice is marked as `PARTIALLY REFUNDED`.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

FlowClient CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheader

Scopes

For managing (Create, Update, Delete) invoice.https://uri.paypal.com/services/invoicing/invoices/readwrite

Path Parameters

invoice_id*string

The ID of the invoice to mark as refunded.

Match^.*$

Length0 <= length <= 2147483647

Header Parameters

Authorization?Schema Object for standard headers

Holds authorization information for external API calls.

Match^.*$

Length1 <= length <= 16000

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/v2/invoicing/invoices/INV2-Z56S-5LLA-Q52L-CPZ5/refunds" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \  -H "Content-Type: application/json" \  -d '{    "method": "BANK_TRANSFER",    "refund_date": "2018-05-21",    "amount": {      "currency_code": "USD",      "value": "5.00"    }  }'

{
  "refund_id": "EXTR-2LG703375E477444T"
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [],
  "links": []
}

{
  "name": "AUTHENTICATION_FAILURE",
  "debug_id": "b1d1f06c7246c",
  "message": "Authentication failed due to missing Authorization header, or invalid authentication credentials."
}

{
  "name": "NOT_AUTHORIZED",
  "debug_id": "b1d1f06c7246c",
  "message": "Authorization failed due to insufficient permissions."
}

{
  "debug_id": "d20c2b8d8f41c",
  "links": [
    {
      "href": "https://developer.paypal.com/docs/limited-release/invoicing/#errors",
      "rel": "information_link"
    }
  ],
  "message": "The specified resource does not exist.",
  "name": "RESOURCE_NOT_FOUND"
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [],
  "links": []
}

{
  "name": "INTERNAL_SERVER_ERROR",
  "debug_id": "b1d1f06c7246c",
  "message": "An internal server error has occurred."
}

{
  "name": "INTERNAL_SERVER_ERROR",
  "debug_id": "b1d1f06c7246c",
  "message": "An internal server error has occurred."
}

Record refund for invoice

API v2

API v1

Records a refund for the invoice. If all payments are refunded, the invoice is marked as `REFUNDED`. Otherwise, the invoice is marked as `PARTIALLY REFUNDED`.

Authorization

AuthorizationBearer <token>

Oauth 2.0 authentication

FlowClient CredentialsToken URLhttps://api-m.sandbox.paypal.com/v1/oauth2/tokenInheader

Scopes

For managing (Create, Update, Delete) invoice.https://uri.paypal.com/services/invoicing/invoices/readwrite

Path Parameters

invoice_id*string

The ID of the invoice to mark as refunded.

Match^.*$

Length0 <= length <= 2147483647

Header Parameters

Authorization?Schema Object for standard headers

Holds authorization information for external API calls.

Match^.*$

Length1 <= length <= 16000

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

type?payment_type

Value in"PAYPAL" | "EXTERNAL"

refund_date?string

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$

Length10 <= length <= 10

amount?

method*payment_method

The payment mode or method through which the invoicer can accept the payments.

Response Body

`application/json`

curl -X POST "https://api-m.sandbox.paypal.com/v2/invoicing/invoices/INV2-Z56S-5LLA-Q52L-CPZ5/refunds" \  -H "Authorization: Bearer A21AAGHr9qtiRRXH4oYcQokQgV99rGqEIfgrr8xHCclP0OzmD9KVgg5ppIIg1jzJgQkV4wd02svIvBJyg6cLFJjFow_SjBhxQ" \  -H "Content-Type: application/json" \  -d '{    "method": "BANK_TRANSFER",    "refund_date": "2018-05-21",    "amount": {      "currency_code": "USD",      "value": "5.00"    }  }'

{
  "refund_id": "EXTR-2LG703375E477444T"
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [],
  "links": []
}

{
  "name": "AUTHENTICATION_FAILURE",
  "debug_id": "b1d1f06c7246c",
  "message": "Authentication failed due to missing Authorization header, or invalid authentication credentials."
}

{
  "name": "NOT_AUTHORIZED",
  "debug_id": "b1d1f06c7246c",
  "message": "Authorization failed due to insufficient permissions."
}

{
  "debug_id": "d20c2b8d8f41c",
  "links": [
    {
      "href": "https://developer.paypal.com/docs/limited-release/invoicing/#errors",
      "rel": "information_link"
    }
  ],
  "message": "The specified resource does not exist.",
  "name": "RESOURCE_NOT_FOUND"
}

{
  "name": "string",
  "message": "string",
  "debug_id": "string",
  "details": [],
  "links": []
}

{
  "name": "INTERNAL_SERVER_ERROR",
  "debug_id": "b1d1f06c7246c",
  "message": "An internal server error has occurred."
}

{
  "name": "INTERNAL_SERVER_ERROR",
  "debug_id": "b1d1f06c7246c",
  "message": "An internal server error has occurred."
}

Record refund for invoice

200application/json

400application/json

401application/json

403application/json

404application/json

422application/json

500application/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

Record refund for invoice

200application/json

400application/json

401application/json

403application/json

404application/json

422application/json

500application/json

defaultapplication/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`