Criar um componente pré-criado de pagamento

O componente pré-criado de pagamento autentica o usuário e permite que ele faça um pagamento. Esse componente usa uma versão personalizada do componente pré-criado Autenticação para autenticar titulares de contas e cartões. O componente também usa os componentes pré-criados Coleta de nomes, Coleta de data de validade do cartão de crédito e Coleta de CVV do cartão de crédito para coletar as informações necessárias para fazer pagamentos.

Tipos de pagamento

Esse componente aceita pagamentos de faturas de cartão de crédito e contas de beneficiários. Para faturas de cartão de crédito, os usuários podem optar por pagar o valor mínimo, total ou personalizado. O usuário pode fazer pagamentos usando a conta bancária, cartão de débito ou crédito ou pagamento com celular.

Tipo de pagamento Formas de pagamento disponíveis Valores de pagamento disponíveis
Fatura do cartão de crédito Conta bancária, cartão de débito, pagamento com celular Valor mínimo, total ou personalizado
Conta do beneficiário Conta bancária, cartão de crédito, cartão de débito, pagamento com celular Valor personalizado

Limitações

Além das limitações comuns de componentes pré-criados, este componente tem as seguintes limitações:

  • Esse componente não criptografa dados.

Diálogos de exemplo

Os exemplos de diálogos a seguir demonstram cenários comuns processados por esse componente pré-criado. As caixas de diálogo de amostra demonstram o comportamento quando o componente é chamado por telefonia, o que aciona a intent de boas-vindas padrão e a primeira resposta do agente no início da conversa.

Pagamento da conta do beneficiário

O agente identifica que o usuário não foi autenticado anteriormente e coleta informações para verificar se ele é um usuário registrado. O usuário indica que quer fazer um pagamento para uma conta de beneficiário, e o agente coleta as informações necessárias, incluindo o nome do beneficiário, e confirma o número da conta. Por fim, o usuário seleciona fazer um pagamento usando o cartão de débito, então o agente coleta o número do cartão de débito, a data de validade, o CVV e confirma o pagamento.

Entrada do usuário Resposta do agente
O agente autentica o usuário usando o componente pré-criado de autenticação
Agradecemos sua atenção. A autenticação foi concluída.
Você quer pagar a fatura do seu cartão de crédito registrado ou fazer um pagamento para uma conta de beneficiário?
Beneficiário
O agente coleta o nome do beneficiário usando o componente pré-criado Coleta de nome
Agradecemos por informar o nome do beneficiário.

De acordo com nossos registros, o número da conta termina em 7821. Diga "sim" para confirmar o número da conta.
Sim
Confirme o valor que você quer pagar. Por exemplo, se você quiser pagar R $100,30, diga "cem vírgula trinta".
50 dólares
Você quer pagar com sua conta bancária, cartão de débito, cartão de crédito ou pagamento com celular?
Débito
Informe os últimos 4 dígitos do número do cartão de débito em questão.
1234
Os últimos quatro dígitos do número do cartão de débito que recebemos são 1234, correto?
Sim, isso mesmo
O agente coleta a data de validade do cartão de débito usando o componente pré-criado Coleta da data de validade do cartão de crédito
Ótimo, já temos a data de validade do cartão de débito.
O agente coleta o CVV do cartão de débito usando o componente pré-criado Coleta de CVV do cartão de crédito
Ótimo, terminamos de coletar o CVV.
Certo, vamos fazer um pagamento de $50 para Jane com o cartão de débito de final 1234. Você confirma essa ação?
Sim
Para continuar, vamos enviar um código para você. Você prefere receber o código por telefone ou e-mail?
Por e-mail, por favor
Enviamos um código para seu e-mail registrado john.doe@google.com. Isso pode levar alguns segundos. Você pode confirmar o código?
123456
Aguarde alguns segundos enquanto fazemos o pagamento.

O pagamento da conta do beneficiário foi concluído.

Pagamento de fatura de cartão de crédito

