MemoryGivingAPIWebService Web Service

MemoryGivingAPIWebService

Click here for a complete list of operations.

makeDonation

Please supply the following fields:
Parameter Type Mandatory Default Description
api_key string Mandatory Your unique code to access this operation.
user_id int Optional * Mandatory if donation_online is false.
The Memory Giving User ID of the person performing this operation.
tribute_id int Mandatory Unique ID that identifies each fund page.
donation_online bool Optional true Indicates whether or not this donation has been made online or offline. Online donations will need to be processed by WordPay in order to appear in the list of donations.
anonymous bool Optional false Indicates whether or not the donor details appear anonymously on fund page.
anonymous_report bool Optional false Indicates whether or not the donor details appear anonymously within closed reports to next of kin, funeral director & charity.
display_name string Mandatory The name displayed when anonymous is supplied as false. Usually the donors name, but can be used to describe a group of donors e.g. Smith family.
message string Optional A message from the donor to the deceased or the deceased’s family. When anonymous is supplied as true, message will be hidden on fund page. When anonymous_report is supplied as true, message will be hidden in reports to NOK.
email string Optional * Mandatory if donation_online is true.
Donor email address.
ip string Optional * Mandatory if donation_online is true.
Donor IP address. Used with WorldPay as a security measure against fraudulent transactions.
donation double Mandatory Donation amount in GBP.
hide_donation_value bool Optional false Indicates whether or not the donation value should be hidden.
gift_aid bool Optional false * Mandatory if donation_online is true.
If you specify this parameter with a value of true, you must also specify the first_name, last_name, address1, town & post_code parameters.
first_name string Optional * Mandatory if gift_aid is true.
Donor first name.
last_name string Optional * Mandatory if gift_aid is true.
Donor last name.
address1 string Optional * Mandatory if gift_aid is true.
Donor address line 1.
address2 string Optional Donor address line 2.
town string Optional * Mandatory if gift_aid is true.
Donor address town.
overseas bool Optional false If you omit this parameter or specify it with a value of false, you must also specify the post_code parameter.
post_code string Optional * Mandatory if gift_aid is true & overseas is false.
Donor address post code.
payment_type string Optional * Mandatory if donation_online is true.
Must be one of the following:
accept_t_c bool Optional false * Mandatory if donation_online is true.
Indicates whether the donor has accepted the terms & conditions. This value must be true in order to submit a donation.
successfulReturnURL string Optional The return URL from WorldPay Payment site after a successful transaction. Must include the scheme, eg. http:// . If you omit this parameter, the return url will be the Memory Giving fund page url. Only applicable to online donations.
unsuccessfulReturnURL string Optional The return URL from WorldPay Payment site after an unsuccessful transaction. Must include the scheme, eg. http:// .If you omit this parameter, the return url will be the same as the successfulReturnURL. Only applicable to online donations.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /admin/api/WebService.asmx HTTP/1.1
Host: memorygiving.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://memorygiving.com/admin/api/WebService.asmx/makeDonation"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <makeDonation xmlns="http://memorygiving.com/admin/api/WebService.asmx">
      <api_key>string</api_key>
    </makeDonation>
  </soap:Body>
</soap:Envelope>

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <makeDonationResponse xmlns="http://memorygiving.com/admin/api/WebService.asmx">
      <makeDonationResult>
        <Data>
          <id>int</id>
          <tribute_id>int</tribute_id>
          <anonymous>boolean</anonymous>
          <display_name>string</display_name>
          <message>string</message>
          <donation>double</donation>
          <donation_online>boolean</donation_online>
          <hide_donation_value>boolean</hide_donation_value>
          <gift_aid>boolean</gift_aid>
          <date_donation>dateTime</date_donation>
          <value_gift_aid>double</value_gift_aid>
          <PaymentGatewayURL>string</PaymentGatewayURL>
          <CurrencyDonation>string</CurrencyDonation>
          <CurrencyGiftAid>string</CurrencyGiftAid>
        </Data>
        <Error>
          <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
          <InternalMessage>string</InternalMessage>
          <FriendlyMessage>string</FriendlyMessage>
        </Error>
      </makeDonationResult>
    </makeDonationResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /admin/api/WebService.asmx HTTP/1.1
Host: memorygiving.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <makeDonation xmlns="http://memorygiving.com/admin/api/WebService.asmx">
      <api_key>string</api_key>
    </makeDonation>
  </soap12:Body>
</soap12:Envelope>

HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <makeDonationResponse xmlns="http://memorygiving.com/admin/api/WebService.asmx">
      <makeDonationResult>
        <Data>
          <id>int</id>
          <tribute_id>int</tribute_id>
          <anonymous>boolean</anonymous>
          <display_name>string</display_name>
          <message>string</message>
          <donation>double</donation>
          <donation_online>boolean</donation_online>
          <hide_donation_value>boolean</hide_donation_value>
          <gift_aid>boolean</gift_aid>
          <date_donation>dateTime</date_donation>
          <value_gift_aid>double</value_gift_aid>
          <PaymentGatewayURL>string</PaymentGatewayURL>
          <CurrencyDonation>string</CurrencyDonation>
          <CurrencyGiftAid>string</CurrencyGiftAid>
        </Data>
        <Error>
          <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
          <InternalMessage>string</InternalMessage>
          <FriendlyMessage>string</FriendlyMessage>
        </Error>
      </makeDonationResult>
    </makeDonationResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /admin/api/WebService.asmx/makeDonation?api_key=string HTTP/1.1
