Criar Boleto

post

https://api.sandbox.empresas.btgpactual.com/v1/bank-slips

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

accountId

string

required

Identificador da conta beneficiaria. Obtido em /v1/accounts.

Body Params

amount

number

required

Valor da cobrança.

dueDate

date

required

Data de vencimento do boleto.

overDueDate

date

Data limite para pagamento do boleto.

referenceNumber

string

required

Número de referencia utilizado pelo parceiro.

description

string

Descrição da cobrança. Aparece no boleto emitido.

payer

object

required

Representa o sacado, entidade pagadora do boleto.

installments

integer

required

Defaults to 1

Número de parcelas. Para cada parcela um novo boleto é gerado.

interests

object

Juros e multas.

discounts

array of objects

Condições de desconto aplicadas. Deve ser aplicada no máximo uma.

discounts

deliveryMediums

array of objects

Configuração de entrega.

deliveryMediums

Allowed:

ourNumber

string

Seu número para identificação. Aceita até 16 dígitos.

pixInfo

object

Insere no boleto QR code para pagamento via Pix

Response

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

202Accepted