O agente identifica que o usuário não foi autenticado anteriormente e coleta informações para verificar se ele é um usuário registrado. O usuário indica que gostaria de pagar a fatura do cartão de crédito usando a conta bancária. O agente confirma o valor e os detalhes da forma de pagamento e conclui o pagamento.

Entrada do usuário Resposta do agente
O agente autentica o usuário usando o componente pré-criado de autenticação
Agradecemos sua atenção. A autenticação foi concluída.
Você quer pagar a fatura do seu cartão de crédito registrado ou fazer um pagamento para uma conta de beneficiário?
Fatura do cartão de crédito
Informe os últimos 4 dígitos do número do cartão de crédito em questão.
4321
Os últimos quatro dígitos do número do cartão de crédito que recebemos são 4321, correto?
Sim
O valor total devido é de US $300, e o pagamento mínimo é de US $20. Você quer pagar o valor total, o mínimo ou outro valor?
Valor total
Você quer pagar com sua conta bancária, cartão de débito ou pagamento com celular?
Conta poupança
Encontramos duas contas associadas ao seu número. Informe os últimos 4 dígitos da conta em questão.
1001
Os últimos quatro dígitos do número da conta que recebemos são 1001, correto?
Sim
Certo, vamos fazer um pagamento de $300 para a fatura do seu cartão de crédito com final 4321 usando o número da conta com final 1001. Você confirma essa ação?
Sim
Para continuar, vamos enviar um código para você. Você prefere receber o código por telefone ou e-mail?
Enviar para meu e-mail
Enviamos um código para seu e-mail registrado john.doe@google.com. Isso pode levar alguns segundos. Você pode confirmar o código?
123456
Aguarde alguns segundos enquanto fazemos o pagamento.

Seu pagamento com cartão de crédito foi concluído.

Fundos ou limites insuficientes

O agente identifica que o usuário não foi autenticado anteriormente e coleta informações para verificar se ele é um usuário registrado. O usuário tenta pagar a fatura do cartão de crédito usando a conta bancária e o cartão de débito, mas os dois pagamentos são recusados devido a fundos ou limites insuficientes. Por fim, o usuário opta por fazer um pagamento com celular, e o agente envia um link para concluir o pagamento.

Entrada do usuário Resposta do agente
O agente autentica o usuário usando o componente pré-criado de autenticação
Agradecemos sua atenção. A autenticação foi concluída.
Você quer pagar a fatura do seu cartão de crédito registrado ou fazer um pagamento para uma conta de beneficiário?
Cartão de crédito
Informe os últimos 4 dígitos do número do cartão de crédito em questão.
4321
Os últimos quatro dígitos do número do cartão de crédito que recebemos são 4321, correto?
Sim
O valor total devido é de US $300, e o pagamento mínimo é de US $20. Você quer pagar o valor total, o mínimo ou outro valor?
Valor total
Você quer pagar com sua conta bancária, cartão de débito ou pagamento com celular?
Poupança
Encontramos duas contas associadas ao seu número. Informe os últimos 4 dígitos da conta em questão.
1002
Os últimos quatro dígitos do número da conta que recebemos são 1002, correto?
Sim
Certo, vamos pagar $300 da fatura do seu cartão de crédito com final 4321 usando o número da conta com final 1002. Você confirma essa ação?
Sim
Para continuar, vamos enviar um código para você. Você prefere receber o código por telefone ou e-mail?
E-mail
Enviamos um código para seu e-mail registrado john.doe@google.com. Isso pode levar alguns segundos. Você pode confirmar o código?
123456
Aguarde alguns segundos enquanto fazemos o pagamento.

