Appearance
Mandates
Mandates allow Legal Entities to initiate a transfer of funds from somebody else's account, to theirs.
The transfer is made using SEPA Direct Debit (SDDE) and can be used to receive one-time or recurring payments.
Information – SEPA Creditor Identifier mandatory in France
In France, only companies holding a SEPA creditor identifier (SCI) are allowed to use Mandates and SDDE. A physical person cannot be allowed to actively retrieve funds from somebody else's account.
Important – Mandates should be kept as proofs in case of litigation
As litigation rules of the SEPA Network are generally in favor of the debtor, it is strongly recommended that Mandates be kept indefinitely to be used as proof if needs be.
Structure
json
{
"mandateId": 0,
"title": "string",
"legalInformations": "string",
"uniqueMandateReference": "string",
"mandateStatus": "VALIDATED",
"userId": 0,
"debtorName": "string",
"debtorAddress": "string",
"debtorCity": "string",
"debtorZipCode": "string",
"debtorCountry": "string",
"debtorIban": "string",
"debtorBic": "string",
"sequenceType": "string",
"creditorName": "string",
"sepaCreditorIdentifier": "string",
"creditorAddress": "string",
"creditorCity": "string",
"creditorZipCode": "string",
"creditorCountry": "string",
"signatureDate": "string",
"debtorSignatureIp": "string",
"signed": 0,
"revocationSignatureDate": null,
"debtorIdentificationCode": "string",
"debtorReferencePartyName": "string",
"debtorReferenceIdentificationCode": "string",
"creditorReferencePartyName": "string",
"creditorReferenceIdentificationCode": "string",
"contractIdentificationNumber": "string",
"contractDescription":"string",
"createdDate": null,
"codeStatus": 0,
"informationStatus": "string",
"isPaper": true,
"userIdUltimateCreditor": 0
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
API – Swagger documentation available
For a complete list of Mandate attributes, check the Mandates section of the Swagger.
Creation
As of today, Treezor doesn't offer electronic signature services. Therefore, isPaper
should always be true
and you should assume the physical mandate signature. This paper Mandate must include the UMR (uniqueMandateReference
attribute of the Mandate object).
Mandatory parameters
Attribute | Type | Description |
---|---|---|
sddType | string | Defines the type of SDD. May be:
|
sequenceType | string | Defines whether the debtor will be debited multiple times:
|
isPaper | boolean | Indicates whether the mandate is a paper-based document or electronically signed. Always set to true. |
userId | integer | The unique identifier of the end user requesting the SDD. |
debtorName | string | Full name of the debited end user (person or entity). Format: alphanumeric with at least 3 alphabetic characters. |
debtorAddress | string | The address of the debited end user. |
debtorCity | string | City in which the debited end user is domiciled. |
debtorZipCode | string | Postcode of the city in which the debited end user is domiciled. |
debtorCountry | string | Country in which the debited end user is domiciled. Format: ISO 3166-1 alpha-2. |
debtorIban | string | IBAN of the debited end user. |
signatureDate | string | Date on which the Mandate has been signed by the end user. Format: YYYY-MM-DD |
To create a Mandate, use the following request.
bash
curl -X POST {baseUrl}/v1/mandates \
--header 'Authorization: Bearer {accessToken}' \
--header 'Content-Type: application/json' \
-d '{payload}'
1
2
3
4
2
3
4
Here is an example of {payload}
:
json
{
"sddType":"core",
"isPaper":true,
"userId":123456,
"debtorName":"Alex Oak",
"debtorAddress":"99 Rosewood lane",
"debtorCity":"Paris",
"debtorZipCode":"75001",
"debtorCountry":"FR",
"debtorIban":"FR763000100794123XXXXXXXXXX",
"debtorBic":"BDFXXXXXXXXX",
"sequenceType":"recurrent",
"signatureDate":"2020-04-01",
"createdIp":"0.0.0.0"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
2
3
4
5
6
7
8
9
10
11
12
13
14
15
Returns the Mandate object, with the corresponding mandateId
.
The mandateStatus
set to VALIDATED
, as Treezor assumes you had it signed by the end user as requested.
json
{
"mandates": [
{
"mandateId": 2356,
"title": "M",
"legalInformations": "Treezor",
"uniqueMandateReference": "79069343D1A80C931FABBC5813E3DB",
"mandateStatus": "VALIDATED",
"userId": 1529390,
"debtorName": "Alex Oak",
"debtorAddress": "99 Rosewood lane",
"debtorCity": "Paris",
"debtorZipCode": "75001",
"debtorCountry": "FR",
"debtorIban": "FR763000100794123XXXXXXXX",
"debtorBic": "BDFXXXXXX",
"sequenceType": "recurrent",
"creditorName": "Treezor",
"sepaCreditorIdentifier": "FR90ZZZ874785",
"creditorAddress": "99 Rosewood lane",
"creditorCity": "Paris",
"creditorZipCode": "75001",
"creditorCountry": "FR",
"signatureDate": "2020-04-01",
"debtorSignatureIp": "",
"signed": 0,
"revocationSignatureDate": null,
"debtorIdentificationCode": "",
"debtorReferencePartyName": "",
"debtorReferenceIdentificationCode": "",
"creditorReferencePartyName": "",
"creditorReferenceIdentificationCode": "",
"contractIdentificationNumber": "",
"contractDescription": "",
"createdDate": null,
"codeStatus": 220001,
"informationStatus": "Mandat complété",
"isPaper": true,
"userIdUltimateCreditor": 0
}
]
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
Note – Contact Treezor if you encounter a 22026
error
This error indicates Unable to create the mandate. User does not have sepa creditor identifier
. Contact your Treezor Account Manager to set up an SCI (SEPA Creditor Identifier) for that User.
Endpoints
Endpoint | Scope |
---|---|
/v1/mandates Create a mandate | read_write |
/v1/mandates Search for mandates | read_only |
/v1/mandates/{mandateId} Retrieve a mandate | read_only |
/v1/mandates/{mandateId} Revoke a mandate | read_write |