java.lang.Object
- com.mercadopago.client.MercadoPagoClient
- - com.mercadopago.client.payment.PaymentClient

public class PaymentClient
extends MercadoPagoClient

Client responsible for performing payment actions.

Field Summary
- Fields inherited from class com.mercadopago.client.MercadoPagoClient
  defaultHeaders, httpClient

Constructor Summary

Constructors
Constructor Description

PaymentClient()
Default constructor.

PaymentClient(MPHttpClient httpClient)
Constructor used for providing a custom http client.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Payment`	`cancel(Long id)`	Method responsible for cancel payment.
`Payment`	`cancel(Long id, MPRequestOptions requestOptions)`	Method responsible for cancel payment with request options.
`Payment`	`capture(Long id)`	Method responsible for capture payment.
`Payment`	`capture(Long id, MPRequestOptions requestOptions)`	Method responsible for capture payment.
`Payment`	`capture(Long id, BigDecimal amount)`	Method responsible for capture payment.
`Payment`	`capture(Long id, BigDecimal amount, MPRequestOptions requestOptions)`	Method responsible for capture payment.
`Payment`	`create(PaymentCreateRequest request)`	Method responsible for creating payment.
`Payment`	`create(PaymentCreateRequest request, MPRequestOptions requestOptions)`	Method responsible for creating payment with request options.
`Payment`	`get(Long id)`	Method responsible for getting payment.
`Payment`	`get(Long id, MPRequestOptions requestOptions)`	Method responsible for getting payment.
`PaymentRefund`	`getRefund(Long paymentId, Long refundId)`	Gets a refund by id from the payment.
`PaymentRefund`	`getRefund(Long paymentId, Long refundId, MPRequestOptions requestOptions)`	Gets a refund by id from the payment.
`MPResourceList<PaymentRefund>`	`listRefunds(Long paymentId)`	Lists the refunds of the payment.
`MPResourceList<PaymentRefund>`	`listRefunds(Long paymentId, MPRequestOptions requestOptions)`	Lists the refunds of the payment.
`PaymentRefund`	`refund(Long paymentId)`	Creates a total refund for payment.
`PaymentRefund`	`refund(Long paymentId, MPRequestOptions requestOptions)`	Creates a total refund for payment.
`PaymentRefund`	`refund(Long paymentId, BigDecimal amount)`	Creates a refund for payment.
`PaymentRefund`	`refund(Long paymentId, BigDecimal amount, MPRequestOptions requestOptions)`	Creates a refund for payment.
`MPResultsResourcesPage<Payment>`	`search(MPSearchRequest request)`	Method responsible for search payments.
`MPResultsResourcesPage<Payment>`	`search(MPSearchRequest request, MPRequestOptions requestOptions)`	Method responsible for search payments.

Methods inherited from class com.mercadopago.client.MercadoPagoClient
list, list, search, search, send, send, send, send

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- PaymentClient
```
public PaymentClient()
```
  Default constructor. Uses the default http client used by the SDK.
- PaymentClient
```
public PaymentClient(MPHttpClient httpClient)
```
  Constructor used for providing a custom http client.
  
  Parameters:
  
  httpClient - httpClient

Method Detail

get
```
public Payment get(Long id)
            throws MPException,
                   MPApiException
```
Method responsible for getting payment.

Parameters:

id - paymentId

Returns:

payment

Throws:

MPException - an error if the request fails

MPApiException

get

public Payment get(Long id,
                   MPRequestOptions requestOptions)
            throws MPException,
                   MPApiException

Method responsible for getting payment.

Parameters:: id - paymentId; requestOptions - metadata to customize the request
Returns:: payment
Throws:: MPException - an error if the request fails; MPApiException

create
```
public Payment create(PaymentCreateRequest request)
               throws MPException,
                      MPApiException
```
Method responsible for creating payment.

Parameters:

request - request

Returns:

payment response

Throws:

MPException - an error if the request fails

MPApiException

create

public Payment create(PaymentCreateRequest request,
                      MPRequestOptions requestOptions)
               throws MPException,
                      MPApiException

Method responsible for creating payment with request options.

Parameters:: request - request; requestOptions - metadata to customize the request
Returns:: payment response
Throws:: MPException - an error if the request fails; MPApiException

cancel
```
public Payment cancel(Long id)
               throws MPException,
                      MPApiException
```
Method responsible for cancel payment.

Parameters:

id - id

Returns:

Payment payment that was cancelled

Throws:

MPException - an error if the request fails

MPApiException

cancel
```
public Payment cancel(Long id,
                      MPRequestOptions requestOptions)
               throws MPException,
                      MPApiException
```
Method responsible for cancel payment with request options.

Parameters:

id - payment id

requestOptions - metadata to customize the request

Returns:

Payment payment that was cancelled

Throws:

MPException - an error if the request fails

MPApiException

capture
```
public Payment capture(Long id)
                throws MPException,
                       MPApiException
