Stripe
Processar pagamentos e administrar clientes, cobranças e outros dados na Stripe.
O que faz
Integra o Stripe ao fluxo. Gerencie intenções de pagamento, clientes, assinaturas, faturas, cobranças, produtos, preços e eventos. Também pode ser usado no modo gatilho, para iniciar um fluxo quando acontecer um evento no Stripe.
Quando usar: Use quando o seu fluxo precisar processar pagamentos e administrar clientes, cobranças e outros dados na Stripe.
Exemplo de situação: Consultar um pedido ou executar uma ação comercial durante o atendimento.
Antes de começar
Conexão necessária: Credencial protegida.
Escolha uma conexão ou credencial já cadastrada no workspace. Nunca cole senhas ou chaves em campos de texto comuns.
Passo a passo
- Adicione Stripe ao desenho a partir da aba Blocos e ligue a entrada dele à etapa anterior.
- Escolha uma conexão ou credencial já cadastrada no workspace. Nunca cole senhas ou chaves em campos de texto comuns.
- Escolha a operação. O painel mostra só os campos que essa operação usa.
- Preencha os campos obrigatórios. Para usar um dado de uma etapa anterior, digite < e escolha o bloco e o campo.
- Clique em Executar com dados de teste e confira, no terminal, o que entrou e o que saiu do bloco.
- Só publique depois de conferir o resultado da execução de teste.
Para configurar o gatilho
- Acesse o Dashboard do Stripe em https://dashboard.stripe.com/webhooks
- Clique no botão "Add destination"
- Em "Events to send", selecione os eventos que você quer receber (precisam ser os mesmos selecionados acima; ou escolha "Select all events" para receber tudo)
- Selecione `Webhook Endpoint`, avance e cole a URL do webhook acima no campo "Endpoint URL"
- Clique em "Create Destination" para salvar
- Depois de criar o endpoint, clique em "Reveal" ao lado de "Signing secret" e copie o valor
- Cole o segredo de assinatura no campo Segredo de assinatura do webhook acima
- Publique o fluxo para ativar o gatilho de webhook
Operações
| Operação | O que faz |
|---|---|
| Criar intenção de pagamento | Cria intenção de pagamento com o bloco Stripe. |
| Obter intenção de pagamento | Obtém intenção de pagamento com o bloco Stripe. |
| Atualizar intenção de pagamento | Atualiza intenção de pagamento com o bloco Stripe. |
| Confirmar intenção de pagamento | Confirma intenção de pagamento com o bloco Stripe. |
| Capturar intenção de pagamento | Captura intenção de pagamento com o bloco Stripe. |
| Cancelar intenção de pagamento | Cancela intenção de pagamento com o bloco Stripe. |
| Listar intenções de pagamento | Lista intenções de pagamento com o bloco Stripe. |
| Buscar intenções de pagamento | Busca intenções de pagamento com o bloco Stripe. |
| Criar cliente | Cria cliente com o bloco Stripe. |
| Obter cliente | Obtém cliente com o bloco Stripe. |
| Atualizar cliente | Atualiza cliente com o bloco Stripe. |
| Excluir cliente | Exclui cliente com o bloco Stripe. |
| Listar clientes | Lista clientes com o bloco Stripe. |
| Buscar clientes | Busca clientes com o bloco Stripe. |
| Criar assinatura | Cria assinatura com o bloco Stripe. |
| Obter assinatura | Obtém assinatura com o bloco Stripe. |
| Atualizar assinatura | Atualiza assinatura com o bloco Stripe. |
| Cancelar assinatura | Cancela assinatura com o bloco Stripe. |
| Retomar assinatura | Retoma assinatura com o bloco Stripe. |
| Listar assinaturas | Lista assinaturas com o bloco Stripe. |
| Buscar assinaturas | Busca assinaturas com o bloco Stripe. |
| Criar fatura | Cria fatura com o bloco Stripe. |
| Obter fatura | Obtém fatura com o bloco Stripe. |
| Atualizar fatura | Atualiza fatura com o bloco Stripe. |
| Excluir fatura | Exclui fatura com o bloco Stripe. |
| Finalizar fatura | Finaliza fatura com o bloco Stripe. |
| Pagar fatura | Paga fatura com o bloco Stripe. |
| Anular fatura | Anula fatura com o bloco Stripe. |
| Enviar fatura | Envia fatura com o bloco Stripe. |
| Listar faturas | Lista faturas com o bloco Stripe. |
| Buscar faturas | Busca faturas com o bloco Stripe. |
| Criar cobrança | Cria cobrança com o bloco Stripe. |
| Obter cobrança | Obtém cobrança com o bloco Stripe. |
| Atualizar cobrança | Atualiza cobrança com o bloco Stripe. |
| Capturar cobrança | Captura cobrança com o bloco Stripe. |
| Listar cobranças | Lista cobranças com o bloco Stripe. |
| Buscar cobranças | Busca cobranças com o bloco Stripe. |
| Criar produto | Cria produto com o bloco Stripe. |
| Obter produto | Obtém produto com o bloco Stripe. |
| Atualizar produto | Atualiza produto com o bloco Stripe. |
| Excluir produto | Exclui produto com o bloco Stripe. |
| Listar produtos | Lista produtos com o bloco Stripe. |
| Buscar produtos | Busca produtos com o bloco Stripe. |
| Criar preço | Cria preço com o bloco Stripe. |
| Obter preço | Obtém preço com o bloco Stripe. |
| Atualizar preço | Atualiza preço com o bloco Stripe. |
| Listar preços | Lista preços com o bloco Stripe. |
| Buscar preços | Busca preços com o bloco Stripe. |
| Obter evento | Obtém evento com o bloco Stripe. |
| Listar eventos | Lista eventos com o bloco Stripe. |
Campos
Operação
Escolhe qual ação este bloco executará.
- Opções:
- Criar intenção de pagamento · Obter intenção de pagamento · Atualizar intenção de pagamento · Confirmar intenção de pagamento · Capturar intenção de pagamento · Cancelar intenção de pagamento · Listar intenções de pagamento · Buscar intenções de pagamento · Criar cliente · Obter cliente · Atualizar cliente · Excluir cliente · Listar clientes · Buscar clientes · Criar assinatura · Obter assinatura · Atualizar assinatura · Cancelar assinatura · Retomar assinatura · Listar assinaturas · Buscar assinaturas · Criar fatura · Obter fatura · Atualizar fatura · Excluir fatura · Finalizar fatura · Pagar fatura · Anular fatura · Enviar fatura · Listar faturas · Buscar faturas · Criar cobrança · Obter cobrança · Atualizar cobrança · Capturar cobrança · Listar cobranças · Buscar cobranças · Criar produto · Obter produto · Atualizar produto e mais 10
- Padrão:
- Criar intenção de pagamento
Chave de API do Stripe
ObrigatórioDado protegidoInforme a sua chave secreta do Stripe (sk_test_... ou sk_live_...).
- Padrão:
- Segredo protegido
ID
Obrigatório conforme a operaçãoInforme o ID.
- Aparece em:
- Obter intenção de pagamento, Atualizar intenção de pagamento, Confirmar intenção de pagamento, Capturar intenção de pagamento, Cancelar intenção de pagamento, Obter cliente, Atualizar cliente, Excluir cliente, Obter assinatura, Atualizar assinatura, Cancelar assinatura, Retomar assinatura, Obter fatura, Atualizar fatura, Excluir fatura, Finalizar fatura, Pagar fatura, Anular fatura, Enviar fatura, Obter cobrança, Atualizar cobrança, Capturar cobrança, Obter produto, Atualizar produto, Excluir produto, Obter preço, Atualizar preço, Obter evento
- Exemplo:
- id-do-recurso
Valor (em centavos)
Obrigatório conforme a operaçãoDefine um valor numérico, quantidade ou limite da operação.
- Aparece em:
- Criar intenção de pagamento, Criar cobrança
- Exemplo:
- 150.00
Moeda
Obrigatório conforme a operaçãoMoeda do valor, em código de três letras minúsculas (ex.: brl para real ou usd para dólar).
- Aparece em:
- Criar intenção de pagamento, Criar cobrança, Criar preço
- Exemplo:
- BRL
ID do método de pagamento
ID do método de pagamento já salvo no Stripe, que começa com pm_, a ser usado no pagamento ou vinculado ao cliente (ex.: pm_1234567890).
- Aparece em:
- Criar intenção de pagamento, Confirmar intenção de pagamento, Criar cliente
- Exemplo:
- pm_1234567890
ID do cliente
Obrigatório conforme a operaçãoID do cliente no Stripe, que começa com cus_, a quem pertence a assinatura, a fatura, a intenção de pagamento ou a cobrança (ex.: cus_1234567890).
- Aparece em:
- Criar assinatura, Criar fatura
- Exemplo:
- cus_1234567890
E-mail
Informa o destinatário ou endereço de e-mail usado pela operação.
- Aparece em:
- Criar cliente, Atualizar cliente
- Exemplo:
- cliente@exemplo.com
Nome
Obrigatório conforme a operaçãoNome do produto.
- Aparece em:
- Criar produto
- Exemplo:
- Exemplo de atendimento
Telefone
Em campos adicionaisIdentifica a conversa, o canal ou o telefone de destino.
- Aparece em:
- Criar cliente, Atualizar cliente
- Exemplo:
- +5511999999999
Endereço (JSON)
Em campos adicionaisInforma dados estruturados ou código no formato exigido pelo campo.
- Aparece em:
- Criar cliente, Atualizar cliente
- Exemplo:
- Avenida Paulista, 1000, São Paulo - SP
Itens (lista em JSON)
Obrigatório conforme a operaçãoInforma dados estruturados ou código no formato exigido pelo campo.
- Aparece em:
- Criar assinatura
- Exemplo:
- { "chave": "valor" }
Período de teste (dias)
Em campos adicionaisQuantos dias de teste grátis a assinatura terá antes da primeira cobrança (ex.: 14).
- Aparece em:
- Criar assinatura
- Exemplo:
- 14
Método de pagamento padrão
Em campos adicionaisID do método de pagamento (pm_...) cobrado por padrão nas faturas desta assinatura; se ficar vazio, vale o método padrão do cliente.
- Aparece em:
- Criar assinatura
- Exemplo:
- pm_1234567890
Cancelar no fim do período
Em campos adicionaisDefine se este comportamento fica ativado ou desativado.
- Aparece em:
- Criar assinatura, Atualizar assinatura
- Opções:
- Sim · Não
- Exemplo:
- Sim
Forma de cobrança
Em campos adicionaisEscolhe uma das opções aceitas por este campo.
- Aparece em:
- Criar fatura
- Opções:
- Cobrar automaticamente · Enviar fatura
- Exemplo:
- Cobrar automaticamente
Finalizar automaticamente
Em campos adicionaisDefine se este comportamento fica ativado ou desativado.
- Aparece em:
- Criar fatura, Atualizar fatura, Finalizar fatura
- Opções:
- Sim · Não
- Exemplo:
- Sim
Fonte de pagamento
Origem do pagamento da cobrança: um token de cartão ou o ID de um cartão já salvo (ex.: tok_visa, usado em testes).
- Aparece em:
- Criar cobrança
- Exemplo:
- tok_visa, ID do cartão
Capturar imediatamente
Em campos adicionaisDefine se este comportamento fica ativado ou desativado.
- Aparece em:
- Criar cobrança
- Opções:
- Sim · Não
- Exemplo:
- Sim
Ativo
Em campos adicionaisDefine se este comportamento fica ativado ou desativado.
- Aparece em:
- Criar produto, Atualizar produto, Atualizar preço
- Opções:
- Sim · Não
- Exemplo:
- Sim
Imagens (lista em JSON)
Em campos adicionaisInforma dados estruturados ou código no formato exigido pelo campo.
- Aparece em:
- Criar produto, Atualizar produto
- Exemplo:
- { "chave": "valor" }
ID do produto
Obrigatório conforme a operaçãoID do produto no Stripe, que começa com prod_, ao qual o novo preço vai pertencer (ex.: prod_1234567890).
- Aparece em:
- Criar preço
- Exemplo:
- prod_1234567890
Valor unitário (em centavos)
Define um valor numérico, quantidade ou limite da operação.
- Aparece em:
- Criar preço
- Exemplo:
- 150.00
Recorrência (JSON)
Informa dados estruturados ou código no formato exigido pelo campo.
- Aparece em:
- Criar preço
- Exemplo:
- { "chave": "valor" }
Descrição
Em campos adicionaisInforme a descrição.
- Aparece em:
- Criar intenção de pagamento, Atualizar intenção de pagamento, Criar cliente, Atualizar cliente, Criar fatura, Atualizar fatura, Criar cobrança, Atualizar cobrança, Criar produto, Atualizar produto
Metadados (JSON)
Em campos adicionaisInforma uma estrutura JSON com os dados exigidos por esta operação.
- Aparece em:
- Criar intenção de pagamento, Atualizar intenção de pagamento, Criar cliente, Atualizar cliente, Criar assinatura, Atualizar assinatura, Criar fatura, Atualizar fatura, Criar cobrança, Atualizar cobrança, Criar produto, Atualizar produto, Criar preço, Atualizar preço
- Exemplo:
- {"key1": "value1", "key2": "value2"}
Limite
Em campos adicionaisDefine um valor numérico, quantidade ou limite da operação.
- Aparece em:
- Listar intenções de pagamento, Listar clientes, Listar assinaturas, Listar faturas, Listar cobranças, Listar produtos, Listar preços, Listar eventos, Buscar intenções de pagamento, Buscar clientes, Buscar assinaturas, Buscar faturas, Buscar cobranças, Buscar produtos, Buscar preços
- Exemplo:
- 10
Consulta de busca
Obrigatório conforme a operaçãoInforma a consulta usada para localizar ou transformar dados.
- Aparece em:
- Buscar intenções de pagamento, Buscar clientes, Buscar assinaturas, Buscar faturas, Buscar cobranças, Buscar produtos, Buscar preços
- Exemplo:
- SELECT * FROM clientes WHERE status = 'ativo'
Começar depois de
Em campos adicionaisID da última assinatura da página anterior.
- Aparece em:
- Listar assinaturas
- Exemplo:
- ID da última assinatura da página anterior
Terminar antes de
Em campos adicionaisID da primeira assinatura da página atual.
- Aparece em:
- Listar assinaturas
- Exemplo:
- ID da primeira assinatura da página atual
Página da busca
Em campos adicionaisToken de metadata.next_page; deixe vazio na primeira página.
- Aparece em:
- Buscar assinaturas
- Exemplo:
- Token de metadata.next_page; deixe vazio na primeira página
Status
Em campos adicionaisFiltra a listagem pela situação: em assinaturas, ex.: active, trialing ou canceled; em faturas, ex.: draft, open ou paid.
- Aparece em:
- Listar assinaturas, Listar faturas
- Exemplo:
- succeeded, pending
E-mail do recibo
Em campos adicionaisInforma o destinatário ou endereço de e-mail usado pela operação.
- Aparece em:
- Criar intenção de pagamento
- Exemplo:
- cliente@exemplo.com
Motivo do cancelamento
Em campos adicionaisMotivo do cancelamento da intenção de pagamento, com um dos valores aceitos pelo Stripe (ex.: requested_by_customer, duplicate, fraudulent ou abandoned).
- Aparece em:
- Cancelar intenção de pagamento
- Exemplo:
- requested_by_customer
Valor a capturar (em centavos)
Em campos adicionaisDeixe vazio para capturar o valor total.
- Aparece em:
- Capturar intenção de pagamento
- Exemplo:
- 150.00
Cobrar proporcionalmente
Em campos adicionaisDefine se este comportamento fica ativado ou desativado.
- Aparece em:
- Cancelar assinatura
- Opções:
- Sim · Não
- Exemplo:
- Sim
Faturar agora
Em campos adicionaisDefine se este comportamento fica ativado ou desativado.
- Aparece em:
- Cancelar assinatura
- Opções:
- Sim · Não
- Exemplo:
- Sim
Pago fora do Stripe
Em campos adicionaisDefine se este comportamento fica ativado ou desativado.
- Aparece em:
- Pagar fatura
- Opções:
- Sim · Não
- Exemplo:
- Sim
Tipo de evento
Em campos adicionaisFiltra os eventos pelo tipo, no formato do Stripe (ex.: payment_intent.succeeded para pagamentos aprovados ou invoice.paid para faturas pagas).
- Aparece em:
- Listar eventos
- Exemplo:
- payment_intent.succeeded
Saídas
Para usar um resultado deste bloco em uma etapa seguinte, digite < no campo e escolha o bloco e o campo. A referência tem o formato <stripe.payment_intent>: antes do ponto vai o nome do bloco no seu fluxo, em minúsculas, sem espaços e sem acentos.
| Referência | Tipo | O que contém |
|---|---|---|
<stripe.payment_intent> | json | Objeto da intenção de pagamento. |
<stripe.payment_intents> | json | Lista de intenções de pagamento. |
<stripe.customer> | json | Objeto do cliente. |
<stripe.customers> | json | Lista de clientes. |
<stripe.subscription> | json | Objeto da assinatura. |
<stripe.subscriptions> | json | Lista de assinaturas. |
<stripe.invoice> | json | Objeto da fatura. |
<stripe.invoices> | json | Lista de faturas. |
<stripe.charge> | json | Objeto da cobrança. |
<stripe.charges> | json | Lista de cobranças. |
<stripe.product> | json | Objeto do produto. |
<stripe.products> | json | Lista de produtos. |
<stripe.price> | json | Objeto do preço. |
<stripe.prices> | json | Lista de preços. |
<stripe.event> | json | Objeto do evento. |
<stripe.events> | json | Lista de eventos. |
<stripe.metadata> | json | Metadados da operação. |
<stripe.deleted> | boolean | Indica se o recurso foi excluído. |
Exemplo de uso
Objetivo: Consultar um pedido ou executar uma ação comercial durante o atendimento.
- Operação
- Criar intenção de pagamento
- Valor (em centavos)
- 150.00
- Moeda
- BRL
- ID do método de pagamento
- pm_1234567890
Os valores são ilustrativos. Teste primeiro com dados fictícios ou de homologação.
Erros comuns e como resolver
- O bloco não executa
- Confira se existe um caminho de setas que parte do gatilho (ou do Início) até este bloco. Blocos soltos no desenho são ignorados.
- Aparece “Validação do fluxo” no terminal
- Há campo obrigatório vazio. Clique no aviso, abra o bloco indicado e preencha o campo marcado.
- Um campo chega vazio na etapa seguinte
- Confira se a referência aponta para um bloco que já executou e para um campo que existe, como <stripe.payment_intent>. O nome antes do ponto é o nome do bloco no seu fluxo, em minúsculas, sem espaços e sem acentos.
- O campo que eu procuro não aparece
- Os campos mudam conforme a operação escolhida. Escolha a operação primeiro; campos menos usados ficam em “Mostrar campos adicionais”.
- Credencial ausente ou recusada
- Escolha uma conexão válida do workspace. Se a senha ou a chave mudou no serviço, atualize a conexão cadastrada em vez de colar o segredo no bloco.
- O serviço recusou a chamada ou devolveu erro
- Leia a mensagem no terminal: ela traz o motivo informado pelo serviço. Confira IDs, limites de uso e permissões, e teste antes com um recurso de homologação.
Blocos relacionados
- AsaasGerar cobranças Pix, boletos, links e assinaturas, consultar pagamentos e reenviar dados sem duplicar cobranças.
- Bling ERPConsultar estoque, movimentar saldo, administrar pedidos, notas fiscais e clientes no Bling ERP.
- CatálogoMostrar o catálogo ou um produto do WhatsApp Business (Z-API) dentro de um fluxo de conversa.
- Melhor EnvioCotar fretes, comprar, gerar, imprimir e cancelar etiquetas e consultar o rastreamento pelo Melhor Envio.
- NuvemshopConsultar a loja, recuperar carrinhos, criar cupons e administrar produtos, pedidos e clientes na Nuvemshop.
- PIXEnviar pelo WhatsApp (Z-API) um botão que copia a chave PIX.