The Mercado Pago Java SDK includes several ancillary clients that cover utility and platform-support operations such as retrieving identification document types, listing available payment methods, querying chargebacks, and managing merchant orders. This page documents each of these clients concisely, grouped by purpose.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/mercadopago/sdk-java/llms.txt
Use this file to discover all available pages before exploring further.
MerchantOrderClient
Package:com.mercadopago.client.merchantorder
MerchantOrderClient manages merchant orders, which group one or more payments and can be linked to a checkout preference, shipment, or external reference. They are commonly used in marketplace-style flows to track fulfilment and associate multiple payment attempts with a single purchase event.
Constructors
Methods
| Signature | Description |
|---|---|
MerchantOrder get(Long id) | Retrieve a merchant order by ID. |
MerchantOrder get(Long id, MPRequestOptions) | Same with custom request options. |
MerchantOrder create(MerchantOrderCreateRequest) | Create a new merchant order. |
MerchantOrder create(MerchantOrderCreateRequest, MPRequestOptions) | Same with custom request options. |
MerchantOrder update(Long id, MerchantOrderUpdateRequest) | Update an existing merchant order. |
MerchantOrder update(Long id, MerchantOrderUpdateRequest, MPRequestOptions) | Same with custom request options. |
MPElementsResourcesPage<MerchantOrder> search(MPSearchRequest) | Search merchant orders with pagination. |
MPElementsResourcesPage<MerchantOrder> search(MPSearchRequest, MPRequestOptions) | Same with custom request options. |
MPException and MPApiException.
MerchantOrderCreateRequest key fields
Checkout preference ID that links this order to a payment preference.
Mercado Libre site ID (e.g.,
"MLA" for Argentina, "MLB" for Brazil).List of items included in the order.
Buyer information.
External reference to correlate with your own system.
Webhook URL for order and payment status notifications.
Application ID for marketplace integrations.
ChargebackClient
Package:com.mercadopago.client.chargeback
ChargebackClient provides read-only access to chargeback dispute records — cases where a cardholder has disputed a charge with their issuing bank. This client is used to retrieve the details of a specific chargeback or search for chargebacks matching given criteria so that your system can trigger internal dispute-handling workflows.
Constructors
Methods
| Signature | Description |
|---|---|
Chargeback get(String id) | Retrieve a chargeback by its ID. |
Chargeback get(String id, MPRequestOptions) | Same with custom request options. |
MPResultsResourcesPage<Chargeback> search(MPSearchRequest) | Search chargebacks with pagination. |
MPResultsResourcesPage<Chargeback> search(MPSearchRequest, MPRequestOptions) | Same with custom request options. |
MPException and MPApiException.
InvoiceClient
Package:com.mercadopago.client.invoice
InvoiceClient retrieves invoices (also called authorized payments) that are generated by Mercado Pago’s subscription (preapproval) engine. Each invoice represents a scheduled billing attempt against a subscriber’s saved payment method for a given billing cycle. The API endpoint is /authorized_payments/{id}.
Constructors
Methods
| Signature | Description |
|---|---|
Invoice get(Long id) | Retrieve an invoice by its numeric ID. |
Invoice get(Long id, MPRequestOptions) | Same with custom request options. |
MPResultsResourcesPage<Invoice> search(MPSearchRequest) | Search invoices (e.g., by preapproval_id or payer_id). |
MPResultsResourcesPage<Invoice> search(MPSearchRequest, MPRequestOptions) | Same with custom request options. |
MPException and MPApiException.
IdentificationTypeClient
Package:com.mercadopago.client.identificationtype
IdentificationTypeClient lists the identification document types recognized by Mercado Pago for the country associated with the authenticated user’s credentials. Common examples include CPF and CNPJ (Brazil) and DNI and CUIL (Argentina). These type IDs are required when creating customers or providing payer identification in payment requests.
Constructors
Methods
| Signature | Description |
|---|---|
MPResourceList<IdentificationType> list() | List all identification types for the authenticated user’s country. |
MPResourceList<IdentificationType> list(MPRequestOptions) | Same with custom request options. |
MPException and MPApiException.
UserClient
Package:com.mercadopago.client.user
UserClient retrieves information about the currently authenticated Mercado Pago user — typically the account associated with the access token in use. It is used internally by OauthClient to determine the seller’s country when building authorization URLs, but can also be called directly to inspect account details such as countryId and siteId.
Constructors
Methods
| Signature | Description |
|---|---|
User get() | Retrieve information about the authenticated user (/users/me). |
User get(MPRequestOptions) | Same with custom request options (e.g., a seller’s access token). |
MPException and MPApiException.
PaymentMethodClient
Package:com.mercadopago.client.paymentmethod
PaymentMethodClient lists all payment methods available for the country associated with the authenticated user’s credentials. Results include credit cards, debit cards, bank transfers, and cash payment networks. The id field of each PaymentMethod is the value required in paymentMethodId when creating payments or card tokens.
Constructors
Methods
| Signature | Description |
|---|---|
MPResourceList<PaymentMethod> list() | List all available payment methods. |
MPResourceList<PaymentMethod> list(MPRequestOptions) | Same with custom request options. |
MPException and MPApiException.
DisbursementRefundClient
Package:com.mercadopago.client.disbursementrefund
DisbursementRefundClient enables partial or full refunds of individual disbursements within an advanced (split) payment. It is used alongside AdvancedPaymentClient. Two operations are available: refund a single disbursement by specifying both the advancedPaymentId and disbursementId, or refund all disbursements at once using the bulk endpoint.
Constructors
Methods
| Signature | Description |
|---|---|
DisbursementRefund create(Long advancedPaymentId, Long disbursementId, DisbursementRefundCreateRequest) | Refund a specific disbursement by amount. |
DisbursementRefund create(Long advancedPaymentId, Long disbursementId, DisbursementRefundCreateRequest, MPRequestOptions) | Same with custom request options. |
DisbursementRefund createAll(Long advancedPaymentId, DisbursementRefundCreateRequest) | Refund all disbursements of an advanced payment at once. |
DisbursementRefund createAll(Long advancedPaymentId, DisbursementRefundCreateRequest, MPRequestOptions) | Same with custom request options. |
MPException and MPApiException.
DisbursementRefundCreateRequest fields
Amount to refund. When
null, the full disbursement amount is refunded.