/v1/payments/search
BASE URI https://api.mercadopago.com/v1/payments/search
HTTP Request
curl
curl -X GET \
'https://api.mercadopago.com/v1/payments/search?sort=date_created&criteria=desc&external_reference="ID_REF"' \
-H 'Authorization: Bearer ACCESS_TOKEN'
Request Params
ParameterTypeDescription
id
Long
Identificador de pagamento.
date_created
Date(ISO_8601)
Data de criação do pagamento.
date_approved
Date(ISO_8601)
Data de aprovação do pagamento.
date_last_updated
Date(ISO_8601)
Data da última modificação.
money_release_date
Date(ISO_8601)
Data de liberação do pagamento.
operation_type
String
Tipo de pagamento.
regular_payment
Typification by default of a purchase being paid using Mercado Pago.
money_transfer
Funds transfer between two users.
recurring_payment
Automatic recurring payment due to an active user subscription.
account_fund
Money income in the user's account.
payment_addition
Addition of money to an existing payment, done in Mercado Pago's site.
cellphone_recharge
Recharge of a user's cellphone account.
pos_payment
Payment done through a Point Of Sale.
payer
Object
Id do pagador.
entity_type
String
Tipo de entidade do pagador (apenas para transferências bancárias).
individual
Payer is individual.
association
Payer is an association.
type
String
Tipo de identificação do pagador associado (se necessário o pagador é um cliente).
customer
Payer is a Customer and belongs to the collector.
registered
The account corresponds to a Mercado Pago registered user.
guest
The payer doesn't have an account.
id
String
Identificação do pagador associado.
email
String
E-mail. (Obrigatório)
identification
Object
Identificação pessoal.
type
String
Tipo de identificação.
number
String
Número de identificação.
phone
Object
Telefone do pagador associado.
area_code
String
Código de área.
number
String
Número de telefone.
extension
String
Extensão do número de telefone.
first_name
String
Nome do pagador associado.
last_name
String
Nome do pagador associado.
binary_mode
Boolean
Quando estiver ativado, o pagamento só pode ser aprovado ou rejeitado. De não estar ativado, para além deste estado, o pagamento pode ser pendente (in_process).
live_mode
Boolean
Indica se o pagamento é processado em ambiente de sandbox ou produção.
order
Object
Identificador de ordem.
type
String
Tipo de ordem.
mercadolibre
The order is from Mercado Libre.
mercadopago
It is a Mercado Pago merchant_order.
id
Long
Identificação da ordem de compra associada.
external_reference
String
Identificação fornecida pelo vendedor em seu sistema.
description
String
Razão de pagamento ou título do item.
metadata
Object
JSON válido que pode ser adicionado ao pagamento para salvar atributos adicionais do comprador.
currency_id
String(3)
Identificador da moeda utilizada no pagamento.
ARS
Argentine peso.
BRL
Brazilian real.
CLP
Chilean peso.
MXN
Mexican peso.
COP
Colombian peso.
PEN
Peruvian sol.
UYU
Uruguayan peso.
transaction_amount
Float
Custo do produto. (Obrigatório)
transaction_amount_refunded
Float
Valor total reembolsado este pagamento.
transaction_details
Object
Agrupa os detalhes da transação.
financial_institution
String
Identificação da instituição financeira externa (por ex: company id para atm)
net_received_amount
Float
Valor recebido pelo vendedor.
total_paid_amount
Float
Valor pago pelo comprador (inclui comissões).
installment_amount
Float
Valor total da quota.
overpaid_amount
Float
Valor pago por outras pessoas (apenas para tickets).
external_resource_url
String
Identifica o recurso no processador de pagamento.
payment_method_reference_id
String
Para pagamentos com cartão de crédito é USN. Para meios de pagamento offline é a referência para lhe dar o caixa ou introduzir no ATM.
fee_details
Array(Object)
Lista de comissões.
type
String
Detalhe de comissão.
mercadopago_fee
Cost for using Mercado Pago.
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
String
Quem absorve o custo da comissão.
collector
The seller absorbs the cost.
payer
The buyer absorbs the cost.
amount
Float
Valor da comissão.
status
String
Estado do pagamento.
pending
The user has not yet completed the payment process.
approved
The payment has been approved and accredited.
authorized
The payment has been authorized but not captured yet.
in_process
Payment is being reviewed.
in_mediation
Users have initiated a dispute.
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
String
Fornece informação detalhada do estado atual, ou o motivo de rejeição.
captured
Boolean
Determina se a captura de a operação foi realizada (somente para cartões de crédito).
call_for_authorize_id
String
Identificador que deve ser fornecida ao banco emissor para autorizar o pagamento.
payment_method_id
String
Meio de pagamento escolhido para fazer o pagamento. (Obrigatório)
issuer_id
String
Id do emitente do meio de pagamento.
payment_type_id
String
Tipo do meio de pagamento escolhido.
account_money
Money in the Mercado Pago 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
Object
Os detalhes do cartão utilizado.
id
Number
Identificação da placa.
last_four_digits
String
Últimos quatro dígitos do número do cartão.
first_six_digits
String
Os primeiros seis dígitos do número do cartão.
expiration_year
Integer
Ano de validade do cartão.
expiration_month
Integer
Mês de validade do cartão.
date_created
Date(ISO_8601)
Data de criação do cartão.
date_last_updated
Date(ISO_8601)
Data de última atualização de informações de cartão.
cardholder
Object
Informações sobre o dono do cartão.
name
String
Nome do proprietário tarjata.
identification
Object
Identificação do proprietário do cartão.
number
String
Número do documento.
type
String
Tipo de documento.
statement_descriptor
String
Como aparecerá o pagamento no extrato do cartão (ex: o MERCADOPAGO).
installments
Integer
Quantidade selecionada de cotas. (Obrigatório)
notification_url
String
URL para qual Mercado Pago enviará notificações associadas a mudanças no status do pagamento.
refunds
Array(Object)
Lista de reembolsos que foram feitas a este pagamento.
id
Number
Identificador de reembolso.
payment_id
Number
Id do pagamento, o qual lhe fez um reembolso.
amount
Float
Valor reembolsado.
metadata
Object
JSON válido que pode ser adicionado ao pagamento para salvar atributos adicionais do comprador.
source
Object
Quem fez o reembolso.
id
String
Id do usuário que fez o reembolso.
name
String
Nome do usuário que fez o reembolso.
type
String
Tipo de usuário que fez o reembolso.
collector
The collector issued the refund.
operator
The refund was made by an account's operator.
admin
The refund was made by a Mercado Pago administrator.
bpp
The refund was made by the Mercado Pago's Buyer Protection Program
date_created
Date(ISO_8601)
Data do reembolso.
unique_sequence_number
String
Identificador de reembolso concedido pelo processador de cartão.
HTTP Response
json
{
"paging": {
"total": 17493,
"limit": 30,
"offset": 0
},
"results": [
{
"id": "0000001",
"date_created": "2017-08-31T07:26:38.000-04:00",
"date_approved": "2017-08-31T07:26:38.000-04:00",
"date_last_updated": "2017-08-31T07:26:38.000-04:00",
"date_of_expiration": null,
"money_release_date": "2017-09-14T07:26:38.000-04:00",
"operation_type": "money_transfer",
"issuer_id": null,
"payment_method_id": "account_money",
"payment_type_id": "account_money",
"status": "approved",
"status_detail": "accredited",
"currency_id": "[FAKER][CURRENCY][ACRONYM]",
"description": "Pago Pizza",
"live_mode": true,
"sponsor_id": null,
"authorization_code": null,
"money_release_schema": null,
"counter_currency": null,
"collector_id": "0000002",
"payer": {
"type": "registered",
"id": "000001",
"email": "afriend@gmail.com",
"identification": {
"type": "DNI",
"number": "12345678"
},
"phone": {
"area_code": null,
"number": "11123456789",
"extension": null
},
"first_name": "Name",
"last_name": "LastName",
"entity_type": null
},
"metadata": {},
"additional_info": {},
"order": {},
"external_reference": null,
"transaction_amount": 250,
"transaction_amount_refunded": 0,
"coupon_amount": 0,
"differential_pricing_id": null,
"deduction_schema": null,
"transaction_details": {
"net_received_amount": 250,
"total_paid_amount": 250,
"overpaid_amount": 0,
"external_resource_url": null,
"installment_amount": 250,
"financial_institution": null,
"payment_method_reference_id": null,
"payable_deferral_period": null,
"acquirer_reference": null
},
"fee_details": [],
"captured": true,
"binary_mode": false,
"call_for_authorize_id": null,
"statement_descriptor": null,
"installments": 1,
"card": {},
"notification_url": null,
"refunds": [],
"processing_mode": null,
"merchant_account_id": null,
"acquirer": null,
"merchant_number": null,
"acquirer_reconciliation": []
}
{
"id": "0000002",
...
},
{
"id": "0000003",
...
},
{
"id": "0000030",
}
]
}
Error Codes
CodeDescription
404 NOT_FOUND
2000
Payment not found.
403 FORBIDDEN
4
The caller is not authorized to access this resource.
3002
The caller is not authorized to perform this action.
400 BAD_REQUEST
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.
2004
POST to Gateway Transactions API fail.
2002
Customer not found.
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.