addGift

Provides a simple method for TeamRaiser participants to record gifts and pledges.

Client Servlet	Server Servlet	HTTP Methods Supported	Requires Authentication
CRTeamraiserAPI	SRTeamraiserAPI	POST	Yes.

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=addGift &api_key=value &v=value [ &auth=value ] [ &sso_auth_token=value ] [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ] &fr_id=value &first_name=value &gift_amount=value &last_name=value &payment_type=cash | check | later | credit | ach &team_id=value [ &billing_city=value ] [ &billing_country=value ] [ &billing_county=value ] [ &billing_first_name=value ] [ &billing_last_name=value ] [ &billing_middle_name=value ] [ &billing_state=value ] [ &billing_street1=value ] [ &billing_street2=value ] [ &billing_street3=value ] [ &billing_zip=value ] [ &check_number=value ] [ &city=value ] [ &country=value ] [ &county=value ] [ &credit_card_month=value ] [ &credit_card_number=value ] [ &credit_card_type=value ] [ &credit_card_verification_code=value ] [ &credit_card_year=value ] [ &donor_cons_id=value ] [ &email=value ] [ &gift_aid_status=value ] [ &gift_category_id=value ] [ &gift_display_name=value ] [ &gift_display_personal_page=value ] [ &middle_name=value ] [ &prof_suffix=Esq. | MD | JD | PhD | DO | DDS | DVM | PE ] [ &state=value ] [ &street1=value ] [ &street2=value ] [ &suffix=Sr. | Jr. | II | III | IV | V ] [ &team_gift=value ] [ &title=Mr. | Ms. | Mrs. | Miss | Dr. ] [ &zip=value ]

Server API Syntax

https://secure2.convio.net/organization/site/SRTeamraiserAPI?method=addGift & api_key =value & login_name =value & login_password =value & v =value [ & center_id =value ] [ & response_format =xml |json ] [ & source =value ] [ & sub_source =value ] [ & suppress_response_codes =value ] & fr_id =value & cons_id =value & email =value & first_name =value & gift_amount =value & last_name =value & payment_type =cash |check & team_id =value [ & anonymous =value ] [ & billing_city =value ] [ & billing_country =value ] [ & billing_county =value ] [ & billing_first_name =value ] [ & billing_last_name =value ] [ & billing_middle_name =value ] [ & billing_state =value ] [ & billing_street1 =value ] [ & billing_street2 =value ] [ & billing_street3 =value ] [ & billing_zip =value ] [ & check_number =value ] [ & city =value ] [ & confirmed =value ] [ & country =value ] [ & county =value ] [ & credit_card_month =value ] [ & credit_card_number =value ] [ & credit_card_type =value ] [ & credit_card_year =value ] [ & donor_cons_id =value ] [ & event_gift =value ] [ & gift_aid_status =value ] [ & gift_category_id =value ] [ & gift_date =value ] [ & gift_display_name =value ] [ & gift_display_personal_page =value ] [ & honor_gift_message_body =value ] [ & honor_gift_type =memorial |honor ] [ & honoree_first_name =value ] [ & honoree_last_name =value ] [ & honoree_title =value ] [ & middle_name =value ] [ & prof_suffix =Esq. |MD |JD |PhD |DO |DDS |DVM |PE ] [ & record_only =value ] [ & state =value ] [ & street1 =value ] [ & street2 =value ] [ & suffix =Sr. |Jr. |II |III |IV |V ] [ & team_gift =value ] [ & title =Mr. |Ms. |Mrs. |Miss |Dr. ] [ & zip =value ]

Usage Notes

This method allows participants to record unconfirmed offline TeamRaiser gifts on behalf of themselves or, if enabled, their teams. It also permits online processing of credit card transactions.

This method must be invoked over a secure channel by a logged in user.

Note: This method requires an authentication token.

Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

first_name

Required. First name

Type xsd:string.

gift_amount

Required. Gift amount

Type xsd:string.

last_name

Required. Last name

Type xsd:string.

payment_type

Required. The payment type.

Note: This field is case sensitive when payment types have been selected in the event setup.

Type xsd:string.

Default is cash.

Options are:

cash
check
later
credit
ach

team_id

Required. A unique team ID

