You are viewing the Portuguese (Brazil) site, but your language preference is set to English. Switch to English site →

Menu

Expand
Classifique esta página:

Recurso de pagamento

Pagamentos assistidos por agente

Introdução

Os pagamentos assistidos por agente permitem que os agentes coletem informações de pagamento de clientes de maneira compatível com PCI em chamadas de voz da Twilio no contact center. Com os pagamentos assistidos por agente, o agente permanece no telefone e orienta o cliente pelo fluxo de pagamento, solicitando as várias informações de pagamento necessárias, um item por vez.

O agente pode controlar o fluxo de pagamento solicitando as informações de pagamento na ordem em que achar melhor para o cliente e até mesmo solicitar novamente as informações conforme necessário. Quando o cliente estiver inserindo suas informações de pagamento, o agente não poderá ouvir os tons DTMF (Dual-Tone Multi-Frequency, multifrequência de dois tons), garantindo a conformidade com o PCI DSS (Payment Card Industry Data Security Standard, padrão de segurança de dados do setor de cartões de pagamento) das informações de pagamento e a segurança das informações de pagamento do cliente.

Depois que o agente progredir em todas as etapas para coletar as informações de pagamento do cliente, ele conclui a captura via Twilio. A Twilio envia as informações de pagamento diretamente ao conector de pagamento para processamento, garantindo que nenhuma informação do cartão seja divulgada ao agente.

Fluxo de trabalho

  • O agente solicita algumas informações, incluindo o método de pagamento, do cliente e inicia uma sessão do Twilio Pay.
  • O agente aciona as chamadas da API por meio de sua IU para coletar informações específicas de pagamento do cliente, como por exemplo, número do cartão de crédito, data de validade ou número da conta bancária.
  • O autor da chamada insere as informações de pagamento solicitadas usando o teclado do telefone. Os agentes não conseguem ouvir nenhum tom DTMF.
  • Quando o cliente terminar, o agente verá o resultado da entrada do cliente, por exemplo xxxx xxxx xxxx 4242, ou invalid-card-number.
  • O agente solicita a próxima informação de pagamento necessária e continua a fazê‐lo até que todas as informações necessárias sejam inseridas.
    • O agente pode solicitar novamente uma informação de pagamento conforme necessário, em qualquer ordem e em qualquer ponto durante o fluxo.
    • O agente também pode cancelar o pagamento a qualquer momento durante o fluxo.
  • Depois que todas as informações forem coletadas, o agente concluirá a sessão Pay (Pagamento) e receberá o resultado do pagamento.

Design e fluxo de trabalho da API

Com a assistência do Agente, a chave é capturar informações do cliente enquanto o Agente está na chamada com o cliente. Isso significa que o agente pode interagir com o cliente orientando‐o pela experiência de inserir os detalhes do cartão. Um fluxo de agente típico é descrito abaixo:

  • O agente coleta e insere informações como método de pagamento, valor de cobrança ou tipo de token e, em seguida, inicia a sessão Pay (Pagamento).
  • Em seguida, o agente chama a API de Atualização (por meio de sua própria IU) para cada informação de pagamento sucessivamente.
  • Se os clientes cometerem um erro ao inserir informações, o agente simplesmente chama a API de Atualização novamente para capturar de novo essas informações específicas.
  • Depois que todas as informações de pagamento necessárias tiverem sido coletadas, o Agente conclui a sessão Pay (Pagamento) definindo o status como complete, que, em seguida, processa o pagamento e conclui a transação. O agente também pode cancelar a sessão Pay (Pagamento), se necessário, definindo o status na API de Atualização como cancel.
  • As informações resultantes em cada uma das chamadas acima serão entregues por meio de retornos de chamada de status, que podem ser usados para atualizar a IU do agente em tempo quase real.

Propriedades de pagamentos

Resource Properties in REST API format
account_sid
sid<AC> Not PII

The SID of the Account that created the Payments resource.

call_sid
sid<CA> Not PII

The SID of the Call the Payments resource is associated with. This will refer to the call sid that is producing the payment card (credit/ACH) information thru DTMF.

sid
sid<PK> Not PII

The SID of the Payments resource.

date_created
date_time<rfc2822> Not PII

A data e a hora em GMT em que o recurso foi criado especificadas no formato RFC 2822.