O pagamento falhou porque não há saldo suficiente na conta. Quer tentar de novo com outra forma de pagamento?
Sim
Você quer pagar com sua conta bancária, cartão de débito ou pagamento com celular?
Cartão de débito
Informe os últimos 4 dígitos do número do cartão de débito em questão.
2345
Os últimos quatro dígitos do número do cartão de débito que recebemos são 2345, correto?
Sim
O agente coleta a data de validade do cartão de débito usando o componente pré-criado Coleta da data de validade do cartão de crédito
Ótimo, já temos a data de validade do cartão de débito.
O agente coleta o CVV do cartão de débito usando o componente pré-criado Coleta de CVV do cartão de crédito
Ótimo, terminamos de coletar o CVV.
Certo, vamos fazer um pagamento de $300 para a fatura do seu cartão de crédito com final 4321 usando o número do cartão de débito com final 2345. Você confirma essa ação?
Sim
Para continuar, vamos enviar um código para você. Você prefere receber o código por telefone ou e-mail?
E-mail
Enviamos um código para seu e-mail registrado john.doe@google.com. Isso pode levar alguns segundos. Você pode confirmar o código?
123456
Aguarde alguns segundos enquanto fazemos o pagamento.

O pagamento falhou porque o limite do cartão de débito foi excedido. Quer tentar de novo com outra forma de pagamento?
Sim
Você quer pagar com sua conta bancária, cartão de débito ou pagamento com celular?
Dispositivo móvel
Certo, estamos enviando o link de pagamento para seu número de celular registrado. Essa ação pode levar alguns segundos. Confirme dizendo "sim" se você recebeu.
Sim
Ótimo, agora você pode abrir o link e continuar o pagamento.

Convenções de nomenclatura

Este componente pré-criado usa as seguintes convenções de nomenclatura:

Recurso Formatar Exemplo
Flow [Nome do componente] Fazer um pagamento
Intenção específica do componente prebuilt_components_[component_name]_[intent_name] prebuilt_components_make_a_payment_payment_type
Tipo da entidade prebuilt_components_[component_name]_[entity_type] prebuilt_components_make_a_payment_payment_mode
Webhook prebuilt_components_[component_name]:[webhook_action] prebuilt_components_make_a_payment:process_payment_credit_card

Parâmetros de entrada

Os parâmetros de entrada são usados para configurar determinados comportamentos do componente. Os parâmetros serão usados por uma ou mais condições no fluxo para determinar como o componente deve se comportar. Os parâmetros com escopo de fluxo precisam ser definidos na página inicial do componente, conforme descrito abaixo. Os parâmetros no escopo da sessão podem ser definidos por um fluxo de chamada ou na página inicial desse componente.

Esse componente pré-criado aceita os seguintes parâmetros de entrada:

Nome do parâmetro Descrição Formato da entrada
$session.params.auth_level (opcional) Indica o nível de autenticação do autor da chamada. integer
$session.params.auth_level_req Indica o nível de autenticação necessário para que um usuário possa acessar o histórico de transações. Esse valor é configurado nas predefinições de parâmetro do fulfillment de entrada da página na página check auth level. Por padrão, esse valor é 1. integer
$session.params.account_auth_enabled Indica se o usuário precisa ser autenticado como proprietário da conta, conforme descrito em Tipos de autenticação. Esse valor é configurado nas predefinições de parâmetro do fulfillment de entrada da página na página check auth level. Por padrão, esse valor é true. booleano
$session.params.card_auth_enabled Indica se o usuário precisa ser autenticado como titular do cartão, conforme descrito em Tipos de autenticação. Esse valor é configurado nas predefinições de parâmetro do fulfillment de entrada da página na página check auth level. Por padrão, esse valor é false. booleano
$session.params.phone_number (Opcional) Número de telefone registrado do cliente usado para autenticação. string
$flow.payment_success_code Especifica o valor do campo payment_status_code retornado pelos webhooks process_payment, indicando que o pagamento foi concluído. Por padrão, esse valor é "200". string
$flow.insufficient_fund_code Especifica o valor do campo payment_status_code retornado pelos webhooks process_payment, indicando que o pagamento não pôde ser concluído devido a fundos insuficientes. Por padrão, esse valor é "400". string
$flow.limit_exceed_code Especifica o valor do campo payment_status_code retornado pelos webhooks process_payment, indicando que o pagamento não pôde ser concluído porque o limite diário foi excedido. Por padrão, esse valor é "401". string
$flow.max_retry_mop_counter Especifica o número de vezes que um usuário pode mudar a forma de pagamento. O valor padrão é 2. integer
$flow.max_retry_credit_card_payment Especifica o número de novas tentativas permitidas ao tentar fazer um pagamento usando um cartão de crédito como forma de pagamento. O valor padrão é 3. integer
$flow.max_retry_mobile_payment_counter Especifica o número de novas tentativas permitidas ao tentar fazer um pagamento usando o pagamento com celular como forma de pagamento. O valor padrão é 2. integer
$flow.max_retry_creditcard_count Especifica o número de tentativas permitidas ao coletar um Número do cartão de crédito válido para fazer um pagamento. O valor padrão é 3. integer
$flow.max_retry_acc_number Especifica o número de tentativas permitidas ao coletar detalhes válidos da conta para fazer um pagamento. O valor padrão é 3. integer
$flow.max_retry_debit_card_details Especifica o número de tentativas permitidas ao coletar detalhes válidos do cartão de débito para fazer um pagamento. O valor padrão é 3. integer
$flow.max_retry_credit_card_details Especifica o número de tentativas permitidas ao coletar detalhes válidos do cartão de crédito para fazer um pagamento. O valor padrão é 3. integer
$flow.otp_length Especifica o tamanho esperado da senha única enviada ao usuário. O valor padrão é 6. integer
$flow.max_retry_otp_count Especifica o número de novas tentativas permitidas ao coletar uma senha de uso único (OTP, na sigla em inglês) válida do usuário. O valor padrão é 3. integer
$flow.max_waiting_room_counter Especifica o número de vezes que o usuário pode pedir para o agente esperar enquanto recebe o link para pagamento com celular. O valor padrão é 2. integer

