- Home
- API reference
- API documentation (JSON/XML)
- Objects
SEPA mandate object
Description
The SEPA Mandate object represents the SEPA mandate of a customer.
Structure
| Keyword JSON | Keyword XML | Occurs | Type | Format | Description |
|---|---|---|---|---|---|
| created | created | 1 | string | date-time | Date on which the SEPA mandate was created. |
| updated | updated | 1 | string | date-time | Date on which the SEPA mandate was updated. |
| document | document | 1 | object | Document | SEPA mandate as PDF document |
| reference | reference | 1 | string | The SEPA mandate reference | |
| confirmSignature | confirm_signature | 0 -1 | string | date-time | Date on which the SEPA mandate was confirmed. |
| confirmIP | confirm_ip | 0 -1 | string | IP via which the SEPA mandate was confirmed. | |
| confirmUseragent | confirm_useragent | 0 -1 | string | User Agent with which the SEPA mandate was confirmed. | |
| confirmChecked | confirm_checked | 0 -1 | boolean | Flag indicating whether the confirmation data has been checked.
Default value = false For XML, 0 (false) and 1 (true) can also be used. | |
| expire | expire | 1 | string | Expiration date of the SEPA mandate | |
| histories | history | 0 - n | object | SEPAMandate | List of previous SEPA mandates |
| status | status | 1 | enum | SEPAStatus | SEPA mandate status |
| accountHolder | bank_account_holder | 1 | string | Owner of the bank account to which the SEPA mandate applies. | |
| iban | bank_iban | 1 | string | IBAN of the account to which the SEPA mandate appli | |
| bic | bank_bic | 1 | string | BIC of the account for which the SEPA mandate applies. | |
| customer | 1 | object | BasicCustomer | The customer to whom the SEPA mandate belongs. | |
message_sent | 0 -1 | string | date-time | Date on which the notification for a new SEPA mandate was sent. | |
creditor_identifier | 1 | string | Creditor reference | ||
bank_name | 1 | string | Name of the bank for which the SEPA mandate applies. | ||
confirm_signature_city | 0 - 1 | string | Place where the SEPA mandate was confirmed | ||
confirm_date | 0 - 1 | string | date-time | Date on which the SEP mandate was confirmed |