/commitments/recurringPayments

post

https://api.securevan.com/v4/commitments/recurringPayments

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

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

contact

object

required

The Person who contributed.

designation

object

required

The Designation which will receive funds associated with this Recurring Commitment.

gatewayId

int32

required

Defaults to 123456

The payment gateway which will process installments of this Recurring Commitment.

startDate

date

required

Defaults to 2025-01-01

The date upon which the first installment of the Recurring Commitment should be processed.

endDate

date

Defaults to 2025-01-01

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

frequency

string

enum

required

The repeated frequency on which all Recurring Commitment installments will be processed.

amount

double

required

Defaults to 10.26

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.

codes

array of objects

An array of zero or one Code 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.

codes

generalLedgerFund

object

The associated generalLedgerFund object.

costCenter

object

The associated costCenter object.

directMarketingCode

string

The direct marketing code.

notes

string

A note describing the Recurring Commitment.

extendedSourceCode

object

The Extended Source Code 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.

Headers

idempotencyKey

string

required

Defaults to 00000000-0000-0000-0000-000000000123

An unique value generated by the client which the server uses to recognize subsequent retries of the same request. Can be any string at most 50 characters long - we recommend a V4 UUID. Keys are temporary and may be removed from the system after 48 hours.

Responses

201201

400400

401401

403403

409409

500500