Newer Version Available
Commitments (POST)
Create recurring gift commitments and schedules, along with associated new or matched
donor. Customize fields for donor accounts, gift commitments, and schedules.
- Resource
-
1/connect/fundraising/commitments - Resource example
-
1https://yourInstance.salesforce.com/services/data/v60.0/connect/fundraising/commitments - Available version
- 60.0
- HTTP methods
- POST
- Request body for POST
-
- JSON example
-
1{ 2 "processingOptions": { 3 "donorOptions": { 4 "defaultUpdateLogic": "update_all" 5 } 6 }, 7 "commitments": [ 8 { 9 "amount": 150.25, 10 "currencyIsoCode": "USD", 11 "transactionPeriod": "monthly", 12 "transactionInterval": 3, 13 "transactionDay": "5", 14 "startDate": "2024-07-06", 15 "endDate": "2024-07-06", 16 "campaign": { 17 "id": "701y0030d0zk6t06f4" 18 }, 19 "outreachSourceCode": { 20 "id": "0gx000d0d0d0FD", 21 "sourceCode": "AnimalEmailCampaign2023" 22 }, 23 "donor": { 24 "donorType": "individual", 25 "id": "0015500000WO1ZiAAL", 26 "organizationName": "mini cat town", 27 "firstName": "Daniel", 28 "lastName": "Chavez", 29 "phone": "510-432-9876", 30 "email": "d.chavez.com", 31 "address": [ 32 { 33 "addressType": "mailing", 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": "Diner's Club", 55 "bankName": "chase", 56 "digitalWalletProvider": "EwalletProvider", 57 "bankAccountHolderType": "primary", 58 "bankAccountType": "checking", 59 "bankAccountNumber": "123456", 60 "bankCode": "HBUK", 61 "gatewayName": "Gateway", 62 "processorName": "Centpro", 63 "processorPaymentReference": "string", 64 "gatewayReference": "string" 65 }, 66 "designations": [ 67 { 68 "designationId": "0gd0030f0303024", 69 "percent": 10 70 } 71 ], 72 "firstTransaction": { 73 "amount": 150.25, 74 "receivedDate": "2024-07-06", 75 "donorCoverAmount": 0.25, 76 "transactionStatus": "Unpaid", 77 "gatewayTransactionFee": 0.75, 78 "processorTransactionFee": 0.45, 79 "processorReference": "cls-1247586928747", 80 "gatewayReference": "102656693ac3ca6e0cdafbfe89ab99", 81 "lastGatewayResponseCode": "invalid_cvc", 82 "lastGatewayErrorMessage": "The card’s security code is invalid. Check the card’s security code or use a different card.", 83 "lastGatewayProcessedDateTime": "2023-07-06T21:57:51Z" 84 }, 85 "giftCommitmentCustomFields": [ 86 { 87 "fieldName": "string", 88 "fieldValue": "string" 89 } 90 ], 91 "giftCommitmentScheduleCustomFields": [ 92 { 93 "fieldName": "string", 94 "fieldValue": "string" 95 } 96 ] 97 } 98 ] 99} - Properties
-
Name Type Description Required or Optional Available Version commitments Create Commitment Request Input[] Details of the request to create the commitment. Limited to one commitment only for API version 60.0.
Multiple commitments in a single request are available in later releases.
Required 60.0 processingOptions Processing Options Details Input Options for the donor matching process. Optional 60.0
- Response body for POST
- Create Commitment