Initiate a Mandate

post

https://www.bankingcircleconnect.com/api/v1/mandates

The endpoint is used for initiating a Mandate.

Body Params

Mandate details

Request model for creating a new Mandate.

trackingIndicator

boolean

required

Specifies whether the direct debit instructions should be automatically re-submitted periodically.

ultimateCreditor

object

Ultimate party to which an amount of money is due.

creditor

object

required

Party that signs the mandate and to whom an amount of money is due.

creditorAccount

object

required

Unambiguous identification of the account of the creditor to which a credit entry will be posted as a result of the payment transaction.

ultimateDebtor

object

Ultimate party that owes an amount of money to the (ultimate) creditor.

debtor

object

required

Party that signs the mandate and owes an amount of money to the (ultimate) creditor.

debtorAccount

object

required

Unambiguous identification of the account of the debtor, to which a debit entry will be made as a result of the transaction.

type

object

required

Specifies the type of mandate.

collectionAmount

object

Amount information expressed in a amount value and amount currency

firstCollectionAmount

object

Amount information expressed in a amount value and amount currency

maximumAmount

object

Amount information expressed in a amount value and amount currency

occurrences

object

required

Provides details of the duration of the mandate and occurrence of the underlying transactions.

Headers

X-MessageReference

string

Unique reference of the HTTP request.
If left blank this field will be populated with a GUID without dashes.
This field is limited to a maximum of 35 characters, if not upheld the API will return with an error 400 - Bad Request.
Example: 6198eb60-d1dd-4aad-9bbd-b01a49214e62

Idempotency-Key

string

Unique value generated by the user which the API uses to recognize subsequent retries of the same request.
This field is limited to a maximum of 100 characters, if not upheld the API will return with an error 400 - Bad Request.
Example: 2b7b05ad-4411-4a19-8c95-2508b17e0fd8

Responses

Language

Credentials

Bearer

Loading…

Response

Choose an example:

application/json

202Accepted

400Bad request. Request is not correctly formulated. Goes for both Header, Query and Body. Verify the error description and properties.

404Not found. There is no resource behind the URL, i.e. requesting data on an account that does not exist.

409Conflict. Idempotency-key violation. Request being handled.

500Internal Server Error. Something unexpected happened on BC Connect side.