initiate_signature
POST - initiate_signature.description is missing
| Argument | Description | Type - Length | Example | Mandatory |
|---|---|---|---|---|
| safedebit_consumer_reference | Safedebit consumer reference | String - 35 | XXXXX | NO |
| consumer_reference | Consumer reference | String - 64 | XXXXXX | YES |
| consumer_type | Consumer type | Integer - 1 | 0: Particulier - 1: Société - 2: Association | YES |
| consumer_ip_address | Consumer's IP address | String - 32 | YES | |
| consumer_store | Safedebit store reference | String - 32 | YES * | |
| consumer_address_street_number | Consumer address: number | String - 16 | YES | |
| consumer_address_street_type | Consumer address: road type | String - 16 | NO | |
| consumer_address_street_name | Consumer address: road name | String - 70 | YES | |
| consumer_zip_code | Zip code | String - 16 | YES | |
| consumer_city | Town/place | String - 35 | YES | |
| consumer_country | Country | String - 32 | YES | |
| consumer_birth_date | Date of birth | String - 10 | DD/MM/YYYY | NO |
| consumer_birth_city | City/place of birth | String - 32 | NO | |
| consumer_nationality | field.consumer_nationality.label is missing | String - 2 | NO | |
| consumer_gender | Gender | Char - 1 | NO | |
| consumer_email | Consumer e-mail | String - 64 | YES *** | |
| otu_email | field.otu_email.label is missing | Boolean - 1 | YES ** | |
| consumer_phone_number | Consumer phone | String - 16 | YES *** | |
| otu_sms | field.otu_sms.label is missing | Boolean - 1 | YES ** | |
| consumer_iban | Consumer's IBAN bank account | String | YES | |
| force_ais | field.force_ais.label is missing | Integer - 1 | NO | |
| umr | Unique mandate reference | String - 35 | NO | |
| url_callback_status | field.url_callback_status.label is missing | String - 35 | NO | |
| beneficiary_reference | Unique reference of beneficiary | String - 32 | NO | |
global.particulier is missing (consumer_type = 0)
| Argument | Description | Type - Length | Example | Mandatory |
|---|---|---|---|---|
| consumer_last_name | Consumer last name | String - 64 | YES | |
| consumer_first_name | Consumer first name | String - 64 | YES | |
Company (consumer_type = 1)
| Argument | Description | Type - Length | Example | Mandatory |
|---|---|---|---|---|
| social_reference | Corporate name | String - 32 | YES | |
| siren | Company's SIREN | String - 9 | YES | |
| nic | Company's NIC | String - 5 | NO | |
| tva_interco | International VAT number | String - 32 | NO | |
Non-profit organisation (consumer_type = 2)
| Argument | Description | Type - Length | Example | Mandatory |
|---|---|---|---|---|
| social_reference | Corporate name | String - 32 | YES | |
| waldec | Unique national number of NPO | String - 10 | YES | |
| siren | Company's SIREN | String - 9 | NO | |
| nic | Company's NIC | String - 5 | NO | |
| tva_interco | International VAT number | String - 32 | NO | |
** initiate_signature.alert4 is missing
*** initiate_signature.alert5 is missing
Request
POST /xxxx/add_mandate HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
{
"consumer_iban": "FRXXXXXX",
"consumer_reference": "XXXX",
"consumer_store": "XXXXXXX",
"social_reference": "XXXXXX",
"consumer_last_name": "TestLastName",
"consumer_first_name": "TestFirstName",
"consumer_address_street_number": "41",
"consumer_type": "1",
"consumer_address_street_type": "avenue",
"consumer_address_street_name": "xxxxx",
"consumer_zip_code": "92700",
"consumer_city": "colombes",
"consumer_country": "France",
"umr": "UMR_XXXXXX",
"otu_email": "XXX",
"consumer_email": "XXX.XXXXX@XXXX.com",
"consumer_phone_number": "0652377054",
"consumer_gender": "M",
"consumer_birth_city": "Paris",
"consumer_ip_address": "192.128.1.1",
"nic": "145",
"siren": "95236"}
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": true,
"safedebit_consumer_reference": "xxxxxxxxxxxxxxxxxxxxxx",
"mandate_umr": "xxxxxxxxxxxxxxxxxxxxxxx"
}
initiate_signature.fail is missing
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result": false,
"code": "xxxxx",
"message": "xxxxxxxxxxxxxxxxxxxx"
}
| Argument | Description |
|---|---|
| result | true or false : true : action succeeded false : action failed |
| code | See (error codes in annex). |