Sign in

v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Collection

Listar cobranças

API responsável por listar cobranças

get/collections

Query parameters

pageSizeinteger required

Quantidade de cobranças por página

Example:10
pageNumberinteger required

Número da página

Example:1
types'BANKSLIP' | 'PIX_QR_CODE' | 'UTILITIES' | 'TED' | 'PIX'

Boleto de cobrança

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

idstring

Id da cobrança

Example:0300e0fe-2ea4-4b01-bddf-7b23604e00c0

Id da cobrança

barcodestring

Código de barras

Example:20894931200004935000050017010554970003849530

Código de barras

digitableLinestring

Linha digitavel

Example:20890050091195069626700021179601493360000000001

Linha digitável

documentNumberstring

Número de documento da cobrança

Example:PARCELA-123

Número do documento

ourNumberstring

Nosso número da cobrança

Example:54865486214

Nosso número

startCreatedAtstring

Data de criação mínima

Example:2024-10-12

Data de criação mínima

endCreatedAtstring

Data de criação máxima

Example:2024-10-12

Data de criação máxima

status'CANCELED' | 'CANCELING' | 'CREATED' | 'EXPIRED' | 'FAILED' | 'UPDATING' | 'PAID' | 'PROCESSING' | 'UPDATED'

Status da cobrança

Example:PAID

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

payer.namestring

Nome do pagador

Example:João da Silva
payer.taxIdstring

Documento do pagador

Example:99261911005
batchIdstring

Id do lote

Example:829c47f2-3b5c-4103-8d15-a55bd66ae905

Id do lote de emissão das cobranças

updatedAtstring

Data da atualização

Example:2025-04-15T21:00:44.875Z

Data de atualização

startDueDatestring

Data de vencimento mínima

Example:2024-10-12

Data de vencimento mínima

endDueDatestring

Data de vencimento máxima

Example:2024-10-12

Data de vencimento máxima

startSettledAtstring

Data de liquidação mínima

Example:2024-10-12

Data de liquidação mínima

endSettledAtstring

Data de liquidação máxima

Example:2024-10-12

Data de liquidação máxima

badCredit.status'STARTING' | 'PROCESSING' | 'WARNING_PERIOD' | 'FAILED_TO_SEND' | 'CONFIRMED' | 'CANCELED'

Status da negativação

Example:STARTING

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

isAnticipatedstring

Cobrança antecipada

Example:true

Cobrança antecipada

Cursor de busca

{
  "previous": {
    "href": "/payment-link/7c17f662-3149-4d4a-b292-c7e00a641d61/collection?cursor=eyJtaW5DcmVhdGVkQXQiOiIyMDI0LTAxLTAxIiwibWF4Q3JlYXRlZEF0IjoiMjAyNS0wMS0wMSIsInBhZ2VOdW1iZXIiOiIyIiwicGFnZVNpemUiOiIxMCIsInR5cGUiOiJCQU5LU0xJUCIsInN0YXR1cyI6IkNSRUFURUQiLCJwYXllci5uYW1lIjoiTHVjYXMiLCJpZCI6IjdjMTdmNjYyLTMxNDktNGQ0YS1iMjkyLWM3ZTAwYTY0MWQ2MSJ9",
    "method": "GET",
    "type": "application/json"
  },
  "next": {
    "href": "/payment-link/7c17f662-3149-4d4a-b292-c7e00a641d61/collection?cursor=eyJtaW5DcmVhdGVkQXQiOiIyMDI0LTAxLTAxIiwibWF4Q3JlYXRlZEF0IjoiMjAyNS0wMS0wMSIsInBhZ2VOdW1iZXIiOiIyIiwicGFnZVNpemUiOiIxMCIsInR5cGUiOiJCQU5LU0xJUCIsInN0YXR1cyI6IkNSRUFURUQiLCJwYXllci5uYW1lIjoiTHVjYXMiLCJpZCI6IjdjMTdmNjYyLTMxNDktNGQ0YS1iMjkyLWM3ZTAwYTY0MWQ2MSJ9",
    "method": "GET",
    "type": "application/json"
  }
}

Headers

x-correlation-idstring

Cabeçalho para correlação de logs

Response

Lista de cobranças

Example response

{
  "data": [
    {
      "collectionId": "0300e0fe-2ea4-4b01-bddf-7b23604e00c0",
      "dueDate": "2024-05-28",
      "overDueDate": "2025-04-20",
      "createdAt": "2025-04-15T21:00:44.875Z",
      "amount": 10.23,
      "batchId": "829c47f2-3b5c-4103-8d15-a55bd66ae905",
      "deliveryMediums": [
        "Email",
        "Push"
      ],
      "interest": {
        "startDate": "2023-10-02",
        "type": "FIXED_VALUE_PER_DAY",
        "value": 123
      },
      "fine": {
        "startDate": "2023-10-02",
        "type": "FIXED_VALUE",
        "value": 13
      },
      "discounts": [
        {
          "limitDate": "2023-10-10",
          "type": "FIXED_VALUE",
          "value": 13
        }
      ],
      "status": "PAID",
      "payee": {
        "document": "00000000000125",
        "fantasyName": "VECHI CONSULTORIA E PROJETOS LTDA",
        "socialName": "VECHI CONSULTORIA E PROJETOS LTDA",
        "bankCode": "208",
        "bankName": "VECHI CONSULTORIA E PROJETOS LTDA"
      },
      "payer": {
        "name": "John Due",
        "email": "user@gmail.com",
        "personType": "J",
        "phoneNumber": "123123121231",
        "taxId": "37297902000141",
        "address": {
          "type": "COMERCIAL",
          "zipCode": "00000001",
          "country": "BR",
          "state": "SP",
          "city": "SAO PAULO",
          "street": "RUA SANDBOX",
          "number": "369",
          "neighborhood": "BAIRRO SANDBOX"
        },
        "deliveryMediums": [
          "Email",
          "Push"
        ]
      },
      "description": "Descrição da cobrança",
      "detail": {
        "barCode": "20894931200004935000050017010554970003849530",
        "digitableLine": "20890050091195069626700021179601493360000000001",
        "ourNumber": "54865486214",
        "documentNumber": "PARCELA-123",
        "emv": "copiaecola",
        "pixKey": "teste@hotmail.com",
        "txId": "3214",
        "correlationId": "54865486214",
        "badCredit": {
          "type": "APPLICABLE",
          "issueDate": "2025-04-01"
        },
        "automaticPix": {
          "authorizationId": "611a3814-dc17-4d0b-b7fc-20f98ba618ee"
        }
      },
      "tags": [
        {
          "key": "name",
          "value": "value"
        }
      ],
      "updatedAt": "2025-04-15T21:00:44.875Z"
    }
  ],
  "_links": {
    "next": {
      "href": "?cursor=eyJ4LWlkZW50aWZpY2F0aW9uIjoiMzcyOTc5MDIwMDAxNDEiLCJwYWdlU2l6ZSI6IjEiLCJwYWdlTnVtYmVyIj",
      "method": "GET",
      "type": "application/json"
    },
    "previous": {
      "href": "?cursor=eyJ4LWlkZW50aWZpY2F0aW9uIjoiMzcyOTc5MDIwMDAxNDEiLCJwYWdlU2l6ZSI6IjEiLCJwYWdlTnVtYmVyIj",
      "method": "GET",
      "type": "application/json"
    }
  }
}