Weekly Payment

post https://v2/paymentplan/weekly

Creates a payment plan where the payment is taken weekly

Body Params

FCCID

string

required

The customer's FCCID

FCAID

string

The customer's FCAID

contractual

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.

arrangementCode

string

The arrangement code

notes

string

The note to attach to the plan

startDate

string

required

The start date for this plan

paymentMethod

required

paymentType

string

required

Payment plan types that aren't a single frequency

interval

number

required

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

fixedPaymentAmount

string

The fixed payment amount for this plan

totalPaymentAmount

string

The total payment amount for this plan

dayOfWeek

number

required

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

Responses

xxxxxxxxxx
curl --request POST \
     --url https://v2/paymentplan/weekly \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '
{
  "contractual": true,
  "paymentType": "PaymentPlanFullBalance",
  "dayOfWeek": 0
}
'

201

400