--- title: "create an instance of payments. This will start a new payments session" method: POST path: "/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments.json" tags: ["Api20100401Payment"] --- # 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 create an instance of payments. This will start a new payments session ## Path parameters - `AccountSid` string, required - `CallSid` string, required ## Request body `application/x-www-form-urlencoded` - object - `IdempotencyKey` string, 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. - `StatusCallback` string, uri, required: 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) - `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`. - `ChargeAmount` number: 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. - `Currency` string: 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. - `Description` string: 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. - `Input` string: 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. - `MinPostalCodeLength` integer: A positive integer that is used to validate the length of the `PostalCode` inputted by the user. User must enter this many digits. - `Parameter` unknown - `PaymentConnector` string: This is the unique name corresponding to the Pay Connector installed in the Twilio Add-ons. Learn more about [ Connectors](https://www.twilio.com/console/voice/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`. - `PostalCode` boolean: 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`. - `SecurityCode` boolean: 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`. - `Timeout` integer: The number of seconds that 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. - `ValidCardTypes` string: Credit card types separated by space that Pay should accept. The default value is `visa mastercard amex` - `RequireMatchingInputs` string: 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 `201` Created - ApiV2010AccountCallPayments - `account_sid` string, nullable: The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Payments resource. - `call_sid` string, nullable: 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. - `sid` string, nullable: The SID of the Payments resource. - `date_created` string, date-time-rfc-2822, nullable: The date and time in GMT that the resource was created specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. - `date_updated` string, date-time-rfc-2822, nullable: The date and time in GMT that the resource was last updated specified in [RFC 2822](https://www.ietf.org/rfc/rfc2822.txt) format. - `uri` string, nullable: The URI of the resource, relative to `https://api.twilio.com`. ## Changes - **2026-03-10** (v2010) `a922c3aef8aa`: 2 info - added the new optional request property `Confirmation` - added the new optional request property `RequireMatchingInputs` - **2025-07-03** (v2010) `475b69553e34`: 1 info - the `Parameter` request property type was generalized from `object` to no type - **2025-03-11** (v2010) `26011eceee1e`: 1 breaking - the `Parameter` request property type changed from no type to `object` - **2024-04-04** (v2010) `446c78a04b46`: 1 info - added the new `payment-method` enum value to the request property `TokenType` [Operation history](https://skmtc.dev/twilio/apis/api-v2010/changes/2010-04-01/Accounts/:AccountSid/Calls/:CallSid/Payments.json/post.md) --- [API](https://skmtc.dev/twilio/apis/api-v2010.md) - [All operations](https://skmtc.dev/twilio/apis/api-v2010/llms.txt) - [OpenAPI document](https://skmtc.dev/twilio/apis/api-v2010/revisions/bfdf249a1298?raw)