Create Refund

POST

/v1/refunds

Starts a asynchronous customer refund process. Created refund is final and can not be canceled. This endpoint works asynchronously, hence it may take some time to finalize the operation. Result of the process will be notified over Create Refund Webhook via RequestId.

Request

Body Params application/json

Example

{
    "refund_number": "r12345",
    "order_number": "mp_order123",
    "refund_date": "2024-09-04T23:20:21+03:00",
    "items": [
        {
            "order_item_number": "oi1",
            "quantity": 1,
            "reason": "incorrect_order",
            "amount": 2.34,
            "currency": "USD",
            "customer_explanation": "bad product"
        },
        {
            "order_item_number": "oi2",
            "quantity": 1,
            "reason": "incompatibility_issues",
            "amount": 1.23,
            "currency": "USD",
            "customer_explanation": "bad product"
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1/refunds' \
--header 'Content-Type: application/json' \
--data-raw '{
    "refund_number": "r12345",
    "order_number": "mp_order123",
    "refund_date": "2024-09-04T23:20:21+03:00",
    "items": [
        {
            "order_item_number": "oi1",
            "quantity": 1,
            "reason": "incorrect_order",
            "amount": 2.34,
            "currency": "USD",
            "customer_explanation": "bad product"
        },
        {
            "order_item_number": "oi2",
            "quantity": 1,
            "reason": "incompatibility_issues",
            "amount": 1.23,
            "currency": "USD",
            "customer_explanation": "bad product"
        }
    ]
}'

Responses

🟢200Success

application/json

Body

Example

{
    "request_id": "01J8ZCJEWZP8Q8HB5XZVCEWD1P"
}

Modified at 2025-03-27 12:45:42

Shipment Tracking With Shipment ID

Product Create