Recursos para IA
Obter caixa

Este endpoint permite obter a configuração de um caixa específico identificado pelo seu ID. O caixa deve pertencer ao usuário do Access Token. Em caso de sucesso, a requisição retornará uma resposta com o status 200.

GET

https://api.mercadopago.com/v2/pos/{pos_id}
Request parameters
Header
Authorization
string

OBRIGATÓRIO

Access Token obtido através do painel de desenvolvedores. Obrigatório ser enviado em todas as requisições.
Path
pos_id
string

OBRIGATÓRIO

Identificador numérico do caixa, atribuído automaticamente pelo Mercado Pago no momento da criação. Deve ser um número inteiro maior ou igual a 0.
Response parameters
id
integer
Identificador numérico único do caixa, gerado automaticamente pelo Mercado Pago no momento da criação. Ao registrar um caixa, você receberá um ID correspondente. Esse ID pode ser utilizado para várias operações, incluind
name
string
Nome do caixa, definido pelo integrador no momento da criação.
status
string
Indica o status atual do caixa. Valores possíveis: active (o caixa está ativado e disponível para receber pagamentos) e inactive (o caixa está desativado e não pode receber pagamentos).
undefined: undefined
undefined: undefined
date_created
string
Data e hora de criação do caixa no formato ISO 8601, como 2024-08-08T19:29:45.019Z.
Erros

400Requisição inválida

resource_bad_request_error

O pos_id fornecido no path não é um inteiro válido ou é negativo. Verifique se o valor é um inteiro base-10 não negativo.

bad_request

O pos_id fornecido no path não é um inteiro válido ou não pertence ao usuário do Access Token. Verifique se o valor é um inteiro base-10 não negativo e se o caixa está associado à sua conta.

401Não autorizado

unauthorized

O valor enviado como Access Token está incorreto ou ausente. Verifique e tente novamente com um Access Token válido.

404Não encontrado

pos_not_found

Nenhum caixa foi encontrado para o pos_id fornecido e o usuário do Access Token. Verifique se o ID está correto e pertence à sua conta.

500Erro interno do servidor

internal_server_error

Ocorreu um erro inesperado no servidor. Trata-se de uma falha transitória não relacionada aos dados da requisição. Tente novamente após alguns instantes.

Request
curl -X GET \
    'https://api.mercadopago.com/v2/pos/{pos_id}'\
    -H 'Content-Type: application/json' \
       -H 'Authorization: Bearer APP_USR-1*********685765-12*********1b4332e5c*********e077d7679*********664' \
    
Response
{
  "id": 1234567,
  "name": "POS-001",
  "status": "active",
  "date_created": "2024-01-15T10:30:00Z",
  "date_last_updated": "2024-03-01T08:00:00Z",
  "user_id": 123456,
  "external_id": "SUC001POS001",
  "qr_response": {
    "uuid": "0977011a027c4b4387e52069da4264deae2946af4dcc44ee98a8f1dbb376c8a1",
    "image": "https://www.mercadopago.com/instore/merchant/qr/1234567/abc123.png",
    "template_document": "https://www.mercadopago.com/instore/merchant/qr/1234567/template_abc123.pdf",
    "template_image": "https://www.mercadopago.com/instore/merchant/qr/1234567/template_abc123.png",
    "qr_code": "00020101021226940014BR.GOV.BCB.PIX2572pix-qr-h.mercadopago.com/instore/h/p/v2/abc123"
  },
  "config": {
    "qr": {
      "operating_mode": "pdv"
    }
  }
}