Para configurar os parâmetros de entrada desse componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Build.
  5. Clique no componente importado na seção Fluxos.
  6. Clique na página inicial na seção Páginas.
  7. Clique na rota true na página inicial.
  8. Na janela "Rota", edite os valores de Predefinições de parâmetros conforme necessário.
  9. Clique em Salvar.

Parâmetros de saída

Os parâmetros de saída são parâmetros de sessão que permanecem ativos após sair do componente. Esses parâmetros contêm informações importantes coletadas pelo componente. Esse componente pré-criado fornece valores para os seguintes parâmetros de saída:

Nome do parâmetro Descrição Formato da saída
auth_level Indica o nível de autenticação do autor da chamada. integer
phone_number Número de telefone local do usuário, sem o código do país, usado para identificar o usuário. string
transfer_reason Esse parâmetro indica o motivo da saída do fluxo, se não tiver sido bem-sucedido. O valor retornado é um dos seguintes:

agent: o usuário final solicitou um agente humano em algum momento da conversa.

denial_of_information: o usuário final se recusou a compartilhar as informações solicitadas pelo componente.

max_no_input: a conversa atingiu o número máximo de novas tentativas para eventos sem entrada. Consulte eventos integrados sem entrada.

max_no_match: a conversa atingiu o número máximo de novas tentativas para eventos sem correspondência. Consulte eventos integrados sem correspondência.

webhook_error: ocorreu um erro de webhook. Consulte o evento integrado webhook.error.

webhook_not_found: um URL do webhook estava inacessível. Consulte o evento integrado webhook.error.not-found.
string

Configuração básica

Para configurar esse componente pré-criado:

  1. Importe o componente pré-criado.
  2. Configure os webhooks flexíveis fornecidos com a configuração que descreve seus serviços externos. Consulte a configuração do webhook abaixo.

Configuração do webhook

Para usar esse componente, você precisa configurar os webhooks flexíveis incluídos para recuperar as informações necessárias dos seus serviços externos.

Autenticação

Se você ainda não configurou os serviços externos necessários para autenticação, será preciso configurá-los para ativar a autenticação de usuários para esse componente. Consulte Configuração do webhook de autenticação para instruções detalhadas.

Validar conta

