v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Carrega, valida e analisa a carga de json de uma Cobrança imediata (COB)

Essa API realiza a consulta de um QR Code atrelado a uma cobrança imediata 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/immediate/payload/{url}

Path parameters

urlstring required

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

Response

200

statusstring

{"stackTrail":"paths:/pix/v1/collection/immediate/payload/{url}:get:responses:200:content:application/json:schema:properties:infoAdicionais","oasType":"schema","type":"unknown"}

txidstring

chavestring

{"stackTrail":"paths:/pix/v1/collection/immediate/payload/{url}:get:responses:200:content:application/json:schema:properties:solicitacaoPagador","oasType":"schema","type":"unknown"}

revisaointeger

Example response

{
  "status": "ATIVA",
  "txid": "kk6g232xel65a0daee4dd13kk9192148",
  "chave": "testepix@celcoin.com.br",
  "valor": {
    "original": "15.01",
    "retirada": {
      "troco": {
        "modalidadeAgente": "AGTEC",
        "prestadorDoServicoDeSaque": "13935893",
        "valor": 10
      },
      "saque": {
        "modalidadeAgente": "AGTEC",
        "prestadorDoServicoDeSaque": "13935893",
        "valor": 10
      }
    }
  },
  "calendario": {
    "criacao": "2022-03-22T14:20:47Z",
    "expiracao": 86400,
    "apresentacao": "2022-03-22T14:22:24Z"
  }
}