• France
lyra.com
Search
Categories
Tags
docs.
France
Spain
Europe (English)
India
Home
Implementation
Embedded form (cards)
REST payment API
REST PCI-DSS payment API
REST SEPA API
Hosted payment
Data collection form
File exchange
Mobile payment
Snippets
Plugins
Marketplace
Back Office
Merchant Back Office
Expert Back Office
Guides
Help
FAQ
Video tutorials
Support

Importing the data of an existing mandate

POST .../mandates

This Web Service allows to generate a UMR and, therefore, allow payments via our gateway.

It does not allow to update the UMR or the date when the mandate was last used.

Parameters

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:
  • RECURR : The signed mandate applies to a series of direct debits
  • ONEOFF : The signed mandate applies to a single direct debit

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 import

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’s address

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/mandates

{
  "bic":"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": true
}

Response:

{
  "identifier":"94aebef39d0349a09fb525a80a6e0d55",
  "rum":"94aebef39d0349a09fb525a80a6e0d55",
  "id":"12345678-94aebef39d0349a09fb525a80a6e0d55",
  "title":"Mr",
  "email":"mrdurand@ymail.com",	
  "first_name":"Michel",
  "last_name":"Durand",
  "address":{
 	"street_number":"109",
 	"street":"rue de l'Innovation",
 	"street2":"Bat 1",
 	"district":"Labège-Innopole",
 	"zip":"31670",
 	"city":"Labège",
 	"country":"France",
 	"state":"Occitanie"
  },
  "site":"12345678",
  "created_at":1634047398000,	
  "fetch_address":true
}
Recruitment

Head Office :

LYRA NETWORK
109, rue de l’innovation
31670 Labège
FRANCE

2.8.1-doc-1.8