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

3 parameters · 4 body fields

AccountSidstringrequired

The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that will update the resource.

CallSidstringrequired

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

Sidstringrequired

The SID of Payments session that needs to be updated.

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 [Update](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-update) and [Complete/Cancel](https://www.twilio.com/docs/voice/api/payment-resource#statuscallback-cancelcomplete) POST requests.

Capturestringoptional

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.

Allowed:payment-card-numberexpiration-datesecurity-codepostal-codebank-routing-numberbank-account-numberpayment-card-number-matcherexpiration-date-matchersecurity-code-matcherpostal-code-matcher

Statusstringoptional

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.

Allowed:completecancel

1 status code

202Accepted

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`.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: {
    username: process.env.API_USER,
    password: process.env.API_PASS,
  },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.payments.create({
  accountSid: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  callSid: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
  sidJson: "example",
  idempotencyKey: "example",
  statusCallback: "example",
});

{
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "call_sid": "CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "date_created": "Wed, 18 Dec 2019 20:02:01 +0000",
  "date_updated": "Wed, 18 Dec 2019 20:02:01 +0000",
  "sid": "PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "uri": "/2010-04-01/Accounts/ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Calls/CAaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Payments/PKaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa.json"
}

Request

Response