/v1/payments
BASE URI https://api.mercadopago.com/v1/payments
HTTP Request
curl
curl -X POST \
'https://api.mercadopago.com/v1/payments' \
-H 'Authorization: Bearer ACCESS_TOKEN_ENV' \
-d '{
"token":"b3a7dbec3eb0d71798c4f19fec445795",
"installments":1,
"transaction_amount":58.80,
"description":"Point Mini a maquininha que dá o dinheiro de suas vendas na hora",
"payment_method_id":"visa",
"payer":{
"email":"test_user_123456@testuser.com",
"identification": {
"number": "19119119100",
"type": "CPF"
}
},
"notification_url":"https://www.suaurl.com/notificacoes/",
"sponsor_id":null,
"binary_mode":false,
"external_reference":"MP0001",
"statement_descriptor":"MercadoPago",
"additional_info":{
"items":[
{
"id":"PR0001",
"title":"Point Mini",
"description": "Producto Point para cobros con tarjetas mediante bluetooth",
"picture_url":"https://http2.mlstatic.com/resources/frontend/statics/growth-sellers-landings/device-mlb-point-i_medium@2x.png",
"category_id": "electronics",
"quantity":1,
"unit_price":58.80
}
],
"payer":{
"first_name":"Nome",
"last_name":"Sobrenome",
"address":{
"zip_code":"06233-200",
"street_name":"Av das Nacoes Unidas",
"street_number":3003
},
"registration_date":"2019-01-01T12:01:01.000-03:00",
"phone":{
"area_code":"011",
"number":"987654321"
}
},
"shipments":{
"receiver_address":{
"street_name":"Av das Nacoes Unidas",
"street_number":3003,
"zip_code":"06233200",
"city_name": "Buzios",
"state_name": "Rio de Janeiro"
}
}
}
}'
Request Params
ParameterTypeDescription
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).
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.
transaction_amount
Float
Custo do produto. (Obrigatório)
coupon_amount
Float
Valor do cupom de desconto.
date_of_expiration
Date(ISO_8601)
Data de expiração do pagamento.
campaign_id
Integer
Identificador da campanha de desconto.
coupon_code
String
Campanha de desconto com um código específico.
differential_pricing_id
Integer
Id do esquema de absorção do custo financeiro.
application_fee
Float
Comissão coletadas pelo mercado ou pelo Mercado Pago.
capture
Boolean
Determina se o pagamento deve ser capturado(true, default value), ou apenas reservado(false).
payment_method_id
String
Meio de pagamento escolhido para fazer o pagamento. (Obrigatório)
issuer_id
String
Id do emitente do meio de pagamento.
token
String
Identificador de token card. (Obrigatório para cartão de crédito)
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.
callback_url
String
URL para a qual o Mercado Pago faz o redirecionamento final (apenas para transferência bancária).
additional_info
Object
Informações que podem melhorar a análise de prevenção de fraude e a taxa de conversão. Trata de enviar-nos toda a informação possível.
ip_address
String
IP do qual provém o request (apenas para transferência bancária).
items
Array(Object)
Lista de itens a pagar.
id
String
Código de anúncio.
title
String
Nome do item.
description
String
Descrição do artigo.
picture_url
String
URL da imagem.
category_id
String
Categoria do item.
quantity
Integer
Quantidade de itens.
unit_price
Float
Preço unitário.
payer
Object
Informação do comprador.
first_name
String
Nome do comprador.
last_name
String
Apelido do comprador.
phone
Object
Telefone do comprador.
area_code
String
Código de área.
number
String
Número de telefone.
address
Object
Endereço.
zip_code
String
Código postal.
street_name
String
Rua.
street_number
Integer
O Número.
registration_date
Date
Data de cadastro do comprador em seu site.
shipments
Object
Informações de envio.
receiver_address
Object
Endereço do comprador.
zip_code
String
Zip code.
state_name
String
Província.
city_name
String
Cidade.
street_name
String
Rua.
street_number
Integer
O Número.
floor
String
Apartamento.
apartment
String
Departamento.
barcode
Object
Informação de código de barra.
type
String
Tipo de encoding.
UCC/EAN 128
Encodes data using the Code 128 symbology.
Code128C
High-density alphanumeric code.
Code39
Media density code.
content
String
Código de barras gerado.
width
Integer
Largura do código de barras.
height
Integer
Altura do código de barras.
HTTP Response
json
{
"id": 20359978,
"date_created": "2019-07-10T10:47:58.000-04:00",
"date_approved": "2019-07-10T10:47:58.000-04:00",
"date_last_updated": "2019-07-10T10:47:58.000-04:00",
"date_of_expiration": null,
"money_release_date": "2019-07-24T10:47:58.000-04:00",
"operation_type": "regular_payment",
"issuer_id": "25",
"payment_method_id": "visa",
"payment_type_id": "credit_card",
"status": "approved",
"status_detail": "accredited",
"currency_id": "[FAKER][CURRENCY][ACRONYM]",
"description": "Point Mini a maquininha que dá o dinheiro de suas vendas na hora",
"live_mode": false,
"sponsor_id": null,
"authorization_code": null,
"money_release_schema": null,
"taxes_amount": 0,
"counter_currency": null,
"shipping_amount": 0,
"pos_id": null,
"store_id": null,
"collector_id": 448876418,
"payer": {
"first_name": "Test",
"last_name": "Test",
"email": "test_user_80507629@testuser.com",
"identification": {
"number": "19119119100",
"type": "CPF"
}
"phone": {
"area_code": "011",
"number": "987654321",
"extension": ""
},
"type": "guest",
"entity_type": null,
"id": null
},
"metadata": {},
"additional_info": {
"items": [
{
"id":"PR0001",
"title":"Point Mini",
"description": "Producto Point para cobros con tarjetas mediante bluetooth",
"picture_url":"https://http2.mlstatic.com/resources/frontend/statics/growth-sellers-landings/device-mlb-point-i_medium@2x.png",
"category_id": "electronics",
"quantity":1,
"unit_price":58.80
}
],
"payer": {
"phone": {
"area_code": "11",
"number": "987654321"
},
"address": {
"zip_code": "06233-200",
"street_name": "Av das Nacoes Unidas",
"street_number": "3003"
},
"first_name": "Nome",
"last_name": "Sobrenome",
"registration_date": "2019-01-01T12:01:01.000-03:00"
},
"shipments": {
"receiver_address":{
"street_name":"Av das Nacoes Unidas",
"street_number":3003,
"zip_code":"06233200",
"city_name": "Buzios",
"state_name": "Rio de Janeiro"
}
}
},
"order": {},
"external_reference": "MP0001",
"transaction_amount": 58.8,
"transaction_amount_refunded": 0,
"coupon_amount": 0,
"differential_pricing_id": null,
"deduction_schema": null,
"transaction_details": {
"payment_method_reference_id": null,
"net_received_amount": 56.16,
"total_paid_amount": 58.8,
"overpaid_amount": 0,
"external_resource_url": null,
"installment_amount": 58.8,
"financial_institution": null,
"payable_deferral_period": null,
"acquirer_reference": null
},
"fee_details": [
{
"type": "mercadopago_fee",
"amount": 2.64,
"fee_payer": "collector"
}
],
"captured": true,
"binary_mode": false,
"call_for_authorize_id": null,
"statement_descriptor":"MercadoPago",
"installments": 1,
"card": {
"id": null,
"first_six_digits": "423564",
"last_four_digits": "5682",
"expiration_month": 6,
"expiration_year": 2023,
"date_created": "2019-07-10T10:47:58.000-04:00",
"date_last_updated": "2019-07-10T10:47:58.000-04:00",
"cardholder": {
"name": "APRO",
"identification": {
"number": "19119119100",
"type": "CPF"
}
}
},
"notification_url": "https://www.suaurl.com/notificacoes/",
"refunds": [],
"processing_mode": "aggregator",
"merchant_account_id": null,
"acquirer": null,
"merchant_number": null,
"acquirer_reconciliation": []
}
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.
23
The following parameters must be valid date and format (yyyy-MM-dd'T'HH:mm:ssz) date_of_expiration.
1000
Number of rows exceeded the limits.
1001
Date format must be yyyy-MM-dd'T'HH:mm:ss.SSSZ.
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.
2060
The customer can't be equal to the collector.
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.
4000
card atributte can't be null.
4001
payment_method_id atributte can't be null.
4002
transaction_amount atributte can't be null.
4003
transaction_amount atributte must be numeric.
4004
installments atributte can't be null.
4005
installments atributte must be numeric.
4006
payer atributte is malformed.
4007
site_id atributte can't be null.
4012
payer.id atributte can't be null.
4013
payer.type atributte can't be null.
4015
payment_method_reference_id atributte can't be null.
4016
payment_method_reference_id atributte must be numeric.
4017
status atributte can't be null.
4018
payment_id atributte can't be null.
4019
payment_id atributte must be numeric.
4020
notificaction_url atributte must be url valid.
4021
notificaction_url atributte must be shorter than 500 character.
4022
metadata atributte must be a valid JSON.
4023
transaction_amount atributte can't be null.
4024
transaction_amount atributte must be numeric.
4025
refund_id can't be null.
4026
Invalid coupon_amount.
4027
campaign_id atributte must be numeric.
4028
coupon_amount atributte must be numeric.
4029
Invalid payer type.
4037
Invalid transaction_amount.
4038
application_fee cannot be bigger than transaction_amount.
4039
application_fee cannot be a negative value.
4050
payer.email must be a valid email.
4051
payer.email must be shorter than 254 characters.
7523
Invalid expiration date.