Listar cobranças

get

https://api.empresas.btgpactual.com/{companyId}/banking/collections

API responsável por listar cobranças

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

📘
Ambiente de sandbox
Esta API utiliza o Wiremock

📘
Headers de Sandbox
Este endpoint suporta Sandbox Headers

Header Descrição
x-response Controlar o tipo de resposta da API.

Header	Descrição
x-response	Controlar o tipo de resposta da API.

📘
Migração
Caso seja um usuário realizando a migração, dirija-se à seção migração em Cobranças

Query Params

pageSize

number

required

Tamanho da pagina

pageNumber

number

required

Número da pagina

types

string

enum

Tipos de cobrança: se vazio retorna por padrão BANKSLIP e BANKSLIP_QRCODE

Allowed:

string

Id da cobrança

barcode

string

Código de barras

digitableLine

string

Linha digitável

documentNumber

string

length ≤ 15

Número do documento

ourNumber

string

length ≤ 20

Nosso número

startCreatedAt

string

Data de criação mínima

endCreatedAt

string

Data de criação máxima

status

string

enum

Status da cobrança, para informar mais de um status, separe os valores por vírgula: CREATED,PAID

Allowed:

payer.name

string

Nome do pagador

payer.taxId

string

Documento do pagador

batchId

uuid

Id do lote de emissão das cobranças

correlationId

string

length ≤ 20

Id de correlação

updatedAt

string

Data de atualização

startDueDate

string

Data de vencimento mínima

endDueDate

string

Data de vencimento máxima

startSettledAt

string

Data de liquidação mínima

endSettledAt

string

Data de liquidação máxima

badCredit.status

string

enum

Status da negativação, para informar mais de um status, separe os valores por vírgula: STARTING,PROCESSING

Allowed:

isAnticipated

string

Cobrança antecipada

cursor

string

Cursor de busca

Response

Language

Credentials

OAuth2

URL

Loading…

Response

Choose an example:

application/json

Ambiente de sandbox

Headers de Sandbox

Migração

200Lista de cobranças