Other payment methods
With Mercado Pago's Checkout Transparente, it is possible to offer, in addition to card and Pix, payments via boleto bancário.
To get a detailed list of all payment methods available for integration, send a GET with your Access token to the endpoint /v1/payment_methods and run the request or, if you prefer, make the request using the SDKs below.
<?php
use MercadoPago\MercadoPagoConfig;
MercadoPagoConfig::setAccessToken("ENV_ACCESS_TOKEN");
$client = new PaymentMethodClient();
$payment_method = $client->get();
?>
import { MercadoPagoConfig, PaymentMethods } from 'mercadopago';
const client = new MercadoPagoConfig({ accessToken: 'access_token' });
const paymentMethods = new PaymentMethods(client);
paymentMethods.get().then((result) => console.log(result))
.catch((error) => console.log(error));
MercadoPagoConfig.setAccessToken("ENV_ACCESS_TOKEN");
PaymentMethodClient client = new PaymentMethodClient();
client.list();
require 'mercadopago'
sdk = Mercadopago::SDK.new('ENV_ACCESS_TOKEN')
payment_methods_response = sdk.payment_methods.get()
payment_methods = payment_methods_response[:response]
using MercadoPago.Client.PaymentMethod;
using MercadoPago.Config;
using MercadoPago.Resource;
using MercadoPago.Resource.PaymentMethod;
MercadoPagoConfig.AccessToken = "ENV_ACCESS_TOKEN";
var client = new PaymentMethodClient();
ResourcesList<PaymentMethod> paymentMethods = await client.ListAsync();
import mercadopago
sdk = mercadopago.SDK("ACCESS_TOKEN")
payment_methods_response = sdk.payment_methods().list_all()
payment_methods = payment_methods_response["response"]
curl -X GET \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-H 'Authorization: Bearer ENV_ACCESS_TOKEN' \
'https://api.mercadopago.com/v1/payment_methods' \
To offer Boleto Bancário, follow the steps below.
Import MercadoPago.js
To perform the Checkout Transparente integration, you need to capture the necessary data to process the payment.
This capture is made by including the MercadoPago.js library in your project, followed by the payment form. Use the code below to import the library before adding the payment form.
<body>
<script src="https://sdk.mercadopago.com/js/v2"></script>
</body>
npm install @mercadopago/sdk-js
Configure credentials
Credentials are unique passwords with which we identify an integration in your account. They are made to capture payments in virtual stores and other applications securely.
This is the first step of a complete code structure that must be followed for the correct integration of the payment flow. Pay attention to the blocks below to add to the codes as indicated.
<script>
const mp = new MercadoPago("YOUR_PUBLIC_KEY");
</script>
import { loadMercadoPago } from "@mercadopago/sdk-js";
await loadMercadoPago();
const mp = new window.MercadoPago("YOUR_PUBLIC_KEY");
Add payment form
With the MercadoPago.js library included, add the payment form below to your project to ensure the secure capture of buyer data. In this step, it is important to use the list you consulted to obtain the available payment methods to create the payment options you want to offer.
<form id="form-checkout" action="/process_payment" method="post">
<div>
<h1>Payer Request</h1>
<div>
<label for="payerFirstName">Nome</label>
<input id="form-checkout__payerFirstName" name="payerFirstName" type="text">
</div>
<div>
<label for="payerLastName">Sobrenome</label>
<input id="form-checkout__payerLastName" name="payerLastName" type="text">
</div>
<div>
<label for="email">E-mail</label>
<input id="form-checkout__email" name="email" type="text">
</div>
<div>
<label for="identificationType">Tipo de documento</label>
<input id="form-checkout__identificationType" name="identificationType" type="text"></input>
</div>
<div>
<label for="identificationNumber">Número do documento</label>
<input id="form-checkout__identificationNumber" name="identificationNumber" type="text">
</div>
<div>
<label for="zip_code"> CEP: </label>
<input id="form-checkout__zip_code" name="zip_code" type="text">
</div>
<div>
<label for="street_name"> Rua: </label>
<input id="form-checkout__street_name" name="street_name" type="text">
</div>
<div>
<label for="street_number"> Número: </label>
<input id="form-checkout__street_number" name="street_number" type="text">
</div>
<div>
<label for="neighborhood"> Bairro: </label>
<input id="form-checkout__neighborhood" name="neighborhood" type="text">
</div>
<div>
<label for="city"> Cidade: </label>
<input id="form-checkout__city" name="city" type="text">
</div>
<div>
<label for="federal_unit"> Estado: </label>
<input id="form-checkout__federal_unit" name="federal_unit" type="text">
</div>
</div>
<div>
<div>
<input type="hidden" name="transactionAmount" id="transactionAmount" value="100">
<input type="hidden" name="description" id="description" value="Nome do Produto">
<br>
<button type="submit">Pagar</button>
</div>
</div>
</form>
Get document types
After configuring the credential, it is necessary to obtain the types of documents that will be part of filling out the payment form.
By including the element of type select
with the id: id = docType
that is on the form, it will be possible to automatically fill in the available options when calling the following function:
(async function getIdentificationTypes() {
try {
const identificationTypes = await mp.getIdentificationTypes();
const identificationTypeElement = document.getElementById('form-checkout__identificationType');
createSelectOptions(identificationTypeElement, identificationTypes);
} catch (e) {
return console.error('Error getting identificationTypes: ', e);
}
})();
function createSelectOptions(elem, options, labelsAndKeys = { label: "name", value: "id" }) {
const { label, value } = labelsAndKeys;
elem.options.length = 0;
const tempOptions = document.createDocumentFragment();
options.forEach(option => {
const optValue = option[value];
const optLabel = option[label];
const opt = document.createElement('option');
opt.value = optValue;
opt.textContent = optLabel;
tempOptions.appendChild(opt);
});
elem.appendChild(tempOptions);
}
Send payment
When finalizing the inclusion of the payment form and obtaining the types of documents, it is necessary to forward the buyer's email, type and document number, the payment method used and the details of the amount to be paid using our Payments API or one of our SDKs.
To configure payments with Boleto Bancário, send a POST with the parameters detailed in the tables below to the endpoint /v1/payments and run the request or, if you prefer, use one of our SDKs below.
<?php
use MercadoPago\Client\Payment\PaymentClient;
use MercadoPago\Client\Common\RequestOptions;
use MercadoPago\MercadoPagoConfig;
MercadoPagoConfig::setAccessToken("YOUR_ACCESS_TOKEN");
$client = new PaymentClient();
$request_options = new RequestOptions();
$request_options->setCustomHeaders(["X-Idempotency-Key: <SOME_UNIQUE_VALUE>"]);
$payment = $client->create([
"transaction_amount" => (float) $_POST['<TRANSACTION_AMOUNT>'],
"payment_method_id" => $_POST['<PAYMENT_METHOD_ID>'],
"payer" => [
"email" => $_POST['<EMAIL>'],
"first_name" => $_POST['<NOME>'],
"last_name" => $_POST['<SOBRENOME>'],
"identification" => [
"type" => $_POST['<TIPO DE DOCUMENTO>'],
"number" => $_POST['<NUMERO>']
],
"address" => [
"zip_code" => $_POST['<CEP>'],
"city" => $_POST['<CIDADE>'],
"street_name" => $_POST['<RUA>'],
"street_number" => $_POST['<NÚMERO>'],
"neighborhood" => $_POST['<BAIRRO>'],
"federal_unit" => $_POST['<SIGLA DO ESTADO>']
]
]
], $request_options);
echo implode($payment);
?>
import { MercadoPagoConfig, Payments } from 'mercadopago';
const client = new MercadoPagoConfig({ accessToken: '<YOUR_ACCESS_TOKEN>' });
const payments = new Payments(client);
payments.create({
body: {
transaction_amount: '<TRANSACTION_AMOUNT>',
payment_method_id: '<PAYMENT_METHOD_ID>',
payer: {
email: '<EMAIL>',
first_name: '<NOMBRE>',
last_name: '<APELLIDO>',
identification:{
type:'<TIPO DE DOCUMENTO>',
number:'<NUMERO_DOCUMENTO>'
},
address:{
zip_code: '<CEP>',
city: '<CIUDAD>',
neighborhood: '<BARRIO>',
street_name: '<CALLE>',
street_number: '<NÚMERO>',
federal_unit: '<SIGLA ESTADO>'
}
}
},
requestOptions: { idempotencyKey: '<SOME_UNIQUE_VALUE>' }
})
.then((result) => console.log(result))
.catch((error) => console.log(error));
PaymentCreateRequest paymentCreateRequest = PaymentCreateRequest.builder()
.transactionAmount(new BigDecimal("<TRANSACTION_AMOUNT>"))
.paymentMethodId("bolbradesco")
.payer(PaymentPayerRequest.builder()
.email("<EMAIL>")
.firstName("<NAME>")
.lastName("<LASTNAME>")
.identification(IdentificationRequest.builder()
.type("CPF")
.number("<NUMERO>")
.build())
.address(PaymentPayerAddressRequest.builder()
.streetName("<RUA XXX>")
.streetNumber("123")
.zipCode("<CEP>")
.federalUnit("<SIGLA DO ESTADO>")
.city("<CIDADE>")
.neighborhood("<BAIRRO>")
.build())
.build())
.build();
require 'mercadopago'
sdk = Mercadopago::SDK.new('ENV_ACCESS_TOKEN')
custom_headers = {
'x-idempotency-key': '<SOME_UNIQUE_VALUE>'
}
custom_request_options = Mercadopago::RequestOptions.new(custom_headers: custom_headers)
payment_request = {
transaction_amount: 100,
description: 'Título del producto',
payment_method_id: 'bolbradesco',
payer: {
email: 'PAYER_EMAIL',
first_name: 'Test',
last_name: 'User',
identification: {
type: 'DNI',
number: '19119119',
},
address: {
zip_code: '1264',
street_name: 'Av. Caseros',
street_number: '3039',
neighborhood: 'Parque Patricios',
city: 'Buenos Aires',
federal_unit: 'BA'
}
}
}
payment_response = sdk.payment.create(payment_request, custom_request_options)
payment = payment_response[:response]
MercadoPagoConfig.AccessToken = "<ENV_ACCESS_TOKEN>";
var request = new PaymentCreateRequest
{
TransactionAmount = 105,
Description = "<DESCRIPCIÓN>",
PaymentMethodId = "bolbradesco",
Payer = new PaymentPayerRequest
{
Email = "<EMAIL>",
FirstName = "<NOMBRE>",
LastName = "<APELLIDO>",
Identification = new IdentificationRequest
{
Type = "CPF",
Number = "<NUMERO DE CPF>",
},
Address = new PaymentPayerAddressRequest
{
ZipCode = "<CÓDIGO POSTAL>",
StreetName = "<CALLE XXX>",
City = "<CIUDAD>",
StreetNumber = "<NÚMERO>",
Neighborhood = "<BARRIO>",
FederalUnit = "<SIGLA DE ESTADO>",
}
},
};
var client = new PaymentClient();
Payment payment = await client.CreateAsync(request);
import mercadopago
sdk = mercadopago.SDK("ENV_ACCESS_TOKEN")
request_options = mercadopago.config.RequestOptions()
request_options.custom_headers = {
'x-idempotency-key': '<SOME_UNIQUE_VALUE>'
}
payment_data = {
"transaction_amount": 100,
"description": "Título del producto",
"payment_method_id": "bolbradesco",
"payer": {
"email": "PAYER_EMAIL",
"first_name": "Test",
"last_name": "User",
"identification": {
"type": "DNI",
"number": "19119119"
},
"address": {
"zip_code": "1264",
"street_name": "Av. Caseros",
"street_number": "3039",
"neighborhood": "Parque Patricios",
"city": "Buenos Aires",
"federal_unit": "BA"
}
}
}
payment_response = sdk.payment().create(payment_data, request_options)
payment = payment_response["response"]
accessToken := "{{ACCESS_TOKEN}}"
cfg, err := config.New(accessToken)
if err != nil {
fmt.Println(err)
return
}
client := payment.NewClient(cfg)
request := payment.Request{
TransactionAmount: 105,
PaymentMethodID: "bolbradesco",
Payer: &payment.PayerRequest{
Email: "{{EMAIL}}",
FirstName: "{{NOME}}",
LastName: "{{SOBRENOME}}",
Identification: &payment.IdentificationRequest{
Type: "{{TIPO DO DOCUMENTO}}",
Number: "{{NUMERO}}",
},
Address: &payment.AddressRequest{
ZipCode: "06233-200",
City: "Osasco",
Neighborhood: "Bonfim",
StreetName: "Av. das Nações Unidas",
StreetNumber: "3003",
FederalUnit: "SP",
},
},
}
resource, err := client.Create(context.Background(), request)
if err != nil {
fmt.Println(err)
return
}
fmt.Println(resource)
curl --location 'https://api.mercadopago.com/v1/payments' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer ENV_ACCESS_TOKEN' \
--header 'X-Idempotency-Key: <SOME_UNIQUE_VALUE>' \
--header 'X-Product-Id: <SOME_UNIQUE_VALUE>' \
--data-raw '{
"transaction_amount": 100,
"description": "Titulo do produto",
"payment_method_id": "bolbradesco",
"payer": {
"email": "test_user_12345@testuser.com",
"first_name": "Test",
"last_name": "User",
"identification": {
"type": "CPF",
"number": "01234567890"
}
"address": {
"zip_code": "88000000",
"street_name": "Nombre de calle",
"street_number": "123",
"neighborhood": "Barrio",
"city": "Ciudad",
"federal_unit": "UF"
}
}
}'
- Mandatory fields for boleto bancário payments
Parameter | Type | Description, possible values and examples |
payment_method_id | string | Payment method. For boleto bancário, it is always bolbradesco . |
address.zip_code | string | Zip code. Example: 88000000 |
address.street_name | string | Buyer's street name. Example: Rua da Abobrinha. |
address.street_number | string | Buyer's address number. Example: 1291 |
address.neighborhood | string | Neighborhood where the buyer's address is located. Example: Copacabana. |
address.city | string | City where the buyer lives. Example: Rio de Janeiro. |
address.federal_unit | string | State abbreviation where the buyer lives. Only two characters are accepted. For example: RJ. |
- Mandatory fields for pagamentos em lotéricas
Parameter | Type | Description, possible values and examples |
payment_method_id | string | Payment method. |
The response will show the pending
status until the buyer completes the payment. Also, in the response to the request, the external_resource_url
parameter will return a URL that contains instructions for the buyer to make the payment. You can redirect to this same link to complete the payment flow. See below for an example return.
[
{
...,
"id": 5466310457,
"status": "pending",
"status_detail": "pending_waiting_payment",
...,
"transaction_details": {
"net_received_amount": 0,
"total_paid_amount": 100,
"overpaid_amount": 0,
"external_resource_url": "https://www.mercadopago.com/mla/payments/ticket/helper?payment_id=123456789&payment_method_reference_id= 123456789&caller_id=123456",
"installment_amount": 0,
"financial_institution": null,
"payment_method_reference_id": "1234567890"
}
}
]
Expiration date
The default expiration date for payments with boleto is 3 days. Optionally, it is possible to change this date by sending the date_of_expiration
field in the payment creation request, defining a period between 1 and 30 days from the boleto issuance date.
To change the expiration date, use one of the codes available below.
$payment->date_of_expiration = "2020-05-30T23:59:59.000-04:00";
The date uses the ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssz
date_of_expiration: "2020-05-30T23:59:59.000-04:00",
The date uses the ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssz
payment.setDateOfExpiration("2020-05-30T23:59:59.000-04:00")
The date uses the ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssz
date_of_expiration: '2020-05-30T23:59:59.000-04:00',
The date uses the ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssz
paymentCreateRequest.DateOfExpiration = DateTime.Parse("2020-05-30T23:59:59.000-04:00");
The date uses the ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssz
"date_of_expiration": "2020-05-30T23:59:59.000-04:00"
The date uses the ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssz
"date_of_expiration": "2020-05-30T23:59:59.000-04:00",
The approval timeframe for the boleto is up to 2 business hours. Therefore, set the expiration date to a minimum of 3 days to ensure that the payment is made.
Cancel payment
To avoid billing issues, it is important to cancel overdue payments. Also, keep in mind that it is possible to cancel only payments that are pending or in process. If a payment is due within 30 days, the cancellation is automatic and the final status of the payment will be canceled
or expired
.
For more information, see the Refunds and Cancellations section.
The date uses the ISO 8601 format: yyyy-MM-dd'T'HH:mm:ssz