Refund Payment

POST

/admin/payments/{id}/refund

Refund a payment. The payment must be captured first.

Request

Path Params

Body Params application/json

Example

{
    "amount": 0,
    "reason": "string",
    "note": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.medusa-commerce.com/admin/payments//refund' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 0,
    "reason": "string",
    "note": "string"
}'

Responses

🟢200OK

application/json

Body

Example

{
    "refund": {
        "id": "ref_01G1G5V27GYX4QXNARRQCW1N8T",
        "order_id": "order_01G8TJSYT9M6AVS5N4EMNFS1EK",
        "order": {},
        "payment_id": "pay_01G8ZCC5W42ZNY842124G7P5R9",
        "payment": {},
        "amount": 1000,
        "note": "I didn't like it",
        "created_at": "2019-08-24T14:15:22Z",
        "updated_at": "2019-08-24T14:15:22Z",
        "reason": "discount",
        "idempotency_key": "string",
        "metadata": {
            "car": "white"
        }
    }
}

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error

Modified at 2023-10-08 12:50:29

Get Payment details

Delete a Payment Collection