be.feelio.mollie.handler

Class RefundHandler

java.lang.Object

be.feelio.mollie.handler.AbstractHandler

be.feelio.mollie.handler.RefundHandler

public class RefundHandler
extends AbstractHandler

Handles the Refund API Mollie docs

Author:

Wout Schoovaerts

Constructor Summary

Constructors

Constructor and Description
RefundHandler(String baseUrl)

Method Summary

Modifier and Type	Method and Description
void	cancelRefund(String paymentId, String refundId) For certain payment methods, like iDEAL, the underlying banking system will delay refunds until the next day.
void	cancelRefund(String paymentId, String refundId, QueryParams params) For certain payment methods, like iDEAL, the underlying banking system will delay refunds until the next day.
RefundResponse	createRefund(String paymentId, RefundRequest body) Most payment methods support refunds.
RefundResponse	createRefund(String paymentId, RefundRequest body, QueryParams params) Most payment methods support refunds.
RefundResponse	getRefund(String paymentId, String refundId) Retrieve a single refund by its ID.
RefundResponse	getRefund(String paymentId, String refundId, QueryParams params) Retrieve a single refund by its ID.
Pagination<RefundListResponse>	listRefunds() Retrieve refunds.
Pagination<RefundListResponse>	listRefunds(QueryParams params) Retrieve refunds.
Pagination<RefundListResponse>	listRefunds(String paymentId) Retrieve refunds.
Pagination<RefundListResponse>	listRefunds(String paymentId, QueryParams params) Retrieve refunds.

Methods inherited from class be.feelio.mollie.handler.AbstractHandler

delete, delete, delete, get, get, patch, patch, post, post, postWithoutBody, validateResponse

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RefundHandler

public RefundHandler(String baseUrl)

Method Detail

createRefund

public RefundResponse createRefund(String paymentId,
                                   RefundRequest body)
                            throws MollieException

Most payment methods support refunds. This means you can request your payment to be refunded to your customer. The refunded amount will be withheld from your next settlement.

Refunds are not available at all for Bitcoin, paysafecard and gift cards. If you need to refund direct debit payments, please contact our support department.

Refunds support descriptions, which we will show in the Dashboard, your exports and pass to your customer if possible.

If you have insufficient balance with Mollie to perform the refund, the refund will be queued. We will automatically process the refund once your balance increases.

Any payments created for Orders can also be refunded using the Payment Refunds API. However, we recommend using the Order Refund API in those cases so you can pass the order lines you are refunding too. For pay after delivery methods, this is mandatory.

Possible errors¶ Sometimes a situation can occur in which it is not possible to perform the refund. In such cases an HTTP 4xx error will be returned. Some of these situations are illustrated here:

There might not be enough balance on your account with the payment provider (e.g. PayPal). You may have forgotten to grant the appropriate rights to Mollie for the payment provider (PayPal only). It is possible that the payment has already been (partially) refunded. It is not always possible to do a partial refund. If you perform many refunds in parallel, you may get an HTTP 503 Service unavailable error. In this case, you can be certain the refund was not performed and you can safely retry the refund.

If there is a connection issue during the creation of a refund (e.g. a client-side time out is triggered) you should not retry automatically as you cannot be sure the refund has been performed or not. In this case we suggest logging into the Mollie Dashboard, or retrieving the payment’s refunds via the API to validate if the refund has been created.

Parameters:

paymentId - the payment id for the payment that needs to be refunded

body - RefundRequest object

Returns:

RefundResponse object

Throws:

MollieException - when something went wrong

createRefund

public RefundResponse createRefund(String paymentId,
                                   RefundRequest body,
                                   QueryParams params)
                            throws MollieException

Most payment methods support refunds. This means you can request your payment to be refunded to your customer. The refunded amount will be withheld from your next settlement.

Refunds are not available at all for Bitcoin, paysafecard and gift cards. If you need to refund direct debit payments, please contact our support department.

Refunds support descriptions, which we will show in the Dashboard, your exports and pass to your customer if possible.

If you have insufficient balance with Mollie to perform the refund, the refund will be queued. We will automatically process the refund once your balance increases.

