Refund captured payment

请求参数

Authorization

在 Header 添加参数

Authorization

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

示例：

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

Path 参数

Header 参数

Body 参数application/json

示例

{
    "amount": {
        "value": "10.00",
        "currency_code": "USD"
    },
    "invoice_id": "{{$timestamp}}",
    "note_to_payer": "Defective product"
}

请求示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request POST 'https://api-m.sandbox.paypal.com/v2/payments/captures/{{capture_id}}/refund' \
--header 'PayPal-Request-Id: ' \
--header 'Prefer: ' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "amount": {
        "value": "10.00",
        "currency_code": "USD"
    },
    "invoice_id": "{{$timestamp}}",
    "note_to_payer": "Defective product"
}'

返回响应

🟢201201 - Partial Refund Captured Payment

application/json

Body

示例

{
    "id": "2YM97310D11241804",
    "amount": {
        "currency_code": "USD",
        "value": "40.00"
    },
    "note_to_payer": "Defective product",
    "seller_payable_breakdown": {
        "gross_amount": {
            "currency_code": "USD",
            "value": "40.00"
        },
        "paypal_fee": {
            "currency_code": "USD",
            "value": "0.00"
        },
        "net_amount": {
            "currency_code": "USD",
            "value": "40.00"
        },
        "total_refunded_amount": {
            "currency_code": "USD",
            "value": "150.00"
        }
    },
    "invoice_id": "1680812997",
    "status": "COMPLETED",
    "create_time": "2023-04-06T13:29:58-07:00",
    "update_time": "2023-04-06T13:29:58-07:00",
    "links": [
        {
            "href": "https://api.sandbox.paypal.com/v2/payments/refunds/2YM97310D11241804",
            "rel": "self",
            "method": "GET"
        },
        {
            "href": "https://api.sandbox.paypal.com/v2/payments/captures/52909142TS941641N",
            "rel": "up",
            "method": "GET"
        }
    ]
}

🟠401401 Unauthorized - Invalid Token

🟠404404 Not Found - Captured Payment Not Found

🟢201201 - Refund All Captured Payments

🟠422422 Unprocessable Entity - Capture Fully Refunded Already

🟠422422 Unprocessable Entity - Refund Capture Currency Mismatch

🟠422422 Unprocessable Entity - Refund Amount Exceeded