Create direct debit batches

Body Params

JSON containing a list of direct debit batches information

directDebitBatches
array of objects
required
length ≥ 1

List of direct debit batches to create

directDebitBatches*
creditor
object
required

Creditor account info. Only one of ID or accountNumber is required.

string
required
length between 0 and 35

Identification of the creditor scheme

directDebits
array of objects
required
length ≥ 1
directDebits*

Set of characteristics that apply to the credit side of the direct debit transaction initiation

number
required
≥ 0

Amount of the direct debit request

string
required
^[a-zA-Z]{3}$

Currency of the direct debit request. Only EUR is currently supported

debtor
object
required

Debtor account info. Only one of ID or accountNumber is required.

string
length between 0 and 35

Optional, if end to end ID is not provided, a unique one will be generated

date
required

Mandate date of signature in ISO extended format yyyy-MM-dd

string
required
length between 0 and 35

Mandate ID

string
required
length between 0 and 140
^[a-zA-Z0-9\s!@#$%^&*()-_=+;:'",.<>?/]*$

Remittance information

date

Requested collection date in ISO extended format yyyy-MM-dd

metadata
object

Metadata associated with all direct debit requests created within this request

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

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