O webhook prebuilt_components_account_services:validate_account é usado pelo componente para verificar se uma conta existe com base no número de telefone registrado do usuário e nos últimos quatro dígitos do número da conta fornecido. O webhook também retorna o saldo da conta, se houver uma.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro Descrição Formato da entrada
$session.params.phone_number Número de telefone local do usuário, sem o código do país, usado para identificar o usuário. string
$session.params.last_four_digit_of_account_number Os últimos quatro dígitos do número da conta que o usuário selecionou e confirmou para fazer um pagamento. string

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API para serem usados pelo componente.

Nome do parâmetro Descrição Formato da saída
account_found Indica se existe uma conta com os últimos quatro dígitos fornecidos para a conta registrada do usuário. booleano
saldo O valor do saldo atual na conta, se houver. número

Para configurar o webhook de validação de conta para este componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Selecione o webhook prebuilt_components_account_services:validate_account.
  7. Substitua o URL no campo URL do webhook do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
  8. Revise e atualize o corpo da solicitação para criar o formato de solicitação adequado para seu webhook.
  9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
  10. Revise e atualize as configurações de Autenticação conforme necessário.
  11. Clique em Salvar.

Detalhes do cartão do usuário

O webhook prebuilt_components_make_a_payment:user_card_details é usado pelo componente para receber detalhes dos cartões de débito e crédito de um usuário registrado.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro Descrição Formato da entrada
$session.params.phone_number Número de telefone local do usuário, sem o código do país, usado para identificar o usuário. string

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API para serem usados pelo componente.

Nome do parâmetro Descrição Formato da saída
credit_card_count Número de cartões de crédito associados ao número de telefone registrado. integer
last_four_digit_of_credit_card_number Os últimos quatro dígitos do cartão de crédito do usuário. Se o cliente tiver vários cartões de crédito, esse valor será null. string
debit_card_count Número de cartões de débito associados ao número de telefone registrado. integer
last_four_digit_of_debit_card_number Os últimos quatro dígitos do cartão de débito do usuário. Se o cliente tiver vários cartões de débito, esse valor será null. string

Para configurar o webhook de detalhes do cartão do usuário para esse componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Selecione o webhook prebuilt_components_make_a_payment:user_card_details.
  7. Substitua o URL no campo URL do webhook do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
  8. Revise e atualize o corpo da solicitação para criar o formato de solicitação adequado para seu webhook.
  9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
  10. Revise e atualize as configurações de Autenticação conforme necessário.
  11. Clique em Salvar.

Verificar o nome do beneficiário

O webhook prebuilt_components_make_a_payment:verify_beneficiary_name é usado pelo componente para verificar se existe uma conta de beneficiário para o nome fornecido pelo usuário.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro Descrição Formato da entrada
$session.params.phone_number Número de telefone local do usuário, sem o código do país, usado para identificar o usuário. string
$session.params.name_collection_first_name Nome do beneficiário. string
$session.params.name_collection_last_name Sobrenome do beneficiário. string
$session.params.name_collection_middle_name Nome do meio do beneficiário. string

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API para serem usados pelo componente.

Nome do parâmetro Descrição Formato da saída
beneficiary_account_number Os últimos quatro dígitos do número da conta do beneficiário para o nome do beneficiário informado. Se uma conta de beneficiário para o nome fornecido não for encontrada, o valor será null. string

Para configurar o webhook de verificação do nome do beneficiário para esse componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Selecione o webhook prebuilt_components_make_a_payment:verify_beneficiary_name.
  7. Substitua o URL no campo URL do webhook do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
  8. Revise e atualize o corpo da solicitação para criar o formato de solicitação adequado para seu webhook.
  9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
  10. Revise e atualize as configurações de Autenticação conforme necessário.
  11. Clique em Salvar.

Receber o valor devido

O webhook prebuilt_components_make_a_payment:get_due_amount é usado pelo componente para receber informações sobre o valor mínimo e total devido da fatura do cartão de crédito do usuário.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro Descrição Formato da entrada
$session.params.phone_number Número de telefone local do usuário, sem o código do país, usado para identificar o usuário. string
$flow.user_credit_card_number Os últimos quatro dígitos do cartão de crédito do usuário. string

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API para serem usados pelo componente.

