Consultar Cobrança PIX Vencimento por TxId (CASH-IN)

Descrição #

Este passo tem a finalidade demonstrar como consultar um PIX agendado .

Endpoints #

• Produção: https://api2.bancosemear.com.br/paas-cashin-api/api/v1/public/billing-due-dates/<TxId>
• Homologação: https://hmlapi2.bancosemear.com.br/paas-cashin-api/api/v1/public/billing-due-dates/<TxId>

Requisição (GET) #

Segue exemplo da requisição:

curl "https://hmlapi2.bancosemear.com.br/paas-cashin-api/api/v1/public/billing-due-dates/<TxId>" \
  --request GET \
  --header "Content-Type: application/json" \
  --header "Authorization: Bearer <APP_TOKEN>" \
  --header "client-cert: <CERTIFICADO_CLIENTE>"\
  --header "client_id: <CLIENT_ID>" \
  --header "access_token: <ACCESS_TOKEN>"

Parâmetros de Requisição #

Cabeçalho #

• Content-Type: Informa ao servidor de que o corpo da requisição possui o formato JSON
• Authorization: Bearer token usado para autenticação de usuário (Recebido no passo “oAuth Aplicação“)
• client-cert: Certificado usado para autenticar o usuário junto à aplicação
• client_id: ID de cliente usado para encaminhar a requisição ao gateway de APIs
• access_token: Token recebido após executar o método oAuth (access token)

A reposta é um json informando os dados da cobrança e o código HTTP 200. #

Abaixo segue um exemplo de reposta:

