API Reference

Weekly Payment

post
https://v2/paymentplan/weekly

Creates a payment plan where the payment is taken weekly

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

New weekly payment plan

string
required

The customer's FCCID

string

The customer's FCAID

boolean
required

Whether the plan is contractual or not. A contractual payment plan cannot break; if payments are missed, it maintains an arrears balance. Only one contractual payment plan can exist at either the Account or Customer level, not both. You can have one per Account if the contractual payment plan is at the Account level.

string

The arrangement code

string

The note to attach to the plan

string
required

The start date for this plan

paymentMethod
required
string
enum
required

Payment plan types that aren't a single frequency

Allowed:
number
required

The frequency at which the payment repeats. E.g interval of 2 would take a payment every two months

string

The fixed payment amount for this plan

string

The total payment amount for this plan

number
enum
required

The day of the week the payment will be taken on (0-6, 0 = Monday, 6 = Sunday)

Allowed:
Responses

Updated over 2 years ago

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago