---
title: "/commitments/recurringPayments"
method: POST
path: "/commitments/recurringPayment"
---

# /commitments/recurringPayments

`POST /commitments/recurringPayment`

## Request

- Base URL: `https://api.securevan.com/v4`
- URL: `https://api.securevan.com/v4/commitments/recurringPayment`
- Auth: HTTP basic

Creates a Recurring Commitment record and processes or initiates the first installment contribution with the payment information provided in the request body.

## Headers

- `idempotencyKey` string, required

## Request body

- object
  - `contact` object, required: The [Person](ref:people) who contributed.
    - `vanId` string
  - `designation` object, required: The [Designation](ref:designations) which will receive funds associated with this Recurring Commitment.
    - `designationId` integer
  - `gatewayId` integer, required: The payment gateway which will process installments of this Recurring Commitment.
  - `startDate` string, date, required: The date upon which the first installment of the Recurring Commitment should be processed.
  - `endDate` string, date: The date upon which no further installments of the Recurring Commitment should be processed.
  - `frequency` 'Weekly' | 'EveryTwoWeeks' | 'EveryFourWeeks' | 'Monthly' | 'TwiceMonthly' | 'Quarterly' | 'Annually' | 'TwiceAnnually', required: The Frequency on which all Recurring Commitment installments will be processed.
  - `amount` number, double, required: Monetary amount of each Recurring Commitment installment. Non-positive values, and values that have more than 2 digits after the decimal point, will not be accepted. Must be between $0.01 and $999,999.99, inclusive.
  - `paymentMethod` object, required: Payment information that will be used to process each installment of the Recurring Commitment.
    - `paymentType` 'CreditCard' | 'ElectronicFundsTransfer': The value of PaymentType determines the required parameters for the rest of this object. CreditCard requires creditCardNumber, expirationMonth, expirationYear, with cvv optional; ElectronicFundsTransfer requires accountType, routingNumber, accountNumber. Including CreditCard fields with paymentType EFT or vice versa will be treated as an invalid request.
    - `creditCardNumber` string: Credit card payments - credit card number
    - `cvv` string: Credit card payments - credit card cvv
    - `expirationMonth` string: Credit card payments - two-digit expiration month of card
    - `expirationYear` string: Credit card payments - four-digit expiration year
    - `accountType` 'PersonalChecking' | 'PersonalSavings': ElectronicFundsTransfer payments - the type of account
    - `accountNumber` string: ElectronicFundsTransfer payments - account number
    - `routingNumber` string: ElectronicFundsTransfer payments - routing number
  - `codes` object[]: An array of zero or one [Code](ref:codes) to apply to the Recurring Commitment. Recurring Commitments may not have more than one Code applied, and if a Code is applied, it must be a Source Code.
    - `codeId` integer, required
    - `codeName` string
  - `generalLedgerFund` object: The associated generalLedgerFund object.
    - `generalLedgerFundId` integer: ID of the general ledger fund
  - `costCenter` object: The associated CostCenter object.
    - `costCenterId` integer: ID of the CostCenter
  - `directMarketingCode` string: The direct marketing code.
  - `notes` string: A note describing the Recurring Commitment.
  - `extendedSourceCode` object: The [Extended Source Code](ref:extendedsourcecodes) object to apply to the Recurring Commitment. Only the extendedSoureCodeId property is required. If this is provided, we’ll look for and apply a matching Source Code to the commitment from a Direct Response Plan segment that the contact is in with a contact history record that has the extended source code. If no matching source code is found, then the POST will fail.
    - `extendedSourceCodeID` integer: The ID of the extended source code to associate with this commitment

## Response `201`

201

## Other responses

- `400`: 400
- `401`: 401
- `403`: 403
- `409`: 409
- `500`: 500

## Changes

- **2026-11-03** `4f2049fba5af`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ngpvan/apis/van-crm/changes/commitments/recurringPayment/post.md)

---

[API](https://skmtc.dev/ngpvan/apis/van-crm.md) - [All operations](https://skmtc.dev/ngpvan/apis/van-crm/llms.txt) - [OpenAPI document](https://skmtc.dev/ngpvan/apis/van-crm/revisions/4f2049fba5af?raw)