Host: memorygiving.com

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ResponseOfDonation xmlns="http://memorygiving.com/admin/api/WebService.asmx">
  <Data>
    <id>int</id>
    <tribute_id>int</tribute_id>
    <anonymous>boolean</anonymous>
    <display_name>string</display_name>
    <message>string</message>
    <donation>double</donation>
    <donation_online>boolean</donation_online>
    <hide_donation_value>boolean</hide_donation_value>
    <gift_aid>boolean</gift_aid>
    <date_donation>dateTime</date_donation>
    <value_gift_aid>double</value_gift_aid>
    <PaymentGatewayURL>string</PaymentGatewayURL>
    <CurrencyDonation>string</CurrencyDonation>
    <CurrencyGiftAid>string</CurrencyGiftAid>
  </Data>
  <Error>
    <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
    <InternalMessage>string</InternalMessage>
    <FriendlyMessage>string</FriendlyMessage>
  </Error>
</ResponseOfDonation>

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /admin/api/WebService.asmx/makeDonation HTTP/1.1
Host: memorygiving.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

api_key=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ResponseOfDonation xmlns="http://memorygiving.com/admin/api/WebService.asmx">
  <Data>
    <id>int</id>
    <tribute_id>int</tribute_id>
    <anonymous>boolean</anonymous>
    <display_name>string</display_name>
    <message>string</message>
    <donation>double</donation>
    <donation_online>boolean</donation_online>
    <hide_donation_value>boolean</hide_donation_value>
    <gift_aid>boolean</gift_aid>
    <date_donation>dateTime</date_donation>
    <value_gift_aid>double</value_gift_aid>
    <PaymentGatewayURL>string</PaymentGatewayURL>
    <CurrencyDonation>string</CurrencyDonation>
    <CurrencyGiftAid>string</CurrencyGiftAid>
  </Data>
  <Error>
    <Severity>ValidationWarning or ValidationError or Warning or Fatal</Severity>
    <InternalMessage>string</InternalMessage>
    <FriendlyMessage>string</FriendlyMessage>
  </Error>
</ResponseOfDonation>

Parameter	Type	Mandatory	Default	Description
api_key	string	Mandatory		Your unique code to access this operation.
user_id	int	Optional		* Mandatory if donation_online is false. The Memory Giving User ID of the person performing this operation.
tribute_id	int	Mandatory		Unique ID that identifies each fund page.
donation_online	bool	Optional	true	Indicates whether or not this donation has been made online or offline. Online donations will need to be processed by WordPay in order to appear in the list of donations.
anonymous	bool	Optional	false	Indicates whether or not the donor details appear anonymously on fund page.
anonymous_report	bool	Optional	false	Indicates whether or not the donor details appear anonymously within closed reports to next of kin, funeral director & charity.
display_name	string	Mandatory		The name displayed when anonymous is supplied as false. Usually the donors name, but can be used to describe a group of donors e.g. Smith family.
message	string	Optional		A message from the donor to the deceased or the deceased’s family. When anonymous is supplied as true, message will be hidden on fund page. When anonymous_report is supplied as true, message will be hidden in reports to NOK.
email	string	Optional		* Mandatory if donation_online is true. Donor email address.
ip	string	Optional		* Mandatory if donation_online is true. Donor IP address. Used with WorldPay as a security measure against fraudulent transactions.
donation	double	Mandatory		Donation amount in GBP.
hide_donation_value	bool	Optional	false	Indicates whether or not the donation value should be hidden.
gift_aid	bool	Optional	false	* Mandatory if donation_online is true. If you specify this parameter with a value of true, you must also specify the first_name, last_name, address1, town & post_code parameters.
first_name	string	Optional		* Mandatory if gift_aid is true. Donor first name.
last_name	string	Optional		* Mandatory if gift_aid is true. Donor last name.
address1	string	Optional		* Mandatory if gift_aid is true. Donor address line 1.
address2	string	Optional		Donor address line 2.
town	string	Optional		* Mandatory if gift_aid is true. Donor address town.
overseas	bool	Optional	false	If you omit this parameter or specify it with a value of false, you must also specify the post_code parameter.
post_code	string	Optional		* Mandatory if gift_aid is true & overseas is false. Donor address post code.
payment_type	string	Optional		* Mandatory if donation_online is true. Must be one of the following:
accept_t_c	bool	Optional	false	* Mandatory if donation_online is true. Indicates whether the donor has accepted the terms & conditions. This value must be true in order to submit a donation.
successfulReturnURL	string	Optional		The return URL from WorldPay Payment site after a successful transaction. Must include the scheme, eg. http:// . If you omit this parameter, the return url will be the Memory Giving fund page url. Only applicable to online donations.
unsuccessfulReturnURL	string	Optional		The return URL from WorldPay Payment site after an unsuccessful transaction. Must include the scheme, eg. http:// .If you omit this parameter, the return url will be the same as the successfulReturnURL. Only applicable to online donations.

Parameter	Value
api_key: