create_beneficiary
POST - Create beneficiary
| Argument | Description | Type - Length | Mandatory |
|---|---|---|---|
| social_reference | Beneficiary's corporate name | String - 32 | NO |
| siren | Beneficiary's SIREN | String - 9 | NO |
| ics | Beneficiary's SEPA | String - 13 | NO |
| iban | Beneficiary's IBAN | String - 34 | YES |
| street_number | Street number | String - 16 | YES |
| street_name | Road name | String - 70 | YES |
| zip_code | Zip code | String - 16 | YES |
| city | Town/place | String - 34 | YES |
| phone_number | Phone umber | String - 16 | NO |
Request
POST /xxxx/create_beneficiary HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json
{
"social_reference": "TEST",
"siren": "xxxxxx",
"ics": "xxxxxx",
"iban": "FRXXXXXXXXXXXXXXXXXXXXXX",
"street_number": "1",
"street_name": "Rue de test",
"zip_code": "00000",
"city": "Ville",
"phone_number": "0000000000"}
If beneficiary was successfully created
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : true,
"beneficiary_reference" : "XXXXXXXXX"
}
If beneficiary creation failed
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : false,
"code" : "XXXX"
}
| Argument | Description |
|---|---|
| result | true or false : true : action succeeded false : action failed |
| beneficiary_reference | Unique beneficiary reference (Max size : 32) |
| code | See (error codes in annex). |
Request
HTTP/1.1 200 OK
POST /ssp/create_beneficiary HTTP/1.1
Host: xxx.safedebit.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json