https://github.com/mercadopago/sdk-java
Mercado Pago's Official Java SDK
https://github.com/mercadopago/sdk-java
backend-sdk java mercadopago sdk
Last synced: 9 months ago
JSON representation
Mercado Pago's Official Java SDK
- Host: GitHub
- URL: https://github.com/mercadopago/sdk-java
- Owner: mercadopago
- License: mit
- Created: 2016-11-01T00:12:29.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2025-05-15T18:13:46.000Z (9 months ago)
- Last Synced: 2025-05-15T18:29:07.559Z (9 months ago)
- Topics: backend-sdk, java, mercadopago, sdk
- Language: Java
- Homepage: https://developers.mercadopago.com/
- Size: 3.52 MB
- Stars: 131
- Watchers: 36
- Forks: 47
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# Mercado Pago SDK for Java
[](https://search.maven.org/search?q=g:com.mercadopago%20AND%20a:sdk-java)
The official [Mercado Pago](https://www.mercadopago.com/developers/en/guides) Java client library.
## 💡 Requirements
Java 1.8 or later
## 📲 Installation
First time using Mercado Pago? Create your [Mercado Pago account](https://www.mercadopago.com), if you don’t have one
already.
1. Append MercadoPago dependencies to pom.xml
```xml
com.mercadopago
sdk-java
2.2.0
```
2. Run `mvn install` and that's all, you have Mercado Pago SDK installed.
3. Copy the access_token in the [credentials](https://www.mercadopago.com/developers/panel) section of the page and
replace YOUR_ACCESS_TOKEN with it.
That's it! Mercado Pago SDK has been successfully installed.
## 🌟 Getting Started
Simple usage looks like:
```java
import com.mercadopago.MercadoPagoConfig;
import com.mercadopago.client.order.*;
import com.mercadopago.core.MPRequestOptions;
import com.mercadopago.exceptions.MPApiException;
import com.mercadopago.exceptions.MPException;
import com.mercadopago.resources.order.Order;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class Example {
public static void main(String[] args) {
MercadoPagoConfig.setAccessToken("{{ACCESS_TOKEN}}");
OrderClient client = new OrderClient();
OrderPaymentRequest payment = OrderPaymentRequest.builder()
.amount("10.00")
.paymentMethod(OrderPaymentMethodRequest.builder()
.id("master")
.type("credit_card")
.token("{{CARD_TOKEN}}")
.installments(1)
.build())
.build();
List payments = new ArrayList<>();
payments.add(payment);
OrderCreateRequest request = OrderCreateRequest.builder()
.type("online")
.totalAmount("10.00")
.externalReference("ext_ref")
.payer(OrderPayerRequest.builder().email("{{EMAIL}}").build())
.transactions(OrderTransactionRequest.builder()
.payments(payments)
.build())
.build();
Map headers = new HashMap<>();
headers.put("X-Idempotency-Key", "{{IDEMPOTENCY_KEY}}");
MPRequestOptions requestOptions = MPRequestOptions.builder()
.customHeaders(headers)
.build();
try {
Order order = client.create(request, requestOptions);
System.out.println("Order created: " + order.getId());
} catch (MPApiException | MPException e) {
System.out.println("Error creating order: " + e.getMessage());
}
}
}
```
### Per-request Configuration
All the request methods accept an optional `MPRequestOptions` object. With this you can set a custom access token,
custom timeouts or even any custom headers you want, like an idempotency key for example.
```java
public class Example {
public static void main(String[] args) {
OrderClient client = new OrderClient();
Map customHeaders = new HashMap<>();
customHeaders.put("x-idempotency-key", "...");
MPRequestOptions requestOptions =
MPRequestOptions.builder()
.accessToken("custom_access_token")
.connectionRequestTimeout(2000)
.connectionTimeout(2000)
.socketTimeout(2000)
.customHeaders(customHeaders)
.build();
OrderCreateRequest createRequest = OrderCreateRequest.builder().build();
try {
Order order = client.create(createRequest, requestOptions);
System.out.println(order);
} catch (MPException | MPApiException ex) {
ex.printStackTrace();
}
}
}
```
### SDK configurations
You can also set some customizations directly at MercadoPagoConfig class, for example set custom timeouts, a custom http
client, log configurations, etc...
```java
public class Example {
public static void main(String[] args) {
MercadoPagoConfig.setConnectionRequestTimeout(2000);
MercadoPagoConfig.setSocketTimeout(2000);
MercadoPagoConfig.setLoggingLevel(Level.FINEST);
}
}
```
### Custom Http Client
You can use a custom http client instead of using the default `MPDefaultHttpClient` by implementing the `MPHttpClient`
interface.
```java
public class CustomHttpClient implements MPHttpClient {
//...
}
```
## 📚 Documentation
See our documentation for more details.
- Mercado Pago reference API. [Portuguese](https://www.mercadopago.com/developers/pt/reference)
/ [English](https://www.mercadopago.com/developers/en/reference)
/ [Spanish](https://www.mercadopago.com/developers/es/reference)
## 🤝 Contributing
All contributions are welcome, ranging from people wanting to triage issues, others wanting to write documentation, to
people wanting to contribute code.
Please read and follow our [contribution guidelines](CONTRIBUTING.md). Contributions not following these guidelines will
be disregarded. The guidelines are in place to make all of our lives easier and make contribution a consistent process
for everyone.
### Patches to version 1.x.x
Since the release of version 2.0.0, version 1 is deprecated and will not be receiving new
features, only bug fixes. If you need to submit PRs for that version, please do so by using `develop-v1` as your base
branch.
## ❤️ Support
If you require technical support, please contact our support team at our developers
site: [English](https://www.mercadopago.com/developers/en/support/center/contact)
/ [Portuguese](https://www.mercadopago.com/developers/pt/support/center/contact)
/ [Spanish](https://www.mercadopago.com/developers/es/support/center/contact)
## 🏻 License
```
MIT license. Copyright (c) 2022 - Mercado Pago / Mercado Libre
For more information, see the LICENSE file.
```