Nonprofit Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introduction to Nonprofit Cloud
Nonprofit Cloud Data Model
Fundraising
Fundraising Standard Objects
Fundraising Fields on Other Objects
Fundraising Business APIs
Resources
Gifts Transactions (POST)
Commitments (POST)
Commitments (PATCH)
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
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
/connect/fundraising/commitments/payment-updates
Resource example
https://yourInstance.salesforce.com/services/data/v63.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
{
  "updates": [
    {
      "giftCommitmentId": "6TR5500000WO1ZIFGE",
      "paymentInstrument": {
        "type": "Venmo",
        "accountHolderName": "Daniel Chavez",
        "expiryMonth": "10",
        "expiryYear": "2026",
        "last4": "4321",
        "cardBrand": "visa",
        "bankName": "chase",
        "digitalWalletProvider": "Diner's Club",
        "bankAccountHolderType": "primary",
        "bankAccountType": "checking",
        "bankAccountNumber": "123456",
        "bankCode": "HBUK",
        "gatewayName": "Gateway",
        "processorName": "Centpro",
        "processorPaymentReference": "string",
        "gatewayReference": "string"
      }
    }
  ]
}
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