NGngpvan

/commitments

Changed on

Use this endpoint to create a new Commitment record with the properties provided in the request body. If successful, the endpoint responds with HTTP Status Code 201 Created and the integer ID of the created Recurring Commitment in the response body. If any of the specified ids (vanId, codeId, or extendedSourceCodeId) are not accessible in the current context (e.g., the associated api user does not have access to the person), the response will be considered invalid.

post/commitments

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/commitments
  • Auth
    HTTP basic

Request body

startDatestring date required

The date the Recurring Commitment started. The startDate must be the same or later than the current US Eastern Time date.

endDatestring date

The date the Recurring Commitment ended. If present, endDate must be later than startDate.

frequency'Weekly' | 'EveryTwoWeeks' | 'EveryFourWeeks' | 'Monthly' | 'TwiceMonthly' | 'Quarterly' | 'Annually' | 'TwiceAnnually' required

The frequency of each recurring commitment installment.

amountnumber double required

Decimal monetary amount of each Recurring Commitment installment.

paymentType'Check' | 'MoneyOrder' | 'Cash' | 'CreditCard' | 'InKind' | 'Unknown' | 'ElectronicFundsTransfer' | 'ElectronicPaySystem' | 'Stock' | 'ApplePay' required

Payment method by which the funds will be contributed

directMarketingCodestring

A direct marketing code

notesstring

A note describing this commitment

Response

201

Changes