date_updated
date_time<rfc2822> Not PII

A data e a hora em GMT em que o recurso foi atualizado pela última vez especificadas no formato RFC 2822.

uri
uri Not PII

O URI do recurso, relativo a “https://api.twilio.com”.

Iniciar uma sessão Pay (Pagamento)

post
https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments.json
Parameters
Parameters in REST API format
account_sid
Path
post sid<AC> Not PII

O SID da Account (Conta) para create (criar) o recurso.

call_sid
Path
post sid<CA> Not PII

The SID of the call that will create the resource. Call leg associated with this sid is expected to provide payment information thru DTMF.

idempotency_key
Required
post string Not PII

A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated.

status_callback
Required
post url Not PII

Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the expected StatusCallback values

bank_account_type
Optional
post ienum:bank_account_type Not PII

Type of bank account if payment source is ACH. One of consumer-checking, consumer-savings, or commercial-checking. The default value is consumer-checking.

charge_amount
Optional
post decimal Not PII

A positive decimal value less than 1,000,000 to charge against the credit card or bank account. Default currency can be overwritten with currency field. Leave blank or set to 0 to tokenize.

currency
Optional
post string Not PII

The currency of the charge_amount, formatted as ISO 4127 format. The default value is USD and all values allowed from the Pay Connector are accepted.

description
Optional
post string Not PII

The description can be used to provide more details regarding the transaction. This information is submitted along with the payment details to the Payment Connector which are then posted on the transactions.

input
Optional
post string Not PII

A list of inputs that should be accepted. Currently only dtmf is supported. All digits captured during a pay session are redacted from the logs.

min_postal_code_length
Optional
post integer Not PII

A positive integer that is used to validate the length of the PostalCode inputted by the user. User must enter this many digits.

parameter
Optional
post object Not PII

A single-level JSON object used to pass custom parameters to payment processors. (Required for ACH payments). The information that has to be included here depends on the Connector. Read more.

payment_connector
Optional
post string Not PII

This is the unique name corresponding to the Pay Connector installed in the Twilio Add-ons. Learn more about Connectors. The default value is Default.

payment_method
Optional
post ienum:payment_method Not PII

Type of payment being captured. One of credit-card or ach-debit. The default value is credit-card.

postal_code
Optional
post boolean Not PII

Indicates whether the credit card postal code (zip code) is a required piece of payment information that must be provided by the caller. The default is true.

security_code
Optional
post boolean Not PII

Indicates whether the credit card security code is a required piece of payment information that must be provided by the caller. The default is true.

timeout
Optional
post integer Not PII

The number of seconds that should wait for the caller to press a digit between each subsequent digit, after the first one, before moving on to validate the digits captured. The default is 5, maximum is 600.

token_type
Optional
post ienum:token_type Not PII

Indicates whether the payment method should be tokenized as a one-time or reusable token. The default value is reusable. Do not enter a charge amount when tokenizing. If a charge amount is entered, the payment method will be charged and not tokenized.

valid_card_types
Optional
post string Not PII

Credit card types separated by space that Pay should accept. The default value is visa mastercard amex

