Payments

Mercado Pago is the payment open platform of Mercado Libre. If you want integrate your business to a payment solution in your applation, you can visit Mercado Pago Developers.

Contents

→Receive a notification →Get details of a payment →Multiple payments →Cashback in account for canceled sales →Check account balance →Reasons for unavailable amounts


Receive a notification

To receive payment notifications, be sure to subscribe your app to payments topic. Learn about the rest of the available topics and more details about the payments topic.


Get details of a payment

To obtain information on a buyer's payment, perform the following GET:

Request:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadopago.com/v1/payments/$PAYMENT_ID

Example:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadopago.com/v1/payments/3506756222

Response:

{
  "counter_currency": null,
  "acquirer_reconciliation": [
  ],
  "statement_descriptor": "MERCADOPAGO",
  "captured": true,
  "fee_details": [
    {
      "amount": 487.2,
      "fee_payer": "payer",
      "type": "financing_fee"
    }
  ],
  "acquirer": null,
  "date_last_updated": "2018-03-05T10:06:55.000-04:00",
  "date_created": "2018-03-05T10:06:54.000-04:00",
  "id": 3506756222,
  "merchant_account_id": null,
  "issuer_id": "157",
  "date_of_expiration": null,
  "external_reference": "1653027692",
  "order": {
    "id": "1653027692",
    "type": "mercadolibre"
  },
  "transaction_amount": 3500,
  "description": "Maquina Industrial Recta Marca ",
  "card": {
    "id": null,
    "first_six_digits": "371772",
    "expiration_month": 10,
    "cardholder": {
      "identification": {
        "number": null,
        "type": null
      },
      "name": "JOAN C GONZALEZ GUZMAN"
    },
    "date_last_updated": "2018-03-05T10:06:54.000-04:00",
    "date_created": "2018-03-05T10:06:54.000-04:00",
    "expiration_year": 2019,
    "last_four_digits": "1001"
  },
  "transaction_details": {
    "total_paid_amount": 3987.2,
    "acquirer_reference": null,
    "payment_method_reference_id": null,
    "net_received_amount": 3500,
    "financial_institution": null,
    "payable_deferral_period": null,
    "installment_amount": 443.02,
    "external_resource_url": null,
    "overpaid_amount": 0
  },
  "coupon_amount": 0,
  "merchant_number": null,
  "call_for_authorize_id": null,
  "metadata": {
  },
  "currency_id": "MXN",
  "money_release_schema": null,
  "collector_id": 277582551,
  "status": "approved",
  "sponsor_id": null,
  "deduction_schema": null,
  "payment_method_id": "amex",
  "additional_info": {
    "items": [
      {
        "id": "MLM610028711",
        "title": "Maquina Industrial Recta Marca",
        "picture_url": null,
        "description": null,
        "category_id": "MLM184696",
        "quantity": "1",
        "unit_price": "3500"
      }
    ]
  },
  "processing_mode": "aggregator",
  "status_detail": "accredited",
  "binary_mode": false,
  "operation_type": "regular_payment",
  "installments": 9,
  "money_release_date": "2018-03-26T10:06:55.000-04:00",
  "payer": {
    "id": "53745235",
    "first_name": "Joan Carlos",
    "phone": {
      "extension": null,
      "area_code": null,
      "number": "5558800201"
    },
    "email": null,
    "identification": {
      "number": "83092109600",
      "type": "IFE"
    },
    "last_name": "Gonzalez Guzman",
    "entity_type": null,
    "type": "registered"
  },
  "notification_url": null,
  "transaction_amount_refunded": 0,
  "refunds": [
  ],
  "date_approved": "2018-03-05T10:06:55.000-04:00",
  "authorization_code": "211118",
  "payment_type_id": "credit_card",
  "live_mode": true
}

See more details on how look for a payment and get the payment in Mercado Pago Developers.


Multiple payments

In some cases, when the payment is declined due to the credit card limit, we allow users to add another payment with a second credit card.

When you make a GET request to the Orders API, you will see that within the payment set there will be two IDs with the details of each payment.
Example:

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/orders/893431118

Response:

