search_beneficiary


 GET    -- Search for beneficary

Search parameter Description Type - Length Example Mandatory
beneficiary_reference Unique reference of beneficiary String - 32 NO
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 NO
street_number Street number String - 16 NO
street_name Road name String - 70 NO
zip_code Zip code String - 16 NO
city Town/place String - 34 NO
phone_number Phone umber String - 16 NO
pack_offer pack offer option String - 1 NO
tva_number Intercommunity VAT number String - 50 NO
cg_status Status type String - 128 NO


Request

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

If beneficiary data successfully fetched

Response

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"
        }
    ]
}
If beneficiary data fetching 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
datas Json array of records responding to search arguments
code See (error codes in annex).
Thanks to fill-in all the mandatory fields
Request

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