Any payments created for Orders can also be refunded using the Payment Refunds API. However, we recommend using the Order Refund API in those cases so you can pass the order lines you are refunding too. For pay after delivery methods, this is mandatory.

Possible errors¶ Sometimes a situation can occur in which it is not possible to perform the refund. In such cases an HTTP 4xx error will be returned. Some of these situations are illustrated here:

There might not be enough balance on your account with the payment provider (e.g. PayPal). You may have forgotten to grant the appropriate rights to Mollie for the payment provider (PayPal only). It is possible that the payment has already been (partially) refunded. It is not always possible to do a partial refund. If you perform many refunds in parallel, you may get an HTTP 503 Service unavailable error. In this case, you can be certain the refund was not performed and you can safely retry the refund.

If there is a connection issue during the creation of a refund (e.g. a client-side time out is triggered) you should not retry automatically as you cannot be sure the refund has been performed or not. In this case we suggest logging into the Mollie Dashboard, or retrieving the payment’s refunds via the API to validate if the refund has been created.

Parameters:

paymentId - the payment id for the payment that needs to be refunded

body - RefundRequest object

params - A map of query params

Returns:

RefundResponse object

Throws:

MollieException - when something went wrong

getRefund

public RefundResponse getRefund(String paymentId,
                                String refundId)
                         throws MollieException

Retrieve a single refund by its ID. Note the original payment’s ID is needed as well.

Parameters:

paymentId - the payment id for of the refund

refundId - the refund id

Returns:

RefundResponse object

Throws:

MollieException - when something went wrong

getRefund

public RefundResponse getRefund(String paymentId,
                                String refundId,
                                QueryParams params)
                         throws MollieException

Retrieve a single refund by its ID. Note the original payment’s ID is needed as well.

Parameters:

paymentId - the payment id for of the refund

refundId - the refund id

params - A map of query params

Returns:

RefundResponse object

Throws:

MollieException - when something went wrong

cancelRefund

public void cancelRefund(String paymentId,
                         String refundId)
                  throws MollieException

For certain payment methods, like iDEAL, the underlying banking system will delay refunds until the next day. Until that time, refunds may be canceled manually in your Mollie account, or automatically by using this endpoint.

The refund can only be canceled while the refund’s status field is either queued or pending. See Get payment refund for more information.

Parameters:

paymentId - the payment id off the refund

refundId - the refund id

Throws:

MollieException - when something went wrong

cancelRefund

public void cancelRefund(String paymentId,
                         String refundId,
                         QueryParams params)
                  throws MollieException

For certain payment methods, like iDEAL, the underlying banking system will delay refunds until the next day. Until that time, refunds may be canceled manually in your Mollie account, or automatically by using this endpoint.

The refund can only be canceled while the refund’s status field is either queued or pending. See Get payment refund for more information.

Parameters:

paymentId - the payment id off the refund

refundId - the refund id

params - A map of query params

Throws:

MollieException - when something went wrong

listRefunds

public Pagination<RefundListResponse> listRefunds()
                                           throws MollieException

Retrieve refunds.

only refunds for the corresponding website profile and mode are returned.

The results are paginated

Returns:

paginated response of RefundResponse objects

Throws:

MollieException - when something went wrong

listRefunds

public Pagination<RefundListResponse> listRefunds(QueryParams params)
                                           throws MollieException

Retrieve refunds.

only refunds for the corresponding website profile and mode are returned.

The results are paginated

Parameters:

params - A map of query params

Returns:

paginated response of RefundResponse objects

Throws:

MollieException - when something went wrong

listRefunds

public Pagination<RefundListResponse> listRefunds(String paymentId)
                                           throws MollieException

Retrieve refunds.

only refunds for that specific payment are returned.

The results are paginated

Parameters:

paymentId - a payment id

Returns:

paginated response of RefundResponse objects

Throws:

MollieException - when something went wrong

listRefunds

public Pagination<RefundListResponse> listRefunds(String paymentId,
                                                  QueryParams params)
                                           throws MollieException

Retrieve refunds.

only refunds for that specific payment are returned.

The results are paginated

Parameters:

paymentId - a payment id

params - A map of query params

Returns:

paginated response of RefundResponse objects

Throws:

MollieException - when something went wrong