{
  "buyer": {
      "alternative_phone": {
          "area_code": null,
          "extension": null,
          "number": ""
      },
      "billing_info": {
          "doc_number": "67045427794",
          "doc_type": "CPF"
      },
      "email": "test_user_21963158@testuser.com",
      "first_name": "Test",
      "id": 160903317,
      "last_name": "Test",
      "nickname": "TETE2022123",
  },
  "coupon": {
      "amount": 0,
      "id": null
    },
  "currency_id": "BRL",
  "date_closed": null,
  "date_created": "2014-10-26T22:46:18.000-04:00",
  "feedback": {
      "purchase": null,
      "sale": null
  },
  "id": 893431118,
  "last_updated": "2014-10-26T22:50:10.000-04:00",
    "mediations": [],
  "order_items": [
      {
          "currency_id": "BRL",
          "item": {
              "id": "MLB600034093",
              "title": "Item De Testeo, Por Favor No Ofertar --kc:off",
              "variation_attributes": [],
              "variation_id": null
          },
          "quantity": 1,
          "unit_price": 591
      }
  ],
  "paid_amount": 591,
  "payments": [
      {
          "activation_uri": null,
          "atm_transfer_reference": {
              "company_id": null,
                "transaction_id": null
          },
            "available_actions": [],
          "card_id": null,
          "collector": {
              "id": 169648308
          },
          "coupon_amount": 0,
          "coupon_id": null,
          "currency_id": "BRL",
          "date_created": "2014-10-26T22:48:46.000-04:00",
            "date_last_modified": "2014-10-27T00:51:53.000-04:00",
          "id": 885920310,
          "installments": 1,
          "issuer_id": "25",
          "operation_type": "regular_payment",
          "order_id": 893431118,
          "overpaid_amount": 0,
          "payer_id": 160903317,
            "payment_method_id": "visa",
          "payment_type": "credit_card",
          "reason": "Item De Testeo, Por Favor No Ofertar --kc:off",
          "shipping_cost": 0,
          "site_id": "MLB",
          "status": "approved",
          "status_code": null,
          "status_detail": "accredited",
            "total_paid_amount": 296,
            "transaction_amount": 296
      },
      {
          "activation_uri": null,
            "atm_transfer_reference": {
              "company_id": null,
                "transaction_id": null
          },
            "available_actions": [],
          "card_id": null,
          "collector": {
              "id": 169648308
          },
          "coupon_amount": 0,
          "coupon_id": null,
          "currency_id": "BRL",
          "date_created": "2014-10-26T22:50:10.000-04:00",
            "date_last_modified": "2014-10-26T22:50:21.000-04:00",
          "id": 885920410,
          "installments": 3,
          "issuer_id": "25",
          "operation_type": "regular_payment",
          "order_id": 893431118,
          "overpaid_amount": 0,
          "payer_id": 160903317,
            "payment_method_id": "visa",
          "payment_type": "credit_card",
          "reason": "Item De Testeo, Por Favor No Ofertar --kc:off",
          "shipping_cost": 0,
          "site_id": "MLB",
          "status": "approved",
          "status_code": null,
          "status_detail": "accredited",
            "total_paid_amount": 315.62,
            "transaction_amount": 295
      }
  ],
  "seller": {
      "alternative_phone": {
          "area_code": null,
          "extension": null,
          "number": ""
      },
      "email": "test_user_70385259@testuser.com",
      "first_name": "Test",
      "id": 169648308,
      "last_name": "Test",
      "nickname": "TETE6072468",
      "phone": {
          "area_code": "01",
          "extension": null,
          "number": "1111-1111"
      }
  },
  "shipping": {
      "status": "null"
  },
  "status": "paid",
  "status_detail": null,
  "tags": [
      "not_delivered",
      "paid"
  ],
  "total_amount": 591,

}

Cashback in account for canceled sales

Important:
It is only available for sellers in Mexico and soon, for those in Argentina and Brazil.

In the event of cancellations, buyers with a good reputation and who make payments with a credit or debit card will automatically receive a refund with money in the Mercado Pago account. In this way, the purchase order remains in a different state with respect to the other flows. The changes will be:

  • status = paid
  • New tag: unfulfilled
Note:
The order will never have the status canceled since by means of the return with money in the account it generates that the payment must be completed. In the payment of the order you will find the refund_account_money tag.

Check account balance

When you have money in your account, you can check your balance using the Mercado Pago Account feature.

curl -X GET -H 'Authorization: Bearer $ACCESS_TOKEN' https://api.mercadolibre.com/users/$USER_ID/mercadopago_account/balance

In the answer you will find several values ​​separated by status and availability. The parameter "unavailable_balance_by_reason" shows the unavailable amounts and will indicate the reason why they are not available. You can also see the amounts available for transfer, withdrawal and payment (credit in the Pago Market) in the parameter "available_balance_by_transaction_type."

Reasons for unavailable amounts

  • dispute: amount blocked while the order is in dispute.
  • fraud: amount blocked due to suspected fraud.
  • ml_debt: amount destined only to MercadoLibre cost.
  • time_period: amount blocked by default time processing Mercado Pago.
  • restriction: amount blocked for other reasons.

This is the information you need. For more information on how to work with Mercado Pago, visit the MercadoPago Developers website.

Next: Feedback on sale.

or register to recieve the latest news about our API