Tutorials: Voice Widget: Collect Payment
Required access: Voxtelesys Portal
The Collect Payment widget goes under the Tools category for the VAST Flow Builder. This widget allows users to collect payment information over the call and send it to a payment connector of their choice. The caller will be prompted to enter each field by pressing digits, and if a field is invalid, then the caller will be asked to retry. The payment information can be used to either charge the caller immediately or create a token to be used later.
The call is billed for each request made using the Collect Payment widget. The rate depends on which payment gateway is used (Stripe, etc.).
*Disclaimer: You will need to have Voice API enabled on your account to do this you will need to open a ticket with support.
Last Updated: 1/9/25
To use the widget simply click and drag it into the builder
Note that naming the widget can help identify it with other tools later on. It is case sensitive, does not accept spaces or dashes
The Collect Payment widget has the following configuration abilities before payment connector is selected:
Payment Connector (required)
The name of the payment connector to which the payment information should be submitted. A payment connector can be added by visiting the Integrations > Payment Connectors page in the Portal.
Language (optional)The language in which the caller should be prompted.
The Collect Payment widget has the following configuration abilities after payment connector is selected:
Payment Method (required)
The type of payment method to be collected (credit card or ACH).
Valid Card Types (optional, applies only when Payment Method = “credit-card”)
The credit card types that are allowed for the payment. If the caller enters a credit card number whose type is not allowed, then they are asked to reenter their credit card number.
Collect Security Code (optional, applies only when Payment Method = “credit-card”)
If enabled, the caller will be asked to enter their credit card security code.
Collect Postal Code (optional, applies only when Payment Method = “credit-card”)
If enabled, the caller will be asked to enter their credit card postal code.
Min Postal Code Length (optional, applies only when Payment Method = “credit-card”)
The minimum length of postal code that is considered valid.
Bank Account Type (optional, applies only when Payment Method = “ach-debit”)
The type of ACH bank account to be collected from the caller.
Customer Name (optional, applies only when Payment Method = “ach-debit”)
The name of the customer whose ACH bank account information is being collected.
Create a Token (optional)
If enabled, a token will be created which stores the payment information for later use. The value of the token will be delivered to the status callback URL once the payment information has been submitted.
For payment connectors that use Stripe, only one-time tokens can be created when ACH is selected as the payment method.
Token Type (required, if Create a Token = true)
The type of token to be created (one-time or reusable).
Charge Amount (required, if Create a Toke = false)
The amount in USD to charge the customer’s payment method. Must be a decimal number greater than zero.
Charge Description (optional)
A description of the charge that is submitted with the payment.
The collect Payment widget has the following configuration capabilities under General Settings:
Max Attempts (optional)
The number of times a caller is allowed to enter an invalid field before the payment collection process fails.
Timeout (optional)
The duration in seconds to wait for the caller to enter each field. If the caller fails to enter a field before the timeout is reached, then the field is considered invalid and the caller is asked to retry.
Status Callback URL (optional)
The URL of a publicly available HTTP endpoint. If provided, then the widget will send status update webhooks to the URL. For more details on the webhook payload structure please refer to the Voice API documentation.
Status Callback Method (optional)
The HTTP method to use when sending callback(s) to the provided URL. The options are POST and GET. For more details on the webhook payload structure please refer to the Voice API documentation.
The Collect Payment widget has the following transition capabilities:
Success
Activated if the payment information was collected and sent to the payment connector successfully.
Failure
Activated if the maximum number of attempts was reached or an error occurred when processing the payment information.
Now, you will want to connect the Collect Payment widget.
Adding the Collect Payment widget is completed!
To continue the flow, connect more widgets to the opposite end of the Collect Payment widget.
Now connect more widgets! Click on the links below to view more tutorials:
Voice
- Answer Call
- Collect Input
- Connect Call
- Hang Up Call
- Pause Call
- Record Voicemail
- Say/Play
- Collect Payment
Messaging
Tools
Control
