get_link_payment


POST  -- Get payment link

Argument Description Type - Length Example Mandatory
beneficiary_reference Beneficiary reference String - 32 YES
amount Amount (in cents) String - 18 YES
payment_reference Payment reference String - 64 YES
consumer_type Consumer type (0 = person, 1 = company) Integer - 1 NO
consumer_reference Consumer reference String - 32 YES
consumer_id Consumer ID String - 32 NO
url_callback Callback URL String - 128 YES
consumer_first_name Consumer first name String - 16 NO
consumer_last_name Consumer last name String - 16 NO
consumer_address_street_number Consumer street number String - 16 NO
consumer_address_street_name Consumer street name String - 70 NO
consumer_zip_code Consumer zip code Integer - 16 NO
consumer_city Consumer town/place String - 35 NO
consumer_email Consumer e-mail String - 70 YES
consumer_phone_number Consumer mobile phone String - 32 YES
social_reference Consumer corporate name String - 32 NO
siren Consumer SIREN String - 9 NO
sms_option Options for sending SMS payment link (1: yes, 0: no) Integer - 1 NO
email_option Options for sending payment link by e-mail (1: yes, 0: no) Integer - 1 NO
payment_scenario Payment scenario reference configured for the merchant String - 64 NO
bic_bank Bank code String - 16 NO
merchant_id Merchant ID String NO
from_bo From BO Boolean NO
get_pay_id Get ID payment Boolean NO
shop_id Beneficiary internal ID String NO
shop_reference Beneficiary internal reference String NO
payment_lang Payment language String NO
list_beneficiary_reference Beneficiary reference list String NO
pay_now Pay now Boolean NO
multi_pay Multi pay Boolean NO
pay_later Pay later Boolean NO
transaction_id Transaction reference String - 64 NO
basket_id Basket id String - 64 NO
manual_redirect_url Manual redirect URL String - 256 NO
reference_label Payment label String - 256 NO
tva_interco International VAT number String - 16 NO
link_duration Payment link duration Integer - 16 NO


Request

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


{
"beneficiary_reference": "395579987182558",
"amount": "1000000",
"payment_reference": "Facture31102019",
"consumer_reference": "xxxxxxxxx",
"url_callback": "https://callback.com",
"consumer_first_name": "Ghandri",
"consumer_last_name": "Naoufel",
"consumer_address_street_number": "5",
"consumer_address_street_name": "Rue de Paris",
"consumer_zip_code": "75002",
"consumer_email": "test@test.com",
"consumer_phone_number": "0000000000"}
If parameters sent are valid

Response

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


{
    "result": true,
    "link": "https://xxxxxxxx/paypage?SDESSID=xxxxx"
}
If erroneous parameters are sent

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
link Payment link
code See (error codes in annex).
Thanks to fill-in all the mandatory fields
Request

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