CRDonationAPI:finishDonation

servlet
methodThe method name
api_key An arbitrary value that must be passed when invoking the Convio Client and Server APIs. The value passed by the caller must match the value in the CONVIO_API_KEY site configuration parameter, which is unique for each Convio site.
v API version to invoke. Must be "1.0".
center_id The ID of a center (in a multi-center enabled site) to associate with the current session.
error_redirect Specifies a URL that the method should redirect to in the event of an error.
redirect Specifies a URL that the method should redirect to upon completion. Used in the absence the more specific ones that depend on whether the request succeeds or fails
response_format Used to specify either XML or JSON formatting for the response.
sign_redirects Specifies that redirect URLs should be signed with a timestamp and a hash of the query string arguments and a secret key.
source Text to associate with newly created constituent records to identify how or from where the record was added. This is recognized by all API methods even though most of them do not directly create constituent records. This is because the value is remembered in the visitor's current web browser session and used if they take any action, either via API call or browser interaction, that causes a new constituent record to be created.
sub_source Further detail to save with the "source" information.
success_redirect Specifies a URL that the method should redirect to upon successful completion.
suppress_response_codes Specifies that all responses will be returned with an HTTP 200 OK status code - even errors. This parameter exists to accommodate Flash and JavaScript applications running in browsers that intercept all non-200 responses. If used, it's then the job of the client to determine error states by parsing the response body.
billing.address.city The billing address of the credit card owner. If not supplied, defaults to donor.address.city.
billing.address.state The billing address of the credit card owner. If not supplied, defaults to donor.address.state.
billing.address.street1 The billing address of the credit card owner. If not supplied, defaults to donor.address.street1.
billing.address.zip The billing address of the credit card owner. If not supplied, defaults to donor.address.zip.
billing.name.first The billing name of the credit card owner. If not supplied, defaults to donor.name.first.
billing.name.last The billing name of the credit card owner. If not supplied, defaults to donor.name.last.
donor.email The donor's email address.
extproc The value designating which external payment processor to use.
form_id The ID of the donation form.
level_id The ID of the donation level.
ach_account ACH (debit) account number.
ach_account_type ACH account type (CHECKING/SAVINGS).
ach_bank ACH bank number (Canada).
ach_routing ACH routing number.
ach_transit ACH transit number (Canada).
additional_amount Donation amount in addition to level amount.
anonymous Whether to mark the donation as "anonymous".
billing.address.country The billing address of the credit card owner.
billing.address.street2 The billing address of the credit card owner.
billing.name.middle The billing name of the credit card owner.
billing.name.profSuffix The billing name of the credit card owner.
billing.name.suffix The billing name of the credit card owner.
billing.name.title The billing name of the credit card owner.
card_cvv Credit card Verification Value. This is usually required, depending on the configuration of the Convio site.
card_exp_date Credit card expiration date in MM/YYYY format. Use either this or both card_exp_date_month and card_exp_date_year.
card_exp_date_month Credit card expiration month (1-12).
card_exp_date_year Credit card expiration year.
card_number Credit card number. For security, this must be specified in the form -- it is an error to include it in the URL.
designated.X.amount The amount of a donation to designate to a designee. The "X" part of the parameter must be an integer used to correspond to designated.X.id or, in the case of write-in designations, designated.X.name and designated.X.contact. This allows multiple pairs of ID/amount for multiple designations.
designated.X.id The ID of a designee to which to designate all or part of a donation. The "X" part of the parameter must be an integer used to correspond to designated.X.amount. This allows multiple pairs of ID/amount for multiple designations.
designated_write_in.X.amount The amount of a donation to designate to a designee. The "X" part of the parameter must be an integer used to correspond to designated_write_in.X.name and designated_write_in.X.contact. This allows multiple pairs of ID/amount for multiple designations.
designated_write_in.X.contact The contact information of an organization to which to designate all or part of a donation. The "X" part of the parameter must be an integer used to correspond to designated_write_in.X.name and designated_write_in.X.amount. This allows multiple sets of name/contact/amount for multiple designations.
designated_write_in.X.name The name of an organization to which to designate all or part of a donation. The "X" part of the parameter must be an integer used to correspond to designated_write_in.X.contact and designated_write_in.X.amount. This allows multiple sets of name/contact/amount for multiple designations.
donor.address.city The donor's address.
donor.address.country The donor's address.
donor.address.state The donor's address.
donor.address.street1 The donor's address.
donor.address.street2 The donor's address.
donor.address.zip The donor's address.
donor.email_opt_in The donor's email opt-in selection.
donor.employer The donor's employer.
donor.name.first The donor's name.
donor.name.last The donor's name.
donor.name.middle The donor's name.
donor.name.profSuffix The donor's name.
donor.name.suffix The donor's name.
donor.name.title The donor's name.
donor.occupation The donor's occupation.
donor.phone The donor's phone number.
donor.phone_type The type of the donor's phone number .
ecard.copy_sender Whether to send a copy of the e-card to the sender.
ecard.id The unique ID of the pre-defined Convio e-card template to use.
ecard.message The message body of the e-card.
ecard.recipients The email addresses of intended e-card recipients (RFC-5322 format) e.g. 'John Doe<user1@host.org>, Jane Roe<user2@host.com>'.
ecard.send Whether or not to send an e-card recognizing the gift.
ecard.send_date Date to send the e-card (ISO 8601 format) e.g. '2009-12-31'.
ecard.subject The subject of the e-card.
gift_aid Gift aid status (UK Only).
installment.duration The duration of an installment plan donation, which is the number of payments that the donation is divided into. To make an installment plan donation, both installment.frequency and installment.duration must be specified.
installment.frequency The frequency of an installment plan donation, which is the interval between payments. To make an installment plan donation, both installment.frequency and installment.duration must be specified.
joint_donor.name.first The name for a joint donor.
joint_donor.name.last The name for a joint donor.
joint_donor.name.middle The name for a joint donor.
joint_donor.name.suffix The name for a joint donor.
joint_donor.name.title The name for a joint donor.
level_autorepeat Whether or not the "recurring gift" option on the Donation Level shadow form should be selected. Valid only for Level shadow forms on which a recurring gift option has been defined.
matching_eligible Whether or not the donation is eligible for a matching gift.
other_amount User specified donation amount.
premium_id Unique ID of premium.
premium_option Premium option.
remember_me Whether to set a log-in cookie.
send_receipt Whether to send a receipt email to the donor. The default behavior is to send a receipt.
send_registration_email If a new constituent record is created for the donor, this specifies whether to send a registration "welcome" email to the donor. The default behavior is to send it.
shipping.address.city Shipping address for premium.
shipping.address.country Shipping address for premium.
shipping.address.state Shipping address for premium.
shipping.address.street1 Shipping address for premium.
shipping.address.street2 Shipping address for premium.
shipping.address.zip Shipping address for premium.
shipping.email Email address of the recipient.
shipping.name.first Premium recipient's name.
shipping.name.last Premium recipient's name.
shipping.name.middle Premium recipient's name.
shipping.name.profSuffix Premium recipient's name.
shipping.name.suffix Premium recipient's name.
shipping.name.title Premium recipient's name.
shipping.phone Phone number of the recipient.
summary The type of donation summary to return. There are three options:'data' returns a structured list of information about every form field; 'page' returns the HTML content (within the "body" element) of the "Thank you" page shown after donations via web page; 'both' returns both types of summary.
sustaining.duration The duration of a sustaining donation, which is the interval between payments. Specify zero to indicate that the donation should repeat indefinitely. To make a sustaining donation, both sustaining.frequency and sustaining.duration must be specified.
sustaining.frequency The frequency of a sustaining donation, which is how often the donation is repeated. To make a sustaining donation, both sustaining.frequency and sustaining.duration must be specified.
teamraiser.message_to_participant If this donation is a TeamRaiser Gift, the body of the message to send to the TeamRaiser participant.
teamraiser.recognition_name If this donation is a TeamRaiser Gift, the recognition name.
teamraiser.show_gift_to_public If this donation is a TeamRaiser Gift, whether or not to the TeamRaiser gift is publicly visible.
tribute.honoree.deceased Whether the tribute honoree is deceased. If set, it overrides "tribute.type" by setting it to "memorial" if true (deceased) and "tribute" if false (not deceased).
tribute.honoree.name.first The first name of the person to honor with the tribute. Takes precedence over tribute.honoree.name.full.
tribute.honoree.name.full The full name of the person to honor with the tribute. Only used if the first and last names are not specified.
tribute.honoree.name.last The last name of the person to honor with the tribute. Takes precedence over tribute.honoree.name.full.
tribute.honoree.name.title The name title of the person to honor with the tribute.
tribute.message.body The body of the tribute notification message.
tribute.message.closing The closing of the tribute notification message.
tribute.message.include_amount Whether to include the donation amount in the tribute notification message.
tribute.message.signature The signature of the tribute notification message.
tribute.notify.address.city The address of the person to notify of the tribute.
tribute.notify.address.country The address of the person to notify of the tribute.
tribute.notify.address.state The address of the person to notify of the tribute.
tribute.notify.address.street1 The address of the person to notify of the tribute.
tribute.notify.address.street2 The address of the person to notify of the tribute.
tribute.notify.address.zip The address of the person to notify of the tribute.
tribute.notify.name.full The full name of the person to notify of the tribute.
tribute.notify.name.title The name title of the person to notify of the tribute.
tribute.type The type of tribute.
validate Whether to enforce validation of every field according to the specification in the ghost form ("true" or "false"). Some validation is always in effect, such as ensuring that the campaign, form, and level IDs reference published entities and that there is sufficient information to process the transaction.