TWtwilio
Api20100401Payment

update an instance of payments with different phases of payment flows.

Changed on

update an instance of payments with different phases of payment flows.

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

Request

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

Path parameters

AccountSidstring required

The SID of the Account that will update the resource.

CallSidstring required

The SID of the call that will update the resource. This should be the same call sid that was used to create payments resource.

Sidstring required

The SID of Payments session that needs to be updated.

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 Update and Complete/Cancel POST requests.

Capture'payment-card-number' | 'expiration-date' | 'security-code' | 'postal-code' | 'bank-routing-number' | 'bank-account-number' | 'payment-card-number-matcher' | 'expiration-date-matcher' | 'security-code-matcher' | 'postal-code-matcher'

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, bank-account-number, or their -matcher variants for input confirmation when RequireMatchingInputs is enabled.

Status'complete' | 'cancel'

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 Pay Connector for processing.

Response

Accepted

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 expiration-date-matcher enum value to the request property

    • info

      added the new payment-card-number-matcher enum value to the request property

    • info

      added the new postal-code-matcher enum value to the request property

    • info

      added the new security-code-matcher enum value to the request property