Create Commitment Input
Input representation of the request to create commitments.
JSON example
1{
2 "processingOptions": {
3 "donorOptions": {
4 "defaultUpdateLogic": "update_all"
5 },
6 "disableGiftTransactionValidations": true,
7 "disableGiftCommitmentValidations": true,
8 "disableGiftCommitmentScheduleValidations": true
9 },
10 "commitments": [
11 {
12 "amount": 150.25,
13 "type": "pledge",
14 "currencyIsoCode": "USD",
15 "transactionPeriod": "monthly",
16 "transactionInterval": 3,
17 "transactionDay": "5",
18 "startDate": "2024-07-06",
19 "endDate": "2024-07-06",
20 "campaign": {
21 "id": "701y0030d0zk6t06f4"
22 },
23 "outreachSourceCode": {
24 "id": "0gx000d0d0d0FD",
25 "sourceCode": "AnimalEmailCampaign2023"
26 },
27 "donor": {
28 "donorType": "individual",
29 "id": "0015500000WO1ZxxAL",
30 "organizationName": "mini cat town",
31 "firstName": "Daniel",
32 "lastName": "Chavez",
33 "phone": "510-432-9876",
34 "email": "d.chavez.com",
35 "address": [
36 {
37 "street": "123 Main Street",
38 "city": "Oakland",
39 "state": "CA",
40 "postalCode": "94610",
41 "country": "US"
42 }
43 ],
44 "accountCustomFields": [
45 {
46 "fieldName": "string",
47 "fieldValue": "string"
48 }
49 ]
50 },
51 "paymentInstrument": {
52 "type": "Credit Card",
53 "accountHolderName": "Daniel Chavez",
54 "expiryMonth": "10",
55 "expiryYear": "2026",
56 "last4": "4321",
57 "cardBrand": "Diner's Club",
58 "bankName": "chase",
59 "digitalWalletProvider": "EwalletProvider",
60 "bankAccountHolderType": "primary",
61 "bankAccountType": "checking",
62 "bankAccountNumber": "123456",
63 "bankCode": "HBUK",
64 "gatewayName": "Gateway",
65 "processorName": "Centpro",
66 "processorPaymentReference": "string",
67 "gatewayReference": "string"
68 },
69 "designations": [
70 {
71 "designationId": "0gd0030f0303024",
72 "percent": 10
73 }
74 ],
75 "firstTransaction": {
76 "amount": 150.25,
77 "receivedDate": "2024-07-06",
78 "donorCoverAmount": 0.25,
79 "transactionStatus": "Unpaid",
80 "gatewayTransactionFee": 0.75,
81 "processorTransactionFee": 0.45,
82 "processorReference": "cls-1247586928747",
83 "gatewayReference": "102656693ac3ca6e0cdafbfe89ab99",
84 "lastGatewayResponseCode": "invalid_cvc",
85 "lastGatewayErrorMessage": "The card's security code is invalid. Check the card's security code or use a different card.",
86 "lastGatewayProcessedDateTime": "2023-07-06T21:57:51Z"
87 },
88 "giftCommitmentCustomFields": [
89 {
90 "fieldName": "string",
91 "fieldValue": "string"
92 }
93 ],
94 "giftCommitmentScheduleCustomFields": [
95 {
96 "fieldName": "string",
97 "fieldValue": "string"
98 }
99 ],
100 "giftTransactionCustomFields": [
101 {
102 "fieldName": "string",
103 "fieldValue": "string"
104 }
105 ]
106 }
107 ]
108}Properties
| Name | Type | Description | Required or Optional | Available Version |
|---|---|---|---|---|
| commitments | Create Commitment Request Input[] | Details of the request to create the commitment. Limited to 100 commitments in a single request. | Required | 60.0 |
| processingOptions | Processing Options Details Input | Options for donor matching process and gift validation pausing. | Optional | 60.0 |