Nome do parâmetro Descrição Formato da saída
minimum_amount Valor mínimo devido para a fatura do cartão de crédito especificado. número
total_amount Valor total devido da fatura do cartão de crédito especificado. número

Para configurar o webhook "Receber valor devido" para esse componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Selecione o webhook prebuilt_components_make_a_payment:get_due_amount.
  7. Substitua o URL no campo URL do webhook do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
  8. Revise e atualize o corpo da solicitação para criar o formato de solicitação adequado para seu webhook.
  9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
  10. Revise e atualize as configurações de Autenticação conforme necessário.
  11. Clique em Salvar.

Verificar o número do cartão de crédito

O webhook prebuilt_components_make_a_payment:verify_credit_card_number é usado pelo componente para verificar se o número do cartão de crédito fornecido está registrado na conta do usuário.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro Descrição Formato da entrada
$session.params.phone_number Número de telefone local do usuário, sem o código do país, usado para identificar o usuário. string
$flow.user_credit_card_number Os últimos quatro dígitos do cartão de crédito do usuário. string

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API para serem usados pelo componente.

Nome do parâmetro Descrição Formato da saída
card_found Indica se o cartão de crédito fornecido foi encontrado. booleano

Para configurar o webhook de verificação do número do cartão de crédito para esse componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Selecione o webhook prebuilt_components_make_a_payment:verify_credit_card_number.
  7. Substitua o URL no campo URL do webhook do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
  8. Revise e atualize o corpo da solicitação para criar o formato de solicitação adequado para seu webhook.
  9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
  10. Revise e atualize as configurações de Autenticação conforme necessário.
  11. Clique em Salvar.

Verificar detalhes do cartão de crédito

O webhook prebuilt_components_make_a_payment:verify_credit_card_details é usado pelo componente para verificar se os detalhes fornecidos, incluindo a data de validade e o CVV, são válidos para o cartão de crédito fornecido pelo usuário.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro Descrição Formato da entrada
$session.params.phone_number Número de telefone local do usuário, sem o código do país, usado para identificar o usuário. string
$flow.credit_card_number Os últimos quatro dígitos do cartão de crédito do usuário. string
$flow.credit_card_exp_date Data de validade do cartão de crédito fornecida pelo usuário para o cartão de crédito específico.
{
"year": integer,
"month": integer
}
$flow.credit_card_cvv_code Código CVV fornecido pelo usuário para o cartão de crédito especificado. string

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API para serem usados pelo componente.

Nome do parâmetro Descrição Formato da saída
creditcard_verification_status Indica se os detalhes do cartão de crédito fornecidos foram validados. booleano

Para configurar o webhook de verificação dos detalhes do cartão de crédito para esse componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Selecione o webhook prebuilt_components_make_a_payment:verify_credit_card_details.
  7. Substitua o URL no campo URL do webhook do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
  8. Revise e atualize o corpo da solicitação para criar o formato de solicitação adequado para seu webhook.
  9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
  10. Revise e atualize as configurações de Autenticação conforme necessário.
  11. Clique em Salvar.

Verificar os detalhes do cartão de débito

O webhook prebuilt_components_make_a_payment:verify_debit_card_details é usado pelo componente para verificar se os detalhes fornecidos, incluindo a data de validade e o CVV, são válidos para o cartão de débito fornecido pelo usuário.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro Descrição Formato da entrada
$session.params.phone_number Número de telefone local do usuário, sem o código do país, usado para identificar o usuário. string
$flow.debit_card_number Os últimos quatro dígitos do cartão de débito do usuário. string
$flow.debit_card_exp_date Data de validade do cartão de débito fornecida pelo usuário para o cartão especificado.
{
"year": integer,
"month": integer
}
$flow.debit_card_cvv_code O código CVV fornecido pelo usuário para o cartão de débito especificado. string

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API para serem usados pelo componente.

