TwiML™ Voice: <Pay>

The <Pay> verb supports the following attributes to modify its default behavior:

A list of inputs that Twilio should accept for <Pay>; only dtmf is supported.

All digits captured by <Pay> are redacted from the logs.

Back to attributes list

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 transaction, 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.

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.

The Result property is the result of the <Pay> transaction. Possible values are listed in the table below.

The ProfileId property is 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.

• ACI: no value
• Base Commerce: no value
• Braintree: ID of the customer object (can't be used as a token)
• CardConnect: profile
• Chase: customer reference number
• Stripe: ID of the customer resource

The PaymentToken property is the tokenized value of the credit card or ACH payment data. Each payment processor handles this differently:

• ACI: value is a Card Token
• Base Commerce: value is a BankCard Token
• Braintree: value is a token
• CardConnect: value is a token
• Chase: no value
• Stripe:
  • Value is a Token object id if the tokenType is one-time or reusable.
  • Value is a PaymentMethod object id if the tokenType is payment-method.

The PaymentConfirmationCode property indicates if <Pay> was used to process the payment instead of tokenizing, this is the confirmation code from the payment gateway.

The PaymentMethod property indicates the payment method provided by the developer in the <Pay> verb's paymentMethod attribute. Example value: "ach-debit"

If credit-card paymentMethod was used, this is the card number provided by the caller/consumer with only last 4 digits visible. Example value: "xxxx-xxxxxx-x4001"

If credit-card paymentMethod was used, the PaymentCardType property is the type of card provided by the caller/consumer. The value will be one of the validCardTypes:

• visa
• mastercard
• amex
• maestro
• discover
• optima
• jcb
• diners-club
• enroute

If credit-card paymentMethod was used, this is the expiration date provided by the caller/consumer in MMDD (two-digit month, two-digit date) format. Example value: 0522

If credit-card paymentMethod was used, this is the security code provided by the caller/consumer. This value will be redacted. Example value: ***

If credit-card paymentMethod was used, this is the postal code provided by the calller/consumer. Example value: 94109

If ach-debit paymentMethod was used, this is the bank account number provided by the caller/consumer. The value will be redacted except for the last 2 digits. Example: A customer enters 508862392. The BankAccountNumber value will be *******92

If ach-debit paymentMethod was used, this is the bank routing number provided by the caller/consumer. The value will be the full routing number provided by the caller/consumer. Example value: 121181976

If ach-debit paymentMethod was used, this is the type of bank account provided by the caller/consumer. Possible values are either "personal" or "business".

The PaymentError property shows error details for the following types of errors:

• Validation error for incorrect <Pay> verb attribute.
  • Example value: paymentAmount='-0.59' (not a number between 0.00 - 1,000,000.00)
• Payment error for failures.
  • Example value: card is declined
• Payment error for input timeout.
  • Example value: invalid-date (if user enters an invalid date or incorrect number of digits and times out)
  • Example value: invalid-security-code (if user enters an invalid CVV and times out)
  • Example value: invalid-postal-code (if user enters incorrect number of digits for the postal/zip code and times out)

The PayErrorCode property is a numerical error code that gives more details about the error. To learn more about the error, please visit the Error Code Dictionary and search for the error code.

The ConnectorError property contains the actual error code/message received from the underlying payment platform.

Back to attributes list

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 will send the following parameters in the body of the POST request to your statusCallback URL:

The unique identifier of the Twilio Account responsible for this Pay session

A unique identifier for the Call Resource associated with the Pay sessions. CallSid always refers to the parent leg of a two-leg call.

The current stage of <Pay>. The possible values are described in the table below.

The type of error that occurred (if applicable). The possible error types are described in the table below.

The Attempt property indicates the current attempt count.

Possible values are 1, 2, or 3.

For ach-debit payments only.

The PaymentCardNumber indicates the card number provided to <Pay> with only the last 4 digits visible. e.g. "xxxxxxxxxxx4001"

For credit-card payments only.

The PaymentCardType indicates the type of card provided to <Pay>, e.g. "amex" The value provided here will be one of the values provided in the validCardTypes attribute.

For credit-card payments only.

The ExpirationDate is the expiration date provided to <Pay> in MMDD (two-digit month, two-digit date) format, e.g. "0522" Note: Expiration date is not PCI data, so it can be clearly visible.

For credit-card payments only.

The SecurityCode is the security code provided to <Pay> with all digits redacted, e.g. "xxxx"

For credit-card payments only.

The PaymentCardPostalCode is the postal code provided to <Pay>, e.g. "94109" Note: Postal Code is not PCI data, so it can be clearly visible.

For ach-debit payments only.

The BankAccountNumber is the bank account number provided by the caller/consumer. Only the last two digits will be unredacted, e.g. "*******92".

For ach-debit payments only.

The BankRoutingNumber is the bank routing number provided by the caller/consumer. <Pay> will return the full routing number provided by the caller/consumer, e.g. "121181976"

For ach-debit payments only.

The BankAccountType is the bank account type provided by the caller/consumer. Possible values are:

• consumer-checking
• consumer-savings
• commercial-checking

Back to attributes list

The paymentMethod attribute specifies 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.

1
<Response>
2
   <Pay paymentConnector=”Your_Connector_Name” paymentMethod=”ach-debit” />
3
</Response>
4

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.

Back to attributes list

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.

Back to attributes list

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.

Back to attributes list

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>.

Back to attributes list

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.

Back to attributes list

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.

Back to attributes list

The minPostalCodeLength attribute takes a positive integer to let <Pay> validate the length of the postalCode attribute. Users are expected to enter at least these many digits.

Back to attributes list

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.

For example, use chargeAmount="20.45" to process payment in the amount of $20.45.

The default currency can be overriden with currency attribute.

Back to attributes list

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

Back to attributes list

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-AU
  • en-CA
  • en-GB
  • en-IN
  • en-US

• Spanish:

  • es-ES
  • es-MX

• French:

  • fr-CA
  • fr-FR

• German:

  • de-DE

• Italian:

  • it-IT

For ACH, possible values are:

• English:

  • en-AU
  • en-CA
  • en-GB
  • en-IN
  • en-US

You can also further customize what the customer hears using the <Prompt> noun.

Back to attributes list

The paymentConnector attribute must contain the unique name corresponding to the Pay Connector installed in your Twilio Marketplace Account 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.

Back to attributes list

The tokenType attribute takes either one-time or reusable as value.

If you're using a Stripe Pay Connector, payment-method is also a possible value.

Back to attributes list

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.

Back to attributes list

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:

Back to attributes list

Collect payment data during a voice call and charge a specific amount.

1
const VoiceResponse = require('twilio').twiml.VoiceResponse;
2

3

4
const response = new VoiceResponse();
5
response.say('Calling Twilio Pay');
6
response.pay({
7
    chargeAmount: '20.45'
8
});
9

10
console.log(response.toString());

1
<?xml version="1.0" encoding="UTF-8"?>
2
<Response>
3
  <Say>Calling Twilio Pay</Say>   
4
  <Pay chargeAmount="20.45"/>
5
</Response>

Collect payment of a specific amount and specify a callback handler

1
const VoiceResponse = require('twilio').twiml.VoiceResponse;
2

3

4
const response = new VoiceResponse();
5
response.say('Calling Twilio Pay');
6
response.pay({
7
    chargeAmount: '20.45',
8
    action: 'https://enter-your-callback-function-url.twil.io/pay'
9
});
10

11
console.log(response.toString());

1
<?xml version="1.0" encoding="UTF-8"?>
2
<Response>
3
  <Say>Calling Twilio Pay</Say>
4
  <Pay chargeAmount="20.45" 
5
    action="https://enter-your-callback-function-url.twil.io/pay"/>
6
</Response>

1
const VoiceResponse = require('twilio').twiml.VoiceResponse;
2

3
const response = new VoiceResponse();
4
response.pay({tokenType: 'one-time', chargeAmount: '0'});
5

6
console.log(response.toString());

1
<?xml version="1.0" encoding="UTF-8"?>
2
<Response>
3
    <Pay tokenType="one-time" chargeAmount="0" />
4
</Response>