E-Mandate object

This page lists every attribute of an e-mandate, as returned by the e-mandate endpoints, and the statuses it goes through.

Attributes

Attribute	Type	Description
`id`	UUID	Identifier of the e-mandate (`emandate_id`).
`type`	string	Always `e-mandates`.
`attributes.status`	string	Status of the e-mandate, see Statuses.
`attributes.flow_step`	string	Where the customer is in the journey, see Flow steps.
`attributes.rum`	string	Unique mandate reference (RUM), up to 35 characters.
`attributes.creditor_identifier`	string	Your SEPA creditor identifier (ICS).
`attributes.scheme`	string	SEPA Direct Debit scheme. Always `core`.
`attributes.currency`	string	Always `EUR`.
`attributes.created_at`	date-time	When the e-mandate was created (ISO 8601, UTC).
`attributes.signed_at`	date-time	When the customer signed. Present once signed.
`attributes.debtor.name`	string	Customer's full name.
`attributes.debtor.email`	string	Customer's email.
`attributes.debtor.first_name`	string	Customer's first name, when provided.
`attributes.debtor.last_name`	string	Customer's last name, when provided.
`attributes.debtor.company_name`	string	Business customer's company name, when provided.
`attributes.debtor.phone_prefix`	string	Phone prefix, when provided.
`attributes.debtor.phone`	string	Phone number, when provided.
`attributes.debtor.address`	object	Customer's address: `number`, `street`, `zip`, `city`, `country`.
`attributes.debtor.iban`	string	IBAN of the account to debit. Present once the customer has verified it.
`attributes.debtor.swift_bic`	string	BIC of the account to debit, when known.
`attributes.beneficiary`	object	Your details as creditor (`name`, `address`). Only with `with_beneficiary=true`.
`links.next`	URL	Link where the customer verifies their account and signs.
`relationships.documents.links.self`	URL	Link to the signed mandate PDF. Present once signed.

Statuses

Status	Meaning	Valid mandate
`draft`	Created, not signed yet.	No
`active`	Signed by the customer.	Yes
`cancelled`	Cancelled by you. Final.	No
`revoked`	The customer withdrew consent. Final.	No
`ended`	End date reached.	No
`expired`	Expired for lack of use.	No
`blocked`	Blocked by Fintecture.	No

stateDiagram-v2
    [*] --> draft: POST /v1/e-mandates
    draft --> active: customer signs
    draft --> cancelled: PATCH cancelled
    active --> cancelled: PATCH cancelled
    active --> revoked: PATCH revoked

Flow steps

Flow step	Meaning
`bank_account_verification`	Waiting for the customer to verify the account to debit.
`mandate_acceptance`	Account verified, waiting for the customer's signature.
`completed`	The customer has finished the journey.

Webhook events

Event	Sent when
`emandates.status.active`	The customer has signed.
`emandates.status.cancelled`	The e-mandate was cancelled.
`emandates.status.revoked`	The e-mandate was revoked.

See Follow e-mandates for the payload.