Payments Search API

This service allows you to search payments

collapse allexpand all

{
  "paging": {
    "total": 1,
    "limit": 30,
    "offset": 0
  },
  "results": [
    {
      "metadata": {
      },
      "corporation_id": null,
      "operation_type": "regular_payment",
      "fee_details": [
        {
          "amount": 3.26,
          "fee_payer": "collector",
          "type": "mercadopago_fee"
        }
      ],
      "notification_url": null,
      "date_approved": "2020-09-11T01:04:31.000-04:00",
      "money_release_schema": null,
      "payer": {
        "first_name": "Test",
        "last_name": "Test",
        "email": "test_user_80507629@testuser.com",
        "identification": {
          "number": "32659430",
          "type": "DNI"
        },
        "phone": {
          "area_code": "01",
          "number": "1111-1111",
          "extension": ""
        },
        "type": "registered",
        "entity_type": null,
        "id": "549039289"
      },
      "transaction_details": {
        "total_paid_amount": 72.5,
        "acquirer_reference": null,
        "installment_amount": 73,
        "financial_institution": null,
        "net_received_amount": 69.24,
        "overpaid_amount": 0,
        "external_resource_url": null,
        "payable_deferral_period": null,
        "payment_method_reference_id": null
      },
      "statement_descriptor": "LIVRARIAFABRI",
      "call_for_authorize_id": null,
      "installments": 1,
      "pos_id": null,
      "external_reference": "47",
      "date_of_expiration": null,
      "charges_details": [
      ],
      "id": 29666399,
      "payment_type_id": "credit_card",
      "order": {
        "id": "1766160356",
        "type": "mercadopago"
      },
      "counter_currency": null,
      "brand_id": null,
      "status_detail": "accredited",
      "differential_pricing_id": null,
      "additional_info": {
        "ip_address": "189.6.247.157",
        "nsu_processadora": null,
        "available_balance": null
      },
      "live_mode": false,
      "marketplace_owner": null,
      "card": {
        "first_six_digits": "503143",
        "expiration_year": 2025,
        "date_created": "2020-09-11T01:04:31.000-04:00",
        "expiration_month": 11,
        "id": null,
        "cardholder": {
          "identification": {
            "number": "01053393008",
            "type": "CPF"
          },
          "name": "APRO"
        },
        "last_four_digits": "6351",
        "date_last_updated": "2020-09-11T01:04:31.000-04:00"
      },
      "integrator_id": null,
      "status": "approved",
      "transaction_amount_refunded": 0,
      "transaction_amount": 72.5,
      "description": "Valor Total da Compra",
      "money_release_date": "2020-09-25T01:04:31.000-04:00",
      "merchant_number": null,
      "refunds": [
      ],
      "authorization_code": null,
      "captured": true,
      "collector_id": 627661261,
      "merchant_account_id": null,
      "taxes_amount": 0,
      "date_last_updated": "2020-09-11T01:04:31.000-04:00",
      "coupon_amount": 0,
      "store_id": null,
      "date_created": "2020-09-11T01:04:31.000-04:00",
      "acquirer_reconciliation": [
      ],
      "sponsor_id": null,
      "shipping_amount": 0,
      "issuer_id": "24",
      "payment_method_id": "master",
      "binary_mode": false,
      "platform_id": null,
      "deduction_schema": null,
      "processing_mode": "aggregator",
      "currency_id": "BRL",
      "shipping_cost": 0
    }
  ]
}
Allowed actions
Retrieves information about all your payments (paid and received)
GET
/v1/payments/search
Retrieves information about your payments
GET
/v1/payments/search?payer.id=me
Retrieves information about your received payments
GET
/v1/payments/search?collector.id=me
Attributes
paging
Provide information about pagination
Data type
Object
Mode
readable
Attributes
total
Data type
Integer
Mode
readable
limit
Data type
Integer
Mode
readable
offset
Data type
Integer
Mode
readable
results
List of payments
Mode
readable
Attributes
id
Payment identifier
Data type
Integer
Mode
searchable
is_test
Is the payment test
Data type
Boolean
Mode
searchable
date_created
Payment’s creation date
Data type
Date(ISO_8601)
Mode
searchable
date_approved
Payment’s approval date
Data type
Date(ISO_8601)
Mode
searchable
date_last_updated
Last modified date
Data type
Date(ISO_8601)
Mode
searchable
money_release_date
Release date of payment
Data type
Date(ISO_8601)
Mode
searchable
collector
Identifies the seller
Data type
Object
Mode
readable
Related resource
https://api.mercadopago.com/users/:payer.id
Attributes
id
Identification of the associated payer
Data type
Integer
Mode
searchable
email
Email
Data type
String
Mode
readable
first_name
First Name
Data type
String
Mode
readable
last_name
Last Name
Data type
String
Mode
readable
nickname
Nickname
Data type
String
Mode
readable
phone
Phone information
Data type
Object
Attributes
extension
Extension
Data type
String
Mode
readable
area_code
Area Code
Data type
String
Mode
readable
number
Number
Data type
String
Mode
readable
operation_type
Type of payment
Data type
String
Mode
searchable
Values
regular_payment
MercadoLibre's article payment or else
money_transfer
Money sent through users
recurring_payment
Automatic recurring payment due to an active user subscription
account_fund
Money income in the user's account
meli_payment
Payment of MercadoLibre's fees
cellphone_recharge
Prepaid Wireless
pos_payment
Payment done through a Point Of Sale
payer
Identifies the buyer
Data type
Object
Mode
readable
Related resource
https://api.mercadopago.com/users/:payer.id
Attributes
type
Identification type of the associated payer
Data type
String
Mode
readable
Values
customer
Payer is a Customer and belongs to the collector
registered
The account corresponds to a MercadoPago registered user
id
Identification of the associated payer
Data type
Integer
Mode
searchable
email
Email
Data type
String
Mode
readable
identification
Personal identification
Data type
Object
Attributes
type
Identification type
Data type
String
Mode
readable
Related resource
https://api.mercadopago.com/sites/:site_id/identification_types
number
Identification number
Data type
String
Mode
readable
first_name
First Name
Data type
String
Mode
readable
last_name
Last Name
Data type
String
Mode
readable
nickname
Nickname
Data type
String
Mode
readable
phone
Phone information
Data type
Object
Attributes
extension
Extension
Data type
String
Mode
readable
area_code
Area Code
Data type
String
Mode
readable
number
Number
Data type
String
Mode
readable
binary_mode
When set to true, the payment can only be approved or rejected. Otherwise in_process status is added
Data type
Boolean
Mode
searchable
live_mode
Whether the payment will be processed in sandbox or in production mode
Data type
Boolean
Mode
readable
order
Order identifier
Data type
Object
Mode
readable
Attributes
type
Type of order
Data type
String
Mode
searchable
Values
mercadolibre
The order is from MercadoLibre
mercadopago
It is a MercadoPago merchant_order
id
Id of the associated purchase order
Data type
Long
Mode
searchable
external_reference
ID given by the merchant in their system
Data type
String
Mode
searchable
description
Payment reason or item title
Data type
String
Mode
searchable
metadata
Valid JSON that can be attached to the payment to record additional attributes of the merchant
Data type
Object
Mode
readable
currency_id
ID of the currency used in the payment
Data type
String(3)
Mode
searchable
Related resource
https://api.mercadopago.com/currencies/:site_id
Values
ARS
Argentine peso
BRL
Brazilian real
VEF
Venezuelan strong bolivar
CLP
Chilean peso
MXN
Mexican peso
COP
Colombian peso
PEN
Peruvian sol
UYU
Uruguayan peso
transaction_amount
Product cost
Data type
Float
Mode
searchable
transaction_amount_refunded
Total refunded amount in this payment
Data type
Float
Mode
searchable
transaction_details
Groups the details of the transaction
Data type
Object
Mode
readable
Attributes
financial_institution
External financial institution identifier (e.g.: company id for atm)
Data type
String
Mode
searchable
net_received_amount
Amount received by the seller
Data type
Float
Mode
searchable
total_paid_amount
Total amount paid by the buyer (includes fees)
Data type
Float
Mode
searchable
installment_amount
descricpción
Data type
Float
Mode
searchable
overpaid_amount
Amount overpaid (only for tickets)
Data type
Float
Mode
searchable
external_resource_url
Identifies the resource in the payment processor
Data type
String
Mode
searchable
payment_method_reference_id
For credit card payments is the USN. For offline payment methods, is the reference to give to the cashier or to input into the ATM.
Data type
String
Mode
searchable
fee_details
List of fees
Data type
Array(Object)
Mode
readable
Attributes
type
Fee detail
Data type
String
Mode
searchable
Values
mercadopago_fee
Cost for using MercadoPago
coupon_fee
Discount given by a coupon
financing_fee
Cost of financing
shipping_fee
Shipping cost
application_fee
Marketplace comision for the service
discount_fee
Discount given by the seller through cost absorption
fee_payer
Who absorbs the cost
Data type
String
Mode
searchable
Values
collector
The seller absorbs the cost
payer
The buyer absorbs the cost
amount
Fee amount
Data type
Float
Mode
searchable
status
Payment status
Data type
String
Mode
searchable
Values
pending
The user has not completed the payment process
approved
The payment has been approved and accredited
in_process
Payment is being reviewed
rejected
Payment was rejected. The user may retry payment.
cancelled
Payment was cancelled by one of the parties or because time for payment has expired
refunded
Payment was refunded to the user
charged_back
Was made a chargeback in the buyer’s credit card
status_detail
Gives more detailed information on the current state or rejection cause
Data type
String
Mode
searchable
captured
Determines if the capture operation was performed (just for credit cards)
Data type
Boolean
Mode
searchable
call_for_authorize_id
Identifier that must be provided to the issuing bank to authorize the payment
Data type
String
Mode
searchable
payment_method_id
Payment method chosen to do the payment
Data type
String
Mode
searchable
Related resource
https://api.mercadopago.com/v1/payment_methods
issuer_id
descricpcion
Data type
String
Mode
searchable
payment_type_id
Type of payment method chosen
Data type
String
Mode
searchable
Related resource
https://api.mercadopago.com/payment_types
Values
account_money
Money in the MercadoPago account
ticket
Printed ticket
bank_transfer
Wire transfer
atm
Payment by ATM
credit_card
Payment by credit card
debit_card
Payment by debit card
prepaid_card
Payment by prepaid card
card
Details of the card used
Data type
Object
Mode
readable
Attributes
id
Id of the card
Data type
Number
Mode
searchable
last_four_digits
Last four digits of card number
Data type
String
Mode
searchable
first_six_digits
First six digit of card number
Data type
String
Mode
searchable
expiration_year
Card expiration year
Data type
Integer
Mode
searchable
expiration_month
Card expiration month
Data type
Integer
Mode
searchable
date_created
Creation date of card
Data type
Date(ISO_8601)
Mode
searchable
date_last_updated
Last update of data from the card
Data type
Date(ISO_8601)
Mode
searchable
cardholder
Card's owner data
Data type
Object
Attributes
name
Cardholder Name
Data type
String
Mode
searchable
identification
ID of the cardholder
Data type
Object
Attributes
number
Document number
Data type
String
Mode
searchable
type
Document type
Data type
String
Mode
searchable
Related resource
https://api.mercadopago.com/sites/:site_id/identification_types
statement_descriptor
How will look the payment in the card bill (e.g.: MERCADOPAGO)
Data type
String
Mode
searchable
installments
Selected quantity of installments
Data type
Integer
Mode
searchable
notification_url
URL where mercadopago will send notifications associated to changes in this payment
Data type
String
Mode
searchable
refunds
List of refunds that were made to this payment
Data type
Array(Object)
Mode
readable
Related resource
https://api.mercadopago.com/v1/payments/:payment_id/refunds/:refunds_id
Attributes
id
Refund identifier
Data type
Number
Mode
searchable
payment_id
Payment on which the return was made
Data type
Number
Mode
searchable
Related resource
https://api.mercadopago.com/v1/payments/:payment_id
amount
Amount refunded
Data type
Float
Mode
searchable
metadata
Valid JSON that can be attached to the payment to record additional attributes of the merchant
Data type
Object
Mode
readable
source
Who made the refund
Data type
Object
Attributes
id
User ID who issued the refund
Data type
String
name
User who issued the refund
Data type
String
type
Type of user who issued the refund
Data type
String
Values
collector
The collector issued the refund
operator
The refund was made by an account's operator
admin
The refund was made by a MercadoPago administrator
bpp
The refund was made by the MercadoPago's Buyer Protection Program
date_created
Date of refund
Data type
Date(ISO_8601)
Mode
searchable
unique_sequence_number
Refund identifier given by the card processor
Data type
String
Mode
searchable