Criar boleto ou BoléPix

Cria um boleto ou BoléPix (boleto com QR Code Pix embutido) via Dock. O tipo é definido pela presença de pixKey:

  • Sem pixKeyBOLETO
  • Com pixKeyBOLEPIX (a chave é validada em tempo real via DICT — chaves expiradas retornam 422)

Como funciona

  1. Valida sintaticamente o body (accountId, paymentslip.amount, paymentslip.dueDate).
  2. Valida ownership: a accountId pertence ao tenant do JWT? Se não, 403.
  3. Se pixKey foi enviada, resolve chave ativa e o accountId correspondente na Dock.
  4. Chama a Dock (/invoice) — se responder 2xx, cria snapshot local (payment_slips) + evento CREATED.
  5. Se a Dock responder 4xx/5xx, evento FAILED é gravado e o erro é retornado com code: DOCK_ERROR.

Autenticação e allowlist

  • Bearer JWT (Autra) no header Authorization (APIGW).
  • IP allowlist do tenant é aplicada.

Status HTTP

Retorna o status HTTP da Dock quando o cache-through passa (2xx = body raw Dock; erros da Dock reencapsulados em {errors:[{code,msg}]} mantendo o status). Erros locais Autra: 400 validação, 403 ownership, 422 chave Pix inválida, 500 timeout/panic.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int64
required

ID numérico da conta Dock do beneficiário.

integer
required

Código do banco (ex.: 341 Itaú).

integer
required

Código Dock do tipo de beneficiário (1=PF, 2=PJ conforme catálogo Dock).

paymentslip
object
required
payer
object
required
fine
object

Multa pós-vencimento (opcional).

interest
object

Juros pós-vencimento por dia (opcional).

string

Chave Pix do beneficiário. Presente = BoléPix; ausente = Boleto tradicional. Resolvida em tempo real via DICT — expirada retorna 422.

uuid

ID interno do pagador em checkout_payers (opcional).

uuid

ID do link de pagamento associado (opcional).

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json