Skip to main content
POST
/
api
/
service
/
merchant
/
payment
/
refund
Create one Refund
curl --request POST \
  --url https://api{env}.getivy.de/api/service/merchant/payment/refund \
  --header 'Content-Type: application/json' \
  --header 'X-Ivy-Api-Key: <api-key>' \
  --data '
{
  "amount": 123,
  "orderId": "<unknown>",
  "referenceId": "<string>",
  "description": "<string>",
  "email": "[email protected]",
  "displayedPaymentReference": "<string>"
}
'
{
  "orderStatus": "failed",
  "refundStatus": "pending",
  "referenceId": "<string>",
  "orderId": "<string>"
}

Authorizations

​
X-Ivy-Api-Key
string
header
required

API key for authentication

Body

application/json
​
amount
number
required
​
orderId
any
​
referenceId
string
​
description
string
​
email
string<email>
​
displayedPaymentReference
string
Maximum string length: 16

Response

200 - application/json

Returns the refund result.

​
orderStatus
enum<string>
required
Available options:
failed,
canceled,
processing,
waiting_for_payment,
paid,
in_refund,
refunded,
refund_failed,
partially_refunded,
in_dispute,
disputed,
refused,
finalizing
​
refundStatus
enum<string>
required
Available options:
pending,
succeeded,
failed,
requires_action,
partially_refunded
​
referenceId
string
required
​
orderId
string
required