initiate_beneficiary


POST  -- Initiate beneficiary

The initiate_beneficiary action permits at the same time to create a new beneficiary and fetch the beneficiary's reference already validated from the merchant code (code field).

Argument Description Type - Length Example Mandatory
social_reference Corporate name String - 32 YES
code Beneficiary unique code at the merchant String - 64 NO
shop_reference Beneficiary internal reference String - 32 NO
email Beneficiary email String - 70 YES
siren Company's SIREN String - 9 YES
url_callback Callback URL String - 128 YES
phone_number Beneficiary mobile phone number String - 32 NO
street_number Beneficiary street number String - 16 NO
street_name Beneficiary road name String - 70 NO
zip_code Beneficiary zip code Integer - 16 NO
city Beneficiary town/place String - 35 NO
nic Beneficiary NIC String - 5 NO


Request

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"}
If beneficiary initiated successfully

Response

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


{
    "result": true,
    "url": "xxxxxxxxxxxxx",
    "beneficiary_reference": "xxxxxxxxx",
    "status": "1"
}
If beneficiary initiation 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
url Beneficiary's data initiation link
status Current beneficiary status
0 : INITIAL (new beneficiary)
1 : WAITING (form filled and account awaiting KYB validation)
2 : OK
3 : KO
4 : WAITING DATA (benficiary data are being input)
5 : WAITING KYB (document modification is required after a first refused check)
code See (error codes in annex).
Thanks to fill-in all the mandatory fields
Request

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