Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

Commitment Payment Updates Request Input

Input representation of the details of the gift commitment and payment instrument.

JSON example

You can pass the campaign, donor, and designation IDs in an externalId object containing fieldName and fieldValue.

Note

1{
2  "giftCommitmentId": "6TR5500000WO1ZIFGE",
3  "paymentInstrument": {
4    "type": "Venmo",
5    "accountHolderName": "Daniel Chavez",
6    "expiryMonth": "10",
7    "expiryYear": "2026",
8    "last4": "4321",
9    "cardBrand": "visa",
10    "bankName": "chase",
11    "digitalWalletProvider": "Diner's Club",
12    "bankAccountHolderType": "primary",
13    "bankAccountType": "checking",
14    "bankAccountNumber": "123456",
15    "bankCode": "HBUK",
16    "gatewayName": "Gateway",
17    "processorName": "Centpro",
18    "processorPaymentReference": "string",
19    "gatewayReference": "string"
20  }
21}

Properties

Name Type Description Required or Optional Available Version
gift​CommitmentId String ID of the gift commitment record for the payment update. This ID can also be passed as an externalID. Required 60.0
payment​Instrument Payment Instrument Details Input Contains details about the payment instrument. Required 60.0

Example externalID format:

1{
2  "externalId": {
3    "fieldName": "<EXTERNAL_ID_FIELD_NAME>",
4    "fieldValue": "<EXTERNAL_ID_FIELD_VALUE>"
5  }
6}