{"id":872,"date":"2024-05-15T11:44:56","date_gmt":"2024-05-15T14:44:56","guid":{"rendered":"https:\/\/www.bancosemear.com.br\/docs\/?post_type=docs&#038;p=872"},"modified":"2024-05-15T11:45:52","modified_gmt":"2024-05-15T14:45:52","slug":"criar-cobranca-pix-cash-in","status":"publish","type":"docs","link":"https:\/\/www.bancosemear.com.br\/docs\/?docs=criar-cobranca-pix-cash-in","title":{"rendered":"Criar Cobran\u00e7a PIX (CASH-IN)"},"content":{"rendered":"\n<h2 class=\"wp-block-heading\" id=\"0-toc-title\">Descri\u00e7\u00e3o<\/h2>\n\n\n\n<p>Este passo tem por finalidade criar uma cobran\u00e7a PIX imediato.<\/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\/immediatly-billings<\/li>\n\n\n\n<li><strong>Homologa\u00e7\u00e3o:<\/strong>\u00a0https:\/\/hmlapi2.bancosemear.com.br\/paas-cashin-api\/api\/v1\/public\/immediatly-billings<\/li>\n<\/ul>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"2-toc-title\">Requisi\u00e7\u00e3o (POST)<\/h3>\n\n\n\n<p>Segue exemplo de requisi\u00e7\u00e3o:<\/p>\n\n\n\n<pre class=\"wp-block-code\"><code>curl \"https:\/\/hmlapi2.bancosemear.com.br\/paas-cashin-api\/api\/v1\/public\/immediatly-billings\" \\\n    --request POST \\\n    --header \"Content-Type: application\/json\" \\\n    --header \"client-cert: &lt;CLIENT_CERT>\" \\\n    --header \"Authorization: Bearer &lt;BEARER_TOKEN>\" \\\n    --header \"client_id: &lt;CLIENT_ID>\" \\\n    --header \"access_token: &lt;ACCESS_TOKEN>\" \\\n    --data '\n{\n    \"calendario\":{\n        \"expiracao\":3600\n    },\n    \"devedor\":{\n        \"nome\":\"Cidad\u00e3o Silva de Oliveira\",\n        \"cpf\":\"21356500056\"\n    },\n    \"valor\":{\n        \"original\":\"500.00\",\n        \"modalidadeAlteracao\":0\n    },\n    \"chave\":\"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n    \"infoAdicionais\":&#91;\n        {\n            \"nome\":\"Infoadicional\",\n            \"valor\":\"222\"\n        }\n    ]\n}'<\/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>Content-Type:<\/strong>\u00a0Informa ao servidor de que o corpo da requisi\u00e7\u00e3o possui o formato JSON<\/li>\n\n\n\n<li><strong>client-cert:<\/strong>\u00a0Certificado usado para autenticar o usu\u00e1rio junto \u00e0 aplica\u00e7\u00e3o<\/li>\n\n\n\n<li><strong>Authorization:<\/strong>\u00a0Bearer token usado para autentica\u00e7\u00e3o de usu\u00e1rio (Recebido no passo \u201c<a href=\"https:\/\/www.bancosemear.com.br\/docs\/?docs=autenticacao-oauth-aplicacao\">oAuth Aplica\u00e7\u00e3o<\/a>\u201c)<\/li>\n\n\n\n<li><strong>client_id:<\/strong>\u00a0ID de cliente usado para encaminhar a requisi\u00e7\u00e3o ao 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 (Access Token)<\/a><\/li>\n<\/ul>\n\n\n\n<h5 class=\"wp-block-heading\" id=\"5-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><th>Obrigatoriedade<\/th><\/tr><\/thead><tbody><tr><td>&nbsp;<strong>calendario.expiracao<\/strong><\/td><td>&nbsp;Tempo de validade da requisi\u00e7\u00e3o em Segundos. Valor padr\u00e3o 86400 quando n\u00e3o passado.<\/td><td>&nbsp;Int32<\/td><td>Obrigat\u00f3rio<\/td><\/tr><tr><td>&nbsp;<strong>devedor.nome<\/strong><\/td><td>&nbsp;Nome do devedor<\/td><td>&nbsp;String<\/td><td>\u00a0Obrigat\u00f3rio<\/td><\/tr><tr><td>\u00a0<strong>devedor.cpf<\/strong> ou \u00a0<strong>devedor.cnpj<\/strong><\/td><td>\u00a0CPF do devedor ou CNPJ do devedor<\/td><td>&nbsp;String&nbsp;<\/td><td>\u00a0Obrigat\u00f3rio<\/td><\/tr><tr><td>&nbsp;<strong>valor.original<\/strong><\/td><td>&nbsp;Valor do CASH-IN<\/td><td>&nbsp;String<\/td><td>\u00a0Obrigat\u00f3rio<\/td><\/tr><tr><td>&nbsp;<strong>valor.modalidadeAlteracao<\/strong><\/td><td>&nbsp;Valor 0 n\u00e3o permite alterar o valor de pagamento do PIX, valor 1 permite alterar o valor do pagamento. Valor padr\u00e3o 0 quando n\u00e3o passado.<\/td><td>&nbsp;Int32<\/td><td>&nbsp;Opcional<\/td><\/tr><tr><td>&nbsp;<strong>chave<\/strong><\/td><td>&nbsp;Chave PIX de recebimento pertencente a conta do usu\u00e1rio recebedor<\/td><td>&nbsp;String<\/td><td>&nbsp;Obrigat\u00f3rio<\/td><\/tr><tr><td><strong>infoAdicionais<\/strong><\/td><td>Array de objetos para informa\u00e7\u00f5es adicionais<\/td><td>Array<\/td><td>Opcional<\/td><\/tr><tr><td>&nbsp;<strong>infoAdicionais.nome<\/strong><\/td><td>Usado para informa\u00e7\u00f5es espec\u00edficas (caso declare o objeto dentro do array, a propriedade se torna obrigat\u00f3ria)<\/td><td>&nbsp;String<\/td><td>&nbsp;Opcional<\/td><\/tr><tr><td>&nbsp;<strong>infoAdicionais.valor<\/strong><\/td><td>Usado para informa\u00e7\u00f5es espec\u00edficas (caso declare o objeto dentro do array, a propriedade se torna obrigat\u00f3ria)<\/td><td>&nbsp;String<\/td><td>&nbsp;Opcional<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\" id=\"6-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    \"calendario\": {\n        \"expiracao\": 3600,\n        \"criacao\": \"2024-05-15T11:20:24.0843525-03:00\"\n    },\n    \"valor\": {\n        \"original\": \"500.00\",\n        \"valor pago\": null,\n        \"modalidadeAlteracao\": 0\n    },\n    \"correlationId\": \"d4c9e080-db19-4eff-b8fe-d34d9c2aa74a\",\n    \"txid\": \"43sfav5ta9j3yrrbn4qgojifrh6guwrrzn4\",\n    \"endToEnd\": \"\",\n    \"status\": \"Pendente\",\n    \"devedor\": {\n        \"nome\": \"Cidad\u00e3o Silva de Oliveira\",\n        \"documento\": \"21356500056\"\n    },\n    \"chave\": \"xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx\",\n    \"pixCopiaECola\": \"00020101021226920014BR.GOV.BCB.PIX2570spi-h.bancosemear.com.br\/qrcode\/gi\/v2\/493640e818a94920869fc9be37cbd7765204000053039865802BR5923XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX***6304180F\",\n    \"qrCode\": \"iVBORw0KGgoAAAANSUhEUgAAAYEAAAGBAQAAAACoIjCJAAAF+ElEQVR4nO2bTY7qWgyEjRhkyBKyE9gYUiKxMdhJlpAhA8R5rq9OaLhXetIdtgUD1IRTDNz+KZd9ov3ja44v4ov4In4fYo2I3Tq1+\/HQluF6eIz5cb\/k03O0Z0xLu+W54ZoPhmKIqeWzPHfUt884j3FqlyW\/2LeIwzze86OOtFYNcY4hPy7DbZ0WfbvEKf8a8ovxLqvJTGO7rTFWRTQf3i861wKneYY+pq2GqogMknsc0g\/kJekqioVV\/qLAyUgZSyIUH2mhds34CNlFkSJbpel2eS5\/6jH+FVEVEORErPF\/b39l0d+P6PUta4CT\/j7rQtpKXhKqEC1d5SwH+aNyFkDMaQV9sXNSmPRX+NldhxM2jxk40+YlVRDKfyeFvQp9Bgk1QMX\/8IgsDvqp9ggyZjFEvinrhQvBMf\/Kj5O4DykjoEJNxotWDZHOn8\/EAET9MhPmW1OZkG\/kOTImVaMY4iEG8MNye5CklxAfSXvyL\/3KT2YogxjtG+J6OiyyQyo4w4Gb8qRI0ZutaiDk\/Kr7HCb1OR3uVPJvKgknccInnlMKkbbi\/99jPx1keEJ15RsnM4A9xD\/KIRQfM+WOxJgEN+2SLd4M4RMRVpl4t1UNhNJhM6Gnr83XMQkQydIdrg5nZsCmpRA0rZkJA7dwtRfXy6jIw02Jwo704gxFENYt0kwmvWZBtDdnF4J7b\/Bjs1UZRA+DJsmCusCzNNOjJ4pX8iiGWN29h0U7JcFutWZEF3Vo9WshXALP+EbPhCeyhb6gBcjMsGDOoRhCrzV6pDxVEnZr72uVIkf6HmxVDEE6zEJAaOAbIIISSLjQ9iX3WYohHPYXcZ9JIlbXLNXY4RbKERSHHy+pgsjqZ4oTk62RhG9WIVALQDXg2VtmKIOwQgXrQ6BrNyu4dDZdvbTViiFmyTau+w2PQLGm0cFpMCcGK4aQmfRRIlZ4GCEBB70O9VJY6uCrr62DID6cHo6wIPkLrb66Hc3pgh9otRBS7mhfcZCjepwTh1Ucjkg52y9XQ1ysWmnwipnEfYDJOND9QLN0x1cJofrGmE1vIju0ueRJ9CuPYP\/QLEsgLh45b7yudforltvaVgKZQbZaCGywGYJydz\/ZVpOWLproIHLHuRoC7uNncD0tHKgukCh2vVaMH\/FRBKG5C93sTQgyA6O3ZrnS2rV0zMerx6mC2BP7ZjwiOw2+i2hHmaDjMweuhnAhGPAXMQBEOzKhZzFaM\/DCQS2E14n2MNrXElGXMO99y0KLJ1uKrISg5qmZ106RisNVtCek3fBREqb7nmIIKbMavd2sZP3MYbVPwzzqpecUQ8zucYgPMbwu1kit5acw4vBuqzoIkr7nLk\/r1A8vCzKkoTgg3bdiiAvFf\/GaARMYJcEIdukOjg8EjdcuThGE9cmZhQOJWAj2Ed62EdU19zm69a2EkHbD2Ikk6MygSHHzk6ZTikSsLoeg3GkqoyUiPWOJCL5LouhYzytKIeaA1zVPIzWFUgt\/l6DB0oX2LZZN2SmFuLA2KAHnPPYhq9j\/kSmUwmXbsnjLiTUQLE1Nr23w2VqGZ1RX79IxjpujGIJutpEZ5vAlEK2Qge1LlCoYn91dCURzU+NxK1SX9Sk0y543euDUQ0iZDQYUin2xepivRxXeRBhNeoshvCW13X3oSybkA\/aq3OwNnzmxBEISzc0R0BkAYxhuvrBWxssXYYohGEHMFufd1968Fz5bpw4W6nZvm+RlEOrfvC7mjfjBF2EOiBwRJv7cfyuGoOZtk8cTWwfeC99brFZbP2LJcgj1b8132KRg+NoXS8HcfLH7xMaG6yB4rT9X+LgKMXHr4y1chrZ+3nYqgOj3vFT3H9x26tdZmVdcvV9ysabViiEmZjGNMKB7p88b2Cg7BpOLT6ZfBsEWTb8GcO9JIcwEWamSlPMxd66F8ODVayR9dZKGlw7XCu5LuSuGYI9Md3gxCRqepByqgQLnfR5VBTH5Di8sF92CIHG4cOOr70mfyyGUExujGZV8kzsJODrXLwk8RoY0xRD\/9voivogv4tch\/gMCWZ8IcZznPwAAAABJRU5ErkJggg==\",\n    \"linkPagamento\": \"https:\/\/hml-semearpay.bancosemear.com.br\/pay\/pix\/43sfav5ta9j3yrrbn4qgojifrh6guwrrzn4\",\n    \"informacoesAdicionais\": &#91;\n        {\n            \"nome\": \"Infoadicional\",\n            \"valor\": \"222\"\n        }\n    ],\n    \"revisao\": 0\n}<\/code><\/pre>\n\n\n\n<h4 class=\"wp-block-heading\" id=\"7-toc-title\">Par\u00e2metros de Resposta<\/h4>\n\n\n\n<h5 class=\"wp-block-heading\" id=\"8-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>\u00a0Status 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 removida).<\/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>\u00a0<strong>valor.original<\/strong><\/td><td>\u00a0Valor do CASH-IN<\/td><td>String<\/td><\/tr><tr><td><strong>valor.valor pago<\/strong><\/td><td>Valor liquido referente ao pagamento do pix.<\/td><td>String<\/td><\/tr><tr><td>\u00a0<strong>valor.modalidadeAlteracao<\/strong><\/td><td>\u00a0Valor 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>correlationId<\/strong><\/td><td>Identificador interno de referencia do pix<\/td><td>String<\/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>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>\u00a0<strong>devedor.documento<\/strong><\/td><td>\u00a0CPF do devedor ou CNPJ do devedor<\/td><td>&nbsp;String<\/td><\/tr><tr><td><strong>chave<\/strong><\/td><td>\u00a0Chave PIX de recebimento<\/td><td>String<\/td><\/tr><tr><td><strong>pixCopiaECola<\/strong><\/td><td>\u00a0Copia e cola referente ao PIX gerado<\/td><td>String<\/td><\/tr><tr><td><strong>qrCode<\/strong><\/td><td>\u00a0Imagem PNG do c\u00f3digo QR PIX codificado em base64<\/td><td>String<\/td><\/tr><tr><td>\u00a0<strong>linkPagamento<\/strong><\/td><td>&nbsp;Link de pagamento do PIX<\/td><td>&nbsp;String<\/td><\/tr><tr><td>\u00a0<strong>informacoesAdicionais.nome<\/strong><\/td><td>\u00a0Nome opcional. Usado para informa\u00e7\u00f5es espec\u00edficas<\/td><td>&nbsp;String<\/td><\/tr><tr><td>\u00a0<strong>informacoesAdicionais.valor<\/strong><\/td><td>&nbsp;Valor opcional. Usado para informa\u00e7\u00f5es espec\u00edficas<\/td><td>&nbsp;String<\/td><\/tr><tr><td><strong>revisao<\/strong><\/td><td>\u00a0Valor de vezes que pix foi revisado\/alterado<\/td><td>Int32<\/td><\/tr><\/tbody><\/table><\/figure>\n","protected":false},"excerpt":{"rendered":"<p>Descri\u00e7\u00e3o Este passo tem por finalidade criar uma cobran\u00e7a PIX imediato. Endpoints Requisi\u00e7\u00e3o (POST) Segue exemplo de requisi\u00e7\u00e3o: Par\u00e2metros de Requisi\u00e7\u00e3o Cabe\u00e7alho Corpo (JSON) Propriedade Descri\u00e7\u00e3o Tipo Obrigatoriedade &nbsp;calendario.expiracao &nbsp;Tempo de validade da requisi\u00e7\u00e3o em Segundos. Valor padr\u00e3o 86400 quando n\u00e3o passado. &nbsp;Int32 Obrigat\u00f3rio &nbsp;devedor.nome &nbsp;Nome do devedor &nbsp;String \u00a0Obrigat\u00f3rio \u00a0devedor.cpf ou \u00a0devedor.cnpj \u00a0CPF do &hellip;<\/p>\n<p class=\"read-more\"> <a class=\"\" href=\"https:\/\/www.bancosemear.com.br\/docs\/?docs=criar-cobranca-pix-cash-in\"> <span class=\"screen-reader-text\">Criar Cobran\u00e7a PIX (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-872","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\/872","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=872"}],"version-history":[{"count":2,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=\/wp\/v2\/docs\/872\/revisions"}],"predecessor-version":[{"id":874,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=\/wp\/v2\/docs\/872\/revisions\/874"}],"wp:attachment":[{"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=872"}],"wp:term":[{"taxonomy":"doc_category","embeddable":true,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_category&post=872"},{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.bancosemear.com.br\/docs\/index.php?rest_route=%2Fwp%2Fv2%2Fdoc_tag&post=872"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}