Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
#import <CkoStringBuilder.h>
#import <NSString.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "processingOptions": {
// "donorOptions": {
// "defaultUpdateLogic": "update_all"
// }
// },
// "commitments": [
// {
// "amount": 150.25,
// "currencyIsoCode": "USD",
// "transactionPeriod": "monthly",
// "transactionInterval": 3,
// "transactionDay": "5",
// "startDate": "2024-07-06",
// "endDate": "2024-08-06",
// "campaign": {
// "id": "<SFDC_CAMPAIGN_ID>"
// },
// "outreachSourceCode": {
// "id": "<SFDC_OUTREACH_SOURCE_CODE_ID>",
// "sourceCode": "AnimalEmailCampaign2023"
// },
// "donor": {
// "donorType": "individual",
// "id": "<SFDC_ACCOUNT_ID>",
// "firstName": "Test",
// "lastName": "Donor",
// "phone": "510-434-8920",
// "email": "test.donor@salesforce.com",
// "address": [
// {
// "addressType": "mailing",
// "street": "123 Main Street",
// "city": "Oakland",
// "state": "CA",
// "postalCode": "94610",
// "country": "US"
// }
// ],
// "accountCustomFields": [
// {
// "fieldName": "<VALID_CUSTOM_FIELD_API_NAME>",
// "fieldValue": "string"
// }
// ]
// },
// "paymentInstrument": {
// "type": "credit card",
// "accountHolderName": "test donor",
// "expiryMonth": "10",
// "expiryYear": "2026",
// "last4": "4585",
// "cardBrand": "visa",
// "bankName": "chase",
// "digitalWalletProvider": "apple pay",
// "bankAccountHolderType": "primary",
// "bankAccountType": "checking",
// "bankAccountNumber": "123456",
// "bankCode": "HBUK",
// "gatewayName": "stripe",
// "processorName": "test processor",
// "processorPaymentReference": "string",
// "gatewayReference": "string"
// },
// "designations": [
// {
// "designationId": "<SFDC_GIFT_DESIGNATION_ID>",
// "percent": 10
// }
// ],
// "firstTransaction": {
// "amount": 150.25,
// "receivedDate": "2024-07-06",
// "donorCoverAmount": 0.25,
// "transactionStatus": "Unpaid",
// "gatewayTransactionFee": 0.75,
// "processorTransactionFee": 0.45,
// "processorReference": "cls-1247586928747",
// "gatewayReference": "102656693ac3ca6e0cdafbfe89ab99",
// "lastGatewayResponseCode": "invalid_cvc",
// "lastGatewayErrorMessage": "The card’s security code is invalid. Check the card’s security code or use a different card.",
// "lastGatewayProcessedDateTime": "2023-07-06T21:57:51Z"
// },
// "giftCommitmentCustomFields": [
// {
// "fieldName": "<VALID_CUSTOM_FIELD_API_NAME>",
// "fieldValue": "string"
// }
// ],
// "giftCommitmentScheduleCustomFields": [
// {
// "fieldName": "<VALID_CUSTOM_FIELD_API_NAME>",
// "fieldValue": "string"
// }
// ]
// }
// ]
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"processingOptions.donorOptions.defaultUpdateLogic" value: @"update_all"];
[json UpdateNumber: @"commitments[0].amount" numericStr: @"150.25"];
[json UpdateString: @"commitments[0].currencyIsoCode" value: @"USD"];
[json UpdateString: @"commitments[0].transactionPeriod" value: @"monthly"];
[json UpdateInt: @"commitments[0].transactionInterval" value: [NSNumber numberWithInt: 3]];
[json UpdateString: @"commitments[0].transactionDay" value: @"5"];
[json UpdateString: @"commitments[0].startDate" value: @"2024-07-06"];
[json UpdateString: @"commitments[0].endDate" value: @"2024-08-06"];
[json UpdateString: @"commitments[0].campaign.id" value: @"<SFDC_CAMPAIGN_ID>"];
[json UpdateString: @"commitments[0].outreachSourceCode.id" value: @"<SFDC_OUTREACH_SOURCE_CODE_ID>"];
[json UpdateString: @"commitments[0].outreachSourceCode.sourceCode" value: @"AnimalEmailCampaign2023"];
[json UpdateString: @"commitments[0].donor.donorType" value: @"individual"];
[json UpdateString: @"commitments[0].donor.id" value: @"<SFDC_ACCOUNT_ID>"];
[json UpdateString: @"commitments[0].donor.firstName" value: @"Test"];
[json UpdateString: @"commitments[0].donor.lastName" value: @"Donor"];
[json UpdateString: @"commitments[0].donor.phone" value: @"510-434-8920"];
[json UpdateString: @"commitments[0].donor.email" value: @"test.donor@salesforce.com"];
[json UpdateString: @"commitments[0].donor.address[0].addressType" value: @"mailing"];
[json UpdateString: @"commitments[0].donor.address[0].street" value: @"123 Main Street"];
[json UpdateString: @"commitments[0].donor.address[0].city" value: @"Oakland"];
[json UpdateString: @"commitments[0].donor.address[0].state" value: @"CA"];
[json UpdateString: @"commitments[0].donor.address[0].postalCode" value: @"94610"];
[json UpdateString: @"commitments[0].donor.address[0].country" value: @"US"];
[json UpdateString: @"commitments[0].donor.accountCustomFields[0].fieldName" value: @"<VALID_CUSTOM_FIELD_API_NAME>"];
[json UpdateString: @"commitments[0].donor.accountCustomFields[0].fieldValue" value: @"string"];
[json UpdateString: @"commitments[0].paymentInstrument.type" value: @"credit card"];
[json UpdateString: @"commitments[0].paymentInstrument.accountHolderName" value: @"test donor"];
[json UpdateString: @"commitments[0].paymentInstrument.expiryMonth" value: @"10"];
[json UpdateString: @"commitments[0].paymentInstrument.expiryYear" value: @"2026"];
[json UpdateString: @"commitments[0].paymentInstrument.last4" value: @"4585"];
[json UpdateString: @"commitments[0].paymentInstrument.cardBrand" value: @"visa"];
[json UpdateString: @"commitments[0].paymentInstrument.bankName" value: @"chase"];
[json UpdateString: @"commitments[0].paymentInstrument.digitalWalletProvider" value: @"apple pay"];
[json UpdateString: @"commitments[0].paymentInstrument.bankAccountHolderType" value: @"primary"];
[json UpdateString: @"commitments[0].paymentInstrument.bankAccountType" value: @"checking"];
[json UpdateString: @"commitments[0].paymentInstrument.bankAccountNumber" value: @"123456"];
[json UpdateString: @"commitments[0].paymentInstrument.bankCode" value: @"HBUK"];
[json UpdateString: @"commitments[0].paymentInstrument.gatewayName" value: @"stripe"];
[json UpdateString: @"commitments[0].paymentInstrument.processorName" value: @"test processor"];
[json UpdateString: @"commitments[0].paymentInstrument.processorPaymentReference" value: @"string"];
[json UpdateString: @"commitments[0].paymentInstrument.gatewayReference" value: @"string"];
[json UpdateString: @"commitments[0].designations[0].designationId" value: @"<SFDC_GIFT_DESIGNATION_ID>"];
[json UpdateInt: @"commitments[0].designations[0].percent" value: [NSNumber numberWithInt: 10]];
[json UpdateNumber: @"commitments[0].firstTransaction.amount" numericStr: @"150.25"];
[json UpdateString: @"commitments[0].firstTransaction.receivedDate" value: @"2024-07-06"];
[json UpdateNumber: @"commitments[0].firstTransaction.donorCoverAmount" numericStr: @"0.25"];
[json UpdateString: @"commitments[0].firstTransaction.transactionStatus" value: @"Unpaid"];
[json UpdateNumber: @"commitments[0].firstTransaction.gatewayTransactionFee" numericStr: @"0.75"];
[json UpdateNumber: @"commitments[0].firstTransaction.processorTransactionFee" numericStr: @"0.45"];
[json UpdateString: @"commitments[0].firstTransaction.processorReference" value: @"cls-1247586928747"];
[json UpdateString: @"commitments[0].firstTransaction.gatewayReference" value: @"102656693ac3ca6e0cdafbfe89ab99"];
[json UpdateString: @"commitments[0].firstTransaction.lastGatewayResponseCode" value: @"invalid_cvc"];
[json UpdateString: @"commitments[0].firstTransaction.lastGatewayErrorMessage" value: @"The card’s security code is invalid. Check the card’s security code or use a different card."];
[json UpdateString: @"commitments[0].firstTransaction.lastGatewayProcessedDateTime" value: @"2023-07-06T21:57:51Z"];
[json UpdateString: @"commitments[0].giftCommitmentCustomFields[0].fieldName" value: @"<VALID_CUSTOM_FIELD_API_NAME>"];
[json UpdateString: @"commitments[0].giftCommitmentCustomFields[0].fieldValue" value: @"string"];
[json UpdateString: @"commitments[0].giftCommitmentScheduleCustomFields[0].fieldName" value: @"<VALID_CUSTOM_FIELD_API_NAME>"];
[json UpdateString: @"commitments[0].giftCommitmentScheduleCustomFields[0].fieldValue" value: @"string"];
// Adds the "Authorization: Bearer <access_token>" header.
http.AuthToken = @"<access_token>";
CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/services/data/v{{version}}/connect/fundraising/commitments" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
CkoStringBuilder *sbResponseBody = [[CkoStringBuilder alloc] init];
[resp GetBodySb: sbResponseBody];
CkoJsonObject *jResp = [[CkoJsonObject alloc] init];
[jResp LoadSb: sbResponseBody];
jResp.EmitCompact = NO;
NSLog(@"%@",@"Response Body:");
NSLog(@"%@",[jResp Emit]);
int respStatusCode = [resp.StatusCode intValue];
NSLog(@"%@%d",@"Response Status Code = ",respStatusCode);
if (respStatusCode >= 400) {
NSLog(@"%@",@"Response Header:");
NSLog(@"%@",resp.Header);
NSLog(@"%@",@"Failed.");
return;
}
// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)
// {
// "successes": 1,
// "failures": 0,
// "notProcessed": 0,
// "details": [
// {
// "success": true,
// "links": {
// "giftcommitment": {
// "href": "/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>",
// "id": "<SFDC_GIFT_COMMITMENT_ID>"
// },
// "giftcommitmentschedule": {
// "href": "/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_SCHEDULE_ID>",
// "id": "<SFDC_GIFT_COMMITMENT_SCHEDULE_ID>"
// },
// "giftdefaultdesignation": [
// {
// "href": "/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_DEFAULT_DESIGNATION_ID>",
// "id": "<SFDC_GIFT_DEFAULT_DESIGNATION_ID>"
// }
// ],
// "gifttransaction": {
// "href": "/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>",
// "id": "<SFDC_GIFT_TRANSACTION_ID>"
// },
// "paymentinstrument": {
// "href": "/services/data/vXX.X/sobjects/sObject/<SFDC_PAYMENT_INSTRUMENT_ID>",
// "id": "<SFDC_PAYMENT_INSTRUMENT_ID>"
// },
// "account": {
// "href": "/services/data/vXX.X/sobjects/sObject/<SFDC_ACCOUNT_ID>",
// "id": "<SFDC_ACCOUNT_ID>"
// }
// }
// },
// {
// "success": true,
// "links": {
// "giftcommitment": {
// "href": "/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>",
// "id": "<SFDC_GIFT_COMMITMENT_ID>"
// },
// "giftcommitmentschedule": {
// "href": "/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_SCHEDULE_ID>",
// "id": "<SFDC_GIFT_COMMITMENT_SCHEDULE_ID>"
// },
// "giftdefaultdesignation": [
// {
// "href": "/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_DEFAULT_DESIGNATION_ID>",
// "id": "<SFDC_GIFT_DEFAULT_DESIGNATION_ID>"
// }
// ],
// "gifttransaction": {
// "href": "/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>",
// "id": "<SFDC_GIFT_TRANSACTION_ID>"
// },
// "paymentinstrument": {
// "href": "/services/data/vXX.X/sobjects/sObject/<SFDC_PAYMENT_INSTRUMENT_ID>",
// "id": "<SFDC_PAYMENT_INSTRUMENT_ID>"
// },
// "account": {
// "href": "/services/data/vXX.X/sobjects/sObject/<SFDC_ACCOUNT_ID>",
// "id": "<SFDC_ACCOUNT_ID>"
// }
// }
// }
// ]
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
BOOL success;
NSString *Href = 0;
NSString *Id = 0;
NSString *GiftcommitmentscheduleHref = 0;
NSString *GiftcommitmentscheduleId = 0;
NSString *GifttransactionHref = 0;
NSString *GifttransactionId = 0;
NSString *PaymentinstrumentHref = 0;
NSString *PaymentinstrumentId = 0;
NSString *AccountHref = 0;
NSString *AccountId = 0;
int j;
int count_j;
NSString *href = 0;
NSString *id = 0;
int successes = [[jResp IntOf: @"successes"] intValue];
int failures = [[jResp IntOf: @"failures"] intValue];
int notProcessed = [[jResp IntOf: @"notProcessed"] intValue];
int i = 0;
int count_i = [[jResp SizeOfArray: @"details"] intValue];
while (i < count_i) {
jResp.I = [NSNumber numberWithInt: i];
success = [jResp BoolOf: @"details[i].success"];
Href = [jResp StringOf: @"details[i].links.giftcommitment.href"];
Id = [jResp StringOf: @"details[i].links.giftcommitment.id"];
GiftcommitmentscheduleHref = [jResp StringOf: @"details[i].links.giftcommitmentschedule.href"];
GiftcommitmentscheduleId = [jResp StringOf: @"details[i].links.giftcommitmentschedule.id"];
GifttransactionHref = [jResp StringOf: @"details[i].links.gifttransaction.href"];
GifttransactionId = [jResp StringOf: @"details[i].links.gifttransaction.id"];
PaymentinstrumentHref = [jResp StringOf: @"details[i].links.paymentinstrument.href"];
PaymentinstrumentId = [jResp StringOf: @"details[i].links.paymentinstrument.id"];
AccountHref = [jResp StringOf: @"details[i].links.account.href"];
AccountId = [jResp StringOf: @"details[i].links.account.id"];
j = 0;
count_j = [[jResp SizeOfArray: @"details[i].links.giftdefaultdesignation"] intValue];
while (j < count_j) {
jResp.J = [NSNumber numberWithInt: j];
href = [jResp StringOf: @"details[i].links.giftdefaultdesignation[j].href"];
id = [jResp StringOf: @"details[i].links.giftdefaultdesignation[j].id"];
j = j + 1;
}
i = i + 1;
}
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-d '{
"processingOptions": {
"donorOptions": {
"defaultUpdateLogic": "update_all"
}
},
"commitments": [
{
"amount": 150.25,
"currencyIsoCode": "USD",
"transactionPeriod": "monthly",
"transactionInterval": 3,
"transactionDay": "5",
"startDate": "2024-07-06",
"endDate": "2024-08-06",
"campaign": {
"id": "<SFDC_CAMPAIGN_ID>"
},
"outreachSourceCode": {
"id": "<SFDC_OUTREACH_SOURCE_CODE_ID>",
"sourceCode": "AnimalEmailCampaign2023"
},
"donor": {
"donorType": "individual",
"id": "<SFDC_ACCOUNT_ID>",
"firstName": "Test",
"lastName": "Donor",
"phone": "510-434-8920",
"email": "test.donor@salesforce.com",
"address": [
{
"addressType": "mailing",
"street": "123 Main Street",
"city": "Oakland",
"state": "CA",
"postalCode": "94610",
"country": "US"
}
],
"accountCustomFields": [
{
"fieldName": "<VALID_CUSTOM_FIELD_API_NAME>",
"fieldValue": "string"
}
]
},
"paymentInstrument": {
"type": "credit card",
"accountHolderName": "test donor",
"expiryMonth": "10",
"expiryYear": "2026",
"last4": "4585",
"cardBrand": "visa",
"bankName": "chase",
"digitalWalletProvider": "apple pay",
"bankAccountHolderType": "primary",
"bankAccountType": "checking",
"bankAccountNumber": "123456",
"bankCode": "HBUK",
"gatewayName": "stripe",
"processorName": "test processor",
"processorPaymentReference": "string",
"gatewayReference": "string"
},
"designations": [
{
"designationId": "<SFDC_GIFT_DESIGNATION_ID>",
"percent": 10
}
],
"firstTransaction": {
"amount": 150.25,
"receivedDate": "2024-07-06",
"donorCoverAmount": 0.25,
"transactionStatus": "Unpaid",
"gatewayTransactionFee": 0.75,
"processorTransactionFee": 0.45,
"processorReference": "cls-1247586928747",
"gatewayReference": "102656693ac3ca6e0cdafbfe89ab99",
"lastGatewayResponseCode": "invalid_cvc",
"lastGatewayErrorMessage": "The card’s security code is invalid. Check the card’s security code or use a different card.",
"lastGatewayProcessedDateTime": "2023-07-06T21:57:51Z"
},
"giftCommitmentCustomFields": [
{
"fieldName": "<VALID_CUSTOM_FIELD_API_NAME>",
"fieldValue": "string"
}
],
"giftCommitmentScheduleCustomFields": [
{
"fieldName": "<VALID_CUSTOM_FIELD_API_NAME>",
"fieldValue": "string"
}
]
}
]
}'
https://domain.com/services/data/v{{version}}/connect/fundraising/commitments
Postman Collection Item JSON
{
"name": "Create Commitments",
"request": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"commitments\": [\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"campaign\": {\n \"id\": \"<SFDC_CAMPAIGN_ID>\"\n },\n \"outreachSourceCode\": {\n \"id\": \"<SFDC_OUTREACH_SOURCE_CODE_ID>\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"<SFDC_ACCOUNT_ID>\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.donor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"<SFDC_GIFT_DESIGNATION_ID>\",\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"fundraising",
"commitments"
]
},
"description": "Create gift transactions with related new or matched donors, optional transaction designations, and payment instrument metadata. Supports custom fields for the donor account and gift transaction.\n\n## Required Attributes:\n\n- commitments.amount\n \n- commitments.transactionPeriod\n \n- commitments.startDate\n \n- donor.donorType (\"individual\" or \"organization\")\n \n- donor.lastName\n \n- donor.organization\n \n- paymentinstrument.type\n \n\nAll other attributes are optional can be left as an empty string or just removed from the request body entirely. The only exceptions to this are:\n\n- CustomFields collections - These cannot be left in the request body as an empty collection or wit an empty string for the FieldName.\n \n\n### Validated Property Formats (an empty string is considered valid)\n\n- DateTime - YYYY-MM-DDTHH:MM:SSZ\n- Date - YYYY-MM-DD\n- Email - a valid formatted email address\n \n\n#### Other Attributes\n\n- OutreachSource -- This is optional. Be sure to create the OutreachSourceCode record in the system if passing a value\n- Will accept **either** an OutreachSourceCode.id (SalesforceId) or an OutreachSourceCode.Code.\n \n\n#### Custom fields\n\n- The field_value can be a text string (inc. for a date data-type) or a numeric value (without quotes)\n- Do not include an empty collection or an empty fieldName in the request body"
},
"response": [
{
"name": "Status201-CreateCommitmentSuccess",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"commitments\": [\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"campaign\": {\n \"id\": \"<SFDC_CAMPAIGN_ID>\"\n },\n \"outreachSourceCode\": {\n \"id\": \"<SFDC_OUTREACH_SOURCE_CODE_ID>\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"<SFDC_ACCOUNT_ID>\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.donor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"<SFDC_GIFT_DESIGNATION_ID>\",\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"fundraising",
"commitments"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": ""
}
],
"cookie": [
],
"body": "{\n \"successes\": 1,\n \"failures\": 0,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>\",\n \"id\": \"<SFDC_GIFT_COMMITMENT_ID>\"\n },\n \"giftcommitmentschedule\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_SCHEDULE_ID>\",\n \"id\": \"<SFDC_GIFT_COMMITMENT_SCHEDULE_ID>\"\n },\n \"giftdefaultdesignation\": [\n {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_DEFAULT_DESIGNATION_ID>\",\n \"id\": \"<SFDC_GIFT_DEFAULT_DESIGNATION_ID>\"\n }\n ],\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>\",\n \"id\": \"<SFDC_GIFT_TRANSACTION_ID>\"\n },\n \"paymentinstrument\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_PAYMENT_INSTRUMENT_ID>\",\n \"id\": \"<SFDC_PAYMENT_INSTRUMENT_ID>\"\n },\n \"account\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_ACCOUNT_ID>\",\n \"id\": \"<SFDC_ACCOUNT_ID>\"\n }\n }\n },\n {\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>\",\n \"id\": \"<SFDC_GIFT_COMMITMENT_ID>\"\n },\n \"giftcommitmentschedule\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_SCHEDULE_ID>\",\n \"id\": \"<SFDC_GIFT_COMMITMENT_SCHEDULE_ID>\"\n },\n \"giftdefaultdesignation\": [\n {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_DEFAULT_DESIGNATION_ID>\",\n \"id\": \"<SFDC_GIFT_DEFAULT_DESIGNATION_ID>\"\n }\n ],\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>\",\n \"id\": \"<SFDC_GIFT_TRANSACTION_ID>\"\n },\n \"paymentinstrument\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_PAYMENT_INSTRUMENT_ID>\",\n \"id\": \"<SFDC_PAYMENT_INSTRUMENT_ID>\"\n },\n \"account\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_ACCOUNT_ID>\",\n \"id\": \"<SFDC_ACCOUNT_ID>\"\n }\n }\n }\n ]\n}"
},
{
"name": "Status201-CreateCommitmentRequestValidationFailure",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"commitments\": [\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"outreachSourceCode\": {\n \"id\": \"INVALID SOURCE CODE ID\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"<SFDC_ACCOUNT_ID>\",\n \"organizationName\": \"test organization\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.donor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"<SFDC_GIFT_DESIGNATION_ID>\",\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"fundraising",
"commitments"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": ""
}
],
"cookie": [
],
"body": "{\n \"successes\": 0,\n \"failures\": 1,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": false,\n \"errors\": {\n \"field\": \"outreachSourceCode.id\",\n \"message\": \"<invalid id message>\"\n }\n }\n ]\n}"
},
{
"name": "Status201-CreateCommitmentDatabaseFailure",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"commitments\": [\n {\n \"amount\": 5.00,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"outreachSourceCode\": {\n \"id\": \"<SFDC_OUTREACH_SOURCE_CODE_ID>\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"<SFDC_ACCOUNT_ID>\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.donor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"<SFDC_GIFT_DESIGNATION_ID>\",\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"fundraising",
"commitments"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": ""
}
],
"cookie": [
],
"body": "// This is a scenario where there is a validation rule on the Gift Commitment Schedule object requiring the amount to be greater than 10.00. One database error occurs for the 5.00 commitment, causing the other two to be rolled back with success of false and no record links.\n{\n \"successes\": 0,\n \"failures\": 2,\n \"notProcessed\": 1,\n \"details\": [\n {\n \"success\": false,\n \"errors\": {\n \"message\": \"Amount must be greater than 10.00\"\n }\n }\n ]\n}"
},
{
"name": "Status201-CreateCommitmentSuccessWithExternalIds",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"commitments\": [\n {\n \"amount\": 2500,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"campaign\": {\n \"externalId\": {\n \"fieldName\": \"<EXTERNAL_ID_FIELD_NAME>\",\n \"fieldValue\": \"<EXTERNAL_ID_FIELD_VALUE>\"\n }\n },\n \"outreachSourceCode\": {\n \"id\": \"<SFDC_OUTREACH_SOURCE_CODE_ID>\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"externalId\": {\n \"fieldName\": \"<EXTERNAL_ID_FIELD_NAME>\",\n \"fieldValue\": \"<EXTERNAL_ID_FIELD_VALUE>\"\n },\n \"firstName\": \"Luke\",\n \"lastName\": \"Smith\",\n \"phone\": \"510-434-8920\",\n \"email\": \"l.smith@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"david chavez\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"externalId\": {\n \"fieldName\": \"<EXTERNAL_ID_FIELD_NAME>\",\n \"fieldValue\": \"<EXTERNAL_ID_FIELD_VALUE>\"\n },\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"campaign\": {\n \"id\": \"<SFDC_CAMPAIGN_ID>\"\n },\n \"outreachSourceCode\": {\n \"id\": \"<SFDC_OUTREACH_SOURCE_CODE_ID>\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"externalId\": {\n \"fieldName\": \"<EXTERNAL_ID_FIELD_NAME>\",\n \"fieldValue\": \"<EXTERNAL_ID_FIELD_VALUE>\"\n },\n \"firstName\": \"David\",\n \"lastName\": \"Chavez\",\n \"phone\": \"510-434-8920\",\n \"email\": \"d.chavez@example.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"david chavez\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"externalId\": {\n \"fieldName\": \"<EXTERNAL_ID_FIELD_NAME>\",\n \"fieldValue\": \"<EXTERNAL_ID_FIELD_VALUE>\"\n },\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"fundraising",
"commitments"
]
}
},
"_postman_previewlanguage": null,
"header": null,
"cookie": [
],
"body": "{\n \"successes\": 2,\n \"failures\": 0,\n \"notProcessed\": 0,\n \"details\": [\n {\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>\",\n \"id\": \"<SFDC_GIFT_COMMITMENT_ID>\"\n },\n \"giftcommitmentschedule\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_SCHEDULE_ID>\",\n \"id\": \"<SFDC_GIFT_COMMITMENT_SCHEDULE_ID>\"\n },\n \"giftdefaultdesignation\": [\n {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_DEFAULT_DESIGNATION_ID>\",\n \"id\": \"<SFDC_GIFT_DEFAULT_DESIGNATION_ID>\"\n }\n ],\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>\",\n \"id\": \"<SFDC_GIFT_TRANSACTION_ID>\"\n },\n \"paymentinstrument\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_PAYMENT_INSTRUMENT_ID>\",\n \"id\": \"<SFDC_PAYMENT_INSTRUMENT_ID>\"\n },\n \"account\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_ACCOUNT_ID>\",\n \"id\": \"<SFDC_ACCOUNT_ID>\"\n }\n }\n },\n {\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>\",\n \"id\": \"<SFDC_GIFT_COMMITMENT_ID>\"\n },\n \"giftcommitmentschedule\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_SCHEDULE_ID>\",\n \"id\": \"<SFDC_GIFT_COMMITMENT_SCHEDULE_ID>\"\n },\n \"giftdefaultdesignation\": [\n {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_DEFAULT_DESIGNATION_ID>\",\n \"id\": \"<SFDC_GIFT_DEFAULT_DESIGNATION_ID>\"\n }\n ],\n \"gifttransaction\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_TRANSACTION_ID>\",\n \"id\": \"<SFDC_GIFT_TRANSACTION_ID>\"\n },\n \"paymentinstrument\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_PAYMENT_INSTRUMENT_ID>\",\n \"id\": \"<SFDC_PAYMENT_INSTRUMENT_ID>\"\n },\n \"account\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_ACCOUNT_ID>\",\n \"id\": \"<SFDC_ACCOUNT_ID>\"\n }\n }\n }\n ]\n}"
},
{
"name": "Status400-BadRequestError",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"processingOptions\": {\n \"donorOptions\": {\n \"defaultUpdateLogic\": \"update_all\"\n }\n },\n \"commitments\": [\n {\n \"amount\": 150.25,\n \"currencyIsoCode\": \"USD\",\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-08-06\",\n \"campaign\": {\n \"id\": \"<SFDC_CAMPAIGN_ID>\"\n },\n \"outreachSourceCode\": {\n \"id\": \"<SFDC_OUTREACH_SOURCE_CODE_ID>\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"id\": \"<SFDC_ACCOUNT_ID>\",\n \"firstName\": \"Test\",\n \"lastName\": \"Donor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"test.donor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"designations\": [\n {\n \"designationId\": \"<SFDC_GIFT_DESIGNATION_ID>\",\n \"percent\": 10\n }\n ],\n \"firstTransaction\": {\n \"amount\": 150.25,\n \"receivedDate\": \"2024-07-06\",\n \"donorCoverAmount\": 0.25,\n \"transactionStatus\": \"Unpaid\",\n \"gatewayTransactionFee\": 0.75,\n \"processorTransactionFee\": 0.45,\n \"processorReference\": \"cls-1247586928747\",\n \"gatewayReference\": \"102656693ac3ca6e0cdafbfe89ab99\",\n \"lastGatewayResponseCode\": \"invalid_cvc\",\n \"lastGatewayErrorMessage\": \"The card’s security code is invalid. Check the card’s security code or use a different card.\",\n \"lastGatewayProcessedDateTime\": \"2023-07-06T21:57:51Z\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"<VALID_CUSTOM_FIELD_API_NAME>\",\n \"fieldValue\": \"string\"\n }\n ]\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"fundraising",
"commitments"
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": ""
}
],
"cookie": [
],
"body": " // Even if the JSON request is valid, this is an example of a 400 error code that will be returned if duplicate matching rules are not active. Any non 200 error code would have a similar response structure.\n {\n \"errorCode\": \"UNKNOWN_EXCEPTION\",\n \"message\": \"Provide active duplicate matching rules on Account and Person Account for donor matching. -- industries.fundraisingops.connect.impl.validator.ValidatorUtil.validateMatchingMethod(ValidatorUtil.java:103)\"\n }"
}
]
}