Importing data from existing mandates across multiple stores
POST .../multimandates
It is possible to import data from several mandates across several stores of different companies (different ICS) in one go, provided that you have:
- the same debtor
- the same IBAN
The response will contain:
- a mandate per shop
- a JSON object per shop
Parameters
| sites ID of the shop(s). E.g.: ["11111111", "22222222"] | Array Required |
| iban IBAN. Debtor’s bank account identifier. | String Required |
| last_name Debtor’s last name. | String Required |
| first_name Debtor’s first name. | String Required |
| email Debtor’s e-mail address. | String Required |
| payment_type Type of mandate:
| String Required |
| locale Language of mandate generation. ISO 639-1 Alpha-2 code. E.g.: FR, DE, ES, IT, EN, PT, PL, NL, SV | String Required |
| bic BIC. International identifier of the debtor’s bank. | String Optional |
| title Debtor’s title | String Optional |
| callback_url Callback URL called after the mandate is imported | String Optional |
| send_mails If the field is set to True, Lyra Collect will send the mandate registration e-mails to the buyer and to the merchant once a mandate is created or updated. Default value: False | Bool Optional |
| fetch_address Allows to indicate whether the address object is returned in the response. Default value: false. | Bool Optional |
| address Debtor address | Recommended |
Address object
Some banks check whether this information is present before accepting a direct debit request.
The address is required if the client has a bank account in the following departments, territories or countries: Switzerland, Monaco, San Marino, Mayotte, St. Pierre and Miquelon, Guernsey, Jersey, Isle of Man.
| country Country code in compliance with the ISO 3166 alpha-2 standard. E.g.: FR | String Recommended |
| city Shipping city | String Optional |
| district Shipping district | String Optional |
| state Buyer’s state/region | String Optional |
| street Street name | String Optional |
| street_number Street number | String Optional |
| street2 Address line 2 | String Optional |
| zip Buyer’s ZIP code | String Optional |
Example
Request
POST https://secure.lyra.com/sdd/multimandates{
"iban":"FR7630002005701234567890158",
"title":"Mr",
"last_name":"Durand",
"first_name":"Michel",
"email":"mrdurand@ymail.com",
"payment_type":"RECURR",
"locale":"FR",
"address":{
"street_number":"109",
"street":"rue de l'Innovation",
"street2":"Bat 1",
"district":"Labège-Innopole",
"zip":"31670",
"city":"Labège",
"country":"FR",
"state":"Occitanie"
},
"fetch_address":false,
"sites":["11111111","22222222","33333333"]
}Response
[
{
"bic":"CRLYFRPP",
"iban":"FR7630002005701234567890158",
"title":"Mr",
"email":"mrdurand@ymail.com",
"locale":"FR",
"identifier":"85d3fc75f08349dbabad6a0654cf61fb",
"rum":"85d3fc75f08349dbabad6a0654cf61fb",
"id":"11111111-85d3fc75f08349dbabad6a0654cf61fb",
"site":"11111111",
"first_name":"Michel",
"last_name":"Durand",
"payment_type":"RECURR",
"callback_url":null,
"created_at":1409136103000,
"updated_at":null,
"fetch_address":"false"
},
{
"bic":"CRLYFRPP",
"iban":"FR7630002005701234567890158",
"title":"Mr",
"email":"mrdurand@ymail.com",
"locale":"FR",
"identifier":"f455bbd2009d431b923b7c759f6cd3a6",
"rum":"f455bbd2009d431b923b7c759f6cd3a6",
"id":"22222222-f455bbd2009d431b923b7c759f6cd3a6",
"site":"22222222",
"first_name":"Michel",
"last_name":"Durand",
"payment_type":"RECURR",
"callback_url":null,
"created_at":1409136105000,
"updated_at":null,
"fetch_address":"false"
},
{
"bic":"CRLYFRPP",
"iban":"FR7630002005701234567890158",
"title":"Mr",
"email":"mrdurand@ymail.com",
"locale":"FR",
"identifier":"c57468616cf848ddb9bbdf39f31e0326",
"rum":"c57468616cf848ddb9bbdf39f31e0326",
"id":"33333333-c57468616cf848ddb9bbdf39f31e0326",
"site":"33333333",
"first_name":"Michel",
"last_name":"Durand",
"payment_type":"RECURR",
"callback_url":null,
"created_at":1409136108000,
"updated_at":null,
"fetch_address":"false"
}
]Note
If an error occurs during a mandate import, then all mandates will show an error.
