Sign in

v1

latestOpenAPI 3.0.42026-07-24150552428.5 KB
Collection

Buscar cobrança

API responsável por buscar uma cobrança. Pode retornar os dados em json ou PDF.

get/collections/{collectionId}

Path parameters

collectionIdstring required

Id da cobrança

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

Identificador da cobrança

Headers

Accept'application/json' | 'application/pdf' required

Tipo de retorno

Example:application/pdf

Tipo de retorno

Response

Buscar cobrança

collectionIdstring required

Id da cobrança

dueDatestring date

Data do vencimento da cobrança

overDueDatestring date

Data de expiração da cobrança

createdAtstring

Data da criação

amountnumber

Valor

batchIdstring

Id do lote

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

Status da cobrança

type'BANKSLIP' | 'PIX_QR_CODE' | 'UTILITIES' | 'TED' | 'PIX'

Boleto de cobrança

descriptionstring
updatedAtstring

Data da atualização

Example response

{
  "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"
}