Importing an existing mandate

In order to import an existing mandate:

  1. Specify the desired action:
  2. Build your HTTP header (see chapter Identifying yourself when exchanging with the payment gateway).
  3. Add the fields iban, last_name, first_name, email, payment_type and locale required for importing the mandate.
    Field Format Description Required Example
    iban string IBAN for International Bank Account Number: Debtor’s bank account identifier
    last_name string Debtor’s last name
    first_name string Debtor’s first name
    email string Debtor’s e-mail address
    payment_type string
    • RECURR
    • ONEOFF

    Type of mandate:
    • Recurring
      The signed mandate applies to a series of direct debits.
    • One-off
      The signed mandate applies to a single direct debit.




    locale string
    • FR for French
    • DE for German
    • EN for English
    • ES for Spanish
    • IT for Italian
    • NL for Dutch
    • PL for Polish
    • PT for Portuguese
    • SV for Swedish
    Language of mandate generation


  4. Add the address object to transmit the debtor address details. 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.
    Attribute of the address object Format Description Example
    city string City Labège
    country string Country code in compliance with the ISO 3166 alpha-2 standard FR
    district string District Labège-Innopole
    state string State / Region Occitanie
    street string Postal address Rue de l’Innovation
    street_number string Street number 109
    street2 string Address line 2 Bat 1
    zip string Zip code 31670
  5. Add the optional fields bic, title, callback_url, send_mails and fetch_address, if necessary.
    Field name Format Description Example
    bic string BIC for Bank Identifier Code: International identifier of the debtor’s bank "bic":"CRLYFRPP"
    title string Debtor’s title "title":"Mr"
    callback_url string URL https://.../
    send_mails boolean

    Default value: False

    If the field is set to True, the Lyra Collect PDF will send the mandate registration e-mails to the buyer and to the merchant once a mandate is created or updated.

    fetch_address boolean

    Allows to indicate whether the address object is sent in return after the WS response.

    Default value: false.


Example of a cURL request:

$ curl 'https://..../mandates' -H'
Authorization:Basic MTIzNDU2Nzg6MTIzNDU2Nzg5MDEyMzQ1Ng==' -H'
Content-Type:application/json' -H 
'Accept: application/json' --data
"street":"rue de l'Innovation","street2":"Bat 1","district":"Labège-Innopole","zip":"31670",
"city":"Labège","country":"FR","state":"Occitanie"},"fetch_address": true}' -i

HTTP/1.1 200 OK
Date: Wed, 27 Aug 2014 10:38:47 GMT

		"street":"rue de l'Innovation",
		"street2":"Bat 1",