NGngpvan

/commitments/recurringPayments

Changed on

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

post/commitments/recurringPayment

Request

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

Headers

idempotencyKeystring required

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.

Request body

gatewayIdinteger required

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

startDatestring date required

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

endDatestring 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.

amountnumber 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.

directMarketingCodestring

The direct marketing code.

notesstring

A note describing the Recurring Commitment.

Response

201

Changes