Record refund for invoice

POST

/v2/invoicing/invoices/{invoice_id}/refunds

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

在 Header 添加参数

Authorization

，其值为在 Basic 之后拼接空格，以及经过 Base64 编码的 username:password

示例：

Authorization: Basic *****************

Path 参数

invoice_id

string

必需

(Required) The ID of the invoice to mark as refunded.

示例值:

Header 参数

Content-Type

string

必需

The Content-Type header field is used to specify the nature of the data in the body of an entity. PayPal REST APIs support application/json.

示例值:

application/json

PayPal-Request-Id

string

必需

The server stores keys for 6 hours. The API callers can request the times to up to 72 hours by speaking to their Account Manager.

示例值:

Body 参数application/json

method

string

必需

refund_date

string

必需

amount

object

必需

currency_code

string

必需

value

string

必需

示例

{
  "method": "BANK_TRANSFER",
  "refund_date": "2021-02-07",
  "amount": {
    "currency_code": "USD",
    "value": "5.00"
  }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location -g --request POST 'https://api-m.sandbox.paypal.com/v2/invoicing/invoices/{{invoice_id}}/refunds' \
--header 'PayPal-Request-Id: ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "method": "BANK_TRANSFER",
    "refund_date": "2021-02-07",
    "amount": {
        "currency_code": "USD",
        "value": "5.00"
    }
}'

返回响应

🟢200200 - Partial Refund

application/json

Body

refund_id

string

必需

示例

{
  "refund_id": "EXTR-98B36987DN684241L"
}

🟠400400 Bad Request - Invalid Refund Method

🟠401401 Unauthorized - Invalid Token

🟠404404 Not Found - Invoice Not Found

🟠422422 Unprocessable Entity - Can Not Process Refunds

🟠422422 Unprocessable Entity - Invalid Refund Amount

修改于 2023-08-16 07:18:59

Delete external payment

Delete external refund