Nome do parâmetro Descrição Formato da saída
debitcard_verification_status Indica se os detalhes do cartão de débito fornecidos foram validados. booleano

Para configurar o webhook de verificação dos detalhes do cartão de débito para esse componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Selecione o webhook prebuilt_components_make_a_payment:verify_debit_card_details.
  7. Substitua o URL no campo URL do webhook do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
  8. Revise e atualize o corpo da solicitação para criar o formato de solicitação adequado para seu webhook.
  9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
  10. Revise e atualize as configurações de Autenticação conforme necessário.
  11. Clique em Salvar.

Processar pagamento com cartão de crédito

O webhook prebuilt_components_make_a_payment:process_payment_credit_card é usado pelo componente para processar um pagamento usando os detalhes do cartão de crédito fornecidos.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro Descrição Formato da entrada
$session.params.phone_number Número de telefone local do usuário, sem o código do país, usado para identificar o usuário. string
$flow.payee_number Últimos quatro dígitos do número da conta do beneficiário para o pagamento. string
$flow.payment_type Tipo de pagamento. Os valores válidos são definidos pela entidade personalizada prebuilt_components_make_a_payment_payment_type. Por padrão, esse componente é compatível com "beneficiary_pay" e "credit_card_pay". string
$flow.credit_card_number Os últimos quatro dígitos do cartão de crédito do usuário. string
$flow.credit_card_exp_date A data de validade do cartão de crédito especificado, fornecida pelo usuário.
{
"year": integer,
"month": integer
}
$flow.credit_card_cvv_code Código CVV fornecido pelo usuário para o cartão de crédito especificado. string
$flow.payment_amount O valor que o usuário escolheu pagar. número

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API para serem usados pelo componente.

Nome do parâmetro Descrição Formato da saída
payment_status_code Indica se o pagamento foi concluído. Os valores válidos são definidos pelos parâmetros de entrada configuráveis $flow.payment_success_code, $flow.insufficient_fund_code e $flow.limit_exceed_code. string

Para configurar o webhook de processamento de pagamento com cartão de crédito para esse componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Selecione o webhook prebuilt_components_make_a_payment:process_payment_credit_card.
  7. Substitua o URL no campo URL do webhook do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
  8. Revise e atualize o corpo da solicitação para criar o formato de solicitação adequado para seu webhook.
  9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
  10. Revise e atualize as configurações de Autenticação conforme necessário.
  11. Clique em Salvar.

Processar pagamento com cartão de débito

O webhook prebuilt_components_make_a_payment:process_payment_debit_card é usado pelo componente para processar um pagamento usando os detalhes do cartão de débito fornecidos.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro Descrição Formato da entrada
$session.params.phone_number Número de telefone local do usuário, sem o código do país, usado para identificar o usuário. string
$flow.payee_number Últimos quatro dígitos do número da conta do beneficiário para o pagamento. string
$flow.payment_type Tipo de pagamento. Os valores válidos são definidos pela entidade personalizada prebuilt_components_make_a_payment_payment_type. Por padrão, esse componente é compatível com "beneficiary_pay" e "credit_card_pay". string
$flow.debit_card_number Os últimos quatro dígitos do cartão de débito do usuário. string
$flow.debit_card_exp_date Data de validade do cartão de débito fornecida pelo usuário para o cartão especificado.
{
"year": integer,
"month": integer
}
$flow.debit_card_cvv_code O código CVV fornecido pelo usuário para o cartão de débito especificado. string
$flow.payment_amount O valor que o usuário escolheu pagar. número

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API para serem usados pelo componente.

Nome do parâmetro Descrição Formato da saída
payment_status_code Indica se o pagamento foi concluído. Os valores válidos são definidos pelos parâmetros de entrada configuráveis $flow.payment_success_code, $flow.insufficient_fund_code e $flow.limit_exceed_code. string

