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>

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

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

refund_datestring<date_no_time>Optional

The stand-alone date, in [Internet date and time format](https://tools.ietf.org/html/rfc3339#section-5.6). To represent special legal values, such as a date of birth, you should use dates with no associated time or time-zone data. Whenever possible, use the standard `date_time` type. This regular expression does not validate all dates. For example, February 31 is valid and nothing is known about leap years.

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Length10 <= length <= 10

amountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

methodenum<payment_method>Required

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

Allowed values

"BANK_TRANSFER"
"CASH"
"CHECK"
"CREDIT_CARD"
"DEBIT_CARD"
"PAYPAL"
"WIRE_TRANSFER"
"OTHER"

Response Body

`application/json`

curl -X POST "https://example.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"}

Header Parameters

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

refund_datestring<date_no_time>Optional

Match^[0-9]{4}-(0[1-9]|1[0-2])-(0[1-9]|[1-2][0-9]|3[0-1])$Length10 <= length <= 10

amountobject<money>Optional

The currency and amount for a financial transaction, such as a balance or payment due.

methodenum<payment_method>Required

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

Allowed values

"BANK_TRANSFER"
"CASH"
"CHECK"
"CREDIT_CARD"
"DEBIT_CARD"
"PAYPAL"
"WIRE_TRANSFER"
"OTHER"

curl -X POST "https://example.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" } }'

Authorization

Path Parameters

Header Parameters

Request Body

money properties

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

On this page

On this page

On this page

Record refund for invoice

Authorization

Path Parameters

Header Parameters

Request Body

money properties

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

On this page

On this page

Record refund for invoice

money properties

200application/json

400application/json

401application/json

403application/json

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

Record refund for invoice

money properties

200application/json

400application/json

401application/json

403application/json

404application/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`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`