be.feelio.mollie.handler

Class SettlementHandler

java.lang.Object

be.feelio.mollie.handler.AbstractHandler

be.feelio.mollie.handler.SettlementHandler

public class SettlementHandler
extends AbstractHandler

Handles the Settlements API Mollie docs

Author:

Wout Schoovaerts

Constructor Summary

Constructors

Constructor and Description
SettlementHandler(String baseUrl)

Method Summary

Modifier and Type	Method and Description
SettlementResponse	getNextSettlement() Retrieve the details of the current settlement that has not yet been paid out.
SettlementResponse	getNextSettlement(QueryParams params) Retrieve the details of the current settlement that has not yet been paid out.
SettlementResponse	getOpenSettlement() Retrieve the details of the open balance of the organization.
SettlementResponse	getOpenSettlement(QueryParams params) Retrieve the details of the open balance of the organization.
SettlementResponse	getSettlement(String id) Successful payments, together with refunds, captures and chargebacks are collected into settlements, which are then paid out according to your organization’s payout schedule.
SettlementResponse	getSettlement(String id, QueryParams params) Successful payments, together with refunds, captures and chargebacks are collected into settlements, which are then paid out according to your organization’s payout schedule.
Pagination<CaptureListResponse>	getSettlementCaptures(String settlementId) Retrieve all captures in a certain settlement.
Pagination<CaptureListResponse>	getSettlementCaptures(String settlementId, QueryParams params) Retrieve all captures in a certain settlement.
Pagination<ChargebackListResponse>	getSettlementChargebacks(String settlementId) Retrieve all chargebacks included in a settlement.
Pagination<ChargebackListResponse>	getSettlementChargebacks(String settlementId, QueryParams params) Retrieve all chargebacks included in a settlement.
Pagination<PaymentListResponse>	getSettlementPayments(String settlementId) Retrieve all payments included in a settlement.
Pagination<PaymentListResponse>	getSettlementPayments(String settlementId, QueryParams params) Retrieve all payments included in a settlement.
Pagination<RefundListResponse>	getSettlementRefund(String settlementId) Retrieve all refunds included in a settlement.
Pagination<RefundListResponse>	getSettlementRefund(String settlementId, QueryParams params) Retrieve all refunds included in a settlement.
Pagination<SettlementListResponse>	getSettlements() Retrieve all settlements, ordered from new to old.
Pagination<SettlementListResponse>	getSettlements(QueryParams params) Retrieve all settlements, ordered from new to old.

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

SettlementHandler

public SettlementHandler(String baseUrl)

Method Detail

getSettlement

public SettlementResponse getSettlement(String id)
                                 throws MollieException

Successful payments, together with refunds, captures and chargebacks are collected into settlements, which are then paid out according to your organization’s payout schedule. By retrieving a single settlement, you can check which payments were paid out with it, when the settlement took place, and what invoice reference was used for it.

Beside payments, settlements can be composed of other entities such as refunds, chargebacks or captures.

Parameters:

id - A settlement ID

Returns:

SettlementResponse object

Throws:

MollieException - when something went wrong

getSettlement

public SettlementResponse getSettlement(String id,
                                        QueryParams params)
                                 throws MollieException

Successful payments, together with refunds, captures and chargebacks are collected into settlements, which are then paid out according to your organization’s payout schedule. By retrieving a single settlement, you can check which payments were paid out with it, when the settlement took place, and what invoice reference was used for it.

Beside payments, settlements can be composed of other entities such as refunds, chargebacks or captures.

Parameters:

id - A settlement ID

params - a map of query params

Returns:

SettlementResponse object

Throws:

MollieException - when something went wrong

getSettlements

public Pagination<SettlementListResponse> getSettlements()
                                                  throws MollieException

Retrieve all settlements, ordered from new to old.

Returns:

Pagination object

Throws:

MollieException - when something went wrong

getSettlements

public Pagination<SettlementListResponse> getSettlements(QueryParams params)
                                                  throws MollieException

Retrieve all settlements, ordered from new to old.

Parameters:

params - a map of query params

Returns:

Pagination object

Throws:

MollieException - when something went wrong

getNextSettlement

public SettlementResponse getNextSettlement()
                                     throws MollieException

