REST

updateRecurringCreditCardInfo

Updates credit card information for a recurring gift.

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
CRRecurringAPISRRecurringAPIPOSTYes.

Client API Syntax

https://secure2.convio.net/organization/site/CRRecurringAPI?method=updateRecurringCreditCardInfo
&recurring_gift_id=value &billing_city=value &billing_first_name=value &billing_last_name=value &billing_state=value
&billing_street1=value &billing_zip=value [ &billing_country=value ] [ &billing_middle_name=value ]
[ &billing_street2=value ] [ &billing_suffix=value ] [ &billing_title=value ] [ &credit_card_cvv=value ]
[ &credit_card_exp_month=value ] [ &credit_card_exp_year=value ] [ &credit_card_number=value ]
[ &auth=value ] [ &sso_auth_token=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SRRecurringAPI?method=updateRecurringCreditCardInfo
&recurring_gift_id=value &billing_city=value &billing_first_name=value &billing_last_name=value &billing_state=value
&billing_street1=value &billing_zip=value [ &billing_country=value ] [ &billing_middle_name=value ]
[ &billing_street2=value ] [ &billing_suffix=value ] [ &billing_title=value ] [ &credit_card_cvv=value ]
[ &credit_card_exp_month=value ] [ &credit_card_exp_year=value ] [ &credit_card_number=value ] & cons_id =value

Usage Notes

Allow a logged-in user to update their credit card information for a recurring gift.

You may use the following methods to allow a logged-in user to manage their recurring gifts themselves via the Client API or to manage recurring gifts as an administrator via the Server API:

Client API Parameters

Common Client Parameters
See topic Common Parameters.
recurring_gift_id
Required. Specifies the ID of the recurring gift to retrieve.
Type xsd:nonNegativeInteger.
billing_city
Required. Specifies the billing city of a recurring gift.
Type xsd:string.
billing_first_name
Required. Specifies the billing first name of a recurring gift.
Type xsd:string.
billing_last_name
Required. Specifies the billing last name of a recurring gift.
Type xsd:string.
billing_state
Required. Specifies the billing state of a recurring gift.
Type xsd:string.
billing_street1
Required. Specifies the billing street1 of a recurring gift.
Type xsd:string.
billing_zip
Required. Specifies the billing zip of a recurring gift.
Type xsd:string.
billing_country
Optional. Specifies the billing country of a recurring gift.
Type xsd:string.
billing_middle_name
Optional. Specifies the billing first name of a recurring gift.
Type xsd:string.
billing_street2
Optional. Specifies the billing street2 of a recurring gift.
Type xsd:string.
billing.name.suffix
Optional. The billing name of the credit card owner.
Type xsd:string.
billing.name.title
Optional. The billing name of the credit card owner.
Type xsd:string.
credit_card_cvv
Optional. Specifies the credit card CVV of a recurring gift.
Type xsd:string.
credit_card_exp_month
Optional. Specifies the credit card expiration month of a recurring gift.
Type xsd:nonNegInteger.
credit_card_exp_year
Optional. Specifies the credit card expiration year of a recurring gift.
Type xsd:nonNegInteger.
credit_card_number
Optional. Specifies the credit card number of a recurring gift.
Type xsd:string.

Server API Parameters

Common Server Parameters
See topic Common Parameters.
recurring_gift_id
Required. Specifies the ID of the recurring gift to retrieve.
Type xsd:nonNegativeInteger.
billing_city
Required. Specifies the billing city of a recurring gift.
Type xsd:string.
billing_first_name
Required. Specifies the billing first name of a recurring gift.
Type xsd:string.
billing_last_name
Required. Specifies the billing last name of a recurring gift.
Type xsd:string.
billing_state
Required. Specifies the billing state of a recurring gift.
Type xsd:string.
billing_street1
Required. Specifies the billing street1 of a recurring gift.
Type xsd:string.
billing_zip
Required. Specifies the billing zip of a recurring gift.
Type xsd:string.
cons_id
Required. Specifies the ID of the constituent.
Type xsd:nonNegativeInteger.
billing_country
Optional. Specifies the billing country of a recurring gift.
Type xsd:string.
billing_middle_name
Optional. Specifies the billing first name of a recurring gift.
Type xsd:string.
billing_street2
Optional. Specifies the billing street2 of a recurring gift.
Type xsd:string.
billing.name.suffix
Optional. The billing name of the credit card owner.
Type xsd:string.
billing.name.title
Optional. The billing name of the credit card owner.
Type xsd:string.
credit_card_cvv
Optional. Specifies the credit card CVV of a recurring gift.
Type xsd:string.
credit_card_exp_month
Optional. Specifies the credit card expiration month of a recurring gift.
Type xsd:nonNegInteger.
credit_card_exp_year
Optional. Specifies the credit card expiration year of a recurring gift.
Type xsd:nonNegInteger.
credit_card_number
Optional. Specifies the credit card number of a recurring gift.
Type xsd:string.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8"?>
<updateRecurringCreditCardInfoResponse
  xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd"
  xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <updated>true</updated>
</updateRecurringCreditCardInfoResponse>
JSON response
JSON 
{"updateRecurringCreditCardInfoResponse":{"updated":"true"}}