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.

Gift Transactions

Get gift transactions associated with a gift commitment record.

Resource:

1/connect/fundraising/gift-commitments/${commitmentId}/gift-transactions

Resource examples:

1https://yourInstance.salesforce.com/services/data/v67.0/connect/fundraising/gift-commitments/6gcxx000004WhULAA0/gift-transactions
1https://yourInstance.salesforce.com/services/data/v67.0/connect/fundraising/gift-commitments/6gcxx000004WhULAA0/gift-transactions?count=2&period=Recent&status=Canceled,Failed
1https://yourInstance.salesforce.com/services/data/v67.0/connect/fundraising/gift-commitments/6gcxx000004WhULAA0/gift-transactions?count=2&period=Past&fromDate=2023-02-11T13:05:23.000Z

Available version: 59.0

HTTP methods: GET

Query parameters for GET

Parameter Name Type Description Required or Optional Available Version
count Integer Number of gift transactions to be retrieved.

You can get a maximum of 12 transactions in one request.

By default, the API returns 12 transactions.

Optional 59.0
fromDate String Date (yyyy-MM-dd'T'HH:mm:ss.SSSX) from when you want to get the transactions. This field is not applicable if period is Recent. Optional 59.0
period String Period for getting gift transactions. possible values are:
  • Future
  • Past
  • Recent
The default period is Future.
Optional 59.0
status String[] Comma-separated list of gift-transactions statuses. Possible values are:
  • Canceled
  • Failed
  • Fully Refunded
  • Paid
  • Unpaid
  • Written-Off

The default status is Unpaid.

Optional 59.0

Response body for GET: Gift Transactions Output