Process a Donation Payment
curl --request POST \
--url https://prod-api.raisedonors.com/api/Raise/give \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 123,
"paymentMethodId": "<string>",
"nonce": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pageRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"currency": "<string>",
"exchangeRate": 123,
"segment": "<string>",
"segmentOverrideCode": "<string>",
"projectOverrideCode": "<string>",
"isRecurring": true,
"startDate": "2023-11-07T05:31:56Z",
"startDateTimeUtc": "2023-11-07T05:31:56Z",
"donorPaidCosts": true,
"isAnonymous": true,
"creditCardType": "<string>",
"giftAidRequested": true,
"doubleTheDonationCompanyId": 123,
"doubleTheDonationEnteredText": "<string>",
"isTestMode": true,
"premiumId": 123,
"visitorId": "<string>",
"comments": "<string>",
"paymentId": "<string>",
"clientId": "<string>",
"sessionId": "<string>",
"timeZone": "<string>",
"coverAdminFee": true,
"adminFee": 123,
"adminFeeProjectId": 123,
"paypalPaymentSource": "<string>",
"motivationCodeId": 123,
"motivationCodeGroupId": 123,
"gatewayId": 123,
"donor": {
"firstName": "<string>",
"lastName": "<string>",
"id": 123,
"title": "<string>",
"middleName": "<string>",
"suffix": "<string>",
"email": "jsmith@example.com",
"noEmailAddress": true,
"phone": "<string>",
"phoneOptIn": true,
"phoneCountryCode": "<string>",
"notes": "<string>",
"isOrganization": true,
"organizationName": "<string>",
"crmKey": "<string>",
"crmKeys": {},
"billingAddress": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"countryString": "<string>"
},
"shippingAddress": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"countryString": "<string>"
},
"emailLists": [
"<string>"
]
},
"tribute": {
"isInMemoryOf": true,
"isInHonorOf": true,
"nameOrOccasion": "<string>",
"tributeFirstName": "<string>",
"tributeLastName": "<string>",
"tributeAddress1": "<string>",
"tributeAddress2": "<string>",
"tributeCity": "<string>",
"tributeState": "<string>",
"tributeCountry": "<string>",
"tributePostal": "<string>",
"acknowledgeeFirstName": "<string>",
"acknowledgeeLastName": "<string>",
"sendByEmail": true,
"acknowledgeeEmailAddress": "<string>",
"sendByPostal": true,
"acknowledgeeAddress1": "<string>",
"acknowledgeeAddress2": "<string>",
"acknowledgeeCity": "<string>",
"acknowledgeeState": "<string>",
"acknowledgeeCountry": "<string>",
"acknowledgeePostal": "<string>",
"message": "<string>"
},
"projects": [
{
"projectId": 123,
"amount": 123
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 123,
paymentMethodId: '<string>',
nonce: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
publicId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
pageRequestId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
currency: '<string>',
exchangeRate: 123,
segment: '<string>',
segmentOverrideCode: '<string>',
projectOverrideCode: '<string>',
isRecurring: true,
startDate: '2023-11-07T05:31:56Z',
startDateTimeUtc: '2023-11-07T05:31:56Z',
donorPaidCosts: true,
isAnonymous: true,
creditCardType: '<string>',
giftAidRequested: true,
doubleTheDonationCompanyId: 123,
doubleTheDonationEnteredText: '<string>',
isTestMode: true,
premiumId: 123,
visitorId: '<string>',
comments: '<string>',
paymentId: '<string>',
clientId: '<string>',
sessionId: '<string>',
timeZone: '<string>',
coverAdminFee: true,
adminFee: 123,
adminFeeProjectId: 123,
paypalPaymentSource: '<string>',
motivationCodeId: 123,
motivationCodeGroupId: 123,
gatewayId: 123,
donor: {
firstName: '<string>',
lastName: '<string>',
id: 123,
title: '<string>',
middleName: '<string>',
suffix: '<string>',
email: 'jsmith@example.com',
noEmailAddress: true,
phone: '<string>',
phoneOptIn: true,
phoneCountryCode: '<string>',
notes: '<string>',
isOrganization: true,
organizationName: '<string>',
crmKey: '<string>',
crmKeys: {},
billingAddress: {
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postal: '<string>',
countryString: '<string>'
},
shippingAddress: {
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postal: '<string>',
countryString: '<string>'
},
emailLists: ['<string>']
},
tribute: {
isInMemoryOf: true,
isInHonorOf: true,
nameOrOccasion: '<string>',
tributeFirstName: '<string>',
tributeLastName: '<string>',
tributeAddress1: '<string>',
tributeAddress2: '<string>',
tributeCity: '<string>',
tributeState: '<string>',
tributeCountry: '<string>',
tributePostal: '<string>',
acknowledgeeFirstName: '<string>',
acknowledgeeLastName: '<string>',
sendByEmail: true,
acknowledgeeEmailAddress: '<string>',
sendByPostal: true,
acknowledgeeAddress1: '<string>',
acknowledgeeAddress2: '<string>',
acknowledgeeCity: '<string>',
acknowledgeeState: '<string>',
acknowledgeeCountry: '<string>',
acknowledgeePostal: '<string>',
message: '<string>'
},
projects: [{projectId: 123, amount: 123}]
})
};
fetch('https://prod-api.raisedonors.com/api/Raise/give', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://prod-api.raisedonors.com/api/Raise/give"
payload = {
"amount": 123,
"paymentMethodId": "<string>",
"nonce": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pageRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"currency": "<string>",
"exchangeRate": 123,
"segment": "<string>",
"segmentOverrideCode": "<string>",
"projectOverrideCode": "<string>",
"isRecurring": True,
"startDate": "2023-11-07T05:31:56Z",
"startDateTimeUtc": "2023-11-07T05:31:56Z",
"donorPaidCosts": True,
"isAnonymous": True,
"creditCardType": "<string>",
"giftAidRequested": True,
"doubleTheDonationCompanyId": 123,
"doubleTheDonationEnteredText": "<string>",
"isTestMode": True,
"premiumId": 123,
"visitorId": "<string>",
"comments": "<string>",
"paymentId": "<string>",
"clientId": "<string>",
"sessionId": "<string>",
"timeZone": "<string>",
"coverAdminFee": True,
"adminFee": 123,
"adminFeeProjectId": 123,
"paypalPaymentSource": "<string>",
"motivationCodeId": 123,
"motivationCodeGroupId": 123,
"gatewayId": 123,
"donor": {
"firstName": "<string>",
"lastName": "<string>",
"id": 123,
"title": "<string>",
"middleName": "<string>",
"suffix": "<string>",
"email": "jsmith@example.com",
"noEmailAddress": True,
"phone": "<string>",
"phoneOptIn": True,
"phoneCountryCode": "<string>",
"notes": "<string>",
"isOrganization": True,
"organizationName": "<string>",
"crmKey": "<string>",
"crmKeys": {},
"billingAddress": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"countryString": "<string>"
},
"shippingAddress": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"countryString": "<string>"
},
"emailLists": ["<string>"]
},
"tribute": {
"isInMemoryOf": True,
"isInHonorOf": True,
"nameOrOccasion": "<string>",
"tributeFirstName": "<string>",
"tributeLastName": "<string>",
"tributeAddress1": "<string>",
"tributeAddress2": "<string>",
"tributeCity": "<string>",
"tributeState": "<string>",
"tributeCountry": "<string>",
"tributePostal": "<string>",
"acknowledgeeFirstName": "<string>",
"acknowledgeeLastName": "<string>",
"sendByEmail": True,
"acknowledgeeEmailAddress": "<string>",
"sendByPostal": True,
"acknowledgeeAddress1": "<string>",
"acknowledgeeAddress2": "<string>",
"acknowledgeeCity": "<string>",
"acknowledgeeState": "<string>",
"acknowledgeeCountry": "<string>",
"acknowledgeePostal": "<string>",
"message": "<string>"
},
"projects": [
{
"projectId": 123,
"amount": 123
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://prod-api.raisedonors.com/api/Raise/give");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
request.AddJsonBody("{\n \"amount\": 123,\n \"paymentMethodId\": \"<string>\",\n \"nonce\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"publicId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pageRequestId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"currency\": \"<string>\",\n \"exchangeRate\": 123,\n \"segment\": \"<string>\",\n \"segmentOverrideCode\": \"<string>\",\n \"projectOverrideCode\": \"<string>\",\n \"isRecurring\": true,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"startDateTimeUtc\": \"2023-11-07T05:31:56Z\",\n \"donorPaidCosts\": true,\n \"isAnonymous\": true,\n \"creditCardType\": \"<string>\",\n \"giftAidRequested\": true,\n \"doubleTheDonationCompanyId\": 123,\n \"doubleTheDonationEnteredText\": \"<string>\",\n \"isTestMode\": true,\n \"premiumId\": 123,\n \"visitorId\": \"<string>\",\n \"comments\": \"<string>\",\n \"paymentId\": \"<string>\",\n \"clientId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"coverAdminFee\": true,\n \"adminFee\": 123,\n \"adminFeeProjectId\": 123,\n \"paypalPaymentSource\": \"<string>\",\n \"motivationCodeId\": 123,\n \"motivationCodeGroupId\": 123,\n \"gatewayId\": 123,\n \"donor\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"id\": 123,\n \"title\": \"<string>\",\n \"middleName\": \"<string>\",\n \"suffix\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"noEmailAddress\": true,\n \"phone\": \"<string>\",\n \"phoneOptIn\": true,\n \"phoneCountryCode\": \"<string>\",\n \"notes\": \"<string>\",\n \"isOrganization\": true,\n \"organizationName\": \"<string>\",\n \"crmKey\": \"<string>\",\n \"crmKeys\": {},\n \"billingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"countryString\": \"<string>\"\n },\n \"shippingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"countryString\": \"<string>\"\n },\n \"emailLists\": [\n \"<string>\"\n ]\n },\n \"tribute\": {\n \"isInMemoryOf\": true,\n \"isInHonorOf\": true,\n \"nameOrOccasion\": \"<string>\",\n \"tributeFirstName\": \"<string>\",\n \"tributeLastName\": \"<string>\",\n \"tributeAddress1\": \"<string>\",\n \"tributeAddress2\": \"<string>\",\n \"tributeCity\": \"<string>\",\n \"tributeState\": \"<string>\",\n \"tributeCountry\": \"<string>\",\n \"tributePostal\": \"<string>\",\n \"acknowledgeeFirstName\": \"<string>\",\n \"acknowledgeeLastName\": \"<string>\",\n \"sendByEmail\": true,\n \"acknowledgeeEmailAddress\": \"<string>\",\n \"sendByPostal\": true,\n \"acknowledgeeAddress1\": \"<string>\",\n \"acknowledgeeAddress2\": \"<string>\",\n \"acknowledgeeCity\": \"<string>\",\n \"acknowledgeeState\": \"<string>\",\n \"acknowledgeeCountry\": \"<string>\",\n \"acknowledgeePostal\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"projects\": [\n {\n \"projectId\": 123,\n \"amount\": 123\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://prod-api.raisedonors.com/api/Raise/give",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 123,
'paymentMethodId' => '<string>',
'nonce' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'publicId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'pageRequestId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'currency' => '<string>',
'exchangeRate' => 123,
'segment' => '<string>',
'segmentOverrideCode' => '<string>',
'projectOverrideCode' => '<string>',
'isRecurring' => true,
'startDate' => '2023-11-07T05:31:56Z',
'startDateTimeUtc' => '2023-11-07T05:31:56Z',
'donorPaidCosts' => true,
'isAnonymous' => true,
'creditCardType' => '<string>',
'giftAidRequested' => true,
'doubleTheDonationCompanyId' => 123,
'doubleTheDonationEnteredText' => '<string>',
'isTestMode' => true,
'premiumId' => 123,
'visitorId' => '<string>',
'comments' => '<string>',
'paymentId' => '<string>',
'clientId' => '<string>',
'sessionId' => '<string>',
'timeZone' => '<string>',
'coverAdminFee' => true,
'adminFee' => 123,
'adminFeeProjectId' => 123,
'paypalPaymentSource' => '<string>',
'motivationCodeId' => 123,
'motivationCodeGroupId' => 123,
'gatewayId' => 123,
'donor' => [
'firstName' => '<string>',
'lastName' => '<string>',
'id' => 123,
'title' => '<string>',
'middleName' => '<string>',
'suffix' => '<string>',
'email' => 'jsmith@example.com',
'noEmailAddress' => true,
'phone' => '<string>',
'phoneOptIn' => true,
'phoneCountryCode' => '<string>',
'notes' => '<string>',
'isOrganization' => true,
'organizationName' => '<string>',
'crmKey' => '<string>',
'crmKeys' => [
],
'billingAddress' => [
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal' => '<string>',
'countryString' => '<string>'
],
'shippingAddress' => [
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal' => '<string>',
'countryString' => '<string>'
],
'emailLists' => [
'<string>'
]
],
'tribute' => [
'isInMemoryOf' => true,
'isInHonorOf' => true,
'nameOrOccasion' => '<string>',
'tributeFirstName' => '<string>',
'tributeLastName' => '<string>',
'tributeAddress1' => '<string>',
'tributeAddress2' => '<string>',
'tributeCity' => '<string>',
'tributeState' => '<string>',
'tributeCountry' => '<string>',
'tributePostal' => '<string>',
'acknowledgeeFirstName' => '<string>',
'acknowledgeeLastName' => '<string>',
'sendByEmail' => true,
'acknowledgeeEmailAddress' => '<string>',
'sendByPostal' => true,
'acknowledgeeAddress1' => '<string>',
'acknowledgeeAddress2' => '<string>',
'acknowledgeeCity' => '<string>',
'acknowledgeeState' => '<string>',
'acknowledgeeCountry' => '<string>',
'acknowledgeePostal' => '<string>',
'message' => '<string>'
],
'projects' => [
[
'projectId' => 123,
'amount' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://prod-api.raisedonors.com/api/Raise/give")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"paymentMethodId\": \"<string>\",\n \"nonce\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"publicId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pageRequestId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"currency\": \"<string>\",\n \"exchangeRate\": 123,\n \"segment\": \"<string>\",\n \"segmentOverrideCode\": \"<string>\",\n \"projectOverrideCode\": \"<string>\",\n \"isRecurring\": true,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"startDateTimeUtc\": \"2023-11-07T05:31:56Z\",\n \"donorPaidCosts\": true,\n \"isAnonymous\": true,\n \"creditCardType\": \"<string>\",\n \"giftAidRequested\": true,\n \"doubleTheDonationCompanyId\": 123,\n \"doubleTheDonationEnteredText\": \"<string>\",\n \"isTestMode\": true,\n \"premiumId\": 123,\n \"visitorId\": \"<string>\",\n \"comments\": \"<string>\",\n \"paymentId\": \"<string>\",\n \"clientId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"coverAdminFee\": true,\n \"adminFee\": 123,\n \"adminFeeProjectId\": 123,\n \"paypalPaymentSource\": \"<string>\",\n \"motivationCodeId\": 123,\n \"motivationCodeGroupId\": 123,\n \"gatewayId\": 123,\n \"donor\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"id\": 123,\n \"title\": \"<string>\",\n \"middleName\": \"<string>\",\n \"suffix\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"noEmailAddress\": true,\n \"phone\": \"<string>\",\n \"phoneOptIn\": true,\n \"phoneCountryCode\": \"<string>\",\n \"notes\": \"<string>\",\n \"isOrganization\": true,\n \"organizationName\": \"<string>\",\n \"crmKey\": \"<string>\",\n \"crmKeys\": {},\n \"billingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"countryString\": \"<string>\"\n },\n \"shippingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"countryString\": \"<string>\"\n },\n \"emailLists\": [\n \"<string>\"\n ]\n },\n \"tribute\": {\n \"isInMemoryOf\": true,\n \"isInHonorOf\": true,\n \"nameOrOccasion\": \"<string>\",\n \"tributeFirstName\": \"<string>\",\n \"tributeLastName\": \"<string>\",\n \"tributeAddress1\": \"<string>\",\n \"tributeAddress2\": \"<string>\",\n \"tributeCity\": \"<string>\",\n \"tributeState\": \"<string>\",\n \"tributeCountry\": \"<string>\",\n \"tributePostal\": \"<string>\",\n \"acknowledgeeFirstName\": \"<string>\",\n \"acknowledgeeLastName\": \"<string>\",\n \"sendByEmail\": true,\n \"acknowledgeeEmailAddress\": \"<string>\",\n \"sendByPostal\": true,\n \"acknowledgeeAddress1\": \"<string>\",\n \"acknowledgeeAddress2\": \"<string>\",\n \"acknowledgeeCity\": \"<string>\",\n \"acknowledgeeState\": \"<string>\",\n \"acknowledgeeCountry\": \"<string>\",\n \"acknowledgeePostal\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"projects\": [\n {\n \"projectId\": 123,\n \"amount\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.raisedonors.com/api/Raise/give")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"paymentMethodId\": \"<string>\",\n \"nonce\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"publicId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pageRequestId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"currency\": \"<string>\",\n \"exchangeRate\": 123,\n \"segment\": \"<string>\",\n \"segmentOverrideCode\": \"<string>\",\n \"projectOverrideCode\": \"<string>\",\n \"isRecurring\": true,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"startDateTimeUtc\": \"2023-11-07T05:31:56Z\",\n \"donorPaidCosts\": true,\n \"isAnonymous\": true,\n \"creditCardType\": \"<string>\",\n \"giftAidRequested\": true,\n \"doubleTheDonationCompanyId\": 123,\n \"doubleTheDonationEnteredText\": \"<string>\",\n \"isTestMode\": true,\n \"premiumId\": 123,\n \"visitorId\": \"<string>\",\n \"comments\": \"<string>\",\n \"paymentId\": \"<string>\",\n \"clientId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"coverAdminFee\": true,\n \"adminFee\": 123,\n \"adminFeeProjectId\": 123,\n \"paypalPaymentSource\": \"<string>\",\n \"motivationCodeId\": 123,\n \"motivationCodeGroupId\": 123,\n \"gatewayId\": 123,\n \"donor\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"id\": 123,\n \"title\": \"<string>\",\n \"middleName\": \"<string>\",\n \"suffix\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"noEmailAddress\": true,\n \"phone\": \"<string>\",\n \"phoneOptIn\": true,\n \"phoneCountryCode\": \"<string>\",\n \"notes\": \"<string>\",\n \"isOrganization\": true,\n \"organizationName\": \"<string>\",\n \"crmKey\": \"<string>\",\n \"crmKeys\": {},\n \"billingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"countryString\": \"<string>\"\n },\n \"shippingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"countryString\": \"<string>\"\n },\n \"emailLists\": [\n \"<string>\"\n ]\n },\n \"tribute\": {\n \"isInMemoryOf\": true,\n \"isInHonorOf\": true,\n \"nameOrOccasion\": \"<string>\",\n \"tributeFirstName\": \"<string>\",\n \"tributeLastName\": \"<string>\",\n \"tributeAddress1\": \"<string>\",\n \"tributeAddress2\": \"<string>\",\n \"tributeCity\": \"<string>\",\n \"tributeState\": \"<string>\",\n \"tributeCountry\": \"<string>\",\n \"tributePostal\": \"<string>\",\n \"acknowledgeeFirstName\": \"<string>\",\n \"acknowledgeeLastName\": \"<string>\",\n \"sendByEmail\": true,\n \"acknowledgeeEmailAddress\": \"<string>\",\n \"sendByPostal\": true,\n \"acknowledgeeAddress1\": \"<string>\",\n \"acknowledgeeAddress2\": \"<string>\",\n \"acknowledgeeCity\": \"<string>\",\n \"acknowledgeeState\": \"<string>\",\n \"acknowledgeeCountry\": \"<string>\",\n \"acknowledgeePostal\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"projects\": [\n {\n \"projectId\": 123,\n \"amount\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyconst url = 'https://prod-api.raisedonors.com/api/Raise/give';
const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 123,
paymentMethodId: '<string>',
nonce: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
publicId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
pageRequestId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
currency: '<string>',
exchangeRate: 123,
segment: '<string>',
segmentOverrideCode: '<string>',
projectOverrideCode: '<string>',
isRecurring: true,
startDate: '2023-11-07T05:31:56Z',
startDateTimeUtc: '2023-11-07T05:31:56Z',
donorPaidCosts: true,
isAnonymous: true,
creditCardType: '<string>',
giftAidRequested: true,
doubleTheDonationCompanyId: 123,
doubleTheDonationEnteredText: '<string>',
isTestMode: true,
premiumId: 123,
visitorId: '<string>',
comments: '<string>',
paymentId: '<string>',
clientId: '<string>',
sessionId: '<string>',
timeZone: '<string>',
coverAdminFee: true,
adminFee: 123,
adminFeeProjectId: 123,
paypalPaymentSource: '<string>',
motivationCodeId: 123,
motivationCodeGroupId: 123,
gatewayId: 123,
donor: {
firstName: '<string>',
lastName: '<string>',
id: 123,
title: '<string>',
middleName: '<string>',
suffix: '<string>',
email: 'jsmith@example.com',
noEmailAddress: true,
phone: '<string>',
phoneOptIn: true,
phoneCountryCode: '<string>',
notes: '<string>',
isOrganization: true,
organizationName: '<string>',
crmKey: '<string>',
crmKeys: {},
billingAddress: {
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postal: '<string>',
countryString: '<string>'
},
shippingAddress: {
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postal: '<string>',
countryString: '<string>'
},
emailLists: ['<string>']
},
tribute: {
isInMemoryOf: true,
isInHonorOf: true,
nameOrOccasion: '<string>',
tributeFirstName: '<string>',
tributeLastName: '<string>',
tributeAddress1: '<string>',
tributeAddress2: '<string>',
tributeCity: '<string>',
tributeState: '<string>',
tributeCountry: '<string>',
tributePostal: '<string>',
acknowledgeeFirstName: '<string>',
acknowledgeeLastName: '<string>',
sendByEmail: true,
acknowledgeeEmailAddress: '<string>',
sendByPostal: true,
acknowledgeeAddress1: '<string>',
acknowledgeeAddress2: '<string>',
acknowledgeeCity: '<string>',
acknowledgeeState: '<string>',
acknowledgeeCountry: '<string>',
acknowledgeePostal: '<string>',
message: '<string>'
},
projects: [{projectId: 123, amount: 123}]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "The Authorization header is missing, malformed, or carries a token that is expired or revoked.",
"instance": "/api/Raise/give"
}Raise
Process a Donation Payment
Processes a donation and records the resulting gift.
POST
https://prod-api.raisedonors.com
/
api
/
Raise
/
give
Process a Donation Payment
curl --request POST \
--url https://prod-api.raisedonors.com/api/Raise/give \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"amount": 123,
"paymentMethodId": "<string>",
"nonce": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pageRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"currency": "<string>",
"exchangeRate": 123,
"segment": "<string>",
"segmentOverrideCode": "<string>",
"projectOverrideCode": "<string>",
"isRecurring": true,
"startDate": "2023-11-07T05:31:56Z",
"startDateTimeUtc": "2023-11-07T05:31:56Z",
"donorPaidCosts": true,
"isAnonymous": true,
"creditCardType": "<string>",
"giftAidRequested": true,
"doubleTheDonationCompanyId": 123,
"doubleTheDonationEnteredText": "<string>",
"isTestMode": true,
"premiumId": 123,
"visitorId": "<string>",
"comments": "<string>",
"paymentId": "<string>",
"clientId": "<string>",
"sessionId": "<string>",
"timeZone": "<string>",
"coverAdminFee": true,
"adminFee": 123,
"adminFeeProjectId": 123,
"paypalPaymentSource": "<string>",
"motivationCodeId": 123,
"motivationCodeGroupId": 123,
"gatewayId": 123,
"donor": {
"firstName": "<string>",
"lastName": "<string>",
"id": 123,
"title": "<string>",
"middleName": "<string>",
"suffix": "<string>",
"email": "jsmith@example.com",
"noEmailAddress": true,
"phone": "<string>",
"phoneOptIn": true,
"phoneCountryCode": "<string>",
"notes": "<string>",
"isOrganization": true,
"organizationName": "<string>",
"crmKey": "<string>",
"crmKeys": {},
"billingAddress": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"countryString": "<string>"
},
"shippingAddress": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"countryString": "<string>"
},
"emailLists": [
"<string>"
]
},
"tribute": {
"isInMemoryOf": true,
"isInHonorOf": true,
"nameOrOccasion": "<string>",
"tributeFirstName": "<string>",
"tributeLastName": "<string>",
"tributeAddress1": "<string>",
"tributeAddress2": "<string>",
"tributeCity": "<string>",
"tributeState": "<string>",
"tributeCountry": "<string>",
"tributePostal": "<string>",
"acknowledgeeFirstName": "<string>",
"acknowledgeeLastName": "<string>",
"sendByEmail": true,
"acknowledgeeEmailAddress": "<string>",
"sendByPostal": true,
"acknowledgeeAddress1": "<string>",
"acknowledgeeAddress2": "<string>",
"acknowledgeeCity": "<string>",
"acknowledgeeState": "<string>",
"acknowledgeeCountry": "<string>",
"acknowledgeePostal": "<string>",
"message": "<string>"
},
"projects": [
{
"projectId": 123,
"amount": 123
}
]
}
'const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 123,
paymentMethodId: '<string>',
nonce: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
publicId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
pageRequestId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
currency: '<string>',
exchangeRate: 123,
segment: '<string>',
segmentOverrideCode: '<string>',
projectOverrideCode: '<string>',
isRecurring: true,
startDate: '2023-11-07T05:31:56Z',
startDateTimeUtc: '2023-11-07T05:31:56Z',
donorPaidCosts: true,
isAnonymous: true,
creditCardType: '<string>',
giftAidRequested: true,
doubleTheDonationCompanyId: 123,
doubleTheDonationEnteredText: '<string>',
isTestMode: true,
premiumId: 123,
visitorId: '<string>',
comments: '<string>',
paymentId: '<string>',
clientId: '<string>',
sessionId: '<string>',
timeZone: '<string>',
coverAdminFee: true,
adminFee: 123,
adminFeeProjectId: 123,
paypalPaymentSource: '<string>',
motivationCodeId: 123,
motivationCodeGroupId: 123,
gatewayId: 123,
donor: {
firstName: '<string>',
lastName: '<string>',
id: 123,
title: '<string>',
middleName: '<string>',
suffix: '<string>',
email: 'jsmith@example.com',
noEmailAddress: true,
phone: '<string>',
phoneOptIn: true,
phoneCountryCode: '<string>',
notes: '<string>',
isOrganization: true,
organizationName: '<string>',
crmKey: '<string>',
crmKeys: {},
billingAddress: {
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postal: '<string>',
countryString: '<string>'
},
shippingAddress: {
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postal: '<string>',
countryString: '<string>'
},
emailLists: ['<string>']
},
tribute: {
isInMemoryOf: true,
isInHonorOf: true,
nameOrOccasion: '<string>',
tributeFirstName: '<string>',
tributeLastName: '<string>',
tributeAddress1: '<string>',
tributeAddress2: '<string>',
tributeCity: '<string>',
tributeState: '<string>',
tributeCountry: '<string>',
tributePostal: '<string>',
acknowledgeeFirstName: '<string>',
acknowledgeeLastName: '<string>',
sendByEmail: true,
acknowledgeeEmailAddress: '<string>',
sendByPostal: true,
acknowledgeeAddress1: '<string>',
acknowledgeeAddress2: '<string>',
acknowledgeeCity: '<string>',
acknowledgeeState: '<string>',
acknowledgeeCountry: '<string>',
acknowledgeePostal: '<string>',
message: '<string>'
},
projects: [{projectId: 123, amount: 123}]
})
};
fetch('https://prod-api.raisedonors.com/api/Raise/give', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://prod-api.raisedonors.com/api/Raise/give"
payload = {
"amount": 123,
"paymentMethodId": "<string>",
"nonce": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"pageRequestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"currency": "<string>",
"exchangeRate": 123,
"segment": "<string>",
"segmentOverrideCode": "<string>",
"projectOverrideCode": "<string>",
"isRecurring": True,
"startDate": "2023-11-07T05:31:56Z",
"startDateTimeUtc": "2023-11-07T05:31:56Z",
"donorPaidCosts": True,
"isAnonymous": True,
"creditCardType": "<string>",
"giftAidRequested": True,
"doubleTheDonationCompanyId": 123,
"doubleTheDonationEnteredText": "<string>",
"isTestMode": True,
"premiumId": 123,
"visitorId": "<string>",
"comments": "<string>",
"paymentId": "<string>",
"clientId": "<string>",
"sessionId": "<string>",
"timeZone": "<string>",
"coverAdminFee": True,
"adminFee": 123,
"adminFeeProjectId": 123,
"paypalPaymentSource": "<string>",
"motivationCodeId": 123,
"motivationCodeGroupId": 123,
"gatewayId": 123,
"donor": {
"firstName": "<string>",
"lastName": "<string>",
"id": 123,
"title": "<string>",
"middleName": "<string>",
"suffix": "<string>",
"email": "jsmith@example.com",
"noEmailAddress": True,
"phone": "<string>",
"phoneOptIn": True,
"phoneCountryCode": "<string>",
"notes": "<string>",
"isOrganization": True,
"organizationName": "<string>",
"crmKey": "<string>",
"crmKeys": {},
"billingAddress": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"countryString": "<string>"
},
"shippingAddress": {
"address1": "<string>",
"address2": "<string>",
"city": "<string>",
"state": "<string>",
"postal": "<string>",
"countryString": "<string>"
},
"emailLists": ["<string>"]
},
"tribute": {
"isInMemoryOf": True,
"isInHonorOf": True,
"nameOrOccasion": "<string>",
"tributeFirstName": "<string>",
"tributeLastName": "<string>",
"tributeAddress1": "<string>",
"tributeAddress2": "<string>",
"tributeCity": "<string>",
"tributeState": "<string>",
"tributeCountry": "<string>",
"tributePostal": "<string>",
"acknowledgeeFirstName": "<string>",
"acknowledgeeLastName": "<string>",
"sendByEmail": True,
"acknowledgeeEmailAddress": "<string>",
"sendByPostal": True,
"acknowledgeeAddress1": "<string>",
"acknowledgeeAddress2": "<string>",
"acknowledgeeCity": "<string>",
"acknowledgeeState": "<string>",
"acknowledgeeCountry": "<string>",
"acknowledgeePostal": "<string>",
"message": "<string>"
},
"projects": [
{
"projectId": 123,
"amount": 123
}
]
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)using RestSharp;
var options = new RestClientOptions("https://prod-api.raisedonors.com/api/Raise/give");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
request.AddJsonBody("{\n \"amount\": 123,\n \"paymentMethodId\": \"<string>\",\n \"nonce\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"publicId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pageRequestId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"currency\": \"<string>\",\n \"exchangeRate\": 123,\n \"segment\": \"<string>\",\n \"segmentOverrideCode\": \"<string>\",\n \"projectOverrideCode\": \"<string>\",\n \"isRecurring\": true,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"startDateTimeUtc\": \"2023-11-07T05:31:56Z\",\n \"donorPaidCosts\": true,\n \"isAnonymous\": true,\n \"creditCardType\": \"<string>\",\n \"giftAidRequested\": true,\n \"doubleTheDonationCompanyId\": 123,\n \"doubleTheDonationEnteredText\": \"<string>\",\n \"isTestMode\": true,\n \"premiumId\": 123,\n \"visitorId\": \"<string>\",\n \"comments\": \"<string>\",\n \"paymentId\": \"<string>\",\n \"clientId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"coverAdminFee\": true,\n \"adminFee\": 123,\n \"adminFeeProjectId\": 123,\n \"paypalPaymentSource\": \"<string>\",\n \"motivationCodeId\": 123,\n \"motivationCodeGroupId\": 123,\n \"gatewayId\": 123,\n \"donor\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"id\": 123,\n \"title\": \"<string>\",\n \"middleName\": \"<string>\",\n \"suffix\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"noEmailAddress\": true,\n \"phone\": \"<string>\",\n \"phoneOptIn\": true,\n \"phoneCountryCode\": \"<string>\",\n \"notes\": \"<string>\",\n \"isOrganization\": true,\n \"organizationName\": \"<string>\",\n \"crmKey\": \"<string>\",\n \"crmKeys\": {},\n \"billingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"countryString\": \"<string>\"\n },\n \"shippingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"countryString\": \"<string>\"\n },\n \"emailLists\": [\n \"<string>\"\n ]\n },\n \"tribute\": {\n \"isInMemoryOf\": true,\n \"isInHonorOf\": true,\n \"nameOrOccasion\": \"<string>\",\n \"tributeFirstName\": \"<string>\",\n \"tributeLastName\": \"<string>\",\n \"tributeAddress1\": \"<string>\",\n \"tributeAddress2\": \"<string>\",\n \"tributeCity\": \"<string>\",\n \"tributeState\": \"<string>\",\n \"tributeCountry\": \"<string>\",\n \"tributePostal\": \"<string>\",\n \"acknowledgeeFirstName\": \"<string>\",\n \"acknowledgeeLastName\": \"<string>\",\n \"sendByEmail\": true,\n \"acknowledgeeEmailAddress\": \"<string>\",\n \"sendByPostal\": true,\n \"acknowledgeeAddress1\": \"<string>\",\n \"acknowledgeeAddress2\": \"<string>\",\n \"acknowledgeeCity\": \"<string>\",\n \"acknowledgeeState\": \"<string>\",\n \"acknowledgeeCountry\": \"<string>\",\n \"acknowledgeePostal\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"projects\": [\n {\n \"projectId\": 123,\n \"amount\": 123\n }\n ]\n}", false);
var response = await client.PostAsync(request);
Console.WriteLine("{0}", response.Content);
<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://prod-api.raisedonors.com/api/Raise/give",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => 123,
'paymentMethodId' => '<string>',
'nonce' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'publicId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'pageRequestId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'currency' => '<string>',
'exchangeRate' => 123,
'segment' => '<string>',
'segmentOverrideCode' => '<string>',
'projectOverrideCode' => '<string>',
'isRecurring' => true,
'startDate' => '2023-11-07T05:31:56Z',
'startDateTimeUtc' => '2023-11-07T05:31:56Z',
'donorPaidCosts' => true,
'isAnonymous' => true,
'creditCardType' => '<string>',
'giftAidRequested' => true,
'doubleTheDonationCompanyId' => 123,
'doubleTheDonationEnteredText' => '<string>',
'isTestMode' => true,
'premiumId' => 123,
'visitorId' => '<string>',
'comments' => '<string>',
'paymentId' => '<string>',
'clientId' => '<string>',
'sessionId' => '<string>',
'timeZone' => '<string>',
'coverAdminFee' => true,
'adminFee' => 123,
'adminFeeProjectId' => 123,
'paypalPaymentSource' => '<string>',
'motivationCodeId' => 123,
'motivationCodeGroupId' => 123,
'gatewayId' => 123,
'donor' => [
'firstName' => '<string>',
'lastName' => '<string>',
'id' => 123,
'title' => '<string>',
'middleName' => '<string>',
'suffix' => '<string>',
'email' => 'jsmith@example.com',
'noEmailAddress' => true,
'phone' => '<string>',
'phoneOptIn' => true,
'phoneCountryCode' => '<string>',
'notes' => '<string>',
'isOrganization' => true,
'organizationName' => '<string>',
'crmKey' => '<string>',
'crmKeys' => [
],
'billingAddress' => [
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal' => '<string>',
'countryString' => '<string>'
],
'shippingAddress' => [
'address1' => '<string>',
'address2' => '<string>',
'city' => '<string>',
'state' => '<string>',
'postal' => '<string>',
'countryString' => '<string>'
],
'emailLists' => [
'<string>'
]
],
'tribute' => [
'isInMemoryOf' => true,
'isInHonorOf' => true,
'nameOrOccasion' => '<string>',
'tributeFirstName' => '<string>',
'tributeLastName' => '<string>',
'tributeAddress1' => '<string>',
'tributeAddress2' => '<string>',
'tributeCity' => '<string>',
'tributeState' => '<string>',
'tributeCountry' => '<string>',
'tributePostal' => '<string>',
'acknowledgeeFirstName' => '<string>',
'acknowledgeeLastName' => '<string>',
'sendByEmail' => true,
'acknowledgeeEmailAddress' => '<string>',
'sendByPostal' => true,
'acknowledgeeAddress1' => '<string>',
'acknowledgeeAddress2' => '<string>',
'acknowledgeeCity' => '<string>',
'acknowledgeeState' => '<string>',
'acknowledgeeCountry' => '<string>',
'acknowledgeePostal' => '<string>',
'message' => '<string>'
],
'projects' => [
[
'projectId' => 123,
'amount' => 123
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}HttpResponse<String> response = Unirest.post("https://prod-api.raisedonors.com/api/Raise/give")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"paymentMethodId\": \"<string>\",\n \"nonce\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"publicId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pageRequestId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"currency\": \"<string>\",\n \"exchangeRate\": 123,\n \"segment\": \"<string>\",\n \"segmentOverrideCode\": \"<string>\",\n \"projectOverrideCode\": \"<string>\",\n \"isRecurring\": true,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"startDateTimeUtc\": \"2023-11-07T05:31:56Z\",\n \"donorPaidCosts\": true,\n \"isAnonymous\": true,\n \"creditCardType\": \"<string>\",\n \"giftAidRequested\": true,\n \"doubleTheDonationCompanyId\": 123,\n \"doubleTheDonationEnteredText\": \"<string>\",\n \"isTestMode\": true,\n \"premiumId\": 123,\n \"visitorId\": \"<string>\",\n \"comments\": \"<string>\",\n \"paymentId\": \"<string>\",\n \"clientId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"coverAdminFee\": true,\n \"adminFee\": 123,\n \"adminFeeProjectId\": 123,\n \"paypalPaymentSource\": \"<string>\",\n \"motivationCodeId\": 123,\n \"motivationCodeGroupId\": 123,\n \"gatewayId\": 123,\n \"donor\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"id\": 123,\n \"title\": \"<string>\",\n \"middleName\": \"<string>\",\n \"suffix\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"noEmailAddress\": true,\n \"phone\": \"<string>\",\n \"phoneOptIn\": true,\n \"phoneCountryCode\": \"<string>\",\n \"notes\": \"<string>\",\n \"isOrganization\": true,\n \"organizationName\": \"<string>\",\n \"crmKey\": \"<string>\",\n \"crmKeys\": {},\n \"billingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"countryString\": \"<string>\"\n },\n \"shippingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"countryString\": \"<string>\"\n },\n \"emailLists\": [\n \"<string>\"\n ]\n },\n \"tribute\": {\n \"isInMemoryOf\": true,\n \"isInHonorOf\": true,\n \"nameOrOccasion\": \"<string>\",\n \"tributeFirstName\": \"<string>\",\n \"tributeLastName\": \"<string>\",\n \"tributeAddress1\": \"<string>\",\n \"tributeAddress2\": \"<string>\",\n \"tributeCity\": \"<string>\",\n \"tributeState\": \"<string>\",\n \"tributeCountry\": \"<string>\",\n \"tributePostal\": \"<string>\",\n \"acknowledgeeFirstName\": \"<string>\",\n \"acknowledgeeLastName\": \"<string>\",\n \"sendByEmail\": true,\n \"acknowledgeeEmailAddress\": \"<string>\",\n \"sendByPostal\": true,\n \"acknowledgeeAddress1\": \"<string>\",\n \"acknowledgeeAddress2\": \"<string>\",\n \"acknowledgeeCity\": \"<string>\",\n \"acknowledgeeState\": \"<string>\",\n \"acknowledgeeCountry\": \"<string>\",\n \"acknowledgeePostal\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"projects\": [\n {\n \"projectId\": 123,\n \"amount\": 123\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod-api.raisedonors.com/api/Raise/give")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"paymentMethodId\": \"<string>\",\n \"nonce\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"publicId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"pageRequestId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"currency\": \"<string>\",\n \"exchangeRate\": 123,\n \"segment\": \"<string>\",\n \"segmentOverrideCode\": \"<string>\",\n \"projectOverrideCode\": \"<string>\",\n \"isRecurring\": true,\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"startDateTimeUtc\": \"2023-11-07T05:31:56Z\",\n \"donorPaidCosts\": true,\n \"isAnonymous\": true,\n \"creditCardType\": \"<string>\",\n \"giftAidRequested\": true,\n \"doubleTheDonationCompanyId\": 123,\n \"doubleTheDonationEnteredText\": \"<string>\",\n \"isTestMode\": true,\n \"premiumId\": 123,\n \"visitorId\": \"<string>\",\n \"comments\": \"<string>\",\n \"paymentId\": \"<string>\",\n \"clientId\": \"<string>\",\n \"sessionId\": \"<string>\",\n \"timeZone\": \"<string>\",\n \"coverAdminFee\": true,\n \"adminFee\": 123,\n \"adminFeeProjectId\": 123,\n \"paypalPaymentSource\": \"<string>\",\n \"motivationCodeId\": 123,\n \"motivationCodeGroupId\": 123,\n \"gatewayId\": 123,\n \"donor\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"id\": 123,\n \"title\": \"<string>\",\n \"middleName\": \"<string>\",\n \"suffix\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"noEmailAddress\": true,\n \"phone\": \"<string>\",\n \"phoneOptIn\": true,\n \"phoneCountryCode\": \"<string>\",\n \"notes\": \"<string>\",\n \"isOrganization\": true,\n \"organizationName\": \"<string>\",\n \"crmKey\": \"<string>\",\n \"crmKeys\": {},\n \"billingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"countryString\": \"<string>\"\n },\n \"shippingAddress\": {\n \"address1\": \"<string>\",\n \"address2\": \"<string>\",\n \"city\": \"<string>\",\n \"state\": \"<string>\",\n \"postal\": \"<string>\",\n \"countryString\": \"<string>\"\n },\n \"emailLists\": [\n \"<string>\"\n ]\n },\n \"tribute\": {\n \"isInMemoryOf\": true,\n \"isInHonorOf\": true,\n \"nameOrOccasion\": \"<string>\",\n \"tributeFirstName\": \"<string>\",\n \"tributeLastName\": \"<string>\",\n \"tributeAddress1\": \"<string>\",\n \"tributeAddress2\": \"<string>\",\n \"tributeCity\": \"<string>\",\n \"tributeState\": \"<string>\",\n \"tributeCountry\": \"<string>\",\n \"tributePostal\": \"<string>\",\n \"acknowledgeeFirstName\": \"<string>\",\n \"acknowledgeeLastName\": \"<string>\",\n \"sendByEmail\": true,\n \"acknowledgeeEmailAddress\": \"<string>\",\n \"sendByPostal\": true,\n \"acknowledgeeAddress1\": \"<string>\",\n \"acknowledgeeAddress2\": \"<string>\",\n \"acknowledgeeCity\": \"<string>\",\n \"acknowledgeeState\": \"<string>\",\n \"acknowledgeeCountry\": \"<string>\",\n \"acknowledgeePostal\": \"<string>\",\n \"message\": \"<string>\"\n },\n \"projects\": [\n {\n \"projectId\": 123,\n \"amount\": 123\n }\n ]\n}"
response = http.request(request)
puts response.read_bodyconst url = 'https://prod-api.raisedonors.com/api/Raise/give';
const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 123,
paymentMethodId: '<string>',
nonce: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
publicId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
pageRequestId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
currency: '<string>',
exchangeRate: 123,
segment: '<string>',
segmentOverrideCode: '<string>',
projectOverrideCode: '<string>',
isRecurring: true,
startDate: '2023-11-07T05:31:56Z',
startDateTimeUtc: '2023-11-07T05:31:56Z',
donorPaidCosts: true,
isAnonymous: true,
creditCardType: '<string>',
giftAidRequested: true,
doubleTheDonationCompanyId: 123,
doubleTheDonationEnteredText: '<string>',
isTestMode: true,
premiumId: 123,
visitorId: '<string>',
comments: '<string>',
paymentId: '<string>',
clientId: '<string>',
sessionId: '<string>',
timeZone: '<string>',
coverAdminFee: true,
adminFee: 123,
adminFeeProjectId: 123,
paypalPaymentSource: '<string>',
motivationCodeId: 123,
motivationCodeGroupId: 123,
gatewayId: 123,
donor: {
firstName: '<string>',
lastName: '<string>',
id: 123,
title: '<string>',
middleName: '<string>',
suffix: '<string>',
email: 'jsmith@example.com',
noEmailAddress: true,
phone: '<string>',
phoneOptIn: true,
phoneCountryCode: '<string>',
notes: '<string>',
isOrganization: true,
organizationName: '<string>',
crmKey: '<string>',
crmKeys: {},
billingAddress: {
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postal: '<string>',
countryString: '<string>'
},
shippingAddress: {
address1: '<string>',
address2: '<string>',
city: '<string>',
state: '<string>',
postal: '<string>',
countryString: '<string>'
},
emailLists: ['<string>']
},
tribute: {
isInMemoryOf: true,
isInHonorOf: true,
nameOrOccasion: '<string>',
tributeFirstName: '<string>',
tributeLastName: '<string>',
tributeAddress1: '<string>',
tributeAddress2: '<string>',
tributeCity: '<string>',
tributeState: '<string>',
tributeCountry: '<string>',
tributePostal: '<string>',
acknowledgeeFirstName: '<string>',
acknowledgeeLastName: '<string>',
sendByEmail: true,
acknowledgeeEmailAddress: '<string>',
sendByPostal: true,
acknowledgeeAddress1: '<string>',
acknowledgeeAddress2: '<string>',
acknowledgeeCity: '<string>',
acknowledgeeState: '<string>',
acknowledgeeCountry: '<string>',
acknowledgeePostal: '<string>',
message: '<string>'
},
projects: [{projectId: 123, amount: 123}]
})
};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));{
"type": "https://tools.ietf.org/html/rfc7235#section-3.1",
"title": "Unauthorized",
"status": 401,
"detail": "The Authorization header is missing, malformed, or carries a token that is expired or revoked.",
"instance": "/api/Raise/give"
}Send the
publicId of the page being given through, the payment nonce or paymentMethodId with its paymentMethodType, the amount and currency, and the donor details. Set isRecurring with a frequency and startDate to start a recurring gift, split the gift across designations with projects, and use donorPaidCosts or coverAdminFee when the donor is covering fees.
To try the call without charging a payment method, send
isTestMode=true with a method from Generate Test Payment Method.The spec does not document error responses for this endpoint beyond
401, so the causes aren’t listed with the responses here. Errors still arrive in the ProblemDetails envelope the rest of the Raise API uses — handle a rejected request (400), and a path ID that doesn’t resolve (404), as you would on any other endpoint.Authorizations
JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"
Body
application/jsontext/jsonapplication/*+json
The donation to process, including the page publicId, the payment details, the amount, and the donor.
Represents a donation payment request.
The donation amount, in the currency given by currency.
How the donor is paying, such as CreditCard, ACH, or PayPal.
Available options:
0, 1, 2, 3, 4, 5, 6, 7, 8, 9 The identifier of the payment method to charge. Use Generate Test Payment Method to get one for isTestMode.
Minimum string length:
1The single-use token representing the payment details collected in the browser. Send it, or paymentMethodId for a stored method.
The public identifier of the page the donation is being given through.
The identifier of the page view the donation came from, used to tie the gift back to the session.
The three-letter ISO currency code of the amount. Defaults to the organization's currency.
The rate used to convert the amount to the organization's base currency.
The segment to attribute the gift to.
The segment code to use instead of the page's default segment.
The project code to use instead of the page's default designation.
Whether to start a recurring gift rather than record a one-time gift. Send frequency and startDate with it.
How often the recurring gift is charged. Required when isRecurring is true.
Available options:
0, 1, 2, 4, 12, 26, 52, 100 The date the recurring gift starts, in the time zone given by timeZone.
The UTC date and time the recurring gift starts.
Whether the donor is covering the payment processing cost on top of the amount. Use Calculate Payment Processing Cost to get what it adds.
Whether the gift is given anonymously.
The brand of the card, such as Visa or Mastercard.
Whether the donor requested Gift Aid on the donation.
The Double the Donation identifier of the donor's employer, for matching gifts.
The employer name the donor typed, for matching gifts.
When true, records the gift without charging a payment method. Pair it with a method from Generate Test Payment Method.
The unique identifier of the premium the donor chose.
The identifier of the visitor, used to tie the gift to their earlier activity.
Any comments the donor left with the donation.
The payment provider's identifier for the payment, when it was taken outside Raise.
The identifier of the client application submitting the donation.
The identifier of the browser session the donation came from.
The time zone startDate is interpreted in.
Whether the donor is covering the administrative fee on top of the amount.
The administrative fee the donor is covering.
The unique identifier of the project the administrative fee is designated to.
The PayPal funding source the donor paid with, such as paypal or venmo.
The unique identifier of the motivation code to attribute the gift to.
The unique identifier of the motivation code group to attribute the gift to.
The payment gateway ID to be used.
The donor giving the gift. An existing donor is matched on id, crmKey, or email address; otherwise one is created.
Show child attributes
Show child attributes
The tribute the gift is given in memory or honor of, if any.
Show child attributes
Show child attributes
The projects associated with the donation.
Show child attributes
Show child attributes
Response
OK
Last modified on July 28, 2026
Was this page helpful?
⌘I