NGngpvan

/contributions/{contributionId}/adjustments

Changed on

Use this endpoint to adjust an existing contribution with the properties provided in the request body. Only contributions processed by the CRM are supported.

Currently “Refund” is the only adjustment type supported by the API. Using this adjustment type will issue a refund to the donor.

post/contributions/{contributionId}/adjustments

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/contributions/{contributionId}/adjustments
  • Auth
    HTTP basic

Path parameters

contributionIdinteger required

Unique contribution identifier available in the current context

Request body

adjustmentTypestring
amountnumber double

Monetary amount of the adjustment. Must be between $0.01 and $999,999.99, inclusive. Values with more than 2 digits after the decimal point will not be accepted.

datePostedstring date

Response

200

contributionIdinteger
adjustmentIdinteger
originalAmountinteger
remainingAmountinteger
dateAdjustedstring

Example response

{
  "contributionId": 123,
  "adjustmentId": 2,
  "originalAmount": 20,
  "remainingAmount": 10,
  "dateAdjusted": "2020-03-04"
}

Changes