Para configurar o webhook de processamento de pagamento com cartão de débito para esse componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Selecione o webhook prebuilt_components_make_a_payment:process_payment_debit_card.
  7. Substitua o URL no campo URL do webhook do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
  8. Revise e atualize o corpo da solicitação para criar o formato de solicitação adequado para seu webhook.
  9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
  10. Revise e atualize as configurações de Autenticação conforme necessário.
  11. Clique em Salvar.

Processar pagamento da conta

O webhook prebuilt_components_make_a_payment:process_payment_account é usado pelo componente para processar um pagamento usando os detalhes da conta fornecidos.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro Descrição Formato da entrada
$session.params.phone_number Número de telefone local do usuário, sem o código do país, usado para identificar o usuário. string
$flow.payee_number Últimos quatro dígitos do número da conta do beneficiário para o pagamento. string
$flow.payment_type Tipo de pagamento. Os valores válidos são definidos pela entidade personalizada prebuilt_components_make_a_payment_payment_type. Por padrão, esse componente é compatível com "beneficiary_pay" e "credit_card_pay". string
$session.params.last_four_digit_of_account_number Últimos quatro dígitos da conta do usuário. string
$flow.payment_amount O valor que o usuário escolheu pagar. número

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API para serem usados pelo componente.

Nome do parâmetro Descrição Formato da saída
payment_status_code Indica se o pagamento foi concluído. Os valores válidos são definidos pelos parâmetros de entrada configuráveis $flow.payment_success_code, $flow.insufficient_fund_code e $flow.limit_exceed_code. string

Para configurar o webhook de pagamento da conta de processamento para este componente, expanda para ver as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Selecione o webhook prebuilt_components_make_a_payment:process_payment_account.
  7. Substitua o URL no campo URL do webhook do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
  8. Revise e atualize o corpo da solicitação para criar o formato de solicitação adequado para seu webhook.
  9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
  10. Revise e atualize as configurações de Autenticação conforme necessário.
  11. Clique em Salvar.

Processar pagamento com celular

O webhook prebuilt_components_make_a_payment:process_payment_mobile é usado pelo componente para gerar e enviar um link de pagamento com celular para os detalhes de pagamento selecionados pelo usuário.

Parâmetros de solicitação de API

Os parâmetros a seguir são fornecidos pelo componente como entradas para a solicitação de API.

Nome do parâmetro Descrição Formato da entrada
$session.params.phone_number Número de telefone local do usuário, sem o código do país, usado para identificar o usuário. string
$flow.payee_number Últimos quatro dígitos do número da conta do beneficiário para o pagamento. string
$flow.payment_type Tipo de pagamento. Os valores válidos são definidos pela entidade personalizada prebuilt_components_make_a_payment_payment_type. Por padrão, esse componente é compatível com "beneficiary_pay" e "credit_card_pay". string
$flow.payment_amount O valor que o usuário escolheu pagar. número

Parâmetros de resposta da API

Os parâmetros a seguir são extraídos da resposta da API para serem usados pelo componente.

Nome do parâmetro Descrição Formato da saída
payment_link_generated Indica se o link de pagamento com celular foi gerado e enviado ao usuário. booleano

Para configurar o webhook de processamento de pagamento com celular para esse componente, abra as instruções.

  1. Abra o console do Dialogflow CX.
  2. Escolha seu projeto do Google Cloud.
  3. Selecione seu agente.
  4. Selecione a guia Gerenciar.
  5. Clique em Webhooks.
  6. Selecione o webhook prebuilt_components_make_a_payment:process_payment_mobile.
  7. Substitua o URL no campo URL do webhook do Dialogflow CX pelo endpoint do serviço com que você quer fazer a integração. Selecione o Método adequado no menu suspenso.
  8. Revise e atualize o corpo da solicitação para criar o formato de solicitação adequado para seu webhook.
  9. Revise e atualize a Configuração de resposta para extrair campos específicos da resposta do webhook. Não modifique os nomes dos parâmetros, porque eles são necessários para que o componente acesse os valores de campo retornados.
  10. Revise e atualize as configurações de Autenticação conforme necessário.
  11. Clique em Salvar.

Concluído

Seu agente e os webhooks dele agora devem estar configurados e prontos para teste.