Type xsd:nonNegativeInteger.

billing_city

Optional. Billing information: City

Type xsd:string.

billing_country

Optional. Billing information: Country

Type xsd:string.

billing_county

Optional. Billing information: County

Type xsd:string.

billing_first_name

Optional. Billing information: First name

Type xsd:string.

billing_last_name

Optional. Billing information: Last name

Type xsd:string.

billing_middle_name

Optional. Billing information: Middle name

Type xsd:string.

billing_state

Optional. Billing information: State

Type xsd:string.

billing_street1

Optional. Billing information: Street1

Type xsd:string.

billing_street2

Optional. Billing information: Street2

Type xsd:string.

billing_street3

Optional. Billing information: Street3

Type xsd:string.

billing_zip

Optional. Billing information: Zip/Postal code

Type xsd:string.

check_number

Optional. Check number

Type xsd:string.

city

Optional. City

Type xsd:string.

country

Optional. Country

Type xsd:string.

county

Optional. County

Type xsd:string.

credit_card_month

Optional. Credit card expiration month

Type xsd:string.

credit_card_number

Optional. Credit card number

Type xsd:string.

credit_card_type

Optional. Credit card type

Type xsd:string.

credit_card_verification_code

Optional. Credit card verification code

Type xsd:string.

credit_card_year

Optional. Credit card expiration year

Type xsd:string.

donor_cons_id

Optional. A unique constituent ID for the donor.

Type xsd:nonNegativeInteger.

email

Optional. E-Mail address

Type xsd:string.

gift_aid_status

Optional. Gift Aid status

Type xsd:nonNegativeInteger.

Default is 0.

gift_category_id

Optional. The gift category id

Type xsd:string.

gift_display_name

Optional. Gift display name

Type xsd:string.

gift_display_personal_page

Optional. Display gift on personal page

Type xsd:boolean.

middle_name

Optional. Middle name

Type xsd:string.

prof_suffix

Optional. Professional suffix

Type xsd:string.

Default is .

Options are:

Esq.
MD
JD
PhD
DO
DDS
DVM
PE

state

Optional. State

Type xsd:string.

street1

Optional. Street1

Type xsd:string.

street2

Optional. Street2

Type xsd:string.

suffix

Optional. Suffix

Type xsd:string.

Default is .

Options are:

team_gift

Optional. This should be set to 'TRUE' if the gift is a team gift.

Type xsd:boolean.

title

Optional. Title

Type xsd:string.

Default is .

Options are:

Mr.
Ms.
Mrs.
Miss
Dr.

zip

Optional. Postal or Zip code

Type xsd:string.

Server API Parameters

Common Server Parameters

See topic Common Parameters.

cons_id

Required. A unique constituent ID.

Type xsd:nonNegativeInteger.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

email

Required. E-Mail address

Type xsd:string.

first_name

Required. First name

Type xsd:string.

gift_amount

Required. Gift amount

Type xsd:string.

last_name

Required. Last name

Type xsd:string.

payment_type

Required. The payment type.

Note: This field is case sensitive when payment types have been selected in the event setup.

Type xsd:string.

Default is cash.

Options are:

cash
check

team_id

Required. A unique team ID

Type xsd:nonNegativeInteger.

anonymous

Optional. Display this gift as anonymous.

Type xsd:boolean.

billing_city

Optional. Billing information: City

Type xsd:string.

billing_country

Optional. Billing information: Country

Type xsd:string.

billing_county

Optional. Billing information: County

Type xsd:string.

billing_first_name

Optional. Billing information: First name

Type xsd:string.

billing_last_name

Optional. Billing information: Last name

Type xsd:string.

billing_middle_name

Optional. Billing information: Middle name

Type xsd:string.

billing_state

Optional. Billing information: State

Type xsd:string.

billing_street1

Optional. Billing information: Street1

Type xsd:string.

billing_street2

Optional. Billing information: Street2

Type xsd:string.

billing_street3

Optional. Billing information: Street3

Type xsd:string.

billing_zip

Optional. Billing information: Zip/Postal code

Type xsd:string.

check_number

Optional. Check number

Type xsd:string.

city

Optional. City

Type xsd:string.

confirmed

Optional. Whether or not the gift is confirmed.

