/commitments/{commitmentId} SWAP

Changed on

Use this endpoint to update a recurring commitment. You can currently:

  1. Cancel a commitment
  2. Update the next transaction date
  3. Update the commitment amount

Please note that you cannot update a commitment you are attempting to cancel. The cancellation will be processed first, and any other changes will be ignored.

patch/commitments/{commitmentId} SWAP

Request

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

Path parameters

commitmentIdinteger required

Required; Unique commitment identifier available in the current context

Request body

status'InactiveCancelled'

The status of the commitment

NextTransactionDatestring date
Amountnumber double

Decimal amount of currency to process each transaction

Response

202

Changes