Pular para o conteúdo principal

Criar Terminal

Registra um novo terminal na plataforma. O terminal é identificado pelo número de série (serialNumber) e associado a um lojista pelo merchantId.

Na primeira chamada, a API retorna um código de verificação de 6 dígitos (verificationCode) que deve ser inserido no terminal para concluir o provisionamento.

Endpoint

POST/v1/terminals

Parâmetros do Corpo

CampoTipoObrigatórioDescrição
merchantIdstringID do lojista ao qual o terminal será associado
serialNumberstringNúmero de série do terminal (máx. 20 caracteres, convertido para maiúsculas)

Resposta

CampoTipoDescrição
idstringID único do terminal
serialNumberstringNúmero de série normalizado
verificationCodestringCódigo de 6 dígitos para provisionamento
verificationCodeExpiresAtstringData/hora de expiração do código (ISO 8601)
Request
curl -X POST https://yby-dev.positivolabs.com.br/v1/terminals \
-H "Authorization: Bearer <access_token>" \
-H "Content-Type: application/json" \
-d '{
"merchantId": "d6uo5nc42nrc73gv867g",
"serialNumber": "SN123456"
}'
Resposta
{
"id": "d59gpddc93gc73jvje0g",
"serialNumber": "SN123456",
"verificationCode": "482951",
"verificationCodeExpiresAt": "2026-05-06T11:30:00Z"
}