IPN
IPN (Instant Payment Notification) é um mecanismo que permite que uma aplicação receba notificaçÔes do Mercado Pago sobre o status de um pagamento, chargebacks e merchant_orders
. Essas notificaçÔes são enviadas através de uma chamada HTTP POST, informando sobre as transaçÔes.
As notificaçÔes IPN podem ser configuradas de duas maneiras:
Modo de configuração | Descrição |
Configuração através de Suas integraçÔes | Poderå ser configurada apenas uma URL de notificação por conta (dependendo da aplicação, mais de uma aplicação pode usar essa URL). |
Configuração durante a criação de pagamentos, preferĂȘncias ou ordens comerciais | Isso pode ser realizado a partir do campo notification_url . A URL poderĂĄ ser diferente para cada objeto. |
Nesta documentação explicaremos as configuraçÔes necessårias para o recebimento das notificaçÔes IPN, além de apresentar quais são as açÔes necessårias para que o Mercado Pago valide o correto recebimento das mensagens.
Configuração via Suas integraçÔes
Configure notificaçÔes diretamente via Suas integraçÔes de forma eficiente e segura.
Indicar URLs e configurar eventos
Para configurar as notificaçÔes IPN via Suas integraçÔes, é necessårio indicar as URLs onde elas serão recebidas e especificar os eventos para os quais deseja receber notificaçÔes.
Para configurar URLS e eventos, siga as etapas descritas abaixo:
- Acesse Suas integraçÔes e selecione uma das aplicaçÔes para configurar as notificaçÔes para toda a sua conta. Caso ainda nĂŁo tenha criado uma aplicação, acesse a documentação Painel do Desenvolvedor e siga as instruçÔes para fazĂȘ-lo.
- No menu Ă esquerda, clique em IPN e configure a URL de produção que serĂĄ usada para receber as notificaçÔes. Leve em consideração que Ă© possĂvel testar se a URL indicada estĂĄ recebendo as notificaçÔes corretamente. Isso permite verificar a solicitação, a resposta do servidor e a descrição do evento.
- Selecione os eventos para os quais deseja receber notificaçÔes em formato
JSON
através de umHTTP POST
para a URL especificada anteriormente. Um evento pode ser qualquer atualização no objeto relatado, incluindo alteraçÔes de status ou atributos. Consulte a tabela abaixo para ver os eventos configuråveis, considerando a solução do Mercado Pago integrada e suas necessidades de negócio.
Nome em Suas integraçÔes | Eventos | Tópico | Produtos associados |
Criação e atualização de pagamentos | Pagos | payment | Checkout Transparente Checkout Pro Checkout Bricks Suscripciones Mercado Pago Point Wallet Connect |
Finalização, cancelamento ou erro ao processar tentativas de pagamento nos dispositivos Mercado Pago Point. | IntegraçÔes Point | point_integration_ipn | Mercado Pago Point |
Alertas de fraude apĂłs o processamento de um pedido | Alertas de fraude | delivery_cancellation | Checkout Transparente Checkout PRO |
Criação, fechamento ou expiração de pedidos. | Ordens comerciais | merchant_order | Checkout Pro Código QR |
Abertura de estornos, alteraçÔes de status e modificaçÔes relacionadas às liberaçÔes de dinheiro. | Estornos | chargebacks | Checkout Pro Checkout Transparente Checkout Bricks |
- Por fim, clique em Salvar.
Configuração durante a criação de pagamentos
Durante o processo de criação de pagamentos, preferĂȘncias ou ordens comerciais, Ă© possĂvel configurar a URL de notificação de maneira especĂfica para cada pagamento. Para isso, utilize o campo notification_url
e implemente o receptor de notificaçÔes necessårio.
A seguir, explicamos como realizar esta configuração utilizando nossoss SDKs.
- No campo
notificaction_url
, indique a URL do qual serão recebidas as notificaçÔes como exemplificado abaixo. Para receber notificaçÔes exclusivamente via IPN e não via Webhooks, adicione o parùmetrosource_news=ipn
Ănotification_url
. Por exemplo:https://www.yourserver.com/notifications?source_news=ipn
.
<?php
require_once 'vendor/autoload.php';
MercadoPago\SDK::setAccessToken("YOUR_ACCESS_TOKEN");
$payment = new MercadoPago\Payment();
$payment->transaction_amount = (float)$_POST['transactionAmount'];
$payment->token = $_POST['token'];
$payment->description = $_POST['description'];
$payment->installments = (int)$_POST['installments'];
$payment->payment_method_id = $_POST['paymentMethodId'];
$payment->issuer_id = (int)$_POST['issuer'];
$payment->notification_url = `http://requestbin.fullcontact.com/1ogudgk1`;
...
$response = array(
'status' => $payment->status,
'status_detail' => $payment->status_detail,
'id' => $payment->id
);
echo json_encode($response);
?>
var mercadopago = require('mercadopago');
mercadopago.configurations.setAccessToken("YOUR_ACCESS_TOKEN");
var payment_data = {
transaction_amount: Number(req.body.transactionAmount),
token: req.body.token,
description: req.body.description,
installments: Number(req.body.installments),
payment_method_id: req.body.paymentMethodId,
issuer_id: req.body.issuer,
notification_url: "http://requestbin.fullcontact.com/1ogudgk1",
payer: {
email: req.body.email,
identification: {
type: req.body.docType,
number: req.body.docNumber
}
}
};
mercadopago.payment.save(payment_data)
.then(function(response) {
res.status(response.status).json({
status: response.body.status,
status_detail: response.body.status_detail,
id: response.body.id
â });
})
.catch(function(error) {
res.status(response.status).send(error);
});
MercadoPago.SDK.setAccessToken("YOUR_ACCESS_TOKEN");
Payment payment = new Payment();
payment.setTransactionAmount(Float.valueOf(request.getParameter("transactionAmount")))
.setToken(request.getParameter("token"))
.setDescription(request.getParameter("description"))
.setInstallments(Integer.valueOf(request.getParameter("installments")))
.setPaymentMethodId(request.getParameter("paymentMethodId"))
.setNotificationUrl("http://requestbin.fullcontact.com/1ogudgk1");
Identification identification = new Identification();
identification.setType(request.getParameter("docType"))
.setNumber(request.getParameter("docNumber"));
Payer payer = new Payer();
payer.setEmail(request.getParameter("email"))
.setIdentification(identification);
payment.setPayer(payer);
payment.save();
System.out.println(payment.getStatus());
require 'mercadopago'
sdk = Mercadopago::SDK.new('YOUR_ACCESS_TOKEN')
payment_data = {
transaction_amount: params[:transactionAmount].to_f,
token: params[:token],
description: params[:description],
installments: params[:installments].to_i,
payment_method_id: params[:paymentMethodId],
notification_url: "http://requestbin.fullcontact.com/1ogudgk1",
payer: {
email: params[:email],
identification: {
type: params[:docType],
number: params[:docNumber]
}
}
}
payment_response = sdk.payment.create(payment_data)
payment = payment_response[:response]
puts payment
using System;
using MercadoPago.Client.Common;
using MercadoPago.Client.Payment;
using MercadoPago.Config;
using MercadoPago.Resource.Payment;
MercadoPagoConfig.AccessToken = "YOUR_ACCESS_TOKEN";
var paymentRequest = new PaymentCreateRequest
{
TransactionAmount = decimal.Parse(Request["transactionAmount"]),
Token = Request["token"],
Description = Request["description"],
Installments = int.Parse(Request["installments"]),
PaymentMethodId = Request["paymentMethodId"],
NotificationUrl = "http://requestbin.fullcontact.com/1ogudgk1",
Payer = new PaymentPayerRequest
{
Email = Request["email"],
Identification = new IdentificationRequest
{
Type = Request["docType"],
Number = Request["docNumber"],
},
},
};
var client = new PaymentClient();
Payment payment = await client.CreateAsync(paymentRequest);
Console.WriteLine(payment.Status);
import mercadopago
sdk = mercadopago.SDK("ACCESS_TOKEN")
payment_data = {
"transaction_amount": float(request.POST.get("transaction_amount")),
"token": request.POST.get("token"),
"description": request.POST.get("description"),
"installments": int(request.POST.get("installments")),
"payment_method_id": request.POST.get("payment_method_id"),
"notification_url": "http://requestbin.fullcontact.com/1ogudgk1",
"payer": {
"email": request.POST.get("email"),
"identification": {
"type": request.POST.get("type"),
"number": request.POST.get("number")
}
}
}
payment_response = sdk.payment().create(payment_data)
payment = payment_response["response"]
print(payment)
curl -X POST \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-H 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
'https://api.mercadopago.com/v1/payments' \
-d '{
"transaction_amount": 100,
"token": "ff8080814c11e237014c1ff593b57b4d",
"description": "Blue shirt",
"installments": 1,
"payment_method_id": "visa",
"issuer_id": 310,
"notification_url": "http://requestbin.fullcontact.com/1ogudgk1",
"payer": {
"email": "test@test.com"
}
}'
- Implemente o receptor de notificaçÔes utilizando o seguinte código como exemplo:
php
<?php
MercadoPago\SDK::setAccessToken("ENV_ACCESS_TOKEN");
$merchant_order = null;
switch($_GET["topic"]) {
case "payment":
$payment = MercadoPago\Payment::find_by_id($_GET["id"]);
// Get the payment and the corresponding merchant_order reported by the IPN.
$merchant_order = MercadoPago\MerchantOrder::find_by_id($payment->order->id);
break;
case "merchant_order":
$merchant_order = MercadoPago\MerchantOrder::find_by_id($_GET["id"]);
break;
}
$paid_amount = 0;
foreach ($merchant_order->payments as $payment) {
if ($payment['status'] == 'approved'){
$paid_amount += $payment['transaction_amount'];
}
}
// If the payment's transaction amount is equal (or bigger) than the merchant_order's amount you can release your items
if($paid_amount >= $merchant_order->total_amount){
if (count($merchant_order->shipments)>0) { // The merchant_order has shipments
if($merchant_order->shipments[0]->status == "ready_to_ship") {
print_r("Totally paid. Print the label and release your item.");
}
} else { // The merchant_order don't has any shipments
print_r("Totally paid. Release your item.");
}
} else {
print_r("Not paid yet. Do not release your item.");
}
?>
- Após realizar as configuraçÔes, o Mercado Pago notificarå essa URL com dois parùmetros sempre que um recurso for criado ou atualizado. Por exemplo, se configurar a URL
https://www.yoursite.com/notifications
, vocĂȘ receberĂĄ as notificaçÔes de pagamento desta maneira:https://www.yoursite.com/notifications?topic=payment&id=123456789
.
Campo | Descrição |
topic | Identifica o tipo de recurso, podendo ser payment , chargebacks , merchant_order ou point_integration_ipn . |
id | Identificador Ășnico do recurso notificado. |
AçÔes necessårias após receber uma notificação
Ao receber uma notificação em sua plataforma, o Mercado Pago aguarda uma resposta para validar se vocĂȘ a recebeu corretamente. Para isso, Ă© necessĂĄrio retornar um status HTTP STATUS 200 (OK)
ou 201 (CREATED)
.
O tempo de espera para a confirmação da recepção das notificaçÔes serå de 22 segundos. Se essa confirmação não for enviada, o sistema entenderå que a notificação não foi recebida e realizarå novas tentativas de envio a cada 15 minutos, até receber uma resposta. Após a terceira tentativa, o prazo serå prorrogado, mas os envios continuarão acontecendo.
ApĂłs responder Ă notificação e confirmar seu recebimento, Ă© possĂvel obter as informaçÔes completas do recurso notificado fazendo uma requisição ao endpoint correspondente da API. Para identificar qual endpoint utilizar, confira a tabela abaixo:
Tópico | URL | Documentação |
payment | https://api.mercadopago.com/v1/payments/[ID] | Obter pagamento |
point_integration_ipn | https://api.mercadopago.com/point/integration-api/payment-intents/{paymentintentid} | Obter intenção de pagamento |
merchant_orders | https://api.mercadopago.com/merchant_orders/[ID] | Obter pedido |
chargebacks | https://api.mercadopago.com/v1/chargebacks/[ID] | Obter estorno |
Com essas informaçÔes, vocĂȘ poderĂĄ realizar as atualizaçÔes necessĂĄrias na sua plataforma como, por exemplo, atualizar um pagamento aprovado.