Create the collection schedule for the given mandate-id.

post

https://api-sandbox.modulrfinance.com/api-sandbox-token/mandates/{mandateId}/collectionschedules

Creates a Direct Debit collection schedule; the agreed to framework for the collections for the given mandate-id. This could be a single collection or multiple and includes the frequency and amounts of the planned payments.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

mandateId

string

required

Id of mandate to create collection for.

Body Params

frequency

string

enum

required

length ≥ 1

Frequency for direct-debit collection. Can be one of: ONCE, WEEKLY, EVERY_TWO_WEEKS, EVERY_FOUR_WEEKS, MONTHLY, QUARTERLY, SEMI_ANNUALLY, ANNUALLY.

numberOfPayments

int32

required

≥ 1

Number of payments for direct-debit collection, must be '1' where frequency is 'ONCE'.

firstPaymentAmount

number

0.01 to 20000000

Amount of the first collection payment.
Note: your item limit is set during onboarding will be lower than field maximum and Bacs scheme item limit of £20m.

firstPaymentDate

string

Date of the first collection payment, format must be: yyyy-MM-dd

regularPaymentAmount

number

0.01 to 20000000

Amount of the regular collection payments following first collection amount. Does not apply where the frequency is 'ONCE'.
Note: your item limit is set during onboarding will be lower than field maximum and Bacs scheme item limit of £20m

regularPaymentStartDate

string

Start date of the regular collection payment, format: yyyy-MM-dd
Note: Does not apply where the frequency is 'ONCE'.

currency

string

required

length ≥ 1

Currency in which payment should be made. Must be 'GBP' currently.

externalReference

string

length between 0 and 50

External Reference for collection schedule, should contain only alphanumeric characters, underscore, hyphen and space.
For your internal reconciliation only, not sent to Bacs scheme.

collectionReference

string

length between 0 and 12

An optional additional collection specific reference to be appended to the reference of the mandate.
This is concatenated after the core reference of the mandate, and will be truncated if combined reference is >18 characters.
Should only contain alphanumeric characters, dot, ampersand, forward-slash and hyphen only.

collectionCorrelationName

string

length between 0 and 18

(If enabled by Modulr) an optional collection specific reference appended to abbreviated SU name for the given collection schedule. If feature not enabled, any parameter supplied will be ignored.
When is enabled, this value is concatenated to a Service User Name abbreviation (set by Modulr) to form a Service User name containing extra information that can be used by payer to correlate (identify) transaction easily.
Characters restricted to: alphanumeric characters, numbers, space, dot, ampersand, forward-slash and hyphen only.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

200OK

400Validation errors

404Not Found