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

Authorizations

OAuth2ClientAuthentication

OpenID ConnectRequired

This API uses OAuth 2 with the client credentials flow. More info

Path parameters

versionstringRequired

Header parameters

X-Request-Idstring · uuidRequired

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

Body

application/json

The request for refunding a payment

paymentIdstring · max: 64Required

Unique ID of the payment

Responses

200

OK

application/json

The response after refunding a card payment

paymentIdstring · max: 64Optional

Unique ID of the refunded payment

refundIdstring · max: 64Optional

Unique ID of the refund

refundStatusstring · enumOptional

Current status of the refund

Possible values:

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

409

Conflict

application/json

503

Service Unavailable

application/json

post

/egw/{version}/refunds

HTTPcURLJavaScriptPython

POST /egw/{version}/refunds HTTP/1.1
Host: sandbox-api.ecomm.api.tietoevry.com
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Content-Type: application/json
Accept: */*
Content-Length: 75

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

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

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

Authorizations

OAuth2ClientAuthentication

OpenID ConnectRequired

This API uses OAuth 2 with the client credentials flow. More info

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

The response after reversing a refund

paymentIdstring · max: 64Optional

Unique ID of the refunded payment

refundIdstring · max: 64Optional

Unique ID of the refund

refundStatusstring · enumOptional

Current status of the refund

Possible values:

400

Bad Request

application/json

403

Forbidden

application/json

404

Not Found

application/json

409

Conflict

application/json

503

Service Unavailable

application/json

patch

/egw/{version}/refunds/{refundId}/revert

HTTPcURLJavaScriptPython

PATCH /egw/{version}/refunds/{refundId}/revert HTTP/1.1
Host: sandbox-api.ecomm.api.tietoevry.com
X-Request-Id: 123e4567-e89b-12d3-a456-426614174000
Accept: */*

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