updateRecurringBankAccountInfo

Updates bank account ACH information for a recurring gift.

Client Servlet	Server Servlet	HTTP Methods Supported	Requires Authentication
CRRecurringAPI	SRRecurringAPI	POST	Yes.

Client API Syntax

https://secure2.convio.net/organization/site/CRRecurringAPI?method=updateRecurringBankAccountInfo &api_key=value &v=value &recurring_gift_id=value &billing_city=value &billing_first_name=value &billing_last_name=value &billing_state=value &billing_street1=value &billing_zip=value [ &ach_account_number=value ] [ &ach_account_type=value ] [ &ach_routing_number=value ] [ &ach_verify_number=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=updateRecurringBankAccountInfo & api_key =value & login_name =value & login_password =value & v =value & recurring_gift_id =value & billing_city =value & billing_first_name =value & billing_last_name =value & billing_state =value & billing_street1 =value & billing_zip =value [ & ach_account_number =value ] [ & ach_account_type =value ] [ & ach_routing_number =value ] [ & ach_verify_number =value ] [ & billing_country =value ] [ & billing_middle_name =value ] [ & billing_street2 =value ] [ & billing_suffix =value ] [ & billing_title =value ] & cons_id =value

Usage Notes

This method allows a logged-in user to update their bank account 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.

ach_account_number

Optional. Specifies the ACH account number of a recurring gift.

Type xsd:string.

ach_account_type

Optional. Specifies the ACH account type of a recurring gift.

Type xsd:string.

ach_routing_number

Optional. Specifies the ACH routing number of a recurring gift.

Type xsd:string.

ach_verify_number

Optional. Specifies the ACH verify number 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.

ach_account_number

Optional. Specifies the ACH account number of a recurring gift.

Type xsd:string.

ach_account_type

Optional. Specifies the ACH account type of a recurring gift.

Type xsd:string.

ach_routing_number

Optional. Specifies the ACH routing number of a recurring gift.

Type xsd:string.

ach_verify_number

Optional. Specifies the ACH verify number 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"?>
<updateRecurringBankAccountInfoResponse 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>
</updateRecurringBankAccountInfoResponse>

JSON response

{"updateRecurringBankAccountInfoResponse":{"updated":"true"}}

Luminate Online

updateRecurringBankAccountInfo

Client API Syntax

Server API Syntax

Usage Notes

Client API Parameters

Server API Parameters

Response

Leave a Comment