NGngpvan

/commitments/{commitmentId}

Changed on

Updates or cancels an existing recurring commitment

patch/commitments/{commitmentId}

Request

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

Path parameters

commitmentIdinteger required

Required; Unique commitment identifier available in the current context

Request body

status'Active' | 'InactiveCancelled'

The status of the commitment

NextTransactionDatestring date
Amountnumber double

Decimal monetary amount of each Recurring Commitment installment. Must be between $0.01 and $999,999.99 inclusive, unless disclosure fields are enabled, in which case all positive or negative values are allowed. May not have more than 2 digits after the decimal point.

endDatestring date

The date upon which no further installments of the Recurring Commitment should be processed.

Response

202

Changes