initiate_beneficiary


POST  -- Initiation du bénéficiaire

L’action initiate_beneficiary permet à la fois de créer un nouveau bénéficiaire mais aussi de récupérer la référence bénéficiaire déjà validée à partir de son code chez le commerçant (champ : code).

Argument Description Type - Taille Exemple Obligatoire
social_reference Raison sociale String - 32 OUI
code Code unique du bénéficiaire chez le commerçant String - 64 NON
shop_reference Référence interne du bénéficiaire String - 32 NON
email Email du bénéficiaire String - 70 OUI
siren SIREN de la société String - 9 OUI
url_callback URL de retour String - 128 OUI
phone_number Téléphone portable du bénéficiaire String - 32 NON
street_number Numéro de la rue du bénéficiaire String - 16 NON
street_name Nom de la rue du bénéficiaire String - 70 NON
zip_code Code postal du bénéficiaire Integer - 16 NON
city Ville du bénéficiaire String - 35 NON
nic NIC du bénéficiaire String - 5 NON


Requête

POST /xxxx/initiate_beneficiary HTTP/1.1
Host: xxx.xxxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json 


{
"social_reference": "12345",
"email": "teste@test.com",
"siren": "xxxxxxxxx",
"url_callback": "https://callback.com",
"phone_number": "0000000000",
"street_number": "1",
"zip_code": "00000",
"city": "Ville"}
Si le bénéficiaire a été initié avec succès

Réponse

HTTP/1.1 200 OK
Content-Type: application/json 


{
    "result": true,
    "url": "xxxxxxxxxxxxx",
    "beneficiary_reference": "xxxxxxxxx",
    "status": "1"
}
Si l’initiation 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
url Lien d’initiation des informations du bénéficiaire
status Statut actuel du bénéficiaire
0 : INITIAL (nouveau bénéficiaire)
1 : WAITING (formulaire rempli et compte en attente de validation KYB)
2 : OK
3 : KO
4 : WAITING DATA (données bénéficiaires en cours de saisie)
5 : WAITING KYB (modification des documents nécessaires après un premier contrôle refusé)
code Voir codes d'erreur en annexe.
Merci de remplir tous les champs obligatoires
Requête

HTTP/1.1 200 OK
POST /xxxx/initiate_beneficiary HTTP/1.1
Host: xxx.xxxxxxx.fr
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json