Peach

Create a refund for an order

POST

/orders/{orderId}/refunds

orders

Issue a full or partial refund for an order via WhatsApp Payment

Request

Authorization

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

orderId

string

required

Reference Order ID from Peach

Body Params application/json

speed

enum<string>

optional

Speed by which refund was processed. Payment Gateways are the ultimate arbitrator of which speed mode refund goes through. This might NOT always match what was included in the request parameters.

Allowed values:

normalinstant

amount

object

optional

currency

enum<string>

optional

Curreny for the order totals, currently only INR is supported.

Allowed value:

INR

value

integer

optional

Total taxes for the order. 1200 for Rs. 12.00

Example:

1200

Example

{
    "speed": "normal",
    "amount": {
        "currency": "INR",
        "value": 1200
    }
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/orders//refunds' \
--header 'Content-Type: application/json' \
--header 'Authorization;' \
--data-raw '{
    "speed": "normal",
    "amount": {
        "currency": "INR",
        "value": 1200
    }
}'

Responses

🟢201Created

application/json

Created a refund request successfully

Body

object {0}

Example

{}

Find order by ID

List available medias