Nonprofit Cloud Developer Guide

Introduction to Nonprofit Cloud
Nonprofit Cloud Data Model
Fundraising
Fundraising Standard Objects
Fundraising Fields on Other Objects
Fundraising Business APIs
Resources
Commitments (POST)
Commitments (PATCH)
Gift Transactions
Gift Transaction Designations
Gift Commitment Transactions
Gift Commitment Default Designations
Gift Campaign Default Designations
Gifts Transactions (POST)
Transactions Payment Updates (POST)
Commitments Payment Updates (POST)
Request Bodies
Response Bodies
Fundraising Invocable Actions
Fundraising Metadata API Types
Fundraising Tooling API Objects
Program Management
Case Management
Outcome Management Standard Objects
Grantmaking
Volunteer Management Standard Objects
Volunteer Management Fields on Other Objects
Group Memberships and Households in Nonprofit Cloud
Record Rollup Definitions
NonProfit Cloud Associated Objects
PDF

Commitments Payment Updates (POST)

Update the metadata for your payment instruments for all active gift commitments.
Resource
1/connect/fundraising/commitments/payment-updates
Resource example
1https://yourInstance.salesforce.com/services/data/v66.0/connect/fundraising/commitments/payment-updates
Available version
60.0
HTTP methods
POST
Request body for POST

You can pass the commitment ID in an externalId object containing fieldName and fieldValue.

Note

JSON example
1{
2  "updates": [
3    {
4      "giftCommitmentId": "6TR5500000WO1ZIFGE",
5      "paymentInstrument": {
6        "type": "Venmo",
7        "accountHolderName": "Daniel Chavez",
8        "expiryMonth": "10",
9        "expiryYear": "2026",
10        "last4": "4321",
11        "cardBrand": "visa",
12        "bankName": "chase",
13        "digitalWalletProvider": "Diner's Club",
14        "bankAccountHolderType": "primary",
15        "bankAccountType": "checking",
16        "bankAccountNumber": "123456",
17        "bankCode": "HBUK",
18        "gatewayName": "Gateway",
19        "processorName": "Centpro",
20        "processorPaymentReference": "string",
21        "gatewayReference": "string"
22      }
23    }
24  ]
25}
Properties
Name Type Description Required or Optional Available Version
updates Commitment Payment Updates Request Input[] Contains the request details to update the commitment payment. Required 60.0
Response body for POST
Commitment Payment Updates