E-commerce Payment Gateway Documentation – Beta Version 1.0 is now available.
Read Me
FAQMerchant APIHow-ToOur Access

Refunds

Refund card or open banking payments

post

Return the funds to the customer's bank.If refunding a payment that is not yet captured it will be cancelled

Path parameters
versionstringRequired
Header parameters
X-Request-Idstring · uuidRequired

ID of the request, unique to the call, as determined by the initiating party

Body

The request for refunding a payment

paymentIdstring · max: 64Required

Unique ID of the payment

Responses
200
OK
application/json
post
POST /egw/{version}/refunds HTTP/1.1
Host: hostname
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 75

{
  "paymentId": "text",
  "instructedAmount": {
    "currency": "EUR",
    "amount": 5877.78
  }
}
{
  "refundId": "text",
  "paymentId": "text",
  "refundStatus": "INITIALIZED",
  "instructedAmount": {
    "currency": "EUR",
    "amount": 5877.78
  }
}

Revert refund for open banking payments

patch

If the refund turns out to be unsuccessful it can be revertedto align the payment status and amount with the real state

Path parameters
refundIdstring · max: 64Required

Unique ID of the refund

versionstringRequired
Header parameters
X-Request-Idstring · uuidRequired

ID of the request, unique to the call, as determined by the initiating party

Responses
200
OK
application/json
patch
PATCH /egw/{version}/refunds/{refundId}/revert HTTP/1.1
Host: hostname
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

{
  "refundId": "text",
  "paymentId": "text",
  "refundStatus": "INITIALIZED",
  "instructedAmount": {
    "currency": "EUR",
    "amount": 5877.78
  }
}
PreviousTokens

Last updated

Was this helpful?