Retrieve the details of the current settlement that has not yet been paid out.

Returns:

Pagination object

Throws:

MollieException - when something went wrong

getNextSettlement

public SettlementResponse getNextSettlement(QueryParams params)
                                     throws MollieException

Retrieve the details of the current settlement that has not yet been paid out.

Parameters:

params - a map of query params

Returns:

Pagination object

Throws:

MollieException - when something went wrong

getOpenSettlement

public SettlementResponse getOpenSettlement()
                                     throws MollieException

Retrieve the details of the open balance of the organization. This will return a settlement object representing your organization’s balance.

Returns:

Pagination object

Throws:

MollieException - when something went wrong

getOpenSettlement

public SettlementResponse getOpenSettlement(QueryParams params)
                                     throws MollieException

Retrieve the details of the open balance of the organization. This will return a settlement object representing your organization’s balance.

Parameters:

params - a map of query params

Returns:

Pagination object

Throws:

MollieException - when something went wrong

getSettlementPayments

public Pagination<PaymentListResponse> getSettlementPayments(String settlementId)
                                                      throws MollieException

Retrieve all payments included in a settlement.

Note that payments for pay after delivery methods (such as Klarna Pay Later) are not listed in here. These payment methods are settled using captures. To retrieve the captures, use the List settlement captures endpoint.

Parameters:

settlementId - A settlement ID

Returns:

Pagination object

Throws:

MollieException - when something went wrong

getSettlementPayments

public Pagination<PaymentListResponse> getSettlementPayments(String settlementId,
                                                             QueryParams params)
                                                      throws MollieException

Retrieve all payments included in a settlement.

Note that payments for pay after delivery methods (such as Klarna Pay Later) are not listed in here. These payment methods are settled using captures. To retrieve the captures, use the List settlement captures endpoint.

Parameters:

settlementId - A settlement ID

params - a map of query params

Returns:

Pagination object

Throws:

MollieException - when something went wrong

getSettlementRefund

public Pagination<RefundListResponse> getSettlementRefund(String settlementId)
                                                   throws MollieException

Retrieve all refunds included in a settlement.

Parameters:

settlementId - A settlement ID

Returns:

Pagination object

Throws:

MollieException - when something went wrong

getSettlementRefund

public Pagination<RefundListResponse> getSettlementRefund(String settlementId,
                                                          QueryParams params)
                                                   throws MollieException

Retrieve all refunds included in a settlement.

Parameters:

settlementId - A settlement ID

params - a map of query params

Returns:

Pagination object

Throws:

MollieException - when something went wrong

getSettlementChargebacks

public Pagination<ChargebackListResponse> getSettlementChargebacks(String settlementId)
                                                            throws MollieException

Retrieve all chargebacks included in a settlement.

Parameters:

settlementId - A settlement ID

Returns:

Pagination object

Throws:

MollieException - when something went wrong

getSettlementChargebacks

public Pagination<ChargebackListResponse> getSettlementChargebacks(String settlementId,
                                                                   QueryParams params)
                                                            throws MollieException

Retrieve all chargebacks included in a settlement.

Parameters:

settlementId - A settlement ID

params - a map of query params

Returns:

Pagination object

Throws:

MollieException - when something went wrong

getSettlementCaptures

public Pagination<CaptureListResponse> getSettlementCaptures(String settlementId)
                                                      throws MollieException

Retrieve all captures in a certain settlement.

Captures are used for pay after delivery payment methods. The only payment methods at the moment that have this flow are Klarna Pay later and Klarna Slice it. Captures are created when (part of) an Order is shipped. The capture is then settled to the merchant

Parameters:

settlementId - A settlement ID

Returns:

Pagination object

Throws:

MollieException - when something went wrong

getSettlementCaptures

public Pagination<CaptureListResponse> getSettlementCaptures(String settlementId,
                                                             QueryParams params)
                                                      throws MollieException

Retrieve all captures in a certain settlement.

Captures are used for pay after delivery payment methods. The only payment methods at the moment that have this flow are Klarna Pay later and Klarna Slice it. Captures are created when (part of) an Order is shipped. The capture is then settled to the merchant

Parameters:

settlementId - A settlement ID

params - a map of query params

Returns:

Pagination object

Throws:

MollieException - when something went wrong