Nonprofit Cloud Developer Guide
jCreate Gift Request Input
Input representation of the data required to create a new gift. This request body
accepts both standard and custom fields for donor account and gift transaction. If a standard
field does not appear in the request body, you can include it in the customFields section for
the relevant object.
JSON example
1{
2 "gifts": [
3 {
4 "amount": 150.25,
5 "currencyIsoCode": "USD",
6 "receivedDate": "2024-07-06",
7 "donorCoverAmount": 0.25,
8 "transactionStatus": "Unpaid",
9 "commitmentId": "00x324303243fsfd",
10 "paymentIdentifier": "1234",
11 "gatewayTransactionFee": 0.75,
12 "processorTransactionFee": 0.45,
13 "processorReference": "cls-1247586928747",
14 "gatewayReference": "102656693ac3ca6e0cdafbfe89ab99",
15 "lastGatewayResponseCode": "invalid_cvc",
16 "lastGatewayErrorMessage": "The card's security code is invalid. Check the card's security code or use a different card.",
17 "lastGatewayProcessedDateTime": "2023-07-06T21:57:51Z",
18 "campaign": {
19 "id": "701y0030d0zk6t06f4"
20 },
21 "outreachSourceCode": {
22 "id": "0gx000d0d0d0FD",
23 "sourceCode": "AnimalEmailCampaign2023"
24 },
25 "donor": {
26 "donorType": "individual",
27 "id": "0015500000WO1ZixxL",
28 "firstName": "Daniel",
29 "lastName": "Chavez",
30 "phone": "510-432-1234",
31 "email": "example@salesforce.com",
32 "address": [
33 {
34 "street": "123 Main Street",
35 "city": "Oakland",
36 "state": "CA",
37 "postalCode": "94610",
38 "country": "US"
39 }
40 ],
41 "accountCustomFields": [
42 {
43 "fieldName": "string",
44 "fieldValue": "string"
45 }
46 ]
47 },
48 "paymentInstrument": {
49 "type": "credit card",
50 "accountHolderName": "Daniel Chavez",
51 "expiryMonth": "10",
52 "expiryYear": "2026",
53 "last4": "4321",
54 "cardBrand": "visa",
55 "bankName": "chase",
56 "digitalWalletProvider": "Diner's Club",
57 "bankAccountHolderType": "primary",
58 "bankAccountType": "checking",
59 "bankAccountNumber": "123456",
60 "bankCode": "HBUK",
61 "gatewayName": "Gateway",
62 "processorName": "OptiSynth",
63 "processorPaymentReference": "string",
64 "gatewayReference": "string"
65 },
66 "designations": [
67 {
68 "designationId": "0gd0030f0303024",
69 "percent": 10,
70 "amount": 150.25
71 }
72 ],
73 "giftTransactionCustomFields": [
74 {
75 "fieldName": "string",
76 "fieldValue": "string"
77 }
78 ]
79 }
80 ]
81}Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| accountCustomFields | Custom Field Details Input[] | Custom fields for the donor account. The accountCustomFields property aslo accepts the standard fields for the donor account. | Optional | 60.0 |
| amount | Double | Original amount of the gift transaction. | Required | 60.0 |
| campaign | Campaign Details Input | Campaign that's associated with the gift transaction. | Optional | 60.0 |
| commitmentId | String | Gift commitment ID that's associated with the gift transaction. | Optional | 60.0 |
| currencyIsoCode | String | ISO code of the currency. | Optional | 60.0 |
| designations | Designation Details Input[] | Designations that are associated with the gift transaction. | Optional | 60.0 |
| donor | Donor Details Input | Donor details that are associated with the gift transaction. | Required | 60.0 |
| donorCoverAmount | Double | Amount that the donor added to their gift to cover fees. | Optional | 60.0 |
| gatewayReference | String | Reference of the transaction to which the gateway is assigned. | Optional | 60.0 |
| gatewayTransactionFee | Double | Transaction fees charged by the gateway. | Optional | 60.0 |
| giftTransactionCustomFields | Custom Field Details Input[] | Custom fields for the gift transaction. The giftTransactionCustomFields property also accepts the standard fields for the gift transaction. | Optional | 60.0 |
| lastGatewayErrorMessage | String | Most recent error message received by the gateway. | Optional | 60.0 |
| lastGatewayProcessedDateTime | String | Last attempt made by the gateway. | Optional | 60.0 |
| lastGatewayResponseCode | String | Most recent response code that was received by the gateway. | Optional | 60.0 |
| outreachSourceCode | Outreach Source Code Details Input | Outreach source code that's associated with the gift transaction. | Optional | 60.0 |
| paymentIdentifier | String | Unique ID for the payment transaction. | Optional | 60.0 |
| paymentInstrument | Payment Instrument Details Input | Payment instrument used for the gift transaction. | Required | 60.0 |
| processorReference | String | Reference of the transaction to which the payment processor is assigned. | Optional | 60.0 |
| processorTransactionFee | Double | Transaction fees charged by the processor. | Optional | 60.0 |
| receivedDate | String | Date when the donor completed the gift transaction. | Required | 60.0 |
| transactionStatus | String | Status of the gift transaction. | Required | 60.0 |