v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Carrega, valida e analisa a carga de json de uma Cobrança com Vencimento (COBV)

Essa API realiza a consulta de um QR Code, atrelado a uma cobrança com vencimento, a partir de uma URL que precisa estar no padrão urlenconded.

Para testar o processo de deixar a urlenconded indicamos o uso do site

get/pix/v1/collection/duedate/payload/{url}

Path parameters

urlstring required

URL do BRCode Location linkado a cobrança com vencimento. Deve ser URLEncoded.

Response

200

transactionIdentificationstring

revisionstring

statusstring

keystring

Example response

{
  "calendar": {
    "createdAt": "2022-03-21T13:11:26",
    "presentation": "2022-03-21T13:11:26",
    "dueDate": "2022-03-21T13:11:26"
  },
  "debtor": {
    "cpf": "string",
    "cnpj": "string",
    "name": "string"
  },
  "receiver": {
    "cnpj": "string",
    "cpf": "string",
    "fantasyName": "string",
    "publicArea": "string",
    "city": "string",
    "state": "string",
    "postalCode": "string"
  },
  "transactionIdentification": "string",
  "revision": "string",
  "status": "string",
  "key": "string",
  "amount": {
    "original": "string",
    "abatement": "string",
    "discount": "string",
    "interest": "string",
    "fine": "string",
    "final": "string"
  },
  "additionalInformation": [
    {
      "value": "Assinatura de serviço",
      "key": "Produto 1"
    }
  ]
}