Listar Cobranças PIX Saque (CASH-IN)

Sumário

Descrição
Endpoints
Requisição (GET)
- Parâmetros de Requisição
  - Cabeçalho
- Query params
Resposta
- Parâmetros de Resposta
  - Corpo (JSON)

Descrição #

Este passo tem por finalidade listar as cobranças PIX Saque usando os filtros.

Endpoints #

Produção: https://api2.bancosemear.com.br/paas-cashin-api/api/v1/public/billing-withdraws
Homologação: https://hmlapi2.bancosemear.com.br/paas-cashin-api/api/v1/public/billing-withdraws

Requisição (GET) #

Segue exemplo de requisição:

curl --location --request GET 'https://hmlapi2.bancosemear.com.br/paas-cashin-api/api/v1/public/billing-withdraws?document=xxxxxxxxxxxxxx&startDate=2024-05-01T00:00:00&finalDate=2024-05-15T21:00:00&statusFilter=TODOS&page=1&itensPage=50' \
--header 'client-cert: <CERTIFICADO DO CLIENTE>' \
--header 'client_id: <CLIENT ID>' \
--header 'access_token: <ACCESS TOKEN' \
--header 'Authorization: <BEARER TOKEN>'

Parâmetros de Requisição #

Cabeçalho #

Authorization: Token Bearer de autenticação
client_id: ID de cliente usado para controle de acesso do gateway de APIs
access_token: Token recebido após executar o método oAuth
client_cert: Certificado usado para autenticar o usuário com a aplicação

Query params #

document: Número de documento vinculado ao client id e a conta. (Obrigatório)
page: Número da pagina(utilizada para navegação), caso não seja enviado um valor, será atribuído 1 como default
itensPage: Quantidade de itens por pagina( utilizado para navegação), caso não seja enviado um valor, será atribuído a quantidade padrão do sistema.
startDate: Data inicial da busca. (Obrigatório)
finalDate: Data final da busca. (Obrigatório)
statusFilter: Filtro por status, valores possíveis TODOS = 0, PENDENTE = 1, PAGO = 2, EXPIRADO = 3

Resposta #

Segue exemplo de resposta:

