create_beneficiary
POST - Création d'un bénéficiaire
| Argument | Description | Type - Taille | Obligatoire |
|---|---|---|---|
| social_reference | Raison sociale du bénéficiaire | String - 32 | NON |
| siren | SIREN du bénéficiaire | String - 9 | NON |
| ics | Identifiant créancier SEPA du bénéficiaire | String - 13 | NON |
| iban | IBAN du bénéficiaire | String - 34 | OUI |
| street_number | Numéro de rue | String - 16 | OUI |
| street_name | Nom de rue | String - 70 | OUI |
| zip_code | Code postal | String - 16 | OUI |
| city | Ville | String - 34 | OUI |
| phone_number | Téléphone | String - 16 | NON |
Requête
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"}
Si le bénéficiaire a bien été créé
Réponse
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : true,
"beneficiary_reference" : "XXXXXXXXX"
}
Si la création du bénéficiaire a échoué
Réponse
HTTP/1.1 200 OK
Content-Type: application/json
{
"result" : false,
"code" : "XXXX"
}
| Argument | Description |
|---|---|
| result | true ou false : true : action réalisée avec succès false : action échouée |
| beneficiary_reference | Référence unique du bénéficiaire (Taille max : 32) |
| code | Voir codes d'erreur en annexe. |
Requête
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