TwiML™ Voice: <Pay>
This TwiML verb is only supported in the default US1 Twilio Region Ireland (IE1) and Australia (AU1) are not yet supported.
For more information on supported features in Twilio Regions, go to the Global Infrastructure docs.
You can use TwiML's <Pay> verb to capture and process both ACH and credit card data during a call.
<Pay> will prompt your customer to enter their payment information and will handle retries if a piece of information is invalid.
In addition to managing necessary interactions when there is timeout or invalid input, <Pay> will send webhooks to your statusCallback URL to keep you informed of the progress of <Pay>.
Once all required credit card or ACH data is captured, <Pay> will send the payment information to your payment processor or gateway via a Pay Connector installed and configured on your account.
Once <Pay> finishes collecting a customer's valid payment information, information about the transaction result will be sent via webhook to your statusCallback URL and/or your action URL.
<Pay> will terminate when DTMF * keypress is received at any point.
When <Pay> finishes collecting a customer's valid payment information or is terminated with a * keypress, Twilio will immediately send a webhook (an HTTP POST request) to the action URL.
Twilio will continue the current call using the TwiML returned in the response from the action URL.
<Pay> can create two types of transactions, charge and tokenize.
- A charge transaction means you want to immediately capture funds from the customer's supplied payment method (i.e. credit card) in return for the goods or services you offer.
- To create a charge transaction, set the
chargeAmountattribute in your <Pay> verb to a decimal value greater than 0.
- To create a charge transaction, set the
- A tokenize transaction means you want to obtain a token based on the user's supplied credit card information from the payment processor instead of posting any charge. Tokens are typically stored so that you can charge the user in the future without having to ask for the credit card information again. Note that tokens are provided by your payment gateway or processor.
- To create a tokenize transaction, you must set the
chargeAmountto "0" or omit thechargeAmountattribute from your <Pay> verb.
- To create a tokenize transaction, you must set the
<Pay> Attributes
The <Pay> verb supports the following attributes to modify its default behavior:
| Attribute Name | Allowed Values | Default Values |
|---|---|---|
| input |
|
"dtmf" |
| action | relative or absolute URL |
Current document URL. Must use https. Only POST is supported. |
| statusCallback | relative or absolute URL | none |
| paymentMethod |
|
"credit-card" |
| bankAccountType |
|
|
| timeout | positive integer | 5 |
| maxAttempts |
|
none |
| securityCode |
|
|
| postalCode |
String |
"true" |
| minPostalCodeLength |
Positive integer |
none |
| paymentConnector | String | "Default" |
| tokenType |
|
|
| chargeAmount | decimal (min: 0, max: 1,000,000) | none |
| currency | String | "usd" |
| language |
For credit card payments, possible values are: English:
Spanish:
French:
German:
Italian:
For ACH, possible values are: English:
|
|
| description | String | none |
| validCardTypes |
String containing one or more of the following values separated by a space:
|
"visa mastercard amex" |
input
A list of inputs that Twilio should accept for <Pay>; only dtmf is supported.
All digits captured by <Pay> are redacted from the logs.
action
The URL where Twilio will send a POST request for the next set of TwiML instructions after a successful <Pay> transaction.
The action attribute takes an absolute or relative URL as value.
When the <Pay> verb has successfully tokenized or created a charge, Twilio will make a POST request to the action URL. The body of the request includes the standard request parameters and the additional parameters described in the Twilio's POST request to your action URL section below.
If no action is provided, Twilio will by default make a POST request to the current document URL.
The attribute only accepts https protocol for the URL.
If you made a tokenize transation, Twilio's request to your application will include the PaymentToken and/or ProfileId parameter. These fields contain the tokenized information received from the Payment Gateway.
If you made a charge transaction, Twilio’s request to your application will include a PaymentConfirmationCode parameter with the confirmation code received from the payment processor/gateway.
If you started or updated a call with a twiml parameter, the action URLs for <Record>, <Gather>, and <Pay> must be absolute.
The Call Resource API Docs have language-specific examples of creating and updating Calls with TwiML:
- See "Create a Call resource with TwiML" under Create a Call Resource to see examples of creating a call with a
twimlparameter. - See "Update a Call resource with TwiML" under Update a Call Resource to see examples of updating a call with a
twimlparameter.
Twilio's POST request to your action URL
After a successful <Pay> transaction, Twilio will send a POST request to your action URL. The body of this request will contain the standard request parameters, along with the additional parameters listed in the table below.
| Parameter | Description |
|---|---|
Result |
The result of the <Pay> transaction. Possible values are:
|
ProfileId |
The identifier of the customer object to which the payment is associated. Can be used as a token depending on which Pay Connector and/or payment processor used.
|
PaymentToken |
The tokenized value of the credit card or ACH payment data. Each payment processor handles this differently:
|
PaymentConfirmationCode |
If <Pay> was used to process the payment instead of tokenizing, this is the confirmation code from the payment gateway. |
PaymentMethod |
The payment method provided by the developer in the <Pay> verb's Example value: |
PaymentCardNumber |
If Example value: |
PaymentCardType |
If The value will be one of the
|
ExpirationDate |
If Example value: |
SecurityCode |
If This value will be redacted. Example value: |
PaymentCardPostalCode |
If Example value: |
BankAccountNumber |
If The value will be redacted except for the last 2 digits. Example: A customer enters 508862392. The |
BankRoutingNumber |
If The value will be the full routing number provided by the caller/consumer. Example value: |
BankAccountType |
If Possible values are either |
PaymentError |
Validation error for incorrect <Pay> verb attribute.
Payment error for failures.
Payment error for input timeout.
|
PayErrorCode |
A numerical error code that gives more details about the error. To learn more about the error, please visit https://www.twilio.com/docs/api/errors and search for the error code. |
ConnectorError |
This parameter contains the actual error code/message received from the underlying payment platform. |
statusCallback
The statusCallback attribute takes an absolute or relative URL as value. Whenever a status change happens in <Pay>, Twilio will make a POST request to this URL with the following parameters.
Twilio's POST request to your statusCallback URL
Twilio will send the following parameters in the body of the POST request to your statusCallback URL:
| Parameter | Description |
|---|---|
AccountSid |
The unique identifier of the Twilio Account responsible for this Pay session |
CallSid |
A unique identifier for the Call Resource associated with the Pay sessions. CallSid will always refer to the parent leg of a two-leg call. |
For |
The current stage of <Pay>. The possible values are:
|
ErrorType |
The type of error that occurred (if applicable). The possible error types are:
|
Attempt |
The current attempt count. Possible values are |
PaymentCardNumber |
If e.g. |
PaymentCardType |
If The value provided here will be one of the values provided in the |
ExpirationDate |
If Note: Expiration date is not PCI data, so it can be clearly visible. |
SecurityCode |
If paymentMethod="credit-card", this is the security code provided to <Pay> with all digits redacted, e.g. "xxxx" |
PaymentCardPostalCode |
If Note: Postal Code is not PCI data, so it can be clearly visible. |
BankAccountNumber |
If |
BankRoutingNumber |
If <Pay> will return the full routing number provided by the caller/consumer, e.g. |
BankAccountType |
If Possible values are:
|
paymentMethod
The paymentMethod attribute specifiies whether to capture credit card or ACH payment information.
<Pay> by default captures credit card information (credit card number, expiration date, security code, and postal code).
To capture bank account information, set the value of the paymentMethod attribute to "ach-debit" as shown below.
<Response>
<Pay paymentConnector=”Your_Connector_Name” paymentMethod=”ach-debit” />
</Response>
Once <Pay> successfully captures the information, it will securely send that information to the appropriate payment platform using the Pay Connector you've configured. Twilio returns the results from the payment platform via a webhook to the action URL specified in the <Pay> verb.
bankAccountType
This attribute indicates the type of bank account information is being provided by the caller/consumer when capturing ACH payments. The bankAccountType attribute accepts either "consumer-checking","consumer-savings", "commercial-checking".
The speed at which the ACH transactions are processed depends on the bankAccountType and the underlying payment platform used.
Use <Gather> to capture the type of bank account and pass one of the allowed values to your bankAccountType attribute when using <Pay> to capture ACH payments.
timeout
The timeout attribute sets the limit in seconds that <Pay> will wait for the caller to press another digit before moving on to validate the digits captured.
For example, if timeout is 3, <Pay> will wait three seconds for the caller to press a key when capturing either credit card number, expiration date, security code or zip code. When accepting ACH payments, <Pay> will wait three seconds for the caller to press a key when capturing either bank account or routing numbers.
maxAttempts
The maxAttempts attribute specifies number of times <Pay> should retry when collecting information.
The default is 1 which means <Pay> will retry once when a timeout or invalid value is received. For example, if a timeout is received when prompted for credit card number, <Pay> will reprompt one more time to enter credit card number before terminating. When <Pay> hits the maxAttempts value, <Pay> will terminate and TwiML execution will start with next verb after <Pay>.
securityCode
The securityCode attribute takes true or false to let <Pay> know whether to prompt for security code.
When paymentMethod is credit-card, <Pay> by default will collect credit card number, expiration date, security code and zip code. Use <Pay securityCode=”false” /> to disable prompting for security code.
postalCode
The postalCode attribute takes true or false to let <Pay> know whether to prompt for postal code (i.e zip code).
When paymentMethod is credit-card, <Pay> by default will collect credit card number, expiration date, security code and postal code (Zip code in US). Use <Pay postalCode=”false” /> to disable prompting for postal code. In addition, if you already have access to customer code instead of asking the payee for that information provide the postal code as value to the attribute. For example, if the billing postal code is 95105 then use <Pay postalCode=”94105” /> and <Pay> will pass 94105 to the Payment Gateway when processing the payment.
minPostalCodeLength
The minPostalCodeLength attribute takes a positive integer to let <Pay> validate the length of the postalCode attribute. Users are expected to enter atleast these many digits.
chargeAmount
The chargeAmount attribute takes an amount to charge against the credit card or bank account captured by <Pay>. The attribute takes a decimal value with no currency prefix and defaults to USD.
If the chargeAmount attribute has a value greater than 0, the transaction will be a charge transaction.
If the chargeAmount attribute has a value of 0 or is omitted from the <Pay> verb, the transaction will be a tokenize transaction.
For example, use chargeAmount="20.45" to process payment in the amount of $20.45.
The default currency can be overriden with currency attribute.
currency
The currency attribute is used to provide the currency of the amount attribute. The default value for currency is usd (US Dollars) and accepts all values accepted by the selected Pay Connector
language
The language attribute is used to provide the language that a customer hears when interacting with <Pay>.
For credit card payments, possible values are:
- English:
en-AUen-CAen-GBen-INen-US
- Spanish:
es-ESes-MX
- French:
fr-CAfr-FR
- German:
de-DE
- Italian:
it-IT
For ACH, possible values are:
- English:
en-AUen-CAen-GBen-INen-US
You can also further customize what the customer hears using the <Prompt> noun.
paymentConnector
The paymentConnector attribute must contain the unique name corresponding to the Pay Connector installed in your Twilio Add-ons in the Twilio Console. Learn more on the Pay Connectors page.
For example, to process the transaction using Stripe use paymentConnector=Stripe_1, where Stripe_1 is the unique name specified when configuring the Pay Connector Add-on in the Marketplace.
If no paymentConnector is specified, <Pay> will use the Pay Connector on your account with the unique name "Default".
If you are using a Generic Pay Connector, you can use the <Parameter> noun with <Pay> to pass custom parameters to your payment processor.
You must have an installed Pay Connector named "Default" or you must include the paymentConnector attribute.
tokenType
The tokenType attribute takes either one-time or reusable as value.
To tokenize a payment method, set chargeAmount = 0 or omit the chargeAmount attribute.
If <Pay> should generate a one-time token, use tokenType="one-time" and to generate a token for recurring payments use, tokenType="reusable".
description
The description attribute takes a value that describes more details regarding the payment.
This information is submitted along with the payment details to the Payment Gateway which are then posted on the transactions. For example, you can provide “Payment of $20.52 submitted from CallSid CAxxxxxx and Phone Number (xxx)-xxx-xxxx” to create a record to show which call created the payment.
validCardTypes
The validCardTypes attributes takes credit card types separated by space that <Pay> should accept.
If the payee enters a card number that is outside of valid card types, <Pay> will generate an “invalid-card-type” error. For example, if validCardTypes=visa mastercard and payee enters an American Express card number, then <Pay> will generate an "invalid-card-type" error.
The default value of validCardTypes is “visa mastercard amex”.
A customer could provide any of the following card types separated by space:
| Card Type | Description |
|---|---|
| visa | Valid length: 13, 15, 19 digits. First digit must be a 4. |
| mastercard |
Valid length: 16 digits. First digit must be 5 and second digit must be in the range 1 through 5 inclusive. The range is 510000 through 559999. First digit must be 2 and second digit must be in the range 2 through 7 inclusive. The range is 222100 through 272099. |
| amex | Valid length: 15 digits. First digit must be a 3 and second digit must be a 4 or 7. |
| maestro |
Valid length: 12-19 digits. First digit must be either 5 or 6. If the first digit starts with 5, then second digit must be either 0, 6, 7 or 8. |
| discover |
Valid length: 16-19 digits. Must start with either 64, 65 or 6011 |
| jcb |
Valid length: 16 to 19 digits. First 4 digits must be in the range 3528 through 3589. |
| diners-club |
Diners Club for USA & Canada Valid length: 16-19 digits. * The digits must begin with 300, 301, 302, 303, 304, 3095, 36, 38, or 39.
* Note: If first two digits are 36, valid length is 14-19 digits. |
| enroute |
Valid length: 15 digits. First four digits must be 2014 or 2149. |
<Pay> Sample Usage
Collect payment data during a voice call and charge a specific amount.
Collect payment of a specific amount and specify a callback handler
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
