Buscar dados de uma cobrança com vencimento

Essa API retorna as informações de uma cobrança com vencimento (COBV) a partir do transctionId.

get/pix/v1/collection/duedate/{transactionId}

Request

  • Base URL
    https://sandbox.openfinance.celcoin.dev
  • URL
    https://sandbox.openfinance.celcoin.dev/pix/v1/collection/duedate/{transactionId}
  • Auth
    OAuth 2

Path parameters

transactionIdinteger required

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

Response

200

transactionIdinteger
statusstring
lastUpdatestring
payerQuestionunknown
additionalInformationunknown
keystring
createAtstring
clientRequestIdstring
transactionIdentificationstring
transactionIdPaymentinteger

Example response

{
  "transactionId": 9189382,
  "status": "ACTIVE",
  "lastUpdate": "2022-03-21T14:27:58.2106288+00:00",
  "debtor": {
    "name": "Fulano de Tal",
    "cnpj": "61360961000100",
    "city": "Barueri",
    "publicArea": "Avenida Brasil",
    "state": "SP",
    "postalCode": "01202003",
    "email": "contato@celcoin.com.br"
  },
  "amount": {
    "original": 15.63,
    "discount": {
      "discountDateFixed": [
        {
          "date": "2022-03-21T00:00:00",
          "amountPerc": "1.00"
        }
      ],
      "modality": "FIXED_VALUE_UNTIL_THE_DATES_INFORMED"
    }
  },
  "key": "testepix@celcoin.com.br",
  "receiver": {
    "name": "João da Silva",
    "cnpj": "60904237000129",
    "postalCode": "01202003",
    "city": "Barueri",
    "publicArea": "Avenida Brasil",
    "state": "SP",
    "fantasyName": "Nome de Comercial"
  },
  "calendar": {
    "expirationAfterPayment": "10",
    "createdAt": "0001-01-01T00:00:00",
    "dueDate": "2022-03-22T00:00:00"
  },
  "createAt": "2022-03-21T14:27:58.2106288+00:00",
  "clientRequestId": "9b26edb7cf254db09f5449c94bf13abc",
  "transactionIdentification": "kk6g232xel65a0daee4dd13kk9189382"
}

Changes

No recorded changes to this operation across all 1 revision of this API.