{"id":660,"date":"2023-10-04T17:23:53","date_gmt":"2023-10-04T20:23:53","guid":{"rendered":"https:\/\/www.bancosemear.com.br\/docs\/?post_type=docs&#038;p=660"},"modified":"2024-09-06T11:58:44","modified_gmt":"2024-09-06T14:58:44","slug":"buscar-lista-de-pagamentos-pix","status":"publish","type":"docs","link":"https:\/\/www.bancosemear.com.br\/docs\/?docs=buscar-lista-de-pagamentos-pix","title":{"rendered":"Listar Pagamentos PIX (CASH-OUT)"},"content":{"rendered":"\n<h3 class=\"wp-block-heading\" id=\"0-toc-title\">Descri\u00e7\u00e3o<\/h3>\n\n\n\n<p>M\u00e9todo para buscar lista de cobran\u00e7as PIX, a consulta da cobran\u00e7a dever\u00e1 ser pela data da transa\u00e7\u00e3o e status(opcional).<\/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:&nbsp;<\/strong>https:\/\/api2.bancosemear.com.br\/paas-management-api\/v1\/public\/payments<\/li>\n\n\n\n<li><strong>Homologa\u00e7\u00e3o:<\/strong>&nbsp;https:\/\/hmlapi2.bancosemear.com.br\/paas-management-api\/v1\/public\/payments<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"2-toc-title\">Par\u00e2metros de Requisi\u00e7\u00e3o<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"3-toc-title\">Cabe\u00e7alho:<\/h4>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>token:<\/strong>&nbsp;Payload JSON criptografado com uma chave p\u00fablica codificado em base64 (Gerado no passo anterior,&nbsp;<a href=\"https:\/\/www.bancosemear.com.br\/docs\/?docs=consulta-geracao-de-token\">Consulta\/Gera\u00e7\u00e3o de token<\/a>)<\/li>\n\n\n\n<li><strong>client_id:<\/strong>&nbsp;ID de cliente usado para controle de acesso do gateway de APIs<\/li>\n\n\n\n<li><strong>access-token:<\/strong>&nbsp;Token recebido ap\u00f3s executar o m\u00e9todo&nbsp;<a rel=\"noreferrer noopener\" href=\"https:\/\/www.bancosemear.com.br\/docs\/?docs=autenticacao-oauth\" target=\"_blank\">oAuth<\/a><\/li>\n\n\n\n<li><strong>date:<\/strong>&nbsp;Data a ser filtrada (somente data)<\/li>\n\n\n\n<li><strong>status<\/strong>: Status do pagamento ( TODOS = n\u00e3o enviar, EM_PROCESSAMENTO = 1, SUCESSO = 2, COM_ERRO = 3)<\/li>\n\n\n\n<li><strong>page<\/strong>: N\u00famero da pagina (default 1)<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"4-toc-title\">Requisi\u00e7\u00e3o (GET)<\/h3>\n\n\n\n<pre class=\"wp-block-code\"><code>curl --location 'https:\/\/hmlapi2.bancosemear.com.br\/paas-management-api\/v1\/public\/payments?page=2&amp;status=2&amp;date=2023-10-04' \\\n--header 'token: &lt;TOKEN&gt;' \\\n--header 'access_token: &lt;ACCESS TOKEN&gt;' \\\n--header 'client_id: &lt;CLIENT ID DO CLIENTE&gt;'<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"5-toc-title\">Resposta<\/h3>\n\n\n\n<pre class=\"wp-block-code\"><code>{\n    \"actualPage\": 2,\n    \"totalPages\": 2,\n    \"totalItens\": 12,\n    \"itensPerPage\": 10,\n    \"pixCashOutResponses\": &#91;\n   {\n    \"id\": \"b23d1db8-7dc3-4f21-9ad9-8f7a5037ed05\",\n    \"endToEnd\": \"E00795423202310041923E8gad39uyaD\",\n    \"status\": \"SUCESSO\",\n    \"dateProccessStart\": \"2023-10-04T16:23:22.957\",\n    \"dateDictRequest\": \"2023-10-04T16:23:23.54\",\n    \"dateSendPayment\": \"2023-10-04T16:23:23.713\",\n    \"dateMovement\": \"2023-10-04T16:23:24.253\",\n    \"dateProccessEnd\": \"2023-10-04T16:23:27.467\",\n    \"value\": 1.74,\n    \"payerDocument\": \"1111111111111\",\n    \"payerAccount\": \"0011000000\",\n    \"key\": \"c0094e8a-f6ee-4716-8aaf-ded51a0b6e86\",\n    \"descrition\": \"Teste com Cash-Out\",\n    \"entryChannel\": \"APP_WEB\",\n    \"beneficiaryIspb\": \"00795400\",\n    \"beneficiaryAgency\": \"0001\",\n    \"beneficiaryAgencyDigit\": null,\n    \"beneficiaryAccount\": \"0110370000\",\n    \"beneficiaryAccountType\": \"CACC\",\n    \"beneficiaryDocument\": \"99999999999\",\n    \"beneficiaryName\": \"TESTE NOME BENEFICIARIO\",\n    \"errorCode\": null,\n    \"errorMessage\": null\n    \"operationCode\": \"SMO00001\"\n   }\n ]\n}<\/code><\/pre>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"6-toc-title\">Par\u00e2metros de Resposta<\/h3>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"7-toc-title\">Corpo (JSON)<\/h4>\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><strong>actualPage<\/strong><\/td><td>Pagina atual da busca<\/td><td>Int32<\/td><\/tr><tr><td><strong>totalPages<\/strong><\/td><td>Quantidade total de paginas<\/td><td>Int32<\/td><\/tr><tr><td><strong>totalItens<\/strong><\/td><td>N\u00famero total de itens para esse filtro<\/td><td>Int32<\/td><\/tr><tr><td><strong>itensPerPage<\/strong><\/td><td>Quantidade de itens por pagina<\/td><td>Int32<\/td><\/tr><tr><td>&nbsp;<strong>id<\/strong><\/td><td>&nbsp;ID da transa\u00e7\u00e3o interna<\/td><td>&nbsp;String<\/td><\/tr><tr><td>&nbsp;<strong>endToEnd<\/strong><\/td><td>&nbsp;ID End to End usado na chamada<\/td><td>&nbsp;String<\/td><\/tr><tr><td>&nbsp;<strong>status<\/strong><\/td><td>&nbsp;Status da transa\u00e7\u00e3o (SUCESSO, EM PROCESSAMENTO, COM ERRO)<\/td><td>&nbsp;String<\/td><\/tr><tr><td>&nbsp;<strong>dateProccessStart<\/strong><\/td><td>Data do inicio do processamento<\/td><td>&nbsp;DateTime<\/td><\/tr><tr><td><strong>dateDictRequest<\/strong><\/td><td>Data da consulta dos dados da chave<\/td><td>DateTime<\/td><\/tr><tr><td><strong>dateSendPayment<\/strong><\/td><td>Data do envio da ordem de pagamento<\/td><td>DateTime<\/td><\/tr><tr><td><strong>dateMovement<\/strong><\/td><td>Data do pagamento<\/td><td>DateTime<\/td><\/tr><tr><td><strong>dateProccessEnd<\/strong><\/td><td>Data do envio do webhook<\/td><td>DateTime<\/td><\/tr><tr><td><strong>value<\/strong><\/td><td>Valor do cash out<\/td><td>decimal<\/td><\/tr><tr><td><strong>payerDocument<\/strong><\/td><td>Documento do pagador<\/td><td>String<\/td><\/tr><tr><td><strong>payerAccount<\/strong><\/td><td>Conta referente do pagador que esta efetuando o cash out<\/td><td>String<\/td><\/tr><tr><td><strong>key<\/strong><\/td><td>Chave de recebimento do pagamento<\/td><td>String<\/td><\/tr><tr><td><strong>descrition<\/strong><\/td><td>Campo livre de digita\u00e7\u00e3o<\/td><td>String<\/td><\/tr><tr><td><strong>entryChannel<\/strong><\/td><td>Canal de entrada do pagamento<\/td><td>String<\/td><\/tr><tr><td><strong>beneficiaryIspb<\/strong><\/td><td>C\u00f3digo banc\u00e1rio<\/td><td>String<\/td><\/tr><tr><td><strong>beneficiaryAgency<\/strong><\/td><td>C\u00f3digo da agencia do benefici\u00e1rio do pagamento<\/td><td>String<\/td><\/tr><tr><td><strong>beneficiaryAgencyDigit<\/strong><\/td><td>Digito da agencia do benefici\u00e1rio do pagamento<\/td><td>String<\/td><\/tr><tr><td><strong>beneficiaryAccount<\/strong><\/td><td>Conta do benefici\u00e1rio do pagamento<\/td><td>String<\/td><\/tr><tr><td><strong>beneficiaryAccountType<\/strong><\/td><td>Tipo de conta do benefici\u00e1rio do pagamento<\/td><td>String<\/td><\/tr><tr><td><strong>beneficiaryDocument<\/strong><\/td><td>Documento do benefici\u00e1rio do pagamento<\/td><td>String<\/td><\/tr><tr><td><strong>beneficiaryName<\/strong><\/td><td>Nome do benefici\u00e1rio do pagamento<\/td><td>String<\/td><\/tr><tr><td><strong>errorCode<\/strong><\/td><td>C\u00f3digo do erro gerado<\/td><td>String<\/td><\/tr><tr><td><strong>errorMessage<\/strong><\/td><td>Mensagem sobre o erro gerado<\/td><td>String<\/td><\/tr><tr><td><strong>operationCode<\/strong><\/td><td>Identificador \u00danico da Transa\u00e7\u00e3o enviado pelo Cliente<\/td><td>String<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Descri\u00e7\u00e3o M\u00e9todo para buscar lista de cobran\u00e7as PIX, a consulta da cobran\u00e7a dever\u00e1 ser pela data da transa\u00e7\u00e3o e status(opcional). Endpoints Par\u00e2metros de Requisi\u00e7\u00e3o Cabe\u00e7alho: Requisi\u00e7\u00e3o (GET) Resposta Par\u00e2metros de Resposta Corpo (JSON) Propriedade Descri\u00e7\u00e3o Tipo actualPage Pagina atual da busca Int32 totalPages Quantidade total de paginas Int32 totalItens N\u00famero total de itens para esse &hellip;<\/p>\n<p class=\"read-more\"> <a class=\"\" href=\"https:\/\/www.bancosemear.com.br\/docs\/?docs=buscar-lista-de-pagamentos-pix\"> <span class=\"screen-reader-text\">Listar Pagamentos PIX (CASH-OUT)<\/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":[15],"doc_tag":[],"class_list":["post-660","docs","type-docs","status-publish","hentry","doc_category-paas-management-api"],"_links":{"self":[{"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=\/wp\/v2\/docs\/660","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=660"}],"version-history":[{"count":4,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=\/wp\/v2\/docs\/660\/revisions"}],"predecessor-version":[{"id":1289,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=\/wp\/v2\/docs\/660\/revisions\/1289"}],"wp:attachment":[{"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=660"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_category&post=660"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=660"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}