POST
/
api
/
service
/
merchant
/
payment
/
refund
/
batch
curl --request POST \
  --url https://api.sand.getivy.de/api/service/merchant/payment/refund/batch \
  --header 'Content-Type: application/json' \
  --header 'X-Ivy-Api-Key: <api-key>' \
  --data '{
  "requestedRefunds": [
    {
      "orderId": "<string>",
      "referenceId": "<string>",
      "amount": 123,
      "description": "<string>",
      "email": "<string>",
      "displayedPaymentReference": "<string>"
    }
  ]
}'
{
  "requestedRefunds": [
    {
      "orderId": "<string>",
      "referenceId": "<string>",
      "orderStatus": "failed",
      "refundStatus": "pending",
      "error": "<string>"
    }
  ]
}

Authorizations

​
X-Ivy-Api-Key
string
header
required

Body

application/json
​
requestedRefunds
object[]
required

An array of refunds to be triggered.

Response

200 - application/json
Returns the refund results and associated errors.
​
requestedRefunds
object[]
required

An array of refund responses.

Retrieve a SubaccountCreate one Refund