v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Buscar dados de uma cobrança com vencimento

Essa API possibilita a busca de dados de uma cobrança com vencimento (COBV) a partir do transctionId, transactionIdentification ou clientRequestId.

get/pix/v1/collection/pi/duedate

Query parameters

transactionIdstring

Identificador de transação fornecido ao criar a cobrança com vencimento.

transactionIdentificationstring

Identificador do QRCode gerado

clientRequestIdstring

Identificador único da transação fornecida pelo do cliente.

Response

200

transactionIdinteger
statusstring
lastUpdatestring
payerQuestionstring
keystring
createAtstring
clientRequestIdstring
transactionIdentificationstring
transactionIdPaymentinteger

Example response

{
  "transactionId": 12345345,
  "status": "ACTIVE",
  "lastUpdate": "2021-04-29",
  "payerQuestion": "Esta cobrança é referente a...",
  "additionalInformation": [
    {
      "value": "Assinatura de serviço",
      "key": "Produto 1"
    }
  ],
  "debtor": {
    "name": "Fulano de Tal",
    "cpf": "11122233366",
    "cnpj": "1112223300100",
    "city": "Barueri",
    "publicArea": "Avenida Brasil",
    "state": "SP",
    "postalCode": "01202003",
    "email": "contato@celcoin.com.br"
  },
  "amount": {
    "original": 15.63,
    "discount": {
      "discountDateFixed": [
        {
          "date": "2021-04-29",
          "amountPerc": "1.00"
        }
      ],
      "modality": "string"
    },
    "abatement": {
      "amountPerc": "1.00",
      "modality": "FIXED_VALUE"
    },
    "fine": {
      "amountPerc": "1.00",
      "modality": "string"
    },
    "interest": {
      "amountPerc": "1.00",
      "modality": "string"
    }
  },
  "key": "5d000ece-b3f0-47b3-8bdd-c183e8875862",
  "receiver": {
    "name": "João da Silva",
    "cpf": "11122233366",
    "cnpj": "1112223300100",
    "postalCode": "01202003",
    "city": "Barueri",
    "publicArea": "Avenida Brasil",
    "state": "SP",
    "fantasyName": "Nome de Comercial"
  },
  "calendar": {
    "expirationAfterPayment": "10",
    "createdAt": "2021-04-29",
    "dueDate": "2021-05-10"
  },
  "createAt": "2021-04-29",
  "clientRequestId": "9b26edb7cf254db09f5449c94bf13abc",
  "transactionIdentification": "kk6g232xel65a0daee4dd13kk479195205",
  "transactionIdPayment": 45854857
}