TWtwilio
Api20100401Payment

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

Changed on

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

post/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments.json

Request

  • Base URL
    https://api.twilio.com
  • URL
    https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments.json
  • Auth
    HTTP basic

Path parameters

AccountSidstring required

The SID of the Account that will create the resource.

CallSidstring required

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

Request body application/x-www-form-urlencoded

IdempotencyKeystring required

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.

StatusCallbackstring uri required

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

BankAccountType'consumer-checking' | 'consumer-savings' | 'commercial-checking'

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

ChargeAmountnumber

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.

Currencystring

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.

Descriptionstring

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.

Inputstring

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.

MinPostalCodeLengthinteger

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

Parameterunknown
PaymentConnectorstring

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

PaymentMethod'credit-card' | 'ach-debit'

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

PostalCodeboolean

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.

SecurityCodeboolean

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.

Timeoutinteger

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.

TokenType'one-time' | 'reusable' | 'payment-method'

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.

ValidCardTypesstring

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

RequireMatchingInputsstring

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.

Confirmation'true' | 'false'

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.

Response

Created

account_sidstring nullable

The SID of the Account that created the Payments resource.

call_sidstring nullable

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.

sidstring nullable

The SID of the Payments resource.

date_createdstring date-time-rfc-2822 nullable

The date and time in GMT that the resource was created specified in RFC 2822 format.

date_updatedstring date-time-rfc-2822 nullable

The date and time in GMT that the resource was last updated specified in RFC 2822 format.

uristring nullable

The URI of the resource, relative to https://api.twilio.com.

Changes

  • v2010a922c3aef8aaRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

  • v2010475b69553e34Revision changes
    • info

      the request property type was generalized from object to no type