API Reference

Criar Cobrança

post
https://api.sandbox.empresas.btgpactual.com//banking/collections

📘 Ambiente de sandbox

Esta API utiliza o Wiremock

No sandbox este endpoint requer a utilização de Sandbox Headers

HeaderDescriçãoValores Aceitos
x-responseControlar o tipo de resposta da API.success ou error
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

CNPJ da empresa

Body Params
number
required

Valor da cobrança

string
enum
required

Cobrança do tipo boleto simples

Allowed:
uuid

Id do lote das cobranças

date
required

Data do vencimento da cobrança

date
required

Data de expiração da cobrança

deliveryMediums
array of strings

Configuração de envio da cobrança para o pagador

deliveryMediums
Allowed:
string
length ≤ 300

Descrição da cobrança

string

Número do convênio

payer
object
required

Dados do pagador

interest
object
fine
object
discounts
array of objects

Dados de desconto

discounts
tags
object

Objeto de exemplo para criação de todos os tipos de cobranças.

account
object
required

Dados da conta do recebedor

detail
object
required
string

Número da nota fiscal

split
object

Configuração de divisão (opcional, somente para cobranças do tipo BANKSLIP)

Responses

Updated about 4 hours ago

Did this page help you?
Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Choose an example:
application/json

Updated about 4 hours ago

Did this page help you?