Configurações iniciais

Ativando as formas de pagamento

Com o Plugin Asaas, o WooCommerce e o Brazilian Market on WooCommerce instalados em seu site, sua loja já estará pronta para ser configurada.

Com isso, você já poderá ativar as formas de pagamento que deseja oferecer.

Para fazer essa configuração, basta acessar o menu WooCommerce > Configurações. Na página, vá na aba "Pagamentos", e você já encontrará todas as formas de pagamento disponíveis, podendo ativá-las conforme sua necessidade.

Cada forma de pagamento possui suas próprias configurações, que podem ser desativadas ou realizadas de maneira independente.

Ambientes e API Key

Antes de começar a configuração das formas de pagamento, será preciso conectar a sua loja no Wordpress com a sua conta Asaas.

Caso queira primeiramente testar a integração, você poderá criar uma conta no ambiente de Desenvolvimento(Sandbox) do Asaas. Para isso, acesse https://sandbox.asaas.com e crie a sua conta.

O ambiente de produção é acessado por https://api.asaas.com/

É importante destacar que, embora o ambiente Sandbox seja idêntico ao ambiente de produção do Asaas, cada ambiente possuirá suas próprias credencias e Chave de API

Depois de definir o ambiente, você precisará gerar a chave de API do mesmo.

Para fazer isso, acesse a sua conta Asaas (no ambiente requerido), e no menu do usuário, acesse a opção "Integrações". Nessa tela, clique em "Gerar nova Chave de API", e copie todo o conteúdo da chave exibida:

Depois de copiar a sua API Key, acesse a página de gerenciamento de qualquer forma de pagamento disponibilizada pelo Asaas, através do menu de Pagamentos do seu WooCommerce. Com a página aberta, navegue até a seção "API".

• Endpoint: Aqui você irá informar o ambiente que deseja conectar com a sua loja. Caso tenha criado sua chave já em produção, informe o valor "https://www.asaas.com/api/v3". Caso esteja testando em Sandbox e tenha criado sua chave por lá, informe o valor "https://sandbox.asaas.com/api/v3".
• Chave da API: Cole aqui todo o conteúdo copiado da API Key no Asaas, incluindo caracteres especiais.

Após informar o Endpoint e a sua Chave de API, você já poderá salvar as alterações.

❗️

Atenção: Sua API Key carrega muitos privilégios, portanto certifique-se de mantê-la protegida. Não informe ela em atendimentos.

Configuração dos Webhooks

Os webhooks são gatilhos enviados pelo Asaas para o seu site, sempre que uma cobrança sofrer qualquer atualização de status no Asaas. O intuíto é atualizar o status de pedidos na sua loja, conforme a situação dos pagamentos.

Para configurar o webhook, ainda na seção "API" da página de gerenciamento da forma de pagamento, você visualizará a label "Webhook".

Logo abaixo, já visualizará um passo a passo descritivo sobre como efetuar essa configuração dentro do Asaas.

No Asaas, vá no menu do usuário e em Integrações, acesse a aba "Webhooks" e escolha a opção "Webhook para cobranças".

Marque "Sim" na opção "Ativar Webhook".

Em seguida, basta seguir o passo a passo exibido na seção de Webhook do meio de pagamento e informar nos respectivos campos do Asaas, conforme instruções.

Os campos configuráveis são estes:

• Webhook ativado?: Opção para manter ativo ou desativar as sincronizações do Webhook. Caso a opção esteja "Não", nenhum evento será criado ou inserido em fila.
• URL: Aqui é o campo para informar a URL da sua loja que será responsável pelo recebimento e tratamentos dos eventos disparados pelo Asaas. Para verificar a URL, é só conferir o passo 3 da seção de webhook nas configurações da forma de pagamento.
• Email: Caso ocorra alguma interrupção ou falha na sincronização dos webhooks, um e-mail de alerta será disparado para o destinatário configurado nesse campo.
• Versão da API: Para integrações com Wordpress, usar sempre a v3.
• Token de Autenticação: Para acrescentar uma camada extra de segurança, você pode adicionar um token de autenticação que será disparado como autenticador de todas as requisições enviadas do Asaas para a sua aplicação. Dessa forma, o token informado no Asaas também precisa estar informado nas configurações do webhook nas definições da forma de pagamento. Caso o token de autenticação seja diferente no Asaas e na loja (campo Token de Acesso), os webhooks não serão sincronizados.
• Fila de sincronização ativada?: Caso ocorra alguma interrupção na fila devido à erros no tratamento da sua aplicação, a fila de sincronização automaticamente será interrompida. Caso isso aconteça, você poderá analisar os LOGs dos webhooks para entender o motivo da interrupção, e após o tratamento da falha, reativar novamente sua fila marcando a opção "Ativa" e salvando a configuração. Enquanto o status da fila estiver "Interrompida", os eventos continuarão sendo gerados normalmente e permanecerão em fila até que a mesma seja reativada novamente.

