Newer Version Available

This content describes an older version of this product. View Latest

Create Commitment Input

Input representation of the request to create commitments.
JSON example
1{
2  "processingOptions": {
3    "donorOptions": {
4      "defaultUpdateLogic": "update_all"
5    }
6  },
7  "commitments": [
8    {
9      "amount": 150.25,
10      "type": "pledge",
11      "currencyIsoCode": "USD",
12      "transactionPeriod": "monthly",
13      "transactionInterval": 3,
14      "transactionDay": "5",
15      "startDate": "2024-07-06",
16      "endDate": "2024-07-06",
17      "campaign": {
18        "id": "701y0030d0zk6t06f4"
19      },
20      "outreachSourceCode": {
21        "id": "0gx000d0d0d0FD",
22        "sourceCode": "AnimalEmailCampaign2023"
23      },
24      "donor": {
25        "donorType": "individual",
26        "id": "0015500000WO1ZxxAL",
27        "organizationName": "mini cat town",
28        "firstName": "Daniel",
29        "lastName": "Chavez",
30        "phone": "510-432-9876",
31        "email": "d.chavez.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": "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 100 commitments in a single request.

Required 60.0
processing​Options Processing Options Details Input Options for the donor matching process. Optional 60.0