/pos

BASE URI https://api.mercadopago.com/pos

HTTP Request

curl 

 curl -X POST \
  'https://api.mercadopago.com/pos?access_token=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 Name of the POS.
fixed_amount Boolean Define if the customer can insert the amount to be paid.
true The customer cannot choose the amount to be paid and must wait for the generation of an order.
false After scanning the QR code of the POS, the customer enters the amount to be paid.
category Long MCC code that indicates the category of the Point of Sale. If not specified, it remains as a generic category
Argentina Gastronomy - 621102
Gas station - 473000
Brasil Gastronomy - 5611203
Gas station - 4731300
Mexico Gastronomy - 5812
Gas station - 468419
Colombia Gastronomy - 5611
Gas station - 4731
Peru Gastronomy - 5520
Gas station - 5050
Uruguay Gastronomy - 56101
Gas station - 47300
Chile Gastronomy - 561000
Gas station - 473001
store_id String Store identifier to which the point of sale belongs.
external_store_id String Unique identifier of the store to which the pos belongs defined by integrator system.
external_id String Unique identifier of the pos defined by integrator system.
url String URL to get the order of the integrator system. It is optional and is used only in the disregarded integration model.

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 HTTP body is required to create pos.
UNKNOWN_FIELD_EXCEPTION The indicated field is not allowed for this operation or is unknown.
INVALID_NAME NAME must be String.
NAME_TOO_LONG The NAME must be less than 45 characters.
INVALID_FIXED_AMOUNT FIXED_AMOUNT must be boolean.
INVALID_CATEGORY CATEGORY must be numeric.
UNKNOWN_MCC The CATEGORY must be valid for the user's site.
INVALID_STORE_ID STORE_ID must be numeric.
INVALID_EXTERNAL_STORE_ID EXTERNAL_STORE_ID must be String.
EXTERNAL_STORE_ID_NOT_MATCH The EXTERNAL_STORE_ID does not refer to the indicated STORE_ID.
INEXISTENT_EXTERNAL_STORE_ID The EXTERNAL_STORE_ID does not refer to any existing store.
INVALID_EXTERNAL_ID The EXTERNAL_ID field must be alphanumeric, only letters and numbers. No spaces or hyphens, or special characters.
EXTERNAL_ID_TOO_LONG The EXTERNAL_ID must be less than 40 characters.
INVALID_URL The URL must be String and must have the format of a valid url.
URL_TOO_LONG The URL must be less than 300 characters.
FIXED_AMOUNT_FALSE If the URL field is indicated, the FIXED_AMOUNT field must be true. We do not support the open amount modality in this case.
403 FORBIDDEN
1 If you are using the URL field, the host must be enabled by Mercado Pago. If it is not, you will receive this error. Please contact your assigned technical advisor.
404 NOT_FOUND
1 If the POS does not exist for an indicated ID or EXTERNAL_ID and user.
409 CONFLICT
1 A pos with the same EXTERNAL_ID already exists.

Your search returns no results.

Verifique a ortografia de termos de pesquisa ou teste com outras palavras-chave.