Finalizando as configurações, basta salvar as alterações no Asaas e nas configurações da forma de pagamento para que entrem em vigência.

📘

A configuração de API e Webhook estará presente em todas as formas de pagamento, porém essa configuração é compartilhada entre todas elas, não sendo necessário configurar em cada uma individualmente.

Configurando Boleto Bancário

Nas opções de gerenciamento da forma de pagamento "Boleto Bancário", você encontrará as seguintes opções de configuração:

Habilitar/Desabilitar

Ative para disponibilizar o pagamento via Boleto Bancário para o seu cliente.

Título

Esse campo controla o título da forma de pagamento na tela de checkout.

Descrição

Informações que serão visualizadas logo abaixo do título da forma de pagamento na tela de checkout.

Parcelas

Informe o limite de parcelas permitidas para Boleto Bancário. Valores aceitos entre 0 a 60.

Juros por parcela

Caso tenha informado um limite de parcelas no campo anterior, serão abertos campos adicionais para que você informe a configuração de juros para cada opção de parcelamento.

Mínimo do valor de parcelas

Define o valor mínimo permitido para cada parcela.

Dias de validade

Quantidade de dias que o boleto bancário terá de vencimento após a compra.

Período de validade

Número de dias que o boleto será mantido no Asaas após sua expiração. No final deste período, o boleto será removido. Ele será mantido se o campo for em branco.

Split

Caso você precise pagar comissionamentos ou realizar divisões do saldo a ser recebido em suas cobranças, poderá utilizar o Split de Pagamentos no WooCoommerce. A funcionalidade está liberada para todos os clientes usuários do WooCommerce, a partir da versão do plugin Asaas 2.2.0. Ver mais, abaixo na sessão de Split.

Notificações entre Asaas e o cliente

Permite a Asaas enviar e-mail e SMS sobre a compra para seu cliente e notificação-lo periodicamente enquanto a compra não é paga. Essa opção é compartilhada com outros métodos de pagamento do Asaas.

API

Caso já tenha configurado seguindo o fluxo da seção "Ambientes, API Key e Configurações de Webhook", não será necessário configurar novamente.

Configurando PIX

Nas opções de gerenciamento da forma de pagamento "Pix", você encontrará as seguintes opções de configuração:

Habilitar/Desabilitar

Ative para disponibilizar o pagamento via Pix para o seu cliente.

Título

Esse campo controla o título da forma de pagamento na tela de checkout.

Descrição

Informações que serão visualizadas logo abaixo do título da forma de pagamento na tela de checkout.

Dias de validade

Quantidade de dias que o Pix é válido após a compra. Ao final desse período, o Pix será removido.

Copia e cola

Se essa opção estiver ativa, o Pix Copia e Cola será visualizado no checkout. Caso esteja desabilitada, será exibido somente o QrCode.

Split

Caso você precise pagar comissionamentos ou realizar divisões do saldo a ser recebido em suas cobranças, poderá utilizar o Split de Pagamentos no WooCoommerce. A funcionalidade está liberada para todos os clientes usuários do WooCommerce, a partir da versão do plugin Asaas 2.2.0. Ver mais, abaixo na sessão de Split.

Notificações entre Asaas e o cliente

Permite a Asaas enviar e-mail e SMS sobre a compra para seu cliente e notificação-lo periodicamente enquanto a compra não é paga. Essa opção é compartilhada com outros métodos de pagamento do Asaas.

API

Caso já tenha configurado seguindo o fluxo da seção "Ambientes, API Key e Configurações de Webhook", não será necessário configurar novamente.

Configurando Cartão de Crédito

Nas opções de gerenciamento da forma de pagamento "Cartão de Crédito", você encontrará as seguintes opções de configuração:

Habilitar/Desabilitar

Ative para disponibilizar o pagamento via Cartão de Crédito para o seu cliente.

Título

Esse campo controla o título da forma de pagamento na tela de checkout.

Descrição

Informações que serão visualizadas logo abaixo do título da forma de pagamento na tela de checkout.

Total mínimo do pedido

