Home
Documentation
Resources
Certifications
Community

Resources

Check for updates on our solutions and system performance, or request technical support.

Community

Get the latest news, ask others for help and share your knowledge.

Search payments - Payments - Mercado Pago Developers

Intelligent search powered by OpenAI 

Search payments

GET

https://api.mercadopago.com/v1/payments/search
This endpoint allows for searches and returns payments made in the last twelve months from the date of the query. In case of success, the request will return a response with status 200.
Request's parameters
QUERY
sort
string

REQUIRED

Parameter used for ordering a list of payments. Sorting can be done using the following attributes - "date_approved", "date_created", "date_last_updated", "id", "money_release_date". Por exemplo, se você escolher o atrib...View more
criteria
string

REQUIRED

It sorts the payments in ascending order (using “asc”) or in descending order (“desc”).
external_reference
string

REQUIRED

It is a payment’s external reference. It could be, for example, a hashcode from the Central Bank, working as a transaction origin identifier.
range
string

REQUIRED

Parameter used to define the payments search interval. The range can refer to the following attributes - "date_created", "date_last_updated", "date_approved", "money_release_date". If not informed, use default "date_crea...View more
Response parameters
paging
object
Information for pagination of search results.
results
array
Search results.
Errors

400Error

1

Params Error.

3

Token must be for test.

5

Must provide your access_token to proceed.

1000

Number of rows exceeded the limits.

1001

Date format must be yyyy-MM-dd'T'HH:mm:ss.SSSZ.

1003

Invalid sort value.

1004

Invalid criteria value.

2001

Already posted the same request in the last minute.

2002

Customer not found.

2004

POST to Gateway Transactions API fail.

2006

Card Token not found.

2007

Connection to Card Token API fail.

2009

Card token issuer can't be null.

3000

You must provide your cardholder_name with your card data.

3001

You must provide your cardissuer_id with your card data.

3003

Invalid card_token_id.

3004

Invalid parameter site_id.

3005

Not valid action, the resource is in a state that does not allow this operation. For more information see the state that has the resource.

3006

Invalid parameter cardtoken_id.

3007

The parameter client_id can not be null or empty.

3008

Not found Cardtoken.

3009

unauthorized client_id.

3010

Not found card on whitelist.

3011

Not found payment_method.

3012

Invalid parameter security_code_length.

3013

The parameter security_code is a required field can not be null or empty.

3014

Invalid parameter payment_method.

3015

Invalid parameter card_number_length.

3016

Invalid parameter card_number.

3017

The parameter card_number_id can not be null or empty.

3018

The parameter expiration_month can not be null or empty.

3019

The parameter expiration_year can not be null or empty.

3020

The parameter cardholder.name can not be null or empty.

3021

The parameter cardholder.document.number can not be null or empty.

3022

The parameter cardholder.document.type can not be null or empty.

3023

The parameter cardholder.document.subtype can not be null or empty.

3024

Not valid action - partial refund unsupported for this transaction.

3025

Invalid Auth Code.

3026

Invalid card_id for this payment_method_id.

3027

Invalid payment_type_id.

3028

Invalid payment_method_id.

3029

Invalid card expiration month.

3030

Invalid card expiration year.

9062

Invalid range interval - Must be less than 365 days.

bad request

The attribute [query param name] is not a possible param.

403Error

4

The caller is not authorized to access this resource.

3002

The caller is not authorized to perform this action.

404Error

2000

Payment not found.

Request
curl -X GET \
    'https://api.mercadopago.com/v1/payments/search?sort=date_created&criteria=desc&external_reference=ID_REF&range=date_created&begin_date=NOW-30DAYS&end_date=NOW&store_id=47792478&pos_id=58930090&collector.id=448876418&payer.id=1162600213'\
    -H 'Content-Type: application/json' \
       -H 'Authorization: Bearer TEST-7719*********832-03141*********ec9309854*********f1e54b5-1*********' \
    
Sample answer
[
  {
    "paging": {
      "total": 17493,
      "limit": 30,
      "offset": 0
    },
    "results": [
      {
        "id": 1,
        "date_created": "2017-08-31T11:26:38.000Z",
        "date_approved": "2017-08-31T11:26:38.000Z",
        "date_last_updated": "2017-08-31T11:26:38.000Z",
        "money_release_date": "2017-09-14T11:26:38.000Z",
        "payment_method_id": "PSE",
        "payment_type_id": "credit_card",
        "status": "approved",
        "status_detail": "accredited",
        "currency_id": "BRL",
        "description": "Pago Pizza",
        "collector_id": 2,
        "payer": {
          "id": 123,
          "email": "test_user_80507629@testuser.com",
          "identification": {
            "type": "CPF",
            "number": 19119119100
          },
          "type": "customer"
        },
        "metadata": {},
        "additional_info": {},
        "external_reference": "MP0001",
        "transaction_amount": 250,
        "transaction_amount_refunded": 0,
        "coupon_amount": 0,
        "transaction_details": {
          "net_received_amount": 250,
          "total_paid_amount": 250,
          "overpaid_amount": 0,
          "installment_amount": 250
        },
        "installments": 1,
        "card": {}
      }
    ]
  }
]