Direct Debit Payment Plan

post

{protocol}://{domain}/helpdesk/payment/plans/directdebit

Creates a Direct Debit Payment Plan using an existing Direct Debit (mandate). The Direct Debit (mandate) will be the walletID connected to the payment plan

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

reference

integer

Reference number of account to user to charge, if x-access-token is sent, this is ignored

Body Params

amount

number

required

Required. The total amount that needs to be paid as part of the payment plan.

settlementAmount

number

Optional. The amount to be settled. If omitted, it is assumed to be the same as 'amount'.

date

string

required

Required. The date when the payment plan starts, formatted as YYYY-MM-DD.

walletID

string

required

Required. The LUUID associated with the Direct Debit mandate.

frequency

string

enum

required

Required. Frequency of the payment

Responses

201Successfully created a Direct Debit Payment plan

400There was an error creating the direct debit payment plan

500Internal Server Error