v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Charge

Pesquisa com paginação de cobranças.

get/charge/search

Query parameters

Sort'ASC' | 'DESC'

Valores SortType Tipo de ordenação.Values:<ul><li>ASC - Crescente.</li><li>DESC - Decrescente.</li></ul>

Example:DESC

Pageinteger

Example:1

Propriedade Page Página atual.

Limitinteger

Example:500

Propriedade Limit Limite de consulta de dados.

Status'CONFIRMED' | 'PROCESSING' | 'PENDING' | 'ERROR' | 'CANCELED'

ReceiverDocumentstring

Example:51236721000136

Propriedade ReceiverDocument CNPJ ou CPF do beneficiário.

ReceiverAccountstring

Example:30023646056263

Propriedade ReceiverAccount Número da conta BaaS do beneficiário.

DebtorDocumentstring

Example:49188474801

Propriedade DebtorDocument CNPJ ou CPF do pagador.

DateType'DUEDATE' | 'CREATED' | 'LIQUIDATION'

Valores DateTypeFilter Tipo de datas para pesquisa.

Propriedade DateType Tipo de data utilizada como filtro.

Startstring date-time

Endstring date-time

Response

versionstring nullable

Versão da api.

statusstring nullable

Status.

Example response

{
  "version": "1.0.0",
  "status": "SUCCESS",
  "body": {
    "data": [
      {
        "transactionId": "ce9b8d9b-0617-42e1-b500-80bf9d8154cf",
        "externalId": "externalId1",
        "amount": 12.5,
        "amountConfirmed": 13,
        "duedate": "2023-12-30",
        "status": "CONFIRMED",
        "debtor": {
          "name": "Marcos Samuel Duarte",
          "document": "49188474801",
          "postalCode": "06463035",
          "publicArea": "Rua Mãe D'Água",
          "number": "1004",
          "complement": "Apto 123",
          "neighborhood": "Jardim Mutinga",
          "city": "Barueri",
          "state": "SP"
        },
        "receiver": {
          "name": "Emilly Malu Tereza Sales",
          "document": "23234457824",
          "postalCode": "06474070",
          "publicArea": "Alameda França",
          "city": "Barueri",
          "state": "SP",
          "account": "30023646056263"
        },
        "instructions": {
          "fine": 10,
          "interest": 5,
          "discount": {
            "amount": 1,
            "modality": "fixed",
            "limitDate": "2023-12-20"
          }
        },
        "boleto": {
          "transactionId": "32290",
          "status": "Pago",
          "bankEmissor": "santander",
          "bankNumber": "4000178961",
          "bankAgency": "1004",
          "bankAccount": "0220060",
          "barCode": "03392942700000009009022006000040001789610101",
          "bankLine": "03399022070600004000317896101015294270000000900",
          "bankAssignor": "CELCOIN INSTITUIÇÃO DE PAGAMENTO - SA",
          "invoiceNumber": "16124"
        },
        "pix": {
          "transactionId": "817885753",
          "transactionIdentification": "817885753",
          "status": "Cancelado",
          "key": "teste@chavepix.com.br",
          "emv": "00020101021226980014br.gov.bcb.pix2576api-h.developer.btgpactual.com/pc/p/v2/cobv/303928a7b4034de09fddec6d1258c15d5204000053039865802BR5910Merle Yost6008Orinside61080863968162070503***6304D7D3"
        }
      }
    ],
    "pagination": {
      "page": 1,
      "limit": 1,
      "totalPages": 1,
      "total": 1
    }
  }
}