Menu
Documentation

Cadastrar favorecido PIX

Endpoint: POST /hb/pix/contacts

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 /hb/pix/contacts

  • Autenticacao: Bearer JWT obrigatorio
  • Contexto de conta: Exige conta ativa quando aplicavel
  • Roles: FINTECH, OPERADOR, ADMIN, GERENTE
  • Scopes: pix.entries.create

Request

Path params

Nao possui.

Query params

Nao possui.

Body

DTO: CreateBeneficiary

CampoTipoObrigatorioDetalhes
namestringSim-
document_numberstringNao-
pix_key_typenumberSim-
pix_keystringSim-
spi_participant_numberstringNao-
branch_codestringNao-
branch_digitstringNao-
account_numberstringNao-
account_digitstringNao-
payment_accountstringNao-
account_typeTipoContaSimValores permitidos: 1, 2, PAYMENT, 4
pix_registration_typeTipoContaSimValores permitidos: 1, 2, PAYMENT, 4

Headers

  • Authorization: Bearer <jwt>: obrigatorio.

Exemplos de requisicao

bash
curl -X POST "https://api.seudominio.com/hb/pix/contacts" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer SEU_JWT" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string_exemplo",
  "pix_key_type": 1,
  "pix_key": "chave_exemplo",
  "account_type": "1",
  "pix_registration_type": "1"
}'

Response

Data (schema)

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

Sucesso (201):

{
  "status_code": 201,
  "success": true,
  "message": "Created",
  "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": "/hb/pix/contacts",
  "details": []
}