be.woutschoovaerts.mollie.handler

Class PaymentHandler

java.lang.Object

be.woutschoovaerts.mollie.handler.AbstractHandler

be.woutschoovaerts.mollie.handler.PaymentHandler

public class PaymentHandler
extends AbstractHandler

Handles the Payments API Mollie docs

Author:

Wout Schoovaerts

Field Summary

Fields inherited from class be.woutschoovaerts.mollie.handler.AbstractHandler

config

Constructor Summary

Constructors

Constructor and Description
PaymentHandler(String baseUrl, Config config)

Method Summary

Modifier and Type	Method and Description
PaymentResponse	cancelPayment(String paymentId) Some payment methods are cancellable for an amount of time, usually until the next day.
PaymentResponse	cancelPayment(String paymentId, QueryParams params) Some payment methods are cancellable for an amount of time, usually until the next day.
PaymentResponse	createPayment(PaymentRequest body) Payment creation is elemental to the Mollie API: this is where most payment implementations start off.
PaymentResponse	createPayment(PaymentRequest body, QueryParams params) Payment creation is elemental to the Mollie API: this is where most payment implementations start off.
PaymentResponse	getPayment(String paymentId) Retrieve a single payment object by its payment token.
PaymentResponse	getPayment(String paymentId, QueryParams params) Retrieve a single payment object by its payment token.
Pagination<PaymentListResponse>	listPayments() Retrieve all payments created with the current website profile, ordered from newest to oldest.
Pagination<PaymentListResponse>	listPayments(QueryParams params) Retrieve all payments created with the current website profile, ordered from newest to oldest.

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

delete, delete, delete, delete, get, 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

PaymentHandler

public PaymentHandler(String baseUrl,
                      Config config)

Method Detail

createPayment

public PaymentResponse createPayment(PaymentRequest body)
                              throws MollieException

Payment creation is elemental to the Mollie API: this is where most payment implementations start off.

Parameters:

body - PaymentRequest can be build with the builder pattern

Returns:

The payment response from mollie

Throws:

MollieException - when something went wrong

createPayment

public PaymentResponse createPayment(PaymentRequest body,
                                     QueryParams params)
                              throws MollieException

Payment creation is elemental to the Mollie API: this is where most payment implementations start off.

Parameters:

body - PaymentRequest can be build with the builder pattern

params - A map of query parameters

Returns:

The payment response from mollie

Throws:

MollieException - when something went wrong

getPayment

public PaymentResponse getPayment(String paymentId)
                           throws MollieException

Retrieve a single payment object by its payment token.

Parameters:

paymentId - payment token

Returns:

The payment response from mollie

Throws:

MollieException - when something went wrong

getPayment

public PaymentResponse getPayment(String paymentId,
                                  QueryParams params)
                           throws MollieException

Retrieve a single payment object by its payment token.

Parameters:

paymentId - payment token

params - A map of query parameters

Returns:

The payment response from mollie

Throws:

MollieException - when something went wrong

cancelPayment

public PaymentResponse cancelPayment(String paymentId)
                              throws MollieException

Some payment methods are cancellable for an amount of time, usually until the next day. Or as long as the payment status is open. Payments may be canceled manually from the Dashboard, or automatically by using this endpoint.

The isCancelable property on the Payment object will indicate if the payment can be canceled.

Parameters:

paymentId - payment token

Returns:

The payment response from mollie

Throws:

MollieException - when something went wrong

cancelPayment

public PaymentResponse cancelPayment(String paymentId,
                                     QueryParams params)
                              throws MollieException

Some payment methods are cancellable for an amount of time, usually until the next day. Or as long as the payment status is open. Payments may be canceled manually from the Dashboard, or automatically by using this endpoint.

The isCancelable property on the Payment object will indicate if the payment can be canceled.

Parameters:

paymentId - payment token

params - A map of query parameters

Returns:

The payment response from mollie

Throws:

MollieException - when something went wrong

listPayments

public Pagination<PaymentListResponse> listPayments()
                                             throws MollieException

Retrieve all payments created with the current website profile, ordered from newest to oldest.

The results are paginated.

Returns:

paginated payment response list

Throws:

MollieException - when something went wrong

listPayments

public Pagination<PaymentListResponse> listPayments(QueryParams params)
                                             throws MollieException

Retrieve all payments created with the current website profile, ordered from newest to oldest.

The results are paginated.

Parameters:

params - A map of query parameters

Returns:

paginated payment response list

Throws:

MollieException - when something went wrong