Type xsd:boolean.

country

Optional. Country

Type xsd:string.

county

Optional. County

Type xsd:string.

credit_card_month

Optional. Credit card expiration month

Type xsd:string.

credit_card_number

Optional. Credit card number

Type xsd:string.

credit_card_type

Optional. Credit card type

Type xsd:string.

credit_card_year

Optional. Credit card expiration year

Type xsd:string.

donor_cons_id

Optional. A unique constituent ID for the donor.

Type xsd:nonNegativeInteger.

event_gift

Optional. This should be set to 'TRUE' if the gift is an event gift.

Type xsd:boolean.

gift_aid_status

Optional. Gift Aid status

Type xsd:nonNegativeInteger.

Default is 0.

gift_category_id

Optional. The gift category id

Type xsd:string.

gift_date

Optional. The date the gift was recorded (yyyy-MM-dd) or (yyyy-MM-dd HH:mm:ss)

Type xsd:string.

gift_display_name

Optional. Gift display name

Type xsd:string.

gift_display_personal_page

Optional. Display gift on personal page

Type xsd:boolean.

honor_gift_message_body

Optional. Honor gift message body. Applies to confirmed gifts only.

Type xsd:string.

honor_gift_type

Optional. Type of honor gift. Valid values are honor or memorial. Applies to confirmed gifts only.

Type xsd:string.

Default is .

Options are:

memorial
honor

honoree_first_name

Optional. Honoree first name. Applies to confirmed gifts only.

Type xsd:string.

honoree_last_name

Optional. Honoree last name. Applies to confirmed gifts only.

Type xsd:string.

honoree_title

Optional. Honoree title. Applies to confirmed gifts only.

Type xsd:string.

middle_name

Optional. Middle name

Type xsd:string.

prof_suffix

Optional. Professional suffix

Type xsd:string.

Default is .

Options are:

Esq.
MD
JD
PhD
DO
DDS
DVM
PE

record_only

Optional. Whether or not to record the transaction without processing it.

Type xsd:boolean.

Default is false.

state

Optional. State

Type xsd:string.

street1

Optional. Street1

Type xsd:string.

street2

Optional. Street2

Type xsd:string.

suffix

Optional. Suffix

Type xsd:string.

Default is .

Options are:

team_gift

Optional. This should be set to 'TRUE' if the gift is a team gift.

Type xsd:boolean.

title

Optional. Title

Type xsd:string.

Default is .

Options are:

Mr.
Ms.
Mrs.
Miss
Dr.

zip

Optional. Postal or Zip code

Type xsd:string.

Response

See topic HTTP Status Codes.

XML response

<?xml version="1.0" encoding="UTF-8"?>
<addGiftResponse 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">
  <gift>
    <acknowledged>false</acknowledged>
    <checkNumber xsi:nil="true"/>
    <confirmed>true</confirmed>
    <date>2023-01-24T16:03:37.236-06:00</date>
    <email>name1@example.com</email>
    <giftAmount>2501</giftAmount>
    <giftAidStatus>1</giftAidStatus>
    <giftMessage>Sample gift message.</giftMessage>
    <id>12001</id>
    <isRecurring>false</isRecurring>
    <name>
      <first>Jo</first>
      <middle>1</middle>
      <last>Public</last>
    </name>
    <paymentType>CREDIT</paymentType>
    <recognitionName>Sample recognition name 1</recognitionName>
  </gift>
</addGiftResponse>

JSON response

{"addGiftResponse":{
     "gift":{
          "date":"2023-01-24T16:03:37.237-06:00",
          "giftAmount":"2501",
          "checkNumber":null,
          "acknowledged":"false",
          "giftMessage":"Sample gift message.",
          "giftAidStatus":"1",
          "isRecurring":"false",
          "confirmed":"true",
          "paymentType":"CREDIT",
          "name":{
               "middle":"1",
               "last":"Public",
               "first":"Jo"
          },
          "id":"12001",
          "recognitionName":"Sample recognition name 1",
          "email":"name1@example.com"
          }
}}

Luminate Online

addGift

Client API Syntax

Server API Syntax

Usage Notes

Client API Parameters

Server API Parameters

Response

Leave a Comment