Update Commitment Input

Input representation of the request to update a commitment.

JSON example

1{
2  "amount": 150.25,
3  "transactionPeriod": "monthly",
4  "transactionInterval": 3,
5  "transactionDay": "5",
6  "startDate": "2024-07-06",
7  "endDate": "2024-07-06",
8  "campaign": {
9    "id": "701y0030d0zk6t06f4"
10  },
11  "outreachSourceCode": {
12    "id": "0gx000d0d0d0FD",
13    "sourceCode": "AnimalEmailCampaign2023"
14  },
15  "paymentInstrument": {
16    "type": "Credit Card",
17    "accountHolderName": "Daniel Chavez",
18    "expiryMonth": "10",
19    "expiryYear": "2026",
20    "last4": "4321",
21    "cardBrand": "Diner's Club",
22    "bankName": "chase",
23    "digitalWalletProvider": "EProvider",
24    "bankAccountHolderType": "primary",
25    "bankAccountType": "checking",
26    "bankAccountNumber": "123456",
27    "bankCode": "HBUK",
28    "gatewayName": "Gateway",
29    "processorName": "Centpro",
30    "processorPaymentReference": "string",
31    "gatewayReference": "string"
32  },
33  "giftCommitmentCustomFields": [
34    {
35      "fieldName": "string",
36      "fieldValue": "string"
37    }
38  ],
39  "giftCommitmentScheduleCustomFields": [
40    {
41      "fieldName": "string",
42      "fieldValue": "string"
43    }
44  ]
45}

Properties

Name	Type	Description	Required or Optional	Available Version
`amount`	Double	Gift amount of each transaction associated with the gift commitment schedule.	Required	60.0
`campaign`	Campaign Details	Campaign that's associated with the gift commitment.	Optional	60.0
`currencyIsoCode`	String	Currency ISO code of the gift commitment.	Optional	60.0
`endDate`	String	End date of the new schedule for this gift commitment. The default format is `YYYY-MM-DD`.	Optional	60.0
`giftCommitmentCustomFields`	Custom Field Details[]	Custom fields of the gift commitment.	Optional	60.0
`giftCommitmentScheduleCustomFields`	Custom Field Details[]	Custom fields of the gift commitment schedule.	Optional	60.0
`outreachSourceCode`	Outreach Source Code Details	Outreach source code that's associated with the campaign for the gift commitment.	Optional	60.0
`paymentInstrument`	Payment Instrument Details	Payment instrument that's used to complete the transaction.	Required	60.0
`startDate`	String	Start date of the new schedule for this gift commitment. The default format is `YYYY-MM-DD`.	Required	60.0
`transactionDay`	String	Specifies the day of the month to create gift transaction in the future for a monthly transaction period. If you select the day as 29 or 30, the gift transaction is created on the last day for the months that don't have that many days.	Optional	60.0
`transactionInterval`	Integer	Transaction interval that's applicable to an incoming transaction in the commitment.	Optional	60.0
`transactionPeriod`	String	Transaction period that's applicable to the incoming transaction in the commitment.	Required	60.0

Nonprofit Cloud Developer Guide

Update Commitment Input