Refunds

Payment Flow

Endpoints

Action	Endpoint
Make Refund	`POST /{paymentId}/refunds`
Retrieve Refunds	`GET /{paymentId}/refunds`

Description

A Refund is the reversal of a previously confirmed payment, either in full or partially. Merchants can create refunds for reasons such as returns, cancellations of goods and services, or goodwill. Refunds are executed via the API. Prerequisite is a captured transaction in advance.

Typical use cases/scenarios

E-Commerce Returns
- Example: Customer returns goods, merchant refunds full or partial amount.
Service Cancellation
- Example: Customer cancels a booked service before it is delivered (e.g. hotel)
Partial Refunds
- Refund of shipping costs, damaged items, or part of an order while keeping the rest intact
Goodwill

Key characteristics

Operation Type: REFUND / PARTIAL_REFUND / MULTIPLE_REFUND
Lifecycle: PENDING → SUCCESSFUL | FAILED
Precondition: Refunds are only possible when a capture/ partial capture happened beforehand.
Relation: refunds always reference a specific payment Id
Amount can be full or partial; up to the captured amount.
Purpose of use: Parameter “transactionDescription“ can be used to submit a purpose of use. It is optional but highly recommended to use, as this information is also provided to the WERO user's bank account.