{"section":"tutorials","requestedLocale":"pt","requestedSlug":"configurar-gateway-cybersource","locale":"pt","slug":"configurar-gateway-cybersource","path":"docs/pt/tutorials/pagamentos/configurações-de-pagamentos/configurar-gateway-cybersource.md","branch":"main","content":"A Cybersource é uma empresa que oferece diversas soluções para auxiliar a gestão de pagamentos da sua loja. Entre elas estão um [gateway](/pt/docs/tutorials/o-que-e-um-gateway-de-pagamentos) e um [antifraude](/pt/docs/tutorials/o-que-e-antifraude), ambos com integrações disponíveis na VTEX.\n\nCaso deseje maiores informações sobre como integrar o antifraude da Cybersource em sua loja, acesse [Configurar antifraude Cybersource](/pt/docs/tutorials/configurar-antifraude-cybersource).\n\nPara utilizar o gateway da Cybersource IO em sua loja, as seguintes ações são necessárias:\n\n1. [Instalar os aplicativos Cybersource IO (VTEX IO CLI)](#instalando-apps-da-cybersource)\n2. [Criar as chaves de autenticação na Cybersource (Cybersource environment)](#criando-chaves-de-autenticacao-na-cybersource)\n3. [Realizar as configurações do app Cybersource (Admin VTEX)](#configurando-o-app-cybersource-io)\n4. [Configurar o gateway Cybersource (Admin VTEX)](#configurando-o-gateway-cybersource)\n5. [Configurar a condição de pagamento (Admin VTEX)](#configurando-condicao-de-pagamento)\n6. [Configurar o Device Fingerprint (opcional)](#configurar-cybersource-io-device-fingerprint-opcional)\n7. [Configurar campos do merchant (opcional)](#configurar-campos-do-merchant-opcional)\n\n## Instalando apps da Cybersource \n\nOs seguintes apps da Cybersource devem ser instalados na conta de sua loja:\n\n- __vtex.cybersource-ui__\n- __vtex.cybersource__\n- __vtex.cybersource-payer-auth__\n\n> ⚠️ Caso você pretenda utilizar o sistema de antifraude da Cybersource, mas deseja transacionar os pagamentos em um gateway que não seja o da Cybersource, será necessário instalar o app **vtex.cybersource-fraud**.\n\nSaiba mais como instalar aplicativos em uma conta VTEX em [Installing an app](https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app). \n\n## Criando chaves de autenticação na Cybersource \n\nApós a instalação dos apps você deve criar as chaves de autenticação no ambiente da Cybersource. \n\n> ⚠️ As configurações realizadas em um ambiente externo à VTEX podem ser descontinuadas ou modificadas sem aviso prévio. Consulte sua conta na Cybersource para informações atualizadas.\n\nSiga os passos abaixo:\n\n1. Acesse o [painel EBC](https://businesscenter.cybersource.com/ebc2/) (Enterprise Business Center) da Cybersource com os seus dados.\n2. No painel de navegação lateral, selecione __Payment Configuration > Key Management__.\n3. Clique em __Generate Key__.\n4. Em __REST APIs__, selecione a opção __REST - Shared Secret__.\n5. Clique em __Generate Key__.\n6. Clique em __Download key__ ou copie as informações das chaves utilizando a função copiar localizada a frente dos campos __Key__ e __Shared Secret__.\n\n## Configurando o app Cybersource IO \n\nCom as chaves de autenticação disponíveis, é o momento de realizar a configuração do app Cybersource IO no Admin. \n\n\n\nSiga os passos abaixo para configurar o app Cybersource IO:\n\n1. No Admin VTEX, acesse __Aplicativos > Apps Instalados > Cybersource__, ou digite __Cybersource__ na barra de busca no topo da página.\n2. Na aba __Admin Settings__, preencha ou selecione os campos abaixo:\n
\n\n
\n \t- **ID do comerciante**: o seu merchant ID na Cybersource.
\n \t- **Chave do comerciante** e **Chave secreta compartilhada**: as duas chaves obtidas anteriormente no ambiente da Cybersource.
\n \t- **Processor**: selecione a empresa que realizará o processamento do pagamento, ou clique em **Other** caso ela não esteja na lista.
\n \t- **Region**: selecione uma das regiões, ou clique em **Other** caso a região desejada não esteja na lista.
\n \t- **Sufixo de referência (opcional)**: por padrão, os pedidos no sistema Cybersource serão associados ao ID do grupo de pedidos VTEX, mas esta configuração pode ser usada para anexar um sufixo como “-01”.
\n \t- **NSU personalizado (opcional)**: substituir NSU padrão por valor personalizado.
\n \t- **Use o ID do pedido para impressão digital do dispositivo**: selecione se deseja utilizar o ID do pedido para impressão digital do dispositivo no lugar do ID da sessão.
\n \t- **Ativar cálculos de impostos**: selecione se deseja utilizar a Cybersource como seu provedor de cálculo de impostos no checkout.
\n \t- **Ativar lançamento de transações**: selecione se deseja ativar o lançamento de transações concluídas para questões de relatórios fiscais.
\n \t- **Canais de vendas a serem excluídos da Cybersource (opcional)**: insira qualquer canal de venda de vendas em que não deseja utilizar as transações na Cybersource.
\n \t- **Código do produto de envio (opcional)**: insira um código de produto para fins de cálculo do imposto de envio.
\n \t- **Regiões de nexo fiscal (opcional)**: insira uma lista de regiões onde os impostos devem ser recolhidos.
\n
\n3. Clique em __Salvar configurações__.\n\n## Configurando o gateway Cybersource\n\nPara configurar o gateway Cybersource, siga os passos abaixo: \n\n1. No Admin VTEX, acesse __Configurações da loja > Pagamentos > Provedores__, ou digite __Provedores__ na barra de busca no topo da página.\n2. Na tela de provedores, clique no botão `Novo provedor`.\n3. Digite o nome __Cybersource IO__ na barra de busca e clique sobre o nome do provedor.\n4. Em __Autorização do provedor__, não é necessário preencher os campos __Chave de aplicação__ e __Token de aplicação__.\n5. Caso deseje modificar o nome de identificação a ser exibido para o gateway Cybersource na tela do Admin VTEX, insira a informação no campo __Nome__ em __Informações básicas__.\n6. Em __Controle de pagamento__, selecione se deseja ativar o gateway em ambiente de teste clicando em __Ativar modo de teste__.\n7. Em __Liquidação automática__, selecione uma das seguintes opções:\n
\n\n
\n \t- **Usar comportamento recomendado pelo processador de pagamentos**: a captura não é automática, mas agendada para ser realizada após 4 dias (ou se o pedido for faturado, o que ocorrer primeiro).
\n \t- **Liquidação automática imediatamente após a autorização do pagamento**: a captura é automática e acontece logo após a autorização, mesmo que a transação possua uma análise antifraude.
\n \t\t- **Liquidação automática imediatamente após a análise antifraude**: a captura é automática e acontece logo após a autorização e análise antifraude (Caso você selecione este comportamento e não possua análise antifraude, a captura do pagamento acontecerá da mesma forma que no comportamento \"Liquidação automática imediatamente após a autorização do pagamento\").
\n \t\t- **Desativado**: a captura acontece somente quando o pedido for faturado. Caso escolha esse comportamento de captura, é importante atentar-se quanto ao tempo do faturamento. Isso porque o faturamento pode ultrapassar o tempo de captura acordado com o provedor de pagamentos e levar à perda da transação.
\n
\n8. Em __Campos do provedor__, preencha ou selecione os campos abaixo:\n\n
\n \t- **Company Name**: nome da empresa.
\n - **Company Tax id**: CNPJ da empresa.
\n - **Capture Setting**: selecione **Delayed Capture** para ocorrer o procedimento padrão da plataforma VTEX (chamadas separadas para autenticação e captura) ou **Immediate Capture**, onde será enviada uma única chamada de autenticação e captura à Cybersource quando o pedido for realizado.
\n \t- **Payer Authentication**: se desejar ativar esta opção, o [3-D Secure Payer Authentication da Cybersource](https://www.cybersource.com/en/solutions/fraud-and-risk-management/payer-authentication-for-3d-secure.html) deverá ser utilizado.
\n \t- **Capture Delay** e **Capture Delay Interval**: determine o período antes da captura automática.
\n \t- **Using Decision Manager**: selecione se o [CyberSource Decision Manager](https://www.cybersource.com/apac/en/solutions/fraud-and-risk-management/decision-manager.html) estará ativo em sua conta.
\n - **Authorized Payments Flagged by Decision Manager**: quando o status é Authorized, Fraud Reject, selecione as seguintes opções:
\n - **Treat as Successful Authorizations**: para aceitar o pedido.
\n - **Treat as Failed Authorizations**: para negar o pedido.
\n - **Treat as Pending Authorizations**: mantém o pedido enquanto é aguardada uma decisão final.
\n
\n9. Os campos __Merchant Id__, __Merchant Key__ e __Shared Secret Key__ devem ser deixados em branco, pois serão utilizados os valores definidos no passo 2 da seção [Configurando o app Cybersource IO](#configurando-o-app-cybersource-io). Caso os campos sejam preenchidos com algum valor, estes irão sobrescrever as informações inseridas no passo 2.\n10. Cliquem em __Salvar__.\n\n## Configurando condição de pagamento\n\nPara processar pagamentos com cartões de crédito por meio da Cybersource, siga os passos abaixo:\n\n1. No Admin VTEX, acesse __Configurações da loja > Pagamentos > Configurações__, ou digite __Configurações__ na barra de busca no topo da página.\n2. Na aba __Condições de Pagamentos__, clique no botão +.\n3. Clique sobre o nome do cartão de crédito desejado.\n4. Preencha o campo __Nome da condição__ com um nome de sua preferência para identificação.\n5. Ative a condição no campo __Status__.\n6. Em __Processar com o provedor__ selecione a opção __Cybersource - IO__.\n7. Se desejar utilizar um sistema antifraude, selecione a opção __Usar solução antifraude__ e escolha o provedor de sua preferência.\n8. Se desejar, você também poderá configurar [condições especiais de pagamento](/pt/docs/tutorials/condicoes-especiais).\n9. Clique em __Salvar__.\n\n> ⚠️ Se você criou anteriormente condições de pagamento com cartão de crédito para outros gateways (incluindo o provedor Cybersource legado), poderá definir essas condições como **Inativas**. As transações em andamento iniciadas nesse provedor ainda serão processadas por ele, mesmo que esteja inativo. Apenas novas transações serão processadas pelo novo provedor Cybersource IO. Caso você precise reverter para o provedor anterior por qualquer motivo, basta definir as respectivas condições de pagamento como **Ativas** e as condições de pagamento do Cybersource IO como **Inativas**.\n\n## Configurar Cybersource IO Device Fingerprint (opcional)\n\nDevice Fingerprint é um identificador que atua no processamento de um pagamento, tendo como objetivo melhorar a análise do risco de fraude em cada transação. \n\nPor meio da coleta de dados não sensíveis, o Device Fingerprint identifica e analisa o nível de segurança do dispositivo utilizado para realizar a transação, bem como as transações que anteriormente foram realizadas com este mesmo dispositivo.\n\n> ℹ️ Cada loja deve ter somente um Device Fingerprint cadastrado. Verifique se você já efetuou o cadastro do Device Fingerprint em outro conector, antes de continuar os passos abaixo.\n\nPara configurar o Device Fingerprint da Cybersource IO, siga os passos abaixo:\n\n1. No Admin VTEX, acesse __Configurações da loja > Storefront > Checkout__, ou digite __Checkout__ na barra de busca no topo da página.\n2. Clique no ícone do site desejado.\n3. No menu de opções azul localizado na parte superior da página, clique em __Código__.\n4. Em __Arquivos__, clique sobre __checkout5.custom.js__.\n5. Insira o código abaixo no campo de texto e clique em `Salvar`.\n\n```\nfunction addsDeviceFingerPrint() {\n if (!window.vtex) return;\n if (window.vtex.deviceFingerprint) return;\n $.ajax({\n type: 'get',\n async: true,\n url: rootPath() + '/api/sessions?items=*'\n }).then(function(response) {\n var ORG_ID = \"{{ORG_ID}}\";\n var MERCHANT_ID = \"{{MERCHANT_ID}}\";\n console.log('session', response);\n window.vtex.deviceFingerprint = response.id;\n var sessionId = response.id || \"CYBERSOURCE\";\n var script = document.createElement(\"script\");\n script.type = \"text/javascript\";\n script.src = `https://h.online-metrix.net/fp/tags.js?org_id=$\\{ORG_ID\\}&session_id=$\\{MERCHANT_ID\\}$\\{sessionId\\}`;\n document.head.appendChild(script);\n var noScript = document.createElement(\"noscript\");\n var iframe = document.createElement(\"iframe\");\n iframe.style = \"width: 100px; height: 100px; border: 0; position: absolute; top: -5000px;\";\n iframe.src = `https://h.online-metrix.net/fp/tags?org_id=$\\{ORG_ID\\}&session_id=$\\{MERCHANT_ID\\}$\\{sessionId\\}`;\n noScript.appendChild(iframe);\n document.body.appendChild(noScript);\n })\n}\n```\n\n## Configurar campos do merchant (opcional)\n\nAdicionalmente, você pode definir campos customizados que serão incluídos em pedidos encaminhados da VTEX para a Cybersource. \n\n\n\nVeja abaixo como criar estes campos:\n\n1. No Admin VTEX, acesse __Aplicativos > Apps Instalados > Cybersource__, ou digite __Cybersource__ na barra de busca no topo da página.\n2. Na aba __Campos definidos pelo comerciante__, em __Informações definidas pelo comerciante__, você pode inserir os campos seguindo as seguintes regras: \n\n
\n \t- Quaisquer valores fora das chaves **\\{\\{\\}\\}** serão considerados como valor direto.
\n - Quaisquer valores entre **\\{\\{\\}\\}** devem estar no seguinte formato *Palavra de Referência|Palavra de Modificação|Valores*.
\n - Todas as **palavras de referência** podem ser encontradas no menu suspenso **Mostrar todas as palavras referenciáveis**:
\n - As **palavras de referência** podem ser deixadas em branco se a **Palavra de Modificação** e os **Valores** estiverem presentes.
\n - A **palavra de referência** diferencia maiúsculas de minúsculas.
\n \t- As **palavras de modificação** devem ser do tipo **Pad**, **Date**, **Trim**, **Age**, ou **Equals**. Veja abaixo as características ao cadastrar cada um deles:
\n - **Pad**: os **Valores** devem estar no formato de **comprimento desejado:caractere preenchido**.
\n - O **caractere preenchido** deve ser um valor único. Por exemplo, *9:x* resultará em um comprimento desejado de 9, e irá preencher espaços vazios com x.
\n - Se o valor do campo exceder o comprimento desejado, o campo será cortado.
\n
\n - **Date**: os **Valores** devem estar no formato dd/MM/aaaa ou qualquer combinação dele.
\n - **M** para mês deve ser maiúsculo. Este formato pode ser ordenado conforme desejar, tal como, **aaaa/MM** ou **aaaa** ou **dd/aaaa/MM**.
\n - **Trim**: limitará o comprimento máximo do valor do campo sem adicionar caracteres de preenchimento.
\n - **Age**: retornará a diferença entre a data atual e o valor do campo usando o formato Timespan.
\n - **Equals**: retornará o valor booleano de uma comparação de string entre o valor do campo e o valor de comparação.
\n
\n \t- Cada nova linha é um considerada como um novo campo definido pelo comerciante.
\n\nExemplos:\n\n| Valor inserido no Admin em `Informações definidas pelo comerciante` | Cenário simulado | Resultado |\n| ---------- | ---------- | ---------- |\n| `969{{Reference|PAD|9:0}}` | Quando `Reference` é 6023 | 969602300000 |\n| `{{OrderId}}-01` | Quando `OrderId` é 124578 | 124578-01 |\n| `{{MiniCart.Buyer.LastName}},{{MiniCart.Buyer.FirstName}}` | Quando o nome do comprador (`Buyer`) é John Doe | Doe,John |"}