{"id":1650,"date":"2025-02-26T14:56:36","date_gmt":"2025-02-26T17:56:36","guid":{"rendered":"https:\/\/www.bancosemear.com.br\/docs\/?post_type=docs&#038;p=1650"},"modified":"2025-02-26T17:56:22","modified_gmt":"2025-02-26T20:56:22","slug":"cancelar-o-bolepix","status":"publish","type":"docs","link":"https:\/\/www.bancosemear.com.br\/docs\/?docs=cancelar-o-bolepix","title":{"rendered":"Cancelar o BOLEPIX"},"content":{"rendered":"\n<h3 class=\"wp-block-heading\" id=\"descrio\">Descri\u00e7\u00e3o<\/h3>\n\n\n\n<p>Este endpoint permite o cancelamento de uma cobran\u00e7a do tipo <strong>BOLEPIX<\/strong> que esteja com status <strong>PENDENTE<\/strong>. Para realizar essa opera\u00e7\u00e3o, \u00e9 necess\u00e1rio informar o <strong>CorrelationId<\/strong> da cobran\u00e7a. O cancelamento deve ser realizado via requisi\u00e7\u00e3o <strong>DELETE<\/strong>, conforme a estrutura detalhada abaixo.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"endpoints\">Endpoints<\/h3>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Produ\u00e7\u00e3o:&nbsp;<\/strong><a href=\"https:\/\/hmlapi2.bancosemear.com.br\/paas-cashin-api\/api\/v1\/public\/immediatly-billings\">https:\/\/api2.bancosemear.com.br\/paas-billet-api\/api\/v1\/public\/paas-billets<\/a><\/li>\n\n\n\n<li><strong>Homologa\u00e7\u00e3o:<\/strong>&nbsp;<a href=\"https:\/\/hmlapi2.bancosemear.com.br\/paas-cashin-api\/api\/v1\/public\/immediatly-billings\">https:\/\/hmlapi2.bancosemear.com.br\/paas-billet-api\/api\/v1\/public\/paas-billets<\/a><\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"requisio-delete\">Requisi\u00e7\u00e3o (DELETE)<\/h3>\n\n\n\n<p>Segue exemplo da requisi\u00e7\u00e3o:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>curl --location --request DELETE 'https:\/\/hmlapi2.bancosemear.com.br\/paas-billet-api\/api\/v1\/public\/paas-billets' \\\n--header 'client_id: f7e8e9a4-8481-4713-a024-f2edb28601a3' \\\n--header 'access_token: 01d0923e-c184-4f8d-b763-d562a9beda13' \\\n--header 'Content-Type: application\/json' \\\n--data '{\n  \"correlationId\": \"e37b99cb-450e-4c28-baf8-ebf10d2d4c7c\",\n  \"accountNumber\": \"0119999991\",\n  \"assignorDocument\": \"99999927000121\"\n}'<\/code><\/pre>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"parmetros-de-requisio\">Par\u00e2metros de Requisi\u00e7\u00e3o<\/h4>\n\n\n\n<h5 class=\"wp-block-heading\" id=\"cabealho\">Cabe\u00e7alho<\/h5>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Content-Type:&nbsp;<\/strong>Informa ao servidor de que o corpo da requisi\u00e7\u00e3o possui o formato JSON.<\/li>\n\n\n\n<li><strong>client_id:&nbsp;<\/strong>ID de cliente usado para encaminhar a requisi\u00e7\u00e3o ao gateway de APIs<\/li>\n\n\n\n<li><strong>access_token:<\/strong>&nbsp;Token recebido ap\u00f3s executar o m\u00e9todo&nbsp;<a href=\"https:\/\/www.bancosemear.com.br\/docs\/?docs=autenticacao-oauth\" target=\"_blank\" rel=\"noreferrer noopener\">oAuth (Access Token)<\/a><\/li>\n<\/ul>\n\n\n\n<h5 class=\"wp-block-heading\">Estrutura do body<\/h5>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th>Propriedade<\/th><th>Descri\u00e7\u00e3o<\/th><th>Tipo<\/th><th>Obrigatoriedade<\/th><\/tr><\/thead><tbody><tr><td>correlationId<\/td><td>CorrelationId gerado ao criar a cobran\u00e7a<\/td><td>string<\/td><td>Obrigat\u00f3rio<\/td><\/tr><tr><td>accountNumber<\/td><td>N\u00famero da conta do cedente<\/td><td>string<\/td><td>Obrigat\u00f3rio<\/td><\/tr><tr><td>assignorDocument<\/td><td>Documento do cedente<\/td><td>string<\/td><td>Obrigat\u00f3rio<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"resposta\">Resposta (200 OK)<\/h3>\n\n\n\n<pre class=\"wp-block-code\"><code>{\n    \"hasCanceled\": true,\n    \"errorMessage\": \"Sem erro\"\n}<\/code><\/pre>\n\n\n\n<figure class=\"wp-block-table\"><table class=\"has-fixed-layout\"><thead><tr><th>Propriedade<\/th><th>Descri\u00e7\u00e3o<\/th><th>Tipo<\/th><\/tr><\/thead><tbody><tr><td>hasCanceled<\/td><td>Propriedade que marca se cancelado com sucesso.<\/td><td>boolean<\/td><\/tr><tr><td>errorMessage<\/td><td>Mensagem de retorno para casos de erro.<\/td><td>string<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<p><\/p>\n","protected":false},"excerpt":{"rendered":"<p>Descri\u00e7\u00e3o Este endpoint permite o cancelamento de uma cobran\u00e7a do tipo BOLEPIX que esteja com status PENDENTE. Para realizar essa opera\u00e7\u00e3o, \u00e9 necess\u00e1rio informar o CorrelationId da cobran\u00e7a. O cancelamento deve ser realizado via requisi\u00e7\u00e3o DELETE, conforme a estrutura detalhada abaixo. Endpoints Requisi\u00e7\u00e3o (DELETE) Segue exemplo da requisi\u00e7\u00e3o: Par\u00e2metros de Requisi\u00e7\u00e3o Cabe\u00e7alho Estrutura do body &hellip;<\/p>\n<p class=\"read-more\"> <a class=\"\" href=\"https:\/\/www.bancosemear.com.br\/docs\/?docs=cancelar-o-bolepix\"> <span class=\"screen-reader-text\">Cancelar o BOLEPIX<\/span> Leia mais &raquo;<\/a><\/p>\n","protected":false},"author":20,"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":[3],"doc_tag":[],"class_list":["post-1650","docs","type-docs","status-publish","hentry","doc_category-api-boleto"],"_links":{"self":[{"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=\/wp\/v2\/docs\/1650","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\/20"}],"replies":[{"embeddable":true,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=1650"}],"version-history":[{"count":3,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=\/wp\/v2\/docs\/1650\/revisions"}],"predecessor-version":[{"id":1653,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=\/wp\/v2\/docs\/1650\/revisions\/1653"}],"wp:attachment":[{"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=1650"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_category&post=1650"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=1650"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}