Update Commitment Payments

POST {{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/payment-updates

Update the future payment instrument metadata for active gift commitments.

Required Attributes:

  • giftCommitmentId

  • paymentInstrument.type

Request Body

{"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"}}]}

RESPONSES

status: OK

{&quot;successes&quot;:2,&quot;failures&quot;:0,&quot;notProcessed&quot;:0,&quot;details&quot;:[{&quot;success&quot;:true,&quot;links&quot;:{&quot;giftcommitment&quot;:{&quot;href&quot;:&quot;/services/data/vXX.X/sobjects/sObject/\u003cSFDC_GIFT_COMMITMENT_ID\u003e&quot;,&quot;id&quot;:&quot;\u003cSFDC_GIFT_COMMITMENT_ID\u003e&quot;},&quot;paymentinstrument&quot;:{&quot;href&quot;:&quot;/services/data/vXX.X/sobjects/sObject/\u003cSFDC_PAYMENT_INSTRUMENT_ID\u003e&quot;,&quot;id&quot;:&quot;\u003cSFDC_PAYMENT_INSTRUMENT_ID\u003e&quot;}}},{&quot;success&quot;:true,&quot;links&quot;:{&quot;giftcommitment&quot;:{&quot;href&quot;:&quot;/services/data/vXX.X/sobjects/sObject/\u003cSFDC_GIFT_COMMITMENT_ID\u003e&quot;,&quot;id&quot;:&quot;\u003cSFDC_GIFT_COMMITMENT_ID\u003e&quot;},&quot;paymentinstrument&quot;:{&quot;href&quot;:&quot;/services/data/vXX.X/sobjects/sObject/\u003cSFDC_PAYMENT_INSTRUMENT_ID\u003e&quot;,&quot;id&quot;:&quot;\u003cSFDC_PAYMENT_INSTRUMENT_ID\u003e&quot;}}}]}