API Reference
  1. Autra Platform API
  2. Banking

Emitir boleto bancário

post
https://api.autra.io/v1/banking/accounts//boletos

Emite um boleto bancário via Autra (POST /payment-slip/v1/).

  • Dois tipos, escolhidos por type: RECHARGE (recarga — depósito na própria conta, sem pagador) e SERVICE_DUPLICATE / MERCHANT_DUPLICATE (cobrança de cliente — exige pagador completo).
  • Idempotência via idempotencyKey (body ou header Idempotency-Key). Se omitido, gerado automaticamente e devolvido no response.
  • Em boletos de cobrança, payer completo (nome, documento e endereço — todos os campos do endereço) é obrigatório. Em RECHARGE, não enviar payer.
  • Multa/juros/desconto são opcionais e válidos só para cobrança. discount.details aceita até 3 faixas por data.

O boleto nasce REQUESTED; vira REGISTERED quando a CIP confirma. Atualizações de status chegam via webhook global_payment_slip (e/ou polling on-demand no GET).

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

Body para emitir boleto bancário via Autra.

O campo type seleciona o tipo de boleto, e o tipo determina quais campos são aceitos:

  • RECHARGE — recarga: gera um boleto para depositar saldo na própria conta. NÃO aceita payer, fine, interest, discount nem freeText — só amount, dueDate e beneficiaryType.
  • SERVICE_DUPLICATE / MERCHANT_DUPLICATE — cobrança (invoice): cobra um cliente por um serviço ou produto. Exige payer completo (nome, documento e endereço — todos os campos do endereço obrigatórios). Aceita fine, interest, discount e freeText.

Defaults: type=MERCHANT_DUPLICATE, beneficiaryType=SUB_EMITTER, autoCancelDays=7.

Idempotência: idempotencyKey (body ou header Idempotency-Key). Se omitido, a Autra gera UUID e devolve em idempotencyKey no response.

string
enum

RECHARGE = recarga da própria conta (sem pagador). SERVICE_DUPLICATE / MERCHANT_DUPLICATE = cobrança de cliente (exige pagador).

Allowed:
string
enum

Default SUB_EMITTER (Autra é o beneficiário registrado, no nível do client — vale para qualquer conta). Use ACCOUNT_OWNER apenas quando a conta tiver beneficiário próprio cadastrado na Autra; caso contrário a Autra retorna 422 "No beneficiary available".

Allowed:
float
required
≥ 0.01
date
required

YYYY-MM-DD, hoje ou futuro, máximo 4 anos a partir da criação.

string

Texto livre no boleto. Ignorado em boletos RECHARGE.

payer
object
fine
object

Multa ou juros por atraso.

interest
object

Multa ou juros por atraso.

discount
object

Desconto progressivo por data (até 3 faixas).

integer
1 to 999
string
string

BoléPix: chave Pix DICT da conta recebedora. Quando informada, gera um boleto híbrido com QR Code Pix vinculado (response traz qrCode, qrCodeImage, txId). A chave deve pertencer à conta. Omitido → boleto comum.

Headers
string
Responses

403

Token inválido.

404

Conta não encontrada.

Updated 11 days ago

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

Updated 11 days ago

Did this page help you?