Update a credit card payment method

Legacy API Reference

Update a credit card payment method

Request

Updates an existing credit card payment method.

Path

payment-method-idstringrequired

Unique ID of the payment method to update.

Accept-Encodingstring

Include the Accept-Encoding: gzip header to compress responses as a gzipped file. It can significantly reduce the bandwidth required for a response.

If specified, Zuora automatically compresses responses that contain over 1000 bytes of data, and the response contains a Content-Encoding header with the compression algorithm so that your client can decompress it.

Content-Encodingstring

Include the Content-Encoding: gzip header to compress a request. With this header specified, you should upload a gzipped file for the request payload instead of sending the JSON payload.

Authorizationstring

The value is in the Bearer {token} format where {token} is a valid OAuth token generated by calling Create an OAuth token.

Zuora-Track-Idstring, <= 64 characters

A custom identifier for tracing the API call. If you set a value for this header, Zuora returns the same value in the response headers. This header enables you to associate your system process identifiers with Zuora API calls, to assist with troubleshooting in the event of an issue.

The value of this field must use the US-ASCII character set and must not include any of the following characters: colon (:), semicolon (;), double quote ("), and quote (').

Zuora-Entity-Idsstring

An entity ID. If you have Zuora Multi-entity enabled and the OAuth token is valid for more than one entity, you must use this header to specify which entity to perform the operation in. If the OAuth token is only valid for a single entity, or you do not have Zuora Multi-entity enabled, you do not need to set this header.

Bodyapplication/jsonrequired

addressLine1string

First address line, 255 characters or less.

addressLine2string

Second address line, 255 characters or less.

cardHolderNamestring

The full name as it appears on the card, e.g., "John J Smith", 50 characters or less.

Example:"Amy Lawrence"

citystring

City, 40 characters or less.

countrystring

Country; must be a valid country name or abbreviation.

defaultPaymentMethodboolean

Specify "true" to make this card the default payment method; otherwise, omit this parameter to keep the current default payment method.

emailstring

Card holder's email address, 80 characters or less.

expirationMonthinteger

One or two digit(s) expiration month (1-12).

expirationYearinteger

Four-digit expiration year.

gatewayOptionsobject

The field used to pass gateway-specific parameters and parameter values.

Zuora sends all the information that you specified to the gateway. If you specify any unsupported gateway option parameters, they will be ignored without error prompts.

numConsecutiveFailuresinteger, (int32), [ 0 .. 100 ]

The number of consecutive failed payments for this payment method. It is reset to 0 upon successful payment.

phonestring

Phone number, 40 characters or less.

securityCodestring

The CVV or CVV2 security code for the credit card or debit card. Only required if changing expirationMonth, expirationYear, or cardHolderName. To ensure PCI compliance, this value isn't stored and can't be queried.

statestring

State; must be a valid state name or 2-character abbreviation.

zipCodestring

Zip code, 20 characters or less.

property name*anyadditional property

Custom fields of the payment method. The name of each custom field has the form customField__c. Custom field names are case sensitive. See Manage Custom Fields for more information.

{
  "cardHolderName": "Amy Lawrence"
}

Responses

Headers

Content-Encodingstring

This header is returned if you specify the Accept-Encoding: gzip request header and the response contains over 1000 bytes of data.

Note that only the following MIME types support gzipped responses:

application/json
application/xml
text/html
text/csv
text/plain

RateLimit-Limitstring

The request limit quota for the time window closest to exhaustion. See rate limits for more information.

RateLimit-Remainingnumber

The number of requests remaining in the time window closest to quota exhaustion. See rate limits for more information.

RateLimit-Resetnumber

The number of seconds until the quota resets for the time window closest to quota exhaustion. See rate limits for more information.

Zuora-Request-Idstring, = 36 characters

The Zuora internal identifier of the API call. You cannot control the value of this header.

Zuora-Track-Idstring, <= 64 characters

A custom identifier for tracing the API call. If you specified a tracing identifier in the request headers, Zuora returns the same tracing identifier. Otherwise, Zuora does not set this header.

Bodyapplication/json

paymentMethodIdstring

ID of the updated payment method.

successboolean

Returns true if the request was processed successfully.

Response

{
  "paymentMethodId": "2c92c8f83dcbd8b1013dcce1d6a600ce",
  "success": true
}