| Client Servlet | Server Servlet | HTTP Methods Supported | Requires Authentication |
|---|---|---|---|
| None. | SRDonationAPI | POST | No. |
https://secure2.convio.net/organization/site/SRDonationAPI?method=offlineOrganizationGiftCheckout &api_key=value &v=value
[ ¢er_id=value ] [ &response_format=xml | json ] [ &source=value ] [ &sub_source=value ]
[ &suppress_response_codes=value ] &billing.name.first=value &billing.name.last=value &donor.email =value &form_id=value
&level_id=value &login_name=value &login_password=value &offline_payment_method=cash | check | credit
&org_gift_payment_method=cash | check | credit | ach [ &additional_amount=value ] [ &anonymous=value ]
[ &billing.address.city=value ] [ &billing.address.country=value ] [ &billing.address.county =value ]
[ &billing.address.state=value ] [ &billing.address.street1=value ] [ &billing.address.street2=value ]
[ &billing.address.street3=value ] [ &billing.address.zip=value ] [ &billing.name.middle=value ]
[ &billing.name.profSuffix=value ] [ &billing.name.suffix=value ] [ &billing.name.title =value ] [ &check_number=value ]
[ &designated.X.amount=value ] [ &designated.X.id=value ] [ &designated_write_in.X.amount=value ]
[ &designated_write_in.X.contact=value ] [ &designated_write_in.X.name=value ] [ &donor.address.city=value ]
[ &donor.address.country=value ] [ &donor.address.county=value ] [ &donor.address.state=value ]
[ &donor.address.street1=value ] [ &donor.address.street2=value ] [ &donor.address.street3 =value ]
[ &donor.address.zip =value ] [ &donor.cons_id=value ] [ &donor.email_opt_in=value ] [ &donor.employer=value ]
[ &donor.name.first=value ] [ &donor.name.last=value ] [ &donor.name.middle=value ] [ &donor.name.profSuffix=value ]
[ &donor.name.suffix=value ] [ &donor.name.title=value ] [ &donor.occupation=value ] [ &donor.phone=value ]
[ &donor.phone_type=home | work | other ] [ &gift_aid=value ] [ &joint_donor.name.first=value ]
[ &joint_donor.name.last=value ] [ &joint_donor.name.middle=value ] [ &joint_donor.name.suffix=value ]
[ &joint_donor.name.title=value ] [ &matching_eligible=value ] [ &org_gift_batch_id=value ]
[ &org_gift_do_not_display_amount=value ] [ &org_gift_gift_category_id=value ] [ &org_gift_note=value ]
[ &org_gift_recognition_name=value ] [ &organization_id=value ] [ &organization_name=value ]
[ &other_amount=value ] [ &premium_id=value ] [ &record_only=value ] [ &send_receipt=value ]
[ &send_registration_email=value ] [ &shipping.address.city=value ] [ &shipping.address.country=value ]
[ &shipping.address.county=value ] [ &shipping.address.state=value ] [ &shipping.address.street1=value ]
[ &shipping.address.street2=value ] [ &shipping.address.street3=value ] [ &shipping.address.zip=value ]
[ &shipping.email=value ] [ &shipping.name.first=value ] [ &shipping.name.last=value ] [ &shipping.name.middle=value ]
[ &shipping.name.profSuffix=value ] [ &shipping.name.suffix=value ] [ &shipping.name.title=value ]
[ &shipping.phone=value ] [ &transactiontoken=value ] [ &validate=value ]Transactions processed with your Blackbaud Payment Services accounts are automatically recorded in your database. This method is to record all other transactions not automatically recorded such as cash and check donations.
This method requires two donation forms. The first is your API donation form. The second is a shadow form used to validate data, associate donations with a Donation Campaign, and update your database. Each field on your API donation form must have a corresponding field on the shadow form. Link your API donation form to the shadow form with the required form_id
Designated giving allows donors to direct their donation to a focus within the greater mission. For example, a donor to a hospital may want to direct money to the pediatrics or cancer ward. A donor to a school may want to direct funds to the art, music, or STEM programs.
getDesignationTypes returns a list of designation types.
getDesignees returns a list of valid designees.
Gifts can be designated to one entity or multiple entities.
Allowing a single designee
When allowing a single designee you must include the Single Gift Designation data element in your standard donation form. See Donation Form Data Elements for more details.
When allowing only a single designee for a donation, include the single_designated_iddesignated.Xdesignated.xsingle_designated_id
Allowing multiple designees
When allowing multiple designees you must include the Designated Gift Donation Level data element in your standard donation form. See Donation Form Data Elements for more details.
When allowing a donor to assign specific donation amounts to multiple designees, you may add an Add a designee button that inserts fields for the designee selection, or write in designee information, and amount onto the form. The code for that button should start with an integer and be incremented for each additional designee. That integer identifies which designation is being referenced, and is the X value inserted in parameters such as designated.X.id
Designees may be pre-configured or write-in.
Pre-configured designee information is passed in a pair of parameters: designated.X.iddesignated.X.amount
Write-in designee information is passed in set of three parameters: designated_write_in.X.namedesignated_write_in.X.contactdesignated_write_in.X.amount
Common API errors return a common error response.
An XML example:
<errorResponse xmlns="http://convio.com/crm/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd">
<code>2</code>
<message>Incorrect API key. Verify that the value of the parameter api_key matches the value of the SDP CONVIO_API_KEY.</message>
</errorResponse>A JSON example:
{"errorResponse":{
"code": "2",
"message": "Incorrect API key. Verify that the value of the parameter api_key matches the value of the SDP CONVIO_API_KEY.",
}}For donation-specific errors, the "donationResponse" returns a list of the error messages.
An XML example:
<donationResponse xmlns="http://convio.com/crm/v1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd">
<errors>
<code>101</code>
<message>Error: There was a problem encountered while processing your donation.</message>
<reason>FIELD_VALIDATION</reason>
<pageError>There was a problem processing your request. Please see below.</pageError>
<fieldError>An email address is required.</fieldError>
<fieldError>Billing state or province is required.</fieldError>
<fieldError>Billing last name is required.</fieldError>
<fieldError>Billing zip or postal code is required.</fieldError>
<fieldError>Billing street address is required.</fieldError>
<fieldError>Billing first name is required.</fieldError>
<fieldError>Billing city is required.</fieldError>
</errors>
</donationResponse>A JSON example:
{"donationResponse":
{"errors":
{"code":"101",
"reason":"FIELD_VALIDATION",
"message":"Error: There was a problem encountered while processing your donation.",
"fieldError":["An email address is required.",
"Billing state or province is required.",
"Billing last name is required.",
"Billing zip or postal code is required.",
"Billing street address is required.",
"Billing first name is required.",
"Billing city is required."],
"pageError":"There was a problem processing your request. Please see below."}
}
}suppress_response_codesdonationResponse200 - OKdonationResponseSee topic Common Parameters.
donor.name.firstdonor.name.lastdonor.address.statedonor.address.street1donor.address.zip Optional. The donor's phone number.
Type xsd:string.
See Checkout API integration parameters for full details.
See topic HTTP Status Codes.
XML response<?xml version="1.0" encoding="UTF-8"?>
<donationResponse 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">
<donation>
<cons_id>1006789</cons_id>
<confirmation_code>0-0000-0-0000-0000</confirmation_code>
<date_time>2024-10-03T13:51:34.957+05:30</date_time>
<org_tax_id>00-0000000</org_tax_id>
<reward_points_earned>100</reward_points_earned>
<transaction_id>100101</transaction_id>
<amount>
<decimal>100</decimal>
<formatted>$100.00</formatted>
</amount>
<tax_deductible_amount>
<decimal>100</decimal>
<formatted>$100.00</formatted>
</tax_deductible_amount>
<value_of_goods>
<decimal>0</decimal>
<formatted>$0.00</formatted>
</value_of_goods>
<summary_data>
<field header="false">
<label>Transaction Date:</label>
<value>1/0/202</value>
<name>date_id</name>
</field>
<field header="true">
<label>Gift Information</label>
<value/>
<name>section-header</name>
</field>
<field header="false">
<label>Amount:</label>
<value>$100.00</value>
<name>level_id</name>
</field>
<field header="true">
<label>Billing Information</label>
<value/>
<name>section-header</name>
</field>
<field header="false">
<label>Billing First Name:</label>
<value>John</value>
<name>billing.name.first</name>
</field>
<field header="false">
<label>Billing Last Name:</label>
<value>Doe</value>
<name>billing.name.last</name>
</field>
<field header="true">
<label>Payment Information</label>
<value/>
<name>section-header</name>
</field>
<field header="false">
<label>Payment Type:</label>
<value>Credit Card</value>
<name>payment_type</name>
</field>
<field header="false">
<label>Credit Card Number:</label>
<value>***************1111</value>
<name>card_number</name>
</field>
</summary_data>
</donation>
</donationResponse>{
{
"donationResponse": {
"donation": {
"transaction_id": "100101",
"org_tax_id": "00-0000000",
"amount": {
"formatted": "$100.00",
"decimal": "100"
},
"confirmation_code": "0-0000-0-0000-0000",
"date_time": "2024-10-03T13:51:34.959+05:30",
"summary_data": {
"field": [
{
"name": "date_id",
"header": "false",
"label": "Transaction Date:",
"value": "1/0/202"
},
{
"name": "section-header",
"header": "true",
"label": "Gift Information",
"value": {}
},
{
"name": "level_id",
"header": "false",
"label": "Amount:",
"value": "$100.00"
},
{
"name": "section-header",
"header": "true",
"label": "Billing Information",
"value": {}
},
{
"name": "billing.name.first",
"header": "false",
"label": "Billing First Name:",
"value": "John"
},
{
"name": "billing.name.last",
"header": "false",
"label": "Billing Last Name:",
"value": "Doe"
},
{
"name": "section-header",
"header": "true",
"label": "Payment Information",
"value": {}
},
{
"name": "payment_type",
"header": "false",
"label": "Payment Type:",
"value": "Credit Card"
},
{
"name": "card_number",
"header": "false",
"label": "Credit Card Number:",
"value": "***************1111"
}
]
},
"reward_points_earned": "100",
"value_of_goods": {
"formatted": "$0.00",
"decimal": "0"
},
"cons_id": "1006789",
"tax_deductible_amount": {
"formatted": "$100.00",
"decimal": "100"
}
}
}
}