search_beneficiary


 GET    -- Chercher des bénéficiaires

Paramètre de recherche Description Type - Taille Exemple Obligatoire
beneficiary_reference Référence unique du bénéficiaire String - 32 NON
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 NON
street_number Numéro de rue String - 16 NON
street_name Nom de rue String - 70 NON
zip_code Code postal String - 16 NON
city Ville String - 34 NON
phone_number Téléphone String - 16 NON
pack_offer option pack offer String - 1 NON
tva_number Numéro de Tva intercommunautaire String - 50 NON
cg_status Type de statut String - 128 NON


Requête

GET /ssp/search_beneficiary?beneficiary_reference=XXXXXX&pack_offer=1 HTTP/1.1
Host: api.xxxxxxxx.xxx
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json

Si les données des bénéficiaires ont été récupérées avec succès

Réponse

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


{
    "result": true,
    "datas": [
        {
            "beneficiary_reference": "BENEF1_XXX",
            "social_reference": "TEST1",
            "siren": "xxxxxx",
            "ics": "xxxxxx",
            "street_number": "1",
            "street_name": "Rue de test",
            "zip_code": "00000",
            "city": "Ville",
            "phone_number": "0000000000",
            "pack_offer": "1",
            "cg_status": "2",
            "tva_number": "3793060166"
        },
        {
            "beneficiary_reference": "BENEF2_XXX",
            "social_reference": "TEST2",
            "siren": "xxxxxx",
            "ics": "xxxxxx",
            "street_number": "2",
            "street_name": "Rue de test",
            "zip_code": "00000",
            "city": "Ville",
            "phone_number": "0000000000",
            "pack_offer": "2",
            "cg_status": "2",
            "tva_number": "3460410751"
        }
    ]
}
Si la récupération des données 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
datas Tableau Json des enregistrements répondant aux arguments de recherche
code Voir codes d'erreur en annexe.
Merci de remplir tous les champs obligatoires
Requête

HTTP/1.1 200 OK
GET /ssp/search_beneficiary? HTTP/1.1
Host: api.xxxxxxx.xxx
Authorization: Basic JQheySHkalSNuakkmSmm==
Content-Type: application/json
Accept: application/json