Stater Platform

Criar PIN

POST /passwords/create-pin — define o PIN inicial da entidade (só quando hasPin=false).

Criar PIN

Define o PIN operacional da entidade (PF ou PJ) pela primeira vez. Só fica disponível enquanto hasPin=false — depois de cadastrado, use /passwords/change-pin pra alterar.

POST/passwords/create-pin

Disponível apenas enquanto hasPin=false (entidade ainda sem PIN cadastrado). Tentar chamar com hasPin=true retorna 4xx — use POST /passwords/change-pin nesse caso. PIN sempre 4 dígitos numéricos. Depois de criado, o PIN é exigido em operações sensíveis (Pix payment, TEF payment, QR Code payment).

Headers

  • AcceptObrigatório
    string
    application/json
  • Content-TypeObrigatório
    string
    application/json
  • AuthorizationObrigatório
    string
    Bearer <token> — JWT da entidade (type=PERSON ou type=COMPANY).
  • X-Tenant-IdObrigatório
    string (UUID)
    Identificador do tenant.

Body

  • pinObrigatório
    string
    PIN da entidade — sempre 4 dígitos numéricos (ex.: "1234").

Exemplo de requisição

bash
curl -X POST https://baas.staterpay.io/passwords/create-pin \  -H "Accept: application/json" \  -H "Content-Type: application/json" \  -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.<payload>.<signature>" \  -H "X-Tenant-Id: 00000000-0000-0000-0000-000000000000" \  -d '{    "pin": "1234"  }'

Resposta

  • message
    string
    Confirmação textual ("PIN criado com sucesso.").
json
{  "message": "PIN criado com sucesso."}
URL base:https://baas.staterpay.io

On this page