/pos
BASE URI https://api.mercadopago.com/pos
HTTP Request
curl
curl -X POST \
'https://api.mercadopago.com/pos' \
-H 'Authorization: Bearer PROD_ACCESS_TOKEN' \
-d '{
"name":"Caja Principal",
"fixed_amount": true,
"category": 621102,
"store_id": "123456",
"external_store_id": "BK021",
"external_id": "4lph4num3r1c",
"url": "https://www.miempresa.com/MP?locationId=6232&positionId=01"
}'
Request Params
ParameterTypeDescription
name
String
Nome da caixa. (Mandatório)
fixed_amount
Boolean
Determine se o cliente pode inserir o valor a ser pago. (Mandatório)
true
O cliente não pode escolher o valor a ser pago, deve aguardar a geração de um pedido.
false
Depois de ler o código QR da caixa, o cliente digita o valor a ser pago.
category
Long
Código MCC que indica a categoria do ponto de venda. Se não especificado, ele permanece como uma categoria genérica.
Argentina
Gastronomia - 621102
Posto de combustível - 473000
Posto de combustível - 473000
Brasil
Gastronomia - 5611203
Posto de combustível - 4731300
Posto de combustível - 4731300
Mexico
Gastronomia - 5812
Posto de combustível - 468419
Posto de combustível - 468419
Colombia
Gastronomia - 5611
Posto de combustível - 4731
Posto de combustível - 4731
Peru
Gastronomia - 5520
Posto de combustível - 5050
Posto de combustível - 5050
Uruguay
Gastronomia - 56101
Posto de combustível - 47300
Posto de combustível - 47300
Chile
Gastronomia - 561000
Posto de combustível - 473001
Posto de combustível - 473001
store_id
String
Identificador da loja à qual o caixa pertence.
external_store_id
String
External_id da loja a que a caixa pertence, definido pelo sistema integrador. (Mandatório)
external_id
String
Identificador único da caixa definido pelo sistema integrador.
url
String
URL para obter a ordem do sistema integrador. É opcional e é usado apenas no modelo de integração desatendido.
HTTP Response
json
{
"id": 2711382,
"qr": {
"image": "https://www.mercadopago.com/instore/merchant/qr/2711382/0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png",
"template_document": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.pdf",
"template_image": "https://www.mercadopago.com/instore/merchant/qr/2711382/template_0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1.png"
},
"status": "active",
"date_created": "2019-08-22T10:11:12.000-04:00",
"date_last_updated": "2019-08-22T10:11:12.000-04:00",
"uuid": "0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1",
"user_id": 446566691,
"name": "Caja Principal",
"fixed_amount": true,
"category": 621102,
"store_id": "12345678",
"external_store_id": "BK021",
"url": "https://www.miempresa.com/MP?locationId=6232&positionId=01",
"external_id": "4lph4num3r1c"
}
Error Codes
CodeDescription
400 BAD_REQUEST
MISSING_BODY
O corpo HTTP é necessário para criar caixas.
UNKNOWN_FIELD_EXCEPTION
O campo indicado não é permitido para esta operação ou é desconhecido.
INVALID_NAME
O NAME deve ser String.
NAME_TOO_LONG
O campo NAME deve ter menos de 45 caracteres.
INVALID_FIXED_AMOUNT
O FIXED_AMOUNT deve ser Boolean.
INVALID_CATEGORY
O campo CATEGORY deve ser numérico.
UNKNOWN_MCC
O CATEGORY deve ser válido para o site do usuário.
INVALID_STORE_ID
O campo STORE_ID deve ser numérico.
INVALID_EXTERNAL_STORE_ID
O EXTERNAL_STORE_ID deve ser String.
EXTERNAL_STORE_ID_NOT_MATCH
O EXTERNAL_STORE_ID não se refere ao STORE_ID indicado.
INEXISTENT_EXTERNAL_STORE_ID
O EXTERNAL_STORE_ID não se refere a nenhuma loja existente.
INVALID_EXTERNAL_ID
O EXTERNAL_ID deve ser alfanumérico, apenas letras e números. Sem espaços ou hífens ou caracteres especiais.
EXTERNAL_ID_TOO_LONG
O campo EXTERNAL_ID deve ter menos de 40 caracteres.
INVALID_URL
O URL deve ser String e ter o formato de um URL válido.
URL_TOO_LONG
O campo URL deve ter menos de 40 caracteres.
FIXED_AMOUNT_FALSE
Se o campo URL for indicado, o campo FIXED_AMOUNT deve ser true.
403 FORBIDDEN
1
Se você estiver usando o campo URL, o host deve ser ativado pelo Mercado Pago. Caso contrário, você receberá este erro. Entre em contato com o consultor técnico designado.
404 NOT_FOUND
1
Se o caixa não existir para um ID indicado ou EXTERNAL_ID e usuário.
409 CONFLICT
1
Uma caixa com o mesmo EXTERNAL_ID já existe.