Salesforce Commitment API

The Commitment API from Salesforce — 1 operation(s) for commitment.

Documentation GitHub OpenAPI

Operations 1

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

POST /data/v64.0/connect/fundraising/commitments/payment-updates Update payment methods on gift commitments · Salesforce Update Commitment Payments #

Ask an LLM

“Can I change the card or bank account future gifts are charged to?”

“Which gift commitments can have their payment instrument updated?”

Tell an agent

Update the payment instruments on these gift commitments: {updates}.

Apply payment updates {updates} to active donor commitments.

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/salesforce:salesforce-commitment-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: Salesforce Commitment API
  description: Find the resources you need to start building.
  contact: {}
  version: '1.0'
servers:
- url: https://login.salesforce.com
  variables: {}
- url: https://id
  variables: {}
- url: https://services
  variables: {}
- url: '{{url}}{{site}}/services/oauth2'
  variables:
    url:
      default: DefaultParameterValue
    site:
      default: DefaultParameterValue
security:
- oauth2:
  - api
tags:
- name: Commitment
paths:
  /data/v64.0/connect/fundraising/commitments/payment-updates:
    parameters: []
    post:
      tags:
      - Commitment
      summary: Salesforce Update Commitment Payments
      description: 'Update the future payment instrument metadata for active gift commitments.


        ## Required Attributes:


        - giftCommitmentId


        - paymentInstrument.type'
      operationId: UpdateCommitmentPayments
      parameters: []
      requestBody:
        description: ''
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/UpdateCommitmentPaymentsRequest'
              - examples:
                - updates:
                  - giftCommitmentId: <SFDC_GIFT_COMMITMENT_ID>
                    paymentInstrument:
                      type: credit card
                      accountHolderName: test donor 1
                      expiryMonth: '10'
                      expiryYear: '2026'
                      last4: '4585'
                      cardBrand: visa
                      bankName: chase
                      digitalWalletProvider: apple pay
                      bankAccountHolderType: primary
                      bankAccountType: checking
                      bankAccountNumber: '123456'
                      bankCode: HBUK
                      gatewayName: stripe
                      processorName: classy
                      processorPaymentReference: string
                      gatewayReference: string
                  - giftCommitmentId: <SFDC_GIFT_COMMITMENT_ID>
                    paymentInstrument:
                      type: credit card
                      accountHolderName: test donor 2
                      expiryMonth: '10'
                      expiryYear: '2026'
                      last4: '4585'
                      cardBrand: visa
                      bankName: chase
                      digitalWalletProvider: apple pay
                      bankAccountHolderType: primary
                      bankAccountType: checking
                      bankAccountNumber: '123456'
                      bankCode: HBUK
                      gatewayName: stripe
                      processorName: test processor
                      processorPaymentReference: string
                      gatewayReference: string
              contentMediaType: application/json
            example:
              updates:
              - giftCommitmentId: <SFDC_GIFT_COMMITMENT_ID>
                paymentInstrument:
                  type: credit card
                  accountHolderName: test donor 1
                  expiryMonth: '10'
                  expiryYear: '2026'
                  last4: '4585'
                  cardBrand: visa
                  bankName: chase
                  digitalWalletProvider: apple pay
                  bankAccountHolderType: primary
                  bankAccountType: checking
                  bankAccountNumber: '123456'
                  bankCode: HBUK
                  gatewayName: stripe
                  processorName: classy
                  processorPaymentReference: string
                  gatewayReference: string
              - giftCommitmentId: <SFDC_GIFT_COMMITMENT_ID>
                paymentInstrument:
                  type: credit card
                  accountHolderName: test donor 2
                  expiryMonth: '10'
                  expiryYear: '2026'
                  last4: '4585'
                  cardBrand: visa
                  bankName: chase
                  digitalWalletProvider: apple pay
                  bankAccountHolderType: primary
                  bankAccountType: checking
                  bankAccountNumber: '123456'
                  bankCode: HBUK
                  gatewayName: stripe
                  processorName: test processor
                  processorPaymentReference: string
                  gatewayReference: string
        required: true
      responses:
        '200':
          description: OK
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Status201-UpdateCommitmentSuccess'
                - examples:
                  - successes: 2
                    failures: 0
                    notProcessed: 0
                    details:
                    - success: true
                      links:
                        giftcommitment:
                          href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>
                          id: <SFDC_GIFT_COMMITMENT_ID>
                        paymentinstrument:
                          href: /services/data/vXX.X/sobjects/sObject/<SFDC_PAYMENT_INSTRUMENT_ID>
                          id: <SFDC_PAYMENT_INSTRUMENT_ID>
                    - success: true
                      links:
                        giftcommitment:
                          href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>
                          id: <SFDC_GIFT_COMMITMENT_ID>
                        paymentinstrument:
                          href: /services/data/vXX.X/sobjects/sObject/<SFDC_PAYMENT_INSTRUMENT_ID>
                          id: <SFDC_PAYMENT_INSTRUMENT_ID>
                contentMediaType: application/json
              example:
                successes: 2
                failures: 0
                notProcessed: 0
                details:
                - success: true
                  links:
                    giftcommitment:
                      href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>
                      id: <SFDC_GIFT_COMMITMENT_ID>
                    paymentinstrument:
                      href: /services/data/vXX.X/sobjects/sObject/<SFDC_PAYMENT_INSTRUMENT_ID>
                      id: <SFDC_PAYMENT_INSTRUMENT_ID>
                - success: true
                  links:
                    giftcommitment:
                      href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>
                      id: <SFDC_GIFT_COMMITMENT_ID>
                    paymentinstrument:
                      href: /services/data/vXX.X/sobjects/sObject/<SFDC_PAYMENT_INSTRUMENT_ID>
                      id: <SFDC_PAYMENT_INSTRUMENT_ID>
        '201':
          description: Created
          headers: {}
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Status200-UpdateCommitmentRequestValidationFailure1'
                - examples:
                  - successes: 1
                    failures: 1
                    notProcessed: 0
                    details:
                    - success: false
                      errors:
                        field: id
                        message: <invalid id message>
                    - success: true
                      links:
                        giftcommitment:
                          href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>
                          id: <SFDC_GIFT_COMMITMENT_ID>
                        paymentinstrument:
                          href: /services/data/vXX.X/sobjects/sObject/<SFDC_PAYMENT_INSTRUMENT_ID>
                          id: <SFDC_PAYMENT_INSTRUMENT_ID>
                contentMediaType: application/json
              example:
                successes: 1
                failures: 1
                notProcessed: 0
                details:
                - success: false
                  errors:
                    field: id
                    message: <invalid id message>
                - success: true
                  links:
                    giftcommitment:
                      href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>
                      id: <SFDC_GIFT_COMMITMENT_ID>
                    paymentinstrument:
                      href: /services/data/vXX.X/sobjects/sObject/<SFDC_PAYMENT_INSTRUMENT_ID>
                      id: <SFDC_PAYMENT_INSTRUMENT_ID>
        '400':
          description: Bad Request
          headers: {}
          content:
            application/json:
              schema:
                type: string
                examples:
                - "    // Even if the JSON request is valid, this is an example of a 400 error code that will be returned if duplicate matching rules are not active. Any non 200 error code would have a similar response structure.\n    {\n        \"errorCode\": \"UNKNOWN_EXCEPTION\",\n        \"message\": \"Provide active duplicate matching rules on Account and Person Account for donor matching. -- industries.fundraisingops.connect.impl.validator.ValidatorUtil.validateMatchingMethod(ValidatorUtil.java:103)\"\n    }"
                contentMediaType: application/json
              example: "    // Even if the JSON request is valid, this is an example of a 400 error code that will be returned if duplicate matching rules are not active. Any non 200 error code would have a similar response structure.\n    {\n        \"errorCode\": \"UNKNOWN_EXCEPTION\",\n        \"message\": \"Provide active duplicate matching rules on Account and Person Account for donor matching. -- industries.fundraisingops.connect.impl.validator.ValidatorUtil.validateMatchingMethod(ValidatorUtil.java:103)\"\n    }"
      deprecated: false
      servers:
      - url: https://services
        variables: {}
      x-api-evangelist-processing:
        PascalCaseOperationSummaries: true
        ChooseTags: true
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    UpdateCommitmentPaymentsRequest:
      title: UpdateCommitmentPaymentsRequest
      required:
      - updates
      type: object
      properties:
        updates:
          type: array
          items:
            $ref: '#/components/schemas/Update1'
          description: ''
          example: []
      examples:
      - updates:
        - giftCommitmentId: <SFDC_GIFT_COMMITMENT_ID>
          paymentInstrument:
            type: credit card
            accountHolderName: test donor 1
            expiryMonth: '10'
            expiryYear: '2026'
            last4: '4585'
            cardBrand: visa
            bankName: chase
            digitalWalletProvider: apple pay
            bankAccountHolderType: primary
            bankAccountType: checking
            bankAccountNumber: '123456'
            bankCode: HBUK
            gatewayName: stripe
            processorName: classy
            processorPaymentReference: string
            gatewayReference: string
        - giftCommitmentId: <SFDC_GIFT_COMMITMENT_ID>
          paymentInstrument:
            type: credit card
            accountHolderName: test donor 2
            expiryMonth: '10'
            expiryYear: '2026'
            last4: '4585'
            cardBrand: visa
            bankName: chase
            digitalWalletProvider: apple pay
            bankAccountHolderType: primary
            bankAccountType: checking
            bankAccountNumber: '123456'
            bankCode: HBUK
            gatewayName: stripe
            processorName: test processor
            processorPaymentReference: string
            gatewayReference: string
    Errors:
      title: Errors
      required:
      - field
      - message
      type: object
      properties:
        field:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
      examples:
      - field: id
        message: <invalid id message>
    Paymentinstrument1:
      title: Paymentinstrument1
      required:
      - href
      - id
      type: object
      properties:
        href:
          type: string
          example: example_value
        id:
          type: string
          example: abc123
      examples:
      - href: /services/data/vXX.X/sobjects/sObject/<SFDC_PAYMENT_INSTRUMENT_ID>
        id: <SFDC_PAYMENT_INSTRUMENT_ID>
    Status201-UpdateCommitmentSuccess:
      title: Status201-UpdateCommitmentSuccess
      required:
      - successes
      - failures
      - notProcessed
      - details
      type: object
      properties:
        successes:
          type: integer
          contentEncoding: int32
          example: 10
        failures:
          type: integer
          contentEncoding: int32
          example: 10
        notProcessed:
          type: integer
          contentEncoding: int32
          example: 10
        details:
          type: array
          items:
            $ref: '#/components/schemas/Detail13'
          description: ''
          example: []
      examples:
      - successes: 2
        failures: 0
        notProcessed: 0
        details:
        - success: true
          links:
            giftcommitment:
              href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>
              id: <SFDC_GIFT_COMMITMENT_ID>
            paymentinstrument:
              href: /services/data/vXX.X/sobjects/sObject/<SFDC_PAYMENT_INSTRUMENT_ID>
              id: <SFDC_PAYMENT_INSTRUMENT_ID>
        - success: true
          links:
            giftcommitment:
              href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>
              id: <SFDC_GIFT_COMMITMENT_ID>
            paymentinstrument:
              href: /services/data/vXX.X/sobjects/sObject/<SFDC_PAYMENT_INSTRUMENT_ID>
              id: <SFDC_PAYMENT_INSTRUMENT_ID>
    Giftcommitment:
      title: Giftcommitment
      required:
      - href
      - id
      type: object
      properties:
        href:
          type: string
          example: example_value
        id:
          type: string
          example: abc123
      examples:
      - href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>
        id: <SFDC_GIFT_COMMITMENT_ID>
    Detail13:
      title: Detail13
      required:
      - success
      - links
      type: object
      properties:
        success:
          type: boolean
          example: true
        links:
          $ref: '#/components/schemas/Links13'
      examples:
      - success: true
        links:
          giftcommitment:
            href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>
            id: <SFDC_GIFT_COMMITMENT_ID>
          paymentinstrument:
            href: /services/data/vXX.X/sobjects/sObject/<SFDC_PAYMENT_INSTRUMENT_ID>
            id: <SFDC_PAYMENT_INSTRUMENT_ID>
    Detail14:
      title: Detail14
      required:
      - success
      type: object
      properties:
        success:
          type: boolean
          example: true
        errors:
          $ref: '#/components/schemas/Errors'
        links:
          $ref: '#/components/schemas/Links13'
      examples:
      - success: false
        errors:
          field: id
          message: <invalid id message>
    Update1:
      title: Update1
      required:
      - giftCommitmentId
      - paymentInstrument
      type: object
      properties:
        giftCommitmentId:
          type: string
          example: '500123'
        paymentInstrument:
          $ref: '#/components/schemas/PaymentInstrument'
      examples:
      - giftCommitmentId: <SFDC_GIFT_COMMITMENT_ID>
        paymentInstrument:
          type: credit card
          accountHolderName: test donor 1
          expiryMonth: '10'
          expiryYear: '2026'
          last4: '4585'
          cardBrand: visa
          bankName: chase
          digitalWalletProvider: apple pay
          bankAccountHolderType: primary
          bankAccountType: checking
          bankAccountNumber: '123456'
          bankCode: HBUK
          gatewayName: stripe
          processorName: classy
          processorPaymentReference: string
          gatewayReference: string
    PaymentInstrument:
      title: PaymentInstrument
      required:
      - type
      - accountHolderName
      - expiryMonth
      - expiryYear
      - last4
      - cardBrand
      - bankName
      - digitalWalletProvider
      - bankAccountHolderType
      - bankAccountType
      - bankAccountNumber
      - bankCode
      - gatewayName
      - processorName
      - processorPaymentReference
      - gatewayReference
      type: object
      properties:
        type:
          type: string
          example: example_value
        accountHolderName:
          type: string
          example: 42
        expiryMonth:
          type: string
          example: example_value
        expiryYear:
          type: string
          example: example_value
        last4:
          type: string
          example: example_value
        cardBrand:
          type: string
          example: example_value
        bankName:
          type: string
          example: example_value
        digitalWalletProvider:
          type: string
          example: example_value
        bankAccountHolderType:
          type: string
          example: 42
        bankAccountType:
          type: string
          example: 42
        bankAccountNumber:
          type: string
          example: 42
        bankCode:
          type: string
          example: example_value
        gatewayName:
          type: string
          example: example_value
        processorName:
          type: string
          example: example_value
        processorPaymentReference:
          type: string
          example: example_value
        gatewayReference:
          type: string
          example: example_value
      examples:
      - type: credit card
        accountHolderName: test donor
        expiryMonth: '10'
        expiryYear: '2027'
        last4: '4585'
        cardBrand: visa
        bankName: chase
        digitalWalletProvider: apple pay
        bankAccountHolderType: primary
        bankAccountType: checking
        bankAccountNumber: '123456'
        bankCode: HBUK
        gatewayName: stripe
        processorName: test processor
        processorPaymentReference: string
        gatewayReference: string
    Links13:
      title: Links13
      required:
      - giftcommitment
      - paymentinstrument
      type: object
      properties:
        giftcommitment:
          $ref: '#/components/schemas/Giftcommitment'
        paymentinstrument:
          $ref: '#/components/schemas/Paymentinstrument1'
      examples:
      - giftcommitment:
          href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>
          id: <SFDC_GIFT_COMMITMENT_ID>
        paymentinstrument:
          href: /services/data/vXX.X/sobjects/sObject/<SFDC_PAYMENT_INSTRUMENT_ID>
          id: <SFDC_PAYMENT_INSTRUMENT_ID>
    Status200-UpdateCommitmentRequestValidationFailure1:
      title: Status200-UpdateCommitmentRequestValidationFailure1
      required:
      - successes
      - failures
      - notProcessed
      - details
      type: object
      properties:
        successes:
          type: integer
          contentEncoding: int32
          example: 10
        failures:
          type: integer
          contentEncoding: int32
          example: 10
        notProcessed:
          type: integer
          contentEncoding: int32
          example: 10
        details:
          type: array
          items:
            $ref: '#/components/schemas/Detail14'
          description: ''
          example: []
      examples:
      - successes: 1
        failures: 1
        notProcessed: 0
        details:
        - success: false
          errors:
            field: id
            message: <invalid id message>
        - success: true
          links:
            giftcommitment:
              href: /services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>
              id: <SFDC_GIFT_COMMITMENT_ID>
            paymentinstrument:
              href: /services/data/vXX.X/sobjects/sObject/<SFDC_PAYMENT_INSTRUMENT_ID>
              id: <SFDC_PAYMENT_INSTRUMENT_ID>
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        implicit:
          authorizationUrl: '{DefaultParameterValue}{DefaultParameterValue}/services/oauth2/authorize'
          scopes:
            api: ''