Pular para o conteúdo principal

Adiciona cartão ao cliente

POST /api/{userId}/establishment/{establishmentId}/clients/{clientId}/cards/new

Vincula um cartão ao cliente.

Parâmetros de rota

NomeTipoDescrição
userIdnumberIdentificador do usuário
establishmentIdnumberIdentificador do estabelecimento
clientIdstringIdentificador do cliente

Corpo (JSON)

CampoTipoObrigatórioDescrição
establishmentIdnumbersimEstabelecimento
cardCodenumbersimCódigo do cartão (inteiro > 0)
userIdnumbernãoUsuário responsável (quando aplicável)

Requisição

  • Método: POST
  • Path: /api/\{userId\}/establishment/\{establishmentId\}/clients/\{clientId\}/cards/new
  • Headers: Authorization, Accept: application/json, Content-Type: application/json

Formato da resposta (JSON)

  • Sucesso (HTTP 200): { "response": "success", "data": <payload> }
  • Erro de validação (HTTP 422): retorna os erros por campo
  • Erro (HTTP 400): { "response": "error", "data": { "msg": "...", "code": "..." } }

Exemplo de resposta (JSON)

Valores ilustrativos; a forma dos campos segue o retorno real.

{
"response": "success",
"data": {
"clientId": "772420260215093421",
"cardCode": 10245,
"establishmentId": 7724,
"status": 1
}
}

Nuâncias

  • O backend verifica se o cartão já está vinculado a outro cliente no mesmo estabelecimento e pode rejeitar o vínculo.