{
    "calendario": {
        "criacao": "2024-05-15T12:28:13.5683789-03:00",
        "dataDeVencimento": "2024-05-20T00:00:00",
        "validadeAposVencimento": 10
    },
    "valor": {
        "original": "02.00",
        "valor pago": null,
        "modalidadeAlteracao": 0,
        "multa": {
            "modalidade": 1,
            "valorPerc": "01.00"
        },
        "juros": {
            "modalidade": 1,
            "valorPerc": "01.01"
        },
        "desconto": {
            "modalidade": 1,
            "valorPerc": "01.01",
            "descontoDataFixa": [
                {
                    "data": "2024-05-20T00:00:00",
                    "valorPerc": "01.01",
                    "modalidade": 1
                }
            ]
        }
    },
    "correlationId": "b261ae06-15de-44d3-9279-f7be1c584af0",
    "txid": "GXTcsp1QvVCBLxViHbi85DDpnkHpeD3ZB",
    "endToEnd": "",
    "status": "Pendente",
    "devedor": {
        "nome": "Joao Silva",
        "documento": "68138423072"
    },
    "chave": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
    "pixCopiaECola": "00020101021226920014BR.GOV.BCB.PIX2570spi-h.bancosemear.com.br/qrcode/gi/v2/493640e818a94920869fc9be37cbd7765204000053039865802BR5923XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX***6304180F",
    "qrCode": "iVBORw0KGgoAAAANSUhEUgAAAW0AAAFtAQAAAADkegaPAAAFeklEQVR4nO1bTa7ySAw0YsGSI+QmcDGkIHExuEkfgWUWT3jqpxvyRqORvtUnR7DII0kF6bndZbvsRP7JZ4kv/Av/wv8a/BkRu7zGcoq5LefnZTo8eLrLbHmPC24cf4CJuT58znw8Y8oH7gt5eDwvcXgdf6Z8xT71E8KVh+OWQC9YAZ99RsAUyxnX8Dv6scsUu63A8R0XZAA4wZ0Lfn7OjY/jFDbaErwtcbxOcU7cIkinCU+IQ/6HZWrCucygKBggM07HbNjpcHWt/52WefA0twAni4m7/ufwL9IrCtcHToCr+zwkrACuxtYO2ugET9Bu+B3KqsJvTZZZdrARDvuGrR2Bg3Y6foJ0Tu8oD8cKO/jSPIFYnEnqXgIH7AGwNmOxtkR9+JT3400hSLGpIQLfeHDGMSFoBaNyfTh8G6ZgMELcDdmIfCajgMBuvAESP42tXRrOuHsRlYW2dtIyYSdAAsIH4SJjaxeGA8R0kYxF7gox1q0pt1QEVpDO++D3ynAkxSQwJBtYcK41vyEBgVH4oK+JtavDGYzO+IM8I50ei6tJ0yFXZx4Z2gPl4UTi3z44FrMaEoFxV480eh3KCsOfIrCfYSO6fyaz5QjVuEgmaZnXBuA0hS/IrWEP58j9FKBditTm8nDtaudVLOetYbAaAk07XinrimHIwnDlkUOfGenxdVICQpp2lnkYhF0abi+fmDgqGFmZonIx+dBz6fpwI4c2cVJhoIxDq474nA97wgbgYfOAkhF85Q6+dZR5silAUa4pD3egRTalTU5TAIkHT0whe9a1Jr3CcIIYY0XOTCbpCVp6pSJMNoTcAlwUtW9h1c0ZZTZ82ycPTU+/C6HKcEtqXPqgcpFa/3DiyGSjq26rlLkuXOlil2F6UauwpEQ5VDvMuZJzSsNZz1ISD0rEcPW7Wx4RUjMUoJaNwElek0p3uDXlmuiCjFjM+swnQakLdw2EFFIPygDMI3VNLa04uyuyAbj6HpRhWMT3PoAaHcHgKwKzcrEBuGTUhEffUtQty+BUqtt18tbebQGuPCMsmYKrLz53i5bVwSiOsjycKSTjrpAS1w7J7ixFVnpHY4MgLbcWh/f0uD8Tx55hWTBXT1anqz5fWTg8WrysAOUNfZIU9fTUBJl8bh9+rwy/eZndjqWMqtikNMvt2Bcb0acNwCkrvriDX5p76UWP044RlffrUFYarioHIdciTepaz5YVoGSjtx5ZGI5/m6WOFONl57Ef+LtSKg8V/JJeC8MdaDUWkq2vugt7s1iq0x7xYYKycDqBxtPGM45NcgzqFWa2Xz5TFq7v19CGpjuwLrqStqQiK8GMtepWGO6u+uBqq1AUHW0tTShSwxi5WGG41fA+vOZ+pPQKtTy050VquQG4u1nXyXwmNdwinOtAglT3HuvDNWSZvR0bypvxae5reUrEzZ4NwD0rka53uhU41tUnKay/rZvsdeE3dyHdiX1p5tJR+cZYPDtevVmsNBwLrhLhYfkiPBaiGWJFJP3Eap6gMPzaR/TOqoE6V0/SMFTis+0zrWu+snDORfRZGImnfajA1rqPYuGwyjjKwtPDTU185vZVOI8cMiolnBUT1IU/ZxfxsowURdtDUqPUm92Y3asO966emzzh0Ef0oufSHLHV6YfFKsP5sZb6E25kqX11P46hf2mp7ymRwvA+AdMjsEYSPV1LG+mNHAnmm4DP/cWbrrDxvi1zaxYdx2hbfbiCr+Ac0ft0s8JRubPYWzYuDx+1+nn0KP0yzsnz73Nbj8vXhiNn1DLHzpPDtAKbPSe9gQSiW40fFIbL3/cc8UmPNLmw7y2AS+jVlVUYLgw3i7EauobGQvT23KI3cjRT0c2T5eF/8PnCv/Av/G/B/wFpq3gIH5up7QAAAABJRU5ErkJggg==",
    "linkPagamento": "https://hml-semearpay.bancosemear.com.br/pay/pix/GXTcsp1QvVCBLxViHbi85DDpnkHpeD3ZB",
    "infoAdicionais": [
    {
        "nome": "Geladeira",
        "valor": "Geladeira cor branca duas portas"
    }
  ],
    "revisao": 0
}

Corpo (JSON) #