{
    "parametros": {
        "inicio": "2024-05-01T00:00:00",
        "fim": "2024-05-15T21:00:00",
        "paginacao": {
            "paginaAtual": 1,
            "itensPorPagina": 50,
            "quantidadeDePaginas": 1,
            "quantidadeTotalDeItens": 15
        }
    },
    "cobranca": [
        {
            "calendario": {
                "expiracao": 36000,
                "criacao": "2024-05-09T17:01:51.997"
            },
            "valor": {
                "original": "00.00",
                "modalidadeAlteracao": 0,
                "retirada": {
                    "saque": {
                        "valor": "01.08",
                        "modalidadeAlteracao": 0,
                        "modalidadeAgente": "AGTEC",
                        "prestadorDoServicoDeSaque": "00795423"
                    }
                }
            },
            "correlationId": "118ad52a-67e6-497b-82a4-664d815668ef",
            "txid": "ogq3tm5qbww6qx76jmrz88tzo0n9gryn76d",
            "endToEnd": "E00795423202404231255mh22jH3TCpD",
            "status": "Pago",
            "devedor": {
                "nome": "Roger J.",
                "documento": "30302472089"
            },
            "chave": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
            "pixCopiaECola": "00020101021226920014BR.GOV.BCB.PIX2570spi-h.bancosemear.com.br/qrcode/gi/v2/a8c1975bf27546ac8e1a216ddabfb2b35204000053039865802BR5923SPEEDRACERAUTOMECANICAL6013BELOHORIZONTE61083013000862070503***6304E767",
            "qrCode": "iVBORw0KGgoAAAANSUhEUgAAAYEAAAGBAQAAAACoIjCJAAAF60lEQVR4nO2bS47yWgyED2KQIUvITmBjSCBlY7CTLIFhBhG+rq9OgFZLV/qHbcEgIo/KwPKjXHZa/OPv2r6IL+KL+HuIR2ttl4fleIh5uB2uYzs99nNePbd4tssc93xuuOWFoRjiEnlt1bW8m4/EIkTe2Edr+YLlFJMeiaiGOLchT+c02GXmbjvl6ZA3xmUnq6Ulx7jnoSwipkTk6dIOCcNpni2tdsvToSoi4yNvpCM823nMg2IhbZWRkk6zy38lEYoPBUTGR8hqIX+RrabNQWIdf0VUBQQ5EWv83+FXFv37iF7fxoyPTPrykqXJanIfVYi0Wl4bflXOAohrWiGzgPLBvNhBWuOa3OesanAdhydvKYVQuTs5DPL0hq0Oaxb/POTDhMtZDjLNxRB5wC2y+k1KD+kbqohN16h+KhOB9aIaIp1fiVHVAFdROgyVidF1kIyZgfPKDFUQqxjAqsS45+EMEuWAp16Q/M//2u4jM1RBZFI4NhG+x3boJD8ZwLHtIwsBr1rf1aAGAkabESCK40yYh3XEYFkC4cD8ps1WVRBB/gulgv3cM7/iQzkxkyUMYO+yWA+xdbMwX1eDPE0sdSEPKhOHT1uVQGCI6L4xqBoQFSTLXiEOdHzXsRoiiz+xL1afN0iR4eZWFUIpch1RNYZaCHezOqXaq4m7B+1N9nkgXnejGKKHgbntsTkB6OEVFiQfWsfov0oINfOxJQXSQzLfSSVfhU/8D1vR6hdDvNUKmjhJdbbQJO6TTqPMgDmHWgiygNRaGScb2at8Yyt8z0begAWdx2qIlRZehB6h9tycHSmBhMvd4fLu7qogKHJTiAbokf1sW22yjRPjlh5qIebmnIjHkAUOUL804pFqgNwhc9ZCSLk7YQhLtpP8xSmyodbS8dlqxRAaQXSGh6uoLIYHMpAiWVAGW1s9BDnRmrTIHaIO3Y4a3kDXGz60jCoI3di5Gqi3Nwvaz44P5QjmdCoTr8xQBSFpUoU+80GzUHu0WK1uBylHjY5sWg2hWLBss7dIuZycLWSch8dTo/r9qIa4NhoYdzEyGBImzJf4QLyFCg3FEJnqHRC0Ny/6S13gfbIVM8iohehNq3nO0L3kYtFuoK899vFUNYQk6mYzkf9o4fMF6NS7bR71Iz6KIMgCffjcMwOTx97xOT6CjFkNcfHkcfHQUQRId6kBC2ot2aIkIlirkBA/qwRauYMGSL4LtHoU3GqIfTBsj86C9n2f5sksunWnkWo/F0MEyqwmcerzTp60ItNPM20uEqb7nmIID5Wl0dLeTC75Gr2NPIe+YT2nHKIzHtNaouLaUGvlPuYCw09b1UBwLWa39SJAzN+W3uy11ufOPxT6GojJYd9Fu2D0lknwyC7dgS4/3oJGIcSDnj1PWS1BptIjXhaU6UwITp88sQbCk3QGbmxTsRiNRyDJy1ay2v2t4pRBUO761qSv3RoTiWB9tHXs46MTLoK4OvZ7TuzrJtRGdorgPvKc62s2UQQB95Ek/2TuwjKFZhNsFzUcRHzoY8uiEIKdIn37sKU+tzxN/iIuYKd569RFEJ602g+al6Zwmpt16rO/gpCYOQ61EA+3N7Hlv97tbLP3cJ5k1aIYItinaRaruSZ+H/7eBYPdPbP52KYqgtgWhhDoYuvo2R5bOjVQbTQlroRApXMhgAGcR8YwfPlCtuCnmJmrIRhB4AyM49giVDt36Hvw1Ao2ysohvPnd9+Cb1yS9QsZHf9Bfr5UVQ2TNC7c3EX2dCN/wRwKsX7BR9q6cZRAzMsYm1K7+7It1WU8e2SZtLzZcBsHv42OHPcuCnrg7Kixj/FC8SiD6d16NbQJYn5fh0eW9NRn9q8YohriI2/ZtKmdCvvJDvxLV5WPmnxOsIgi2aJi7kBiVAF5zZ+i+bvyYR5VCbI3dzcqdSCAfCcD/ZKtPL6mFaF4iYuFA8mzruxV8q0/fs5ZDXDx78ibRzptTOIgHFIFi/bkXXgbRXPw9kDlZyFvZHaTfnyFFcOBiiH/7fRFfxBfx5xD/AZ+ylxpTmdFrAAAAAElFTkSuQmCC",
            "linkPagamento": "https://hml-semearpay.bancosemear.com.br/pay/pix/ogq3tm5qbww6qx76jmrz88tzo0n9gryn76d",
            "informacoesAdicionais": [],
            "revisao": 0
        }
    ]
}

Parâmetros de Resposta #

Corpo (JSON) #

Propriedade	Descrição	Tipo
status	Status da cobrança: PENDENTE(indica que o registro se refere a uma cobrança que foi gerada mas ainda não foi paga nem esta expirada); PAGO(indica que o registro se refere a uma cobrança que já foi paga e, por conseguinte, não pode acolher outro pagamento); EXPIRADO (indica que o pix está expirado e não pode mais ser pago ou alterado).	String
calendario.expiracao	Tempo de validade da chave (em segundos).	int32
calendario.criacao	Data de criação da chave	DateTime
txid	ID da transação	String
correlationId	Identificador interno de referencia do pix	String
endToEnd	EndToEnd da transação, gerado quando pix estiver com status PAGO	String
devedor.nome	Nome do devedor	String
devedor.documento	CPF ou CNPJ do devedor	String
valor.original	Valor do CASH-IN	String
valor.modalidadeAlteracao	Valor 0 não permite alterar o valor de pagamento do PIX nessa modalidade	int32
valor.retirada.saque.valor	Valor de saque do CASH-IN	String
valor.retirada.saque.modalidadeAlteracao	Valor 0 não permite alterar o valor de pagamento do PIX, valor 1 permite alterar o valor do pagamento.	Int32
valor.retirada.saque.modalidadeAgente	Agente de saque (AGTEC, AGTOT, AGFSS)*	String
valor.retirada.saque.prestadorDoServicoDeSaque	Facilitador de Serviço de Saque registrado.	String
revisao	valor de vezes que pix foi revisado/alterado	int32
linkPagamento	Link de pagamento do PIX	String
pixCopiaECola	Código do PIX	String
qrCode	Imagem PNG do código QR PIX codificado em base64	String
chave	Chave PIX de recebimento	String
informacoesAdicionais.nome	Chave opcional. Usado para informações específicas	String
informacoesAdicionais.valor	Valor opcional. Usado para informações específicas	String