{"id":243,"date":"2023-04-12T09:49:55","date_gmt":"2023-04-12T12:49:55","guid":{"rendered":"https:\/\/www.bancosemear.com.br\/docs\/?post_type=docs&#038;p=243"},"modified":"2024-09-06T11:54:28","modified_gmt":"2024-09-06T14:54:28","slug":"enviar-pagamento-cash-out","status":"publish","type":"docs","link":"https:\/\/www.bancosemear.com.br\/docs\/?docs=enviar-pagamento-cash-out","title":{"rendered":"Enviar Pagamento (CASH-OUT)"},"content":{"rendered":"\n<h3 class=\"wp-block-heading\">Descri\u00e7\u00e3o<\/h3>\n\n\n\n<p>Esta API tem por finalidade realizar um pagamento via PIX para outra institui\u00e7\u00e3o, <strong>onde o id de transa\u00e7\u00e3o (TXID) \u00e9 criado automaticamente<\/strong>.<br>No momento do onboarding, o cliente nos envia uma URL do webhook, e assim que a transa\u00e7\u00e3o for confirmada pelo Banco Semear, nossa API realiza uma chamada de confirma\u00e7\u00e3o ao webhook informado.<\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Funcionamento<\/h3>\n\n\n\n<p>Para realizar o pagamento (cash-out) \u00e9 necess\u00e1rio realizar dois passos:<\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Consulta\/Gera\u00e7\u00e3o de token<\/li>\n\n\n\n<li>Requisi\u00e7\u00e3o de pagamento<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\">Requisi\u00e7\u00e3o de Pagamento (POST)<\/h3>\n\n\n\n<p>Segue exemplo de requisi\u00e7\u00e3o:<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">Endpoints<\/h4>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Produ\u00e7\u00e3o:<\/strong> https:\/\/api2.bancosemear.com.br\/paas-management-api\/v1\/public\/payments<\/li>\n\n\n\n<li><strong>Homologa\u00e7\u00e3o:<\/strong> https:\/\/hmlapi2.bancosemear.com.br\/paas-management-api\/v1\/public\/payments<\/li>\n<\/ul>\n\n\n\n<h6 class=\"wp-block-heading\">Op\u00e7\u00e3o 1 (atrav\u00e9s da chave)<\/h6>\n\n\n\n<pre class=\"wp-block-code\"><code>curl --location 'https:\/\/hmlapi2.bancosemear.com.br\/paas-management-api\/v1\/public\/payments' \\\n--header 'client_id: &lt;CLIENT_ID>' \\\n--header 'token: &lt;TOKEN>' \\\n--header 'access_token: &lt;ACCESS_TOKEN>' \\\n--header 'Content-Type: application\/json' \\\n--data-raw '{\n    \"chave\": \"+5511999999999\",\n    \"valor\": 1.00, \n    \"descricao\": \"Cash-Out para ...\",\n    \"verificaDocumentoBeneficiario\": true,\n    \"documentoBeneficiario\": \"00000000000\",\n    \"identificadortransacao\": \"SMO00001\"\n}'<\/code><\/pre>\n\n\n\n<h6 class=\"wp-block-heading\">Op\u00e7\u00e3o 2 (atrav\u00e9s da conta)<\/h6>\n\n\n\n<pre class=\"wp-block-code\"><code>curl --location 'https:\/\/hmlapi2.bancosemear.com.br\/paas-management-api\/v1\/public\/payments' \\\n--header 'client_id: &lt;CLIENT_ID>' \\\n--header 'token: &lt;TOKEN>' \\\n--header 'access_token: &lt;ACCESS_TOKEN>' \\\n--header 'Content-Type: application\/json' \\\n--data-raw '{\n    \"valor\": 0.99,\n    \"descricao\": \"Teste\",\n    \"codAgenciaBeneficiario\": \"0001\",\n    \"codInstituicaoBeneficiario\": \"00999999\",\n    \"nroContaBeneficiario\": \"00000000\",\n    \"tipoContaBeneficiario\": \"CACC\",\n    \"nomeBeneficiario\": \"teste\",\n    \"documentoBeneficiario\": \"00000000000\"\n    \"identificadortransacao\": \"SMO00001\"\n}'<\/code><\/pre>\n\n\n\n<h4 class=\"wp-block-heading\">Par\u00e2metros de Requisi\u00e7\u00e3o<\/h4>\n\n\n\n<h5 class=\"wp-block-heading\">Cabe\u00e7alho<\/h5>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Content-Type:<\/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:<\/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 rel=\"noreferrer noopener\" href=\"https:\/\/www.bancosemear.com.br\/docs\/?docs=autenticacao-oauth\" target=\"_blank\">oAuth<\/a><\/li>\n\n\n\n<li><strong>token:<\/strong> Payload JSON criptografado com uma chave p\u00fablica codificado em base64 (Gerado no passo anterior, <a href=\"https:\/\/www.bancosemear.com.br\/docs\/?docs=consulta-geracao-de-token\">Consulta\/Gera\u00e7\u00e3o de token<\/a>)<\/li>\n<\/ul>\n\n\n\n<p><\/p>\n\n\n\n<h5 class=\"wp-block-heading\">Corpo<\/h5>\n\n\n\n<h6 class=\"wp-block-heading\">Op\u00e7\u00e3o 1<\/h6>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>Chave:<\/strong> chave&nbsp;PIX&nbsp;de&nbsp;quem&nbsp;vai&nbsp;receber.<\/li>\n\n\n\n<li><strong>valor:<\/strong> valor a ser enviado.<\/li>\n\n\n\n<li><strong>descricao:<\/strong> Descri\u00e7\u00e3o para a transa\u00e7\u00e3o realizada.<\/li>\n\n\n\n<li><strong>verificaDocumentoBeneficiario:<\/strong> Flag de controle que determina se valida ou n\u00e3o o documento do benefici\u00e1rio enviado na requisi\u00e7\u00e3o. (Caso false ou null, n\u00e3o \u00e9 necess\u00e1rio o envio da propriedade <strong>documentoBeneficiario<\/strong>).<\/li>\n\n\n\n<li><strong>documentoBeneficiario:<\/strong> Documento de quem ira receber o pagamento, pode ser CPF ou CNPJ.<\/li>\n\n\n\n<li><strong>identificadortransacao:<\/strong> Identifica\u00e7\u00e3o \u00fanica com no m\u00e1ximo 40 caracteres alfanum\u00e9ricos, utilizado para controle do cliente.<\/li>\n<\/ul>\n\n\n\n<h6 class=\"wp-block-heading\">Op\u00e7\u00e3o 2<\/h6>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>valor:<\/strong> valor a ser enviado.<\/li>\n\n\n\n<li><strong>descricao:<\/strong> Descri\u00e7\u00e3o para a transa\u00e7\u00e3o realizada.<\/li>\n\n\n\n<li><strong>codAgenciaBeneficiario<\/strong>: C\u00f3digo da agencia do benefici\u00e1rio.<\/li>\n\n\n\n<li><strong>codInstituicaoBeneficiario<\/strong>: C\u00f3digo da institui\u00e7\u00e3o do benefici\u00e1rio.<\/li>\n\n\n\n<li><strong>nroContaBeneficiario<\/strong>: N\u00famero da conta do benefici\u00e1rio.<\/li>\n\n\n\n<li><strong>tipoContaBeneficiario<\/strong>: Tipo de conta do benefici\u00e1rio (CACC&nbsp;&#8211;&nbsp;Conta&nbsp;Corrente,&nbsp;SLRY&nbsp;&#8211;&nbsp;Conta&nbsp;Sal\u00e1rio,&nbsp;SVGS&nbsp;&#8211;&nbsp;Conta&nbsp;Poupan\u00e7a,&nbsp;TRAN&nbsp;&#8211;&nbsp;Conta&nbsp;Pagamento).<\/li>\n\n\n\n<li><strong>nomeBeneficiario: <\/strong> Nome de benefici\u00e1rio que recebera o pagamento.<\/li>\n\n\n\n<li><strong>documentoBeneficiario:<\/strong> Documento de quem ira receber o pagamento.<\/li>\n\n\n\n<li><strong>identificadortransacao:<\/strong> Identifica\u00e7\u00e3o \u00fanica com no m\u00e1ximo 40 caracteres alfanum\u00e9ricos, utilizado para controle do cliente.<\/li>\n<\/ul>\n\n\n\n<h4 class=\"wp-block-heading\">Resposta<\/h4>\n\n\n\n<p>Segue exemplo de resposta:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>{\n    \"CorrelationId\": \"xxxxxxxxxxxxxxxxxxxxxxxxxxxx\",\n    \"Mensagem\": \"Ordem de pagamento recebida com sucesso.\"\n}<\/code><\/pre>\n\n\n\n<h4 class=\"wp-block-heading\">Par\u00e2metros de Resposta<\/h4>\n\n\n\n<h5 class=\"wp-block-heading\">Corpo (JSON)<\/h5>\n\n\n\n<ul class=\"wp-block-list\">\n<li><strong>CorrelationId<\/strong>: Chave (Identificador) da transa\u00e7\u00e3o realizada.<\/li>\n\n\n\n<li><strong>Mensagem:<\/strong> Mensagem para cada transa\u00e7\u00e3o.<\/li>\n<\/ul>\n\n\n\n<p>Assim que o pagamento for confirmado, o webhook cadastrado receber\u00e1 a informa\u00e7\u00e3o.<\/p>\n\n\n\n<h4 class=\"wp-block-heading\">Par\u00e2metros de Resposta do Webhook<\/h4>\n\n\n\n<h5 class=\"wp-block-heading\">Envio &#8220;verificaDocumentoBeneficiario&#8221;: true com &#8220;documentoBeneficiario&#8221; incorreto.<\/h5>\n\n\n\n<p>Resposta quando enviado a TAG &#8220;verificaDocumentoBeneficiario&#8221;: true, com o documento informado<strong> incorretamente <\/strong>na TAG &#8220;documentoBeneficiario&#8221;.<br>   &#8211; Nas TAGs <strong>&#8220;DestinationDocument&#8221; e &#8220;Document&#8221;<\/strong> trazem a informa\u00e7\u00e3o do documento enviado.<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">{<br>  \"Environment\": \"Homolog\",<br>  \"Registration\": \"EnvioPixCashout\",<br>  \"Details\": {<br>    \"Account\": \"XXXXXXXXXX\",<br>    \"Type\": \"PAASCASHOUT\",<br>    \"Status\": \"COM ERRO\",<br>    \"Error\": {<br>      \"Code\": \"40018\",<br>      \"Detail\": \"Documento do benefici\u00e1rio diferente do Documento da DICT.\"<br>    },<br>    \"CorrelationId\": \"XXXXXXXXXXXX-XXXX-XXXX-XXXXXXXXXXX\",<br>    \"Pix\": {<br>      \"TxId\": null,<br>      \"DestinationKey\": \"XXXXXXXXXXXX-XXXX-XXXX-XXXXXXXXXXX\",<br>      \"EndToEnd\": null,<br>      \"Value\": 0.71,<br>      \"PaymentDate\": null,<br>      \"Description\": \"Teste\",<br>      \"DestinationDocument\": \"XXXXXXXXXXXXXX\",<br>      \"RejectionReasonCode\": null,<br>      \"RejectionReasonDescription\": null,<br>      \"IspbCode\": null,<br>      \"Beneficiary\": {<br>        \"IspbCode\": null,<br>        \"Agency\": null,<br>        \"DigitAgency\": null,<br>        \"Account\": null,<br>        \"Type\": null,<br>        \"Document\": \"XXXXXXXXXXXXXXX\",<br>        \"Name\": null,<br>        \"OperationCode\": \"SMO00001\"<br>      }<br>    }<br>  }<br>}<\/pre>\n","protected":false},"excerpt":{"rendered":"<p>Descri\u00e7\u00e3o Esta API tem por finalidade realizar um pagamento via PIX para outra institui\u00e7\u00e3o, onde o id de transa\u00e7\u00e3o (TXID) \u00e9 criado automaticamente.No momento do onboarding, o cliente nos envia uma URL do webhook, e assim que a transa\u00e7\u00e3o for confirmada pelo Banco Semear, nossa API realiza uma chamada de confirma\u00e7\u00e3o ao webhook informado. Funcionamento &hellip;<\/p>\n<p class=\"read-more\"> <a class=\"\" href=\"https:\/\/www.bancosemear.com.br\/docs\/?docs=enviar-pagamento-cash-out\"> <span class=\"screen-reader-text\">Enviar Pagamento (CASH-OUT)<\/span> Leia mais &raquo;<\/a><\/p>\n","protected":false},"author":1,"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-243","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\/243","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\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=243"}],"version-history":[{"count":47,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=\/wp\/v2\/docs\/243\/revisions"}],"predecessor-version":[{"id":1285,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=\/wp\/v2\/docs\/243\/revisions\/1285"}],"wp:attachment":[{"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=243"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_category&post=243"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=243"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}