Amend a Mandate (Coming Soon)

patch

https://www.bankingcircleconnect.com/api/v1/mandates/{mandate-id}

The endpoint is used for amending the details or status of a Mandate.

Path Params

mandate-id

uuid

required

Mandate identifier

Body Params

Amend details

Request model for amending the details or status of a Mandate.

ultimateCreditor

object

Ultimate party to which an amount of money is due.

creditor

object

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

creditorAccount

object

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

creditorAgent

object

The creditor's bank (financial institution).

ultimateDebtor

object

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

debtor

object

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

debtorAccount

object

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

debtorAgent

object

The debtor's bank (financial institution).

type

object

Specifies the type of mandate.

description

string | null

Free text providing further details on the 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

finalCollectionAmount

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

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

status

object

Describes the status the mandate is requested to be updated to and the reason for it.

Headers

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.