Menu
Documentation

Criar QR Code dinamico PIX

Endpoint: POST /hb/pix/qrcodes/dynamic

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/qrcodes/dynamic

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

Request

Path params

Nao possui.

Query params

Nao possui.

Body

DTO: CreatePixQRCodeDynamicDto

CampoTipoObrigatorioDetalhes
addressingKeyAddressingKeyDtoDynamicSimObjeto esperado: { type: PixKeyTypeEnumDynamic (enum: CPF, CNPJ, CELULAR, EMAIL, EVP); value: string }
singlePaymentbooleanSim-
payerPayerDtoSimObjeto esperado: { type: PayerTypeEnum (enum: CUSTOMER, BUSINESS); address: { addressLine: string; state: string; city: string; zipCode: string }; name: string; documentNumber: string }
changeAmountTypeChangeAmountTypeEnumSimValores permitidos: ALLOWED, NOT_ALLOWED
conciliationIdstringSim-
recipientNamestringSim-
expiresAtstringSim-
amountnumberSim-

Headers

  • Authorization: Bearer <jwt>: obrigatorio.

Exemplos de requisicao

bash
curl -X POST "https://api.seudominio.com/hb/pix/qrcodes/dynamic" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer SEU_JWT" \
  -H "Content-Type: application/json" \
  -d '{
  "addressingKey": {
    "type": "CPF",
    "value": 100.5
  },
  "singlePayment": true,
  "payer": {
    "type": "CUSTOMER",
    "address": {
      "addressLine": "string_exemplo",
      "state": "string_exemplo",
      "city": "string_exemplo",
      "zipCode": "string_exemplo"
    },
    "name": "string_exemplo",
    "documentNumber": "12345678901"
  },
  "changeAmountType": "ALLOWED",
  "conciliationId": "123",
  "recipientName": "string_exemplo",
  "expiresAt": "string_exemplo",
  "amount": 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/qrcodes/dynamic",
  "details": []
}