Example 1
        
        
        

        Iniciar uma sessão Pay (Pagamento)

        StatusCallback

        Forneça um URL absoluto ou relativo para este parâmetro. O Twilio Pay fará uma solicitação POST para este URL sempre que houver uma atualização do parâmetro que está sendo capturado. A solicitação POST terá os seguintes parâmetros:

        Parâmetro

        Descrição

        AccountSid

        O identificador exclusivo da conta responsável por esta sessão de pagamento

        CallSid

        O identificador exclusivo da chamada associada à sessão de pagamento. CallSid sempre se refere ao trecho principal de uma chamada de dois trechos

        Sid

        O identificador exclusivo da sessão Pay (Pagamento) atual

        DateCreated

        A data em que a sessão Pay (Pagamento) foi iniciada

        BankAccountType

        Se o PaymentMethod ach-debit for usado, o Tipo de conta bancária fornecido pelo autor da chamada e inserido pelo agente

        ChargeAmount

        Se não estiver gerado um token, ou seja, o valor do encargo for especificado e maior que zero, o valor a ser cobrado pelo método de pagamento

        PaymentConnector

        O nome exclusivo do conector de pagamento correspondente ao Conector do Pay instalado nos Add-ons da Twilio

        PaymentMethod

        Ach-debit ou credit-card

        TokenType

        Uma vez ou reutilizável se o valor do encargo não for especificado

        Todas as solicitações StatusCallback conterão esses campos. Valores adicionais de StatusCallback podem ser encontrados durante as APIs Update e Complete/Cancel.

        Atualizar uma sessão Pay (Pagamento)

        post
        https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments/{Sid}.json
        Parameters
        Parameters in REST API format
        account_sid
        Path
        post sid<AC> Not PII

        The SID of the Account that will update the resource.

        call_sid
        Path
        post sid<CA> Not PII

        The SID of the call that will update the resource. This should be the same call sid that was used to create payments resource.

        sid
        Path
        post sid<PK> Not PII

        The SID of Payments session that needs to be updated.

        idempotency_key
        Required
        post string Not PII

        A unique token that will be used to ensure that multiple API calls with the same information do not result in multiple transactions. This should be a unique string value per API call and can be a randomly generated.

        status_callback
        Required
        post url Not PII

        Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the Update and Complete/Cancel POST requests.

        capture
        Optional
        post ienum:capture Not PII

        The piece of payment information that you wish the caller to enter. Must be one of payment-card-number, expiration-date, security-code, postal-code, bank-routing-number, or bank-account-number.

        status
        Optional
        post ienum:status Not PII

        Indicates whether the current payment session should be cancelled or completed. When cancel the payment session is cancelled. When complete, Twilio sends the payment information to the selected Pay Connector for processing.

        Example 1
              
              
              
              Faça esta solicitação de API para cada informação de pagamento que desejar

              Atualizar uma sessão Pay (Pagamento)

              Faça esta solicitação de API para cada informação de pagamento que desejar

              StatusCallback (Atualização)

              Forneça um URL absoluto ou relativo para este parâmetro. O Twilio Pay fará uma solicitação POST para este URL sempre que a API de atualização for chamada e sempre que houver uma atualização do parâmetro que está sendo capturado. A solicitação POST conterá todos os parâmetros comuns de StatusCallback, bem como estes parâmetros adicionais:

              Parâmetro

              Descrição

              DateUpdated

              A data em que a sessão Pay (Pagamento) foi atualizada pela última vez

              BankAccountNumber

              Se PaymentMethod for em débito automático, o número da conta bancária inserido pelo autor da chamada. A Twilio só retornará os dois últimos dígitos. Por exemplo, se o número da conta bancária for 508862392, o Pay retornará BankAccountNumber=*******92

              BankRoutingNumber

              Se PaymentMethod for em débito automático, o número de Roteamento do banco será fornecido pelo autor da chamada. A Twilio retornará o número de roteamento completo inserido. Por exemplo, se o autor da chamada digitar 121181976 como o Número de roteamento do banco fornecido, o Pay retornará BankRoutingNumber=121181976

              Capture

              As informações de pagamento que o Pay estava esperando

              ChargeAmount

              Se não gerar token, ou seja, o valor do encargo foi especificado e maior que zero, o valor a ser cobrado pelo método de pagamento

              ErrorType

              A lista completa de tipos de erro está visível aqui

              ExpirationDate

              Se PaymentMethod for credit-card, a data de expiração inserida pelo autor da chamada. Por exemplo, ExpirationDate=0522. A data de expiração não é um dado PCI, por isso pode ser claramente visível

              PartialResult

              true, se o DTMF ainda estiver sendo capturado e false depois que todos os dígitos das informações de pagamento que estão sendo capturadas forem inseridos

              PaymentCardNumber

              Se PaymentMethod for credit-card, o número do cartão inserido pelo autor da chamada com apenas os últimos 4 dígitos visíveis. Por exemplo, PaymentCardNumber=xxxx-xxxxxx-x4001

              PaymentCardPostalCode

              Se PaymentMethod for credit-card, o código postal será exibido pelo autor da chamada ou pelo agente. Por exemplo, PaymentCardPostalCode=94109. O código postal não é um dado PCI, portanto, pode estar claramente visível.

              PaymentCardType

              Se PaymentMethod for credit-card, o tipo de cartão inserido pelo autor da chamada. Por exemplo, PaymentCardType=amex. O valor fornecido aqui será um dos valores fornecidos com o parâmetro cardTypes na API Iniciar

              Obrigatório

              As informações de pagamento que ainda devem ser coletadas. Por exemplo, se o código postal e o código de segurança forem falsos e o número do cartão de crédito já tiver sido inserido, então Required=ExpirationDate

              SecurityCode

              Se PaymentMethod for credit-card, o código de segurança inserido pelo autor da chamada com todos os dígitos editados, por exemplo, SecurityCode=xxx

              Status

              Indique se a sessão de pagamento atual deve ser cancelada ou concluída quando esta solicitação de API for feita. Quando o status for cancel, a sessão de pagamento será cancelada. Você terá que usar a API Iniciar para iniciar uma nova sessão de pagamento. Quando o status for complete, a Twilio envia as informações de pagamento ao conector do Pay selecionado para processamento.

              Example 2
                    
                    
                    

                    Conclua uma sessão Pay (Pagamento)

                    Example 3
                          
                          
                          

                          Cancelar uma sessão Pay (Pagamento)

                          StatusCallback (Cancelar/Concluir)

                          Forneça um URL absoluto ou relativo para este parâmetro. O Twilio Pay fará uma solicitação POST para este URL sempre que a API Cancelar/Concluir for chamada. A solicitação POST conterá todos os parâmetros comuns de StatusCallback, bem como estes parâmetros adicionais:

                          Parâmetro

                          Descrição

                          DateUpdated

                          A data em que a sessão Pay (Pagamento) foi atualizada pela última vez

                          ConnectorError

                          Este parâmetro contém o código/mensagem de erro recebida do gateway de pagamento subjacente

                          PayErrorCode

                          Um código de erro numérico que fornece mais detalhes sobre o erro. Para saber mais sobre o erro, visite a página de erro e procure o código de erro

                          PaymentError

                          Erro de pagamento por falhas. Por exemplo, card is declined

                          PaymentConfirmationCode

                          Se o método de pagamento fornecido foi cobrado e não gerou token, este é o código de confirmação do Gateway de pagamento

                          PaymentToken

                          O valor que gerou token do cartão de crédito ou dos dados de pagamento da ACH. O pagamento não gerou token se um valor de encargo for fornecido. Valores:

                          • ACI – token Card (cartão)
                          • Base Commerce – token BankCard (cartão bancário)
                          • Braintree – token
                          • CardConnect – token
                          • Chase – sem valor
                          • Stripe – token único

                          ProfileId

                          O identificador do objeto do cliente ao qual o pagamento está associado. Pode ser usado como um token dependendo do conector. O pagamento não gerou token se um valor de encargo for fornecido. Valores:

                          • ACI – sem valor
                          • Base Commerce - sem valor
                          • Braintree – ID do objeto do cliente (não pode ser usado como um token)
                          • CardConnect – perfil
                          • Chase – número de referência do cliente
                          • Stripe – ID do recurso do cliente

                          Resultado

                          O resultado da transação. Consulte a tabela abaixo para obter todos os valores

                          Resultado

                          Resultado

                          Descrição

                          success

                          Twilio capturou com êxito os dados de pagamento e gerou token ou processou o pagamento

                          payment-connecter-error

                          O Twilio Pay apresentou um erro de comunicação com o Gateway de pagamento

                          caller-interrupted-with-star

                          O autor da chamada pressionou a tecla asterisco * para interromper a sessão de pagamento

                          caller-hung-up

                          O autor da chamada desligou a chamada

                          validation-error

                          Um valor de parâmetro inválido, por exemplo, chargeAmount="-0.5"

                          Classifique esta página:

                          Precisa de ajuda?

                          Às vezes, todos nós precisamos; a programação é difícil. Receba ajuda agora da nossa equipe de suporte, ou confie na sabedoria da multidão navegando pelo Stack Overflow Collective da Twilio ou buscando a tag Twilio no Stack Overflow.

                                
                                
                                

                                Obrigado pelo seu feedback!

                                Selecione o(s) motivo(s) para seu feedback. As informações adicionais que você fornece nos ajudam a melhorar nossa documentação:

                                Enviando seu feedback...
                                🎉 Obrigado pelo seu feedback!
                                Algo deu errado. Tente novamente.

                                Obrigado pelo seu feedback!

                                thanks-feedback-gif