Payment Resource

Example JSON API response

Starting a Pay session

StatusCallback

Provide an absolute or relative URL for this parameter. Twilio Pay will make a POST request to this URL with the whenever this API is called. The POST request will have the following parameters.

Parameter	Description
AccountSid	The unique identifier of the Account responsible for this pay session
CallSid	The unique identifier for the call associated with the pay session. CallSid will always refer to the parent leg of a two-leg call
Sid	The unique identifier of the current Pay session
DateCreated	The date when the Pay session was started
BankAccountType	If ach-debit PaymentMethod is used, the Bank Account Type provided by the caller and entered by the agent
ChargeAmount	If not tokenizing (i.e. charge amount specified and greater than 0), the amount to charge the payment method
PaymentConnector	The unique name of Payment Connector corresponding to the Payment Gateway Connector installed in the Twilio Add-ons
PaymentMethod	Ach-debit or credit-card
TokenType	One-time or reusable if charge amount not specified

All StatusCallback requests will contain these fields. Additional StatusCallback values can be found during the Update and Complete/Cancel APIs

Update a Pay session

post

https://api.twilio.com/2010-04-01/Accounts/{AccountSid}/Calls/{CallSid}/Payments/{Sid}.json

Parameters

Parameters in REST API format
`account_sid` Path	post sid<AC> Not PII The SID of the Account that will update the resource.
`call_sid` Path	post sid<CA> Not PII The SID of the call that will update the resource. This should be the same call sid that was used to create payments resource.
`sid` Path	post sid<PK> Not PII The SID of Payments session that needs to be updated.
`idempotency_key` Required	post string Not PII 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.
`status_callback` Required	post url Not PII Provide an absolute or relative URL to receive status updates regarding your Pay session. Read more about the Update and Complete/Cancel POST requests.
`capture` Optional	post ienum:capture Not PII The piece of payment information that you wish the caller to enter. Must be one of `payment-card-number`, `expiration-date`, `security-code`, `postal-code`, `bank-routing-number`, or `bank-account-number`.
`status` Optional	post ienum:status Not PII Indicates whether the current payment session should be cancelled or completed. When `cancel` the payment session is cancelled. When `complete`, Twilio sends the payment information to the selected connector for processing.

Example 1

Example JSON API response

Make this API request for each piece of payment information that you wish

Update a Pay session

Make this API request for each piece of payment information that you wish

StatusCallback (Update)

Provide an absolute or relative URL for this parameter. Twilio Pay will make a POST request to this URL with the whenever the Update API is called and whenever there is an update to the Parameter being captured. The POST request will contain all of common StatusCallback parameters as well as these additional parameters:

Parameter	Description
DateUpdated	The date when the Pay session was last updated
BankAccountNumber	If the `ach-debit` PaymentMethod is used, the Bank Account Number entered by the caller. Twilio will only return the last 2 digits. For example, if the Bank Account Number is 508862392, then Pay will return `BankAccountNumber=*******92`
BankRoutingNumber	If the `ach-debit` paymentMethod used, The Bank Routing Number provided by the caller. Twilio will return the full routing number entered. For example, if caller enters 121181976 as their Bank Routing Number provided, then Pay will return `BankRoutingNumber=121181976`
Capture	The piece of payment information that Pay was expecting
ChargeAmount	If not tokenizing (i.e. charge amount specified and greater than 0), the amount to charge the payment method
ErrorType	The full list of error types is visible here.
ExpirationDate	If the `PaymentMethod` is credit card, the expiration date that is input by the caller. For example, `ExpirationDate=0522` Note: Expiration date is not PCI data, so it can be clearly visible.
PartialResult	`"true"` if DTMF is still being captured and `"false"` once all the digits of the piece of payment information being captured have been entered.
PaymentCardNumber	If `credit-card` `paymentMethod` is used, the card number input by the caller with only the last 4 digits visible. For example, `PaymentCardNumber=xxxx-xxxxxx-x4001`
PaymentCardPostalCode	If `credit-card` `paymentMethod` is used, the postal code inout by the caller or by the agent. For example, `PaymentCardPostalCode=94109` Note: Postal Code is not PCI data, so it can be clearly visible.
PaymentCardType	If `credit-card` `paymentMethod` used, the type of card input by the caller. For example, `PaymentCardType=amex` The value provided here will be one of the values provided with the `cardTypes` parameter in the Start API.
Required	The pieces of payment information that remain to be collected. For example, if postal code and security code are false and credit card number has already been input, then `Required=ExpirationDate`
SecurityCode	If `credit-card` `paymentMethod` is used, the security code input by the caller with all digits redacted. For example, `SecurityCode=xxx`

Example 2

Example JSON API response

Complete a Pay Session

Example 3