```
Method responsible for capture payment.

Parameters:

id - id

Returns:

Payment payment that was captured

Throws:

MPException - an error if the request fails

MPApiException

capture

public Payment capture(Long id,
                       MPRequestOptions requestOptions)
                throws MPException,
                       MPApiException

Method responsible for capture payment.

Parameters:: id - id; requestOptions - metadata to customize the request
Returns:: Payment payment that was captured
Throws:: MPException - an error if the request fails; MPApiException

capture

public Payment capture(Long id,
                       BigDecimal amount)
                throws MPException,
                       MPApiException

Method responsible for capture payment.

Parameters:: id - id; amount - amount to be captured
Returns:: Payment payment that was captured
Throws:: MPException - an error if the request fails; MPApiException

capture

public Payment capture(Long id,
                       BigDecimal amount,
                       MPRequestOptions requestOptions)
                throws MPException,
                       MPApiException

Method responsible for capture payment.

Parameters:: id - paymentId; amount - amount to be captured; requestOptions - metadata to customize the request
Returns:: Payment payment that was captured
Throws:: MPException - an error if the request fails; MPApiException

search

public MPResultsResourcesPage<Payment> search(MPSearchRequest request)
                                       throws MPException,
                                              MPApiException

Method responsible for search payments.

Parameters:: request - search request information
Returns:: list of results
Throws:: MPException - an error if the request fails; MPApiException

search

public MPResultsResourcesPage<Payment> search(MPSearchRequest request,
                                              MPRequestOptions requestOptions)
                                       throws MPException,
                                              MPApiException

Method responsible for search payments.

Parameters:: request - search request information; requestOptions - metadata to customize the request
Returns:: list of results
Throws:: MPException - an error if the request fails; MPApiException

refund
```
public PaymentRefund refund(Long paymentId)
                     throws MPException,
                            MPApiException
```
Creates a total refund for payment.

Parameters:

paymentId - payment id

Returns:

PaymentRefund refund information

Throws:

MPException - an error if the request fails

MPApiException

refund

public PaymentRefund refund(Long paymentId,
                            MPRequestOptions requestOptions)
                     throws MPException,
                            MPApiException

Creates a total refund for payment.

Parameters:: paymentId - payment id; requestOptions - metadata to customize the request
Returns:: PaymentRefund refund information
Throws:: MPException - an error if the request fails; MPApiException

refund

public PaymentRefund refund(Long paymentId,
                            BigDecimal amount)
                     throws MPException,
                            MPApiException

Creates a refund for payment.

Parameters:: paymentId - payment id; amount - refund amount
Returns:: PaymentRefund refund information
Throws:: MPException - an error if the request fails; MPApiException

refund

public PaymentRefund refund(Long paymentId,
                            BigDecimal amount,
                            MPRequestOptions requestOptions)
                     throws MPException,
                            MPApiException

Creates a refund for payment.

Parameters:: paymentId - payment id; amount - refund amount; requestOptions - metadata to customize the request
Returns:: PaymentRefund refund information
Throws:: MPException - an error if the request fails; MPApiException

getRefund

public PaymentRefund getRefund(Long paymentId,
                               Long refundId)
                        throws MPException,
                               MPApiException

Gets a refund by id from the payment.

Parameters:: paymentId - payment id; refundId - refund id
Returns:: PaymentRefund refund information
Throws:: MPException - an error if the request fails; MPApiException

getRefund

public PaymentRefund getRefund(Long paymentId,
                               Long refundId,
                               MPRequestOptions requestOptions)
                        throws MPException,
                               MPApiException

Gets a refund by id from the payment.

Parameters:: paymentId - payment id; refundId - refund id; requestOptions - metadata to customize the request
Returns:: PaymentRefund refund information
Throws:: MPException - an error if the request fails; MPApiException

listRefunds

public MPResourceList<PaymentRefund> listRefunds(Long paymentId)
                                          throws MPException,
                                                 MPApiException

Lists the refunds of the payment.

Parameters:: paymentId - payment id
Returns:: list of PaymentRefund
Throws:: MPException - an error if the request fails; MPApiException

listRefunds

public MPResourceList<PaymentRefund> listRefunds(Long paymentId,
                                                 MPRequestOptions requestOptions)
                                          throws MPException,
                                                 MPApiException

Lists the refunds of the payment.

Parameters:: paymentId - payment id; requestOptions - metadata to customize the request
Returns:: list of PaymentRefund
Throws:: MPException - an error if the request fails; MPApiException

Constructor	Description
`PaymentClient()`	Default constructor.
`PaymentClient(MPHttpClient httpClient)`	Constructor used for providing a custom http client.

Class PaymentClient

Field Summary

Fields inherited from class com.mercadopago.client.MercadoPagoClient

Constructor Summary

Method Summary

Methods inherited from class com.mercadopago.client.MercadoPagoClient

Methods inherited from class java.lang.Object

Constructor Detail

PaymentClient

PaymentClient

Method Detail

get

get

create

create

cancel

cancel

capture

capture

capture

capture

search

search

refund

refund

refund

refund

getRefund

getRefund

listRefunds

listRefunds