{"id":916,"date":"2024-05-15T16:08:02","date_gmt":"2024-05-15T19:08:02","guid":{"rendered":"https:\/\/www.bancosemear.com.br\/docs\/?post_type=docs&#038;p=916"},"modified":"2024-05-15T16:08:02","modified_gmt":"2024-05-15T19:08:02","slug":"listar-cobrancas-pix-troco-cash-in","status":"publish","type":"docs","link":"https:\/\/www.bancosemear.com.br\/docs\/?docs=listar-cobrancas-pix-troco-cash-in","title":{"rendered":"Listar Cobran\u00e7as PIX Troco (CASH-IN)"},"content":{"rendered":"\n<h3 class=\"wp-block-heading\" id=\"0-toc-title\">Descri\u00e7\u00e3o<\/h3>\n\n\n\n<p>Este passo tem por finalidade listar as cobran\u00e7as PIX Troco usando os filtros.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"1-toc-title\">Endpoints<\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Produ\u00e7\u00e3o:<\/strong>\u00a0https:\/\/api2.bancosemear.com.br\/paas-cashin-api\/api\/v1\/public\/billing-changes<\/li>\n\n\n\n<li><strong>Homologa\u00e7\u00e3o:<\/strong>\u00a0https:\/\/hmlapi2.bancosemear.com.br\/paas-cashin-api\/api\/v1\/public\/billing-changes<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"2-toc-title\">Requisi\u00e7\u00e3o (GET)<\/h3>\n\n\n\n<p>Segue exemplo de requisi\u00e7\u00e3o:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>curl --location --request GET 'https:\/\/hmlapi2.bancosemear.com.br\/paas-cashin-api\/api\/v1\/public\/billing-changes?document=xxxxxxxxxxxxxx&amp;startDate=2024-05-01T00:00:00&amp;finalDate=2024-05-15T21:00:00&amp;statusFilter=TODOS&amp;page=1&amp;itensPage=50' \\\n--header 'client-cert: &lt;CERTIFICADO DO CLIENTE>' \\\n--header 'client_id: &lt;CLIENT ID>' \\\n--header 'access_token: &lt;ACCESS TOKEN' \\\n--header 'Authorization: &lt;BEARER TOKEN>'<\/code><\/pre>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"3-toc-title\">Par\u00e2metros de Requisi\u00e7\u00e3o<\/h4>\n\n\n\n<h5 class=\"wp-block-heading\" id=\"4-toc-title\">Cabe\u00e7alho<\/h5>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Authorization:<\/strong>\u00a0Token Bearer de autentica\u00e7\u00e3o<\/li>\n\n\n\n<li><strong>client_id:<\/strong>\u00a0ID de cliente usado para controle de acesso do gateway de APIs<\/li>\n\n\n\n<li><strong>access_token:<\/strong>\u00a0Token recebido ap\u00f3s executar o m\u00e9todo\u00a0<a href=\"https:\/\/www.bancosemear.com.br\/docs\/?docs=autenticacao-oauth\" target=\"_blank\" rel=\"noreferrer noopener\">oAuth<\/a><\/li>\n\n\n\n<li><strong>client_cert:<\/strong>\u00a0Certificado usado para autenticar o usu\u00e1rio com a aplica\u00e7\u00e3o<\/li>\n<\/ul>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"5-toc-title\">Query params<\/h4>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>document:<\/strong>\u00a0N\u00famero de documento vinculado ao client id e a conta. (Obrigat\u00f3rio)<\/li>\n\n\n\n<li><strong>page:<\/strong>\u00a0N\u00famero da pagina(utilizada para navega\u00e7\u00e3o), caso n\u00e3o seja enviado um valor, ser\u00e1 atribu\u00eddo 1 como default<\/li>\n\n\n\n<li><strong>itensPage:<\/strong>\u00a0Quantidade de itens por pagina( utilizado para navega\u00e7\u00e3o), caso n\u00e3o seja enviado um valor, ser\u00e1 atribu\u00eddo a quantidade padr\u00e3o do sistema.<\/li>\n\n\n\n<li><strong>startDate:<\/strong>\u00a0Data inicial da busca. (Obrigat\u00f3rio)<\/li>\n\n\n\n<li><strong>finalDate:<\/strong>\u00a0Data final da busca. (Obrigat\u00f3rio)<\/li>\n\n\n\n<li><strong>statusFilter:<\/strong>\u00a0Filtro por status, valores poss\u00edveis TODOS = 0, PENDENTE = 1, PAGO = 2, EXPIRADO = 3<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"5-toc-title\">Resposta<\/h3>\n\n\n\n<p>Segue exemplo de resposta:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>{\n    \"parametros\": {\n        \"inicio\": \"2024-05-01T00:00:00\",\n        \"fim\": \"2024-05-15T21:00:00\",\n        \"paginacao\": {\n            \"paginaAtual\": 1,\n            \"itensPorPagina\": 50,\n            \"quantidadeDePaginas\": 1,\n            \"quantidadeTotalDeItens\": 15\n        }\n    },\n    \"cobranca\": &#91;\n        {\n            \"calendario\": {\n                \"expiracao\": 36000,\n                \"criacao\": \"2024-05-09T17:01:51.997\"\n            },\n            \"valor\": {\n                \"original\": \"20.00\",\n                \"modalidadeAlteracao\": 0,\n                \"retirada\": {\n                    \"troco\": {\n                        \"valor\": \"10.00\",\n                        \"modalidadeAlteracao\": 0,\n                        \"modalidadeAgente\": \"AGTEC\",\n                        \"prestadorDoServicoDeSaque\": \"00795423\"\n                    }\n                }\n            },\n            \"correlationId\": \"118ad52a-67e6-497b-82a4-664d815668ef\",\n            \"txid\": \"ogq3tm5qbww6qx76jmrz88tzo0n9gryn76d\",\n            \"endToEnd\": \"E00795423202404231255mh22jH3TCpD\",\n            \"status\": \"Pago\",\n            \"devedor\": {\n                \"nome\": \"Jhon A J.\",\n                \"documento\": \"30302472089\"\n            },\n            \"chave\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n            \"pixCopiaECola\": \"00020101021226920014BR.GOV.BCB.PIX2570spi-h.bancosemear.com.br\/qrcode\/gi\/v2\/a8c1975bf27546ac8e1a216ddabfb2b35204000053039865802BR5923SPEEDRACERAUTOMECANICAL6013BELOHORIZONTE61083013000862070503***6304E767\",\n            \"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\",\n            \"linkPagamento\": \"https:\/\/hml-semearpay.bancosemear.com.br\/pay\/pix\/ogq3tm5qbww6qx76jmrz88tzo0n9gryn76d\",\n            \"informacoesAdicionais\": &#91;],\n            \"revisao\": 0\n        }\n    ]\n}<\/code><\/pre>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"6-toc-title\">Par\u00e2metros de Resposta<\/h4>\n\n\n\n<h5 class=\"wp-block-heading\" id=\"7-toc-title\">Corpo (JSON)<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th>Propriedade<\/th><th>Descri\u00e7\u00e3o<\/th><th>Tipo<\/th><\/tr><\/thead><tbody><tr><td>&nbsp;<strong>status<\/strong><\/td><td>&nbsp;Status da cobran\u00e7a:<br><strong>PENDENTE<\/strong>(indica que o registro se refere a uma cobran\u00e7a que foi gerada mas ainda n\u00e3o foi paga nem esta expirada);<br><strong>PAGO<\/strong>(indica que o registro se refere a uma cobran\u00e7a que j\u00e1 foi paga e, por conseguinte, n\u00e3o pode acolher outro pagamento);<br><strong>EXPIRADO&nbsp;<\/strong>(indica que o pix est\u00e1 expirado e n\u00e3o pode mais ser pago ou alterado).<\/td><td>&nbsp;String<\/td><\/tr><tr><td>&nbsp;<strong>calendario.expiracao<\/strong><\/td><td>&nbsp;Tempo de validade da chave (<strong>em segundos<\/strong>).<\/td><td>&nbsp;int32<\/td><\/tr><tr><td>&nbsp;<strong>calendario.criacao<\/strong><\/td><td>&nbsp;Data de cria\u00e7\u00e3o da chave<\/td><td>&nbsp;DateTime<\/td><\/tr><tr><td>&nbsp;<strong>txid<\/strong><\/td><td>&nbsp;ID da transa\u00e7\u00e3o<\/td><td>&nbsp;String<\/td><\/tr><tr><td><strong>correlationId<\/strong><\/td><td>Identificador interno de referencia do pix<\/td><td>String<\/td><\/tr><tr><td><strong>endToEnd<\/strong><\/td><td>EndToEnd da transa\u00e7\u00e3o, gerado quando pix estiver com status PAGO<\/td><td>String<\/td><\/tr><tr><td>&nbsp;<strong>devedor.nome<\/strong><\/td><td>&nbsp;Nome do devedor<\/td><td>&nbsp;String<\/td><\/tr><tr><td>&nbsp;<strong>devedor.documento<\/strong><\/td><td>&nbsp;CPF ou CNPJ do devedor<\/td><td>&nbsp;String<\/td><\/tr><tr><td>&nbsp;<strong>valor.original<\/strong><\/td><td>&nbsp;Valor do CASH-IN<\/td><td>&nbsp;String<\/td><\/tr><tr><td>&nbsp;<strong>valor.modalidadeAlteracao<\/strong><\/td><td>&nbsp;Valor 0 n\u00e3o permite alterar o valor de pagamento do PIX nessa modalidade<\/td><td>&nbsp;int32<\/td><\/tr><tr><td><strong>valor.retirada.troco.valor<\/strong><\/td><td>\u00a0Valor de troco do CASH-IN<\/td><td>String<\/td><\/tr><tr><td><strong>valor.retirada.<strong>troco<\/strong>.modalidadeAlteracao<\/strong><\/td><td>Valor 0 n\u00e3o permite alterar o valor de pagamento do PIX, valor 1 permite alterar o valor do pagamento.<\/td><td>Int32<\/td><\/tr><tr><td><strong>valor.retirada.<strong>troco<\/strong>.modalidadeAgente<\/strong><\/td><td>Agente de saque (AGTEC, AGTOT, AGFSS)*<\/td><td>String<\/td><\/tr><tr><td><strong>valor.retirada.<strong>troco<\/strong>.prestadorDoServicoDeSaque<\/strong><\/td><td>Facilitador&nbsp;de&nbsp;Servi\u00e7o&nbsp;de&nbsp;Saque&nbsp;registrado.<\/td><td>String<\/td><\/tr><tr><td>&nbsp;<strong>revisao<\/strong><\/td><td>&nbsp;valor de vezes que pix foi revisado\/alterado<\/td><td>&nbsp;int32<\/td><\/tr><tr><td>&nbsp;<strong>linkPagamento<\/strong><\/td><td>&nbsp;Link de pagamento do PIX<\/td><td>&nbsp;String<\/td><\/tr><tr><td>&nbsp;<strong>pixCopiaECola<\/strong><\/td><td>&nbsp;C\u00f3digo do PIX<\/td><td>&nbsp;String<\/td><\/tr><tr><td>&nbsp;<strong>qrCode<\/strong><\/td><td>&nbsp;Imagem PNG do c\u00f3digo QR PIX codificado em base64<\/td><td>&nbsp;String<\/td><\/tr><tr><td>&nbsp;<strong>chave<\/strong><\/td><td>&nbsp;Chave PIX de recebimento<\/td><td>&nbsp;String<\/td><\/tr><tr><td>&nbsp;<strong>informacoesAdicionais.nome<\/strong><\/td><td>&nbsp;Chave opcional. Usado para informa\u00e7\u00f5es espec\u00edficas<\/td><td>&nbsp;String<\/td><\/tr><tr><td><strong>informacoesAdicionais.valor<\/strong><\/td><td>&nbsp;Valor opcional. Usado para informa\u00e7\u00f5es espec\u00edficas<\/td><td>&nbsp;String<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"<p>Descri\u00e7\u00e3o Este passo tem por finalidade listar as cobran\u00e7as PIX Troco usando os filtros. Endpoints Requisi\u00e7\u00e3o (GET) Segue exemplo de requisi\u00e7\u00e3o: Par\u00e2metros de Requisi\u00e7\u00e3o Cabe\u00e7alho Query params Resposta Segue exemplo de resposta: Par\u00e2metros de Resposta Corpo (JSON) Propriedade Descri\u00e7\u00e3o Tipo &nbsp;status &nbsp;Status da cobran\u00e7a:PENDENTE(indica que o registro se refere a uma cobran\u00e7a que foi gerada &hellip;<\/p>\n<p class=\"read-more\"> <a class=\"\" href=\"https:\/\/www.bancosemear.com.br\/docs\/?docs=listar-cobrancas-pix-troco-cash-in\"> <span class=\"screen-reader-text\">Listar Cobran\u00e7as PIX Troco (CASH-IN)<\/span> Leia mais &raquo;<\/a><\/p>\n","protected":false},"author":8,"featured_media":0,"parent":0,"comment_status":"open","ping_status":"closed","template":"","meta":{"site-sidebar-layout":"default","site-content-layout":"default","ast-global-header-display":"","ast-main-header-display":"","ast-hfb-above-header-display":"","ast-hfb-below-header-display":"","ast-hfb-mobile-header-display":"","site-post-title":"","ast-breadcrumbs-content":"","ast-featured-img":"","footer-sml-layout":"","theme-transparent-header-meta":"","adv-header-id-meta":"","stick-header-meta":"","header-above-stick-meta":"","header-main-stick-meta":"","header-below-stick-meta":"","footnotes":""},"doc_category":[2],"doc_tag":[],"class_list":["post-916","docs","type-docs","status-publish","hentry","doc_category-api-pix"],"_links":{"self":[{"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=\/wp\/v2\/docs\/916","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=\/wp\/v2\/users\/8"}],"replies":[{"embeddable":true,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=916"}],"version-history":[{"count":1,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=\/wp\/v2\/docs\/916\/revisions"}],"predecessor-version":[{"id":917,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=\/wp\/v2\/docs\/916\/revisions\/917"}],"wp:attachment":[{"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=916"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_category&post=916"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=916"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}