API Library

updateRecurringCheckoutPaymentInfo

Updates credit card information for a recurring gift.

On this page

Client ServletServer ServletHTTP Methods SupportedRequires Authentication
CRRecurringAPISRRecurringAPIPOSTYes

Client API Syntax

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

Server API Syntax

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

Usage Notes

The client API call allows a logged-in constituent to update their billing information for a recurring gift. The server API call allows an administrator to update billing information for a recurring gift donor.

An example of call order and information flow for when a donor manages a recurring gift update is:

  1. authenticateUser - The constituent logs in.
  2. getRecurringGifts - The constituent searches for their recurring gifts and may select one. This response includes the gift id.
  3. getRecurringConfiguration - Based on the gift id, collect general information about what billing information may be modified for this gift. For example, can the constituent update the next payment date or switch the credit card on file?
  4. getRecurringGiftDetails - Based on the gift id, collect constituent specific information about the current billing payment settings. For example, the constituent is currently making a $10.00 payment every month with a billing street address of 123 Happy Land Drive.
  5. validateUpdateRecurringCheckoutPaymentInfo - After the constituent enters updated information in the fields, validate the fields prior to recording the changes in your database.
  6. updateRecurringCheckoutPaymentInfo - Record the updated values in your database.

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.
checkout_transaction_token
Required. Specifies the checkout transaction token 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_suffix
Optional. Specifies the billing suffix of a recurring gift.
Type xsd:string.
billing_title
Optional. Specifies the billing title 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.
checkout_transaction_token
Required. Specifies the checkout transaction token 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_suffix
Optional. Specifies the billing suffix of a recurring gift.
Type xsd:string.
billing_title
Optional. Specifies the billing title of a recurring gift.
Type xsd:string.
cons_id
Required. Specifies the ID of the constituent.
Type xsd:nonNegativeInteger.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<updateRecurringCheckoutPaymentInfoResponse
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>
</updateRecurringCheckoutPaymentInfoResponse>

JSON response

JSON 
{"updateRecurringCheckoutPaymentInfoResponse":{"updated":"true"}}