Sample - Twilio API
POST/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments.json

create an instance of payments. This will start a new payments session

create an instance of payments. This will start a new payments session

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters · 18 body fields
AccountSidstringrequired
The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will create the resource.
CallSidstringrequired
The SID of the call that will create the resource. Call leg associated with this sid is expected to provide payment information thru DTMF.
IdempotencyKeystringrequired
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.
StatusCallbackstringrequired
Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the [expected StatusCallback values](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback)
BankAccountTypestringoptional
Type of bank account if payment source is ACH. One of `consumer-checking`, `consumer-savings`, or `commercial-checking`. The default value is `consumer-checking`.
Allowed:consumer-checkingconsumer-savingscommercial-checking
ChargeAmountnumberoptional
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.
Currencystringoptional
The currency of the `charge_amount`, formatted as [ISO 4127](http://www.iso.org/iso/home/standards/currency_codes.htm) format. The default value is `USD` and all values allowed from the Pay Connector are accepted.
Descriptionstringoptional
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.
Inputstringoptional
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.
MinPostalCodeLengthintegeroptional
A positive integer that is used to validate the length of the `PostalCode` inputted by the user. User must enter this many digits.
Parameterunknownoptional
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 <Pay> Connector. [Read more](https://www.twilio.com/console/voice/pay-connectors).
PaymentConnectorstringoptional
This is the unique name corresponding to the Pay Connector installed in the Twilio Add-ons. Learn more about [<Pay> Connectors](https://www.twilio.com/console/voice/pay-connectors). The default value is `Default`.
PaymentMethodstringoptional
Type of payment being captured. One of `credit-card` or `ach-debit`. The default value is `credit-card`.
Allowed:credit-cardach-debit
PostalCodebooleanoptional
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`.
SecurityCodebooleanoptional
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`.
Timeoutintegeroptional
The number of seconds that <Pay> 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`.
TokenTypestringoptional
Indicates whether the payment method should be tokenized as a `one-time`, `reusable`, or `payment-method` 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.
Allowed:one-timereusablepayment-method
ValidCardTypesstringoptional
Credit card types separated by space that Pay should accept. The default value is `visa mastercard amex`
RequireMatchingInputsstringoptional
A comma-separated list of payment information fields that require the caller to enter the same value twice for confirmation. Supported values are `payment-card-number`, `expiration-date`, `security-code`, and `postal-code`.
Confirmationstringoptional
Whether to prompt the caller to confirm their payment information before submitting to the payment gateway. If `true`, the caller will hear the last 4 digits of their card or account number and must press 1 to confirm or 2 to cancel. Default is `false`.
Allowed:truefalse

1 status code
201Created
account_sidstringoptional
The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Payments resource.
call_sidstringoptional
The SID of the [Call](https://www.twilio.com/docs/voice/api/call-resource) the Payments resource is associated with. This will refer to the call sid that is producing the payment card (credit/ACH) information thru DTMF.
sidstringoptional
The SID of the Payments resource.
date_createdstringoptional
The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
date_updatedstringoptional
The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format.
uristringoptional
The URI of the resource, relative to `https://api.twilio.com`.