Menu
Documentation

Processar handshake do supplier

Endpoint: POST /suppliers/hiperbanco/handshake

Formato padrao de resposta

Envelope de sucesso (interceptor global):

{
  "status_code": 200,
  "success": true,
  "message": "OK",
  "data": {}
}

Envelope de erro (filtro global):

{
  "status_code": 400,
  "code": "VALIDATION_ERROR",
  "message": "Erro de validacao",
  "timestamp": "2026-02-13T00:00:00.000Z",
  "path": "/exemplo",
  "details": []
}

POST /suppliers/hiperbanco/handshake

  • Autenticacao: Publico
  • Contexto de conta: Exige conta ativa quando aplicavel
  • Roles: Nao declarado
  • Scopes: Nao declarado

Request

Path params

Nao possui.

Query params

Nao possui.

Body

Body livre (sem DTO tipado no controller).

Headers

  • Authorization: opcional.

Exemplos de requisicao

bash
curl -X POST "https://api.seudominio.com/suppliers/hiperbanco/handshake" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
  "campo_exemplo": "valor_exemplo"
}'

Response

Data (schema)

Nao tipado no retorno do controller. Informe um tipo de retorno para documentar automaticamente.

Sucesso (200):

{
  "status_code": 200,
  "success": true,
  "message": "OK",
  "data": "<resultado da operacao>"
}

Erro (contrato padrao):

{
  "status_code": 400,
  "code": "VALIDATION_ERROR",
  "message": "Erro de validacao",
  "timestamp": "2026-02-13T00:00:00.000Z",
  "path": "/suppliers/hiperbanco/handshake",
  "details": []
}