Define o valor mínimo do pedido para disponibilizar a forma de pagamento Cartão de Crédito. Caso informe o valor "0", a forma de pagamento será disponibilizada integralmente.

Parcelas

Informe o limite de parcelas permitidas para Cartão de Crédito. Valores aceitos entre 0 a 12.

Juros por parcela

Caso tenha informado um limite de parcelas no campo anterior, serão abertos campos adicionais para que você informe a configuração de juros para cada opção de parcelamento.

Mínimo do valor de parcelas

Define o valor mínimo permitido para cada parcela.

Split

Caso você precise pagar comissionamentos ou realizar divisões do saldo a ser recebido em suas cobranças, poderá utilizar o Split de Pagamentos no WooCoommerce. A funcionalidade está liberada para todos os clientes usuários do WooCommerce, a partir da versão do plugin Asaas 2.2.0. Ver mais, abaixo na sessão de Split.

Notificações entre Asaas e o cliente

Permite a Asaas enviar e-mail e SMS sobre a compra para seu cliente e notificação-lo periodicamente enquanto a compra não é paga. Essa opção é compartilhada com outros métodos de pagamento do Asaas.

API

Caso já tenha configurado seguindo o fluxo da seção "Ambientes, API Key e Configurações de Webhook", não será necessário configurar novamente.

Assinaturas

Se você possui em sua loja o Plugin WooCommerce Subscriptions, poderá utilizá-lo em conjunto com o Asaas para criar e gerenciar suas cobranças de boleto bancário e cartão de crédito no formato de recorrência/assinaturas

O gateway Asaas suporta recorrências nos seguintes ciclos: MENSAL, QUINZENAL, BIMESTRAL, TRIMESTRAL, SEMESTRAL, ANUAL.

Para criar e gerenciar suas assinaturas, basta acessar o menu WooCommerce > Assinaturas.

No menu, você poderá acompanhar o status de todas as suas assinaturas já criadas, além de criar novas assinaturas.

Com o plugin Asaas, você pode criar assinaturas com tempo de teste (trial), além de cobrar também taxas de inscrição.

Todos os pedidos criados dentro de uma assinatura ficarão atrelados para a mesma como "pedido-filho", e poderão ser visualizadas dentro do painel de gestão da assinatura, no campo "Compras relacionadas".

É possível também, determinar uma data fim para a assinatura diretamente nas configurações da mesma, sendo que essa configuração será enviada ao Asaas para determinar o término das cobranças.

Split de Pagamentos

Caso você precise pagar comissionamentos ou realizar divisões do saldo a ser recebido em suas cobranças, poderá utilizar o Split de Pagamentos no WooCoommerce. A funcionalidade está liberada para todos os clientes usuários do WooCommerce, a partir da versão do plugin Asaas 2.2.0.

No momento, é possível configurar splits percentuais de maneira individual para cartão de crédito, boleto e Pix, possibilitando assim que você configure splits diferentes para cada forma de pagamento.

Configurando o Split

Primeiramente você precisa do WalletId da carteira que receberá o comissionamento.

Seu comissionado, precisa acessar a conta Asaas e no menu de Integrações será localizado o WalletId.

Com o WalletId, você já pode configurar o Split de Pagamentos. Para isso, vá na sua loja e acesse o menu WooCommerce > Configurações > Pagamentos e selecione a forma de pagamento Asaas para qual deseja configurar o split.

Ao selecionar a forma de pagamento desejada, navegue até a sessão de Split. Em seguida, você irá definir em Quantidade o número de carteiras comissionadas. Após salvar, será visualizado o índice de carteiras. Agora, você poderá colocar um Apelido (de sua escolha, para poder identificar facilmente nos logs do pedido), o ID da carteira (que é o WalletId informado pelo seu parceiro) e a Porcentagem que o comissionado receberá. No total, não deverá ultrapassar de 100%.

Depois disso, é só salvar as alterações e repetir o processo nas demais formas de pagamento, caso necessário.

❗️

Atenção

• Assinaturas ainda não são compatíveis, mas trabalharemos nisso em breve.
• As configurações de split não são compartilhadas entre formas de pagamento, sendo necessário configurar separadamente para o Pix, Boleto e Cartão.

Possíveis erros

Se você inserir um valor acima de 100%, ao salvar as alterações, receberá a seguinte exceção:

Split: A soma das carteiras não pode ultrapassar 100%.

Se informar uma carteira inválida, receberá a seguinte exceção:

Carteiras sem apelido, ID inválido ou porcentagem igual a zero não serão processadas na finalização da compra. A carteira $apelido contém um formato ID inválido.