https://www.easypay.pt/_s/api_easypay_01BG.php
http://test.easypay.pt/_s/api_easypay_01BG.php
This API call returns the data necessary for the client accomplish a payment.
Updated on 16-01-2019
|
ep_cin
required |
The CIN of your easypay account. Example value: 9999 |
|
ep_user
required |
The USER of your easypay account. Example value: USER010101 |
|
ep_entity
required |
The ENTITY of your easypay account. Available values: 10611, 21098 or 11683 (if you use this entity you must send o_max_date) |
|
ep_ref_type
required |
Always auto Available value: auto |
|
ep_type
optional |
Send this if you want to add a boleto link to your response Available value: boleto |
|
ep_currency
optional |
Send this parameter if you want to set the boleto's currency to brazilian real. Available value: BRL |
|
ep_country
required |
Must always correspond to the ISO-3301-alpha2 country code in your CIN, you may check this in your backoficce. Available values: PT, GB, FR or ... |
|
ep_language
required |
The language that the user should see on credit card gateway. Available values: PT, EN, ES or FR |
|
t_value
required |
The value the client have to pay. Must be a double with "." ( dot ) as the decimal separator. Example value: 15.25 |
|
t_key
optional |
An identifier of the order corresponding to this payment request. Example value: 3 |
|
o_name
optional for multibanco, required for boleto, credit card and direct debit |
Your client name. It will be automatically filled on Credit Card gateway. Example value: John Doe |
|
o_description
optional |
You can use this to store whatever you want.. |
|
o_obs
optional |
You can use this to store whatever you want.. |
|
o_mobile
optional |
Your client mobile or phone number. It will be automatically filled on Credit Card gateway. Example value: 912 345 678 |
|
o_email
optional for multibanco, required for boleto, credit card and direct debit |
Your client email. It will be automatically filled on Credit Card gateway. Example value: tec@easypay.pt |
|
o_max_date
required for entity 11683 |
You must send this var if you are using 11683 entity. Example value: 2014-12-31 |
|
ep_partner
required for entity 11683 |
You must send this var if you are using 11683 entity. Example value: use the same value as ep_user |
| Additional parameters only for Direct debit frequent payments | |
|---|---|
|
ep_rec
required |
Must be always yes. Available value: yes |
|
ep_rec_freq
required |
Charge frequency. Available value:
|
|
ep_rec_url
required |
URL to where easypay will redirect clients from our gateway after they finalize the process Example value: http://yoursite.com/easypay/direct_debit_return.php |
https://www.easypay.pt/_s/api_easypay_01BG.php?ep_cin=9999&ep_user=USER010101&ep_entity=10611&ep_ref_type=auto&ep_type=boleto&ep_currency=BRL&ep_country=PT&ep_language=EN&t_value=15.25&t_key=3&o_name=John+Doe&o_description=&o_obs=&o_mobile=912+345+678&o_email=tec%40easypay.pt&o_max_date=2014-12-31&ep_partner=use+the+same+value+as+ep_user
http://test.easypay.pt/_s/api_easypay_01BG.php?ep_cin=9999&ep_user=USER010101&ep_entity=10611&ep_ref_type=auto&ep_type=boleto&ep_currency=BRL&ep_country=PT&ep_language=EN&t_value=15.25&t_key=3&o_name=John+Doe&o_description=&o_obs=&o_mobile=912+345+678&o_email=tec%40easypay.pt&o_max_date=2014-12-31&ep_partner=use+the+same+value+as+ep_user
ok0 ep_country and ep_entity and ep_user and ep_cin ok and validation by ip;ip ok - new reference generated - 999907994 9999 USER010101 10611 999907995 15.25 3 https://www.easypay.pt/_s/c11.php?e=10611&r=999907995&v=15.25&c=PT&l=EN https://checkout.ebanx.com/checkout?hash=1998bff11bf7b3185e8f2af113ee3fb1fa4c9654c7 BRL 15.25
string string integer string integer string double string string string string double
https://www.easypay.pt/_s/api_easypay_01BG.php?ep_cin=9999&ep_user=USER010101&ep_entity=10611&ep_ref_type=auto&ep_type=boleto&ep_currency=BRL&ep_country=PT&ep_language=EN&t_value=15.25&t_key=3&o_name=John+Doe&o_description=&o_obs=&o_mobile=912+345+678&o_email=tec%40easypay.pt&o_max_date=2014-12-31&ep_partner=use+the+same+value+as+ep_user&ep_rec=yes&ep_rec_freq=1M&ep_rec_url=http%3A%2F%2Fyoursite.com%2Feasypay%2Fdirect_debit_return.php
http://test.easypay.pt/_s/api_easypay_01BG.php?ep_cin=9999&ep_user=USER010101&ep_entity=10611&ep_ref_type=auto&ep_type=boleto&ep_currency=BRL&ep_country=PT&ep_language=EN&t_value=15.25&t_key=3&o_name=John+Doe&o_description=&o_obs=&o_mobile=912+345+678&o_email=tec%40easypay.pt&o_max_date=2014-12-31&ep_partner=use+the+same+value+as+ep_user&ep_rec=yes&ep_rec_freq=1M&ep_rec_url=http%3A%2F%2Fyoursite.com%2Feasypay%2Fdirect_debit_return.php
ok0 ep_country and ep_entity and ep_user and ep_cin ok and validation by ip;ip ok - new reference generated - 999907994 9999 USER010101 10611 999907995 15.25 3 https://www.easypay.pt/_s/c11.php?e=10611&r=999907995&v=15.25&c=PT&l=EN https://checkout.ebanx.com/checkout?hash=1998bff11bf7b3185e8f2af113ee3fb1fa4c9654c7 BRL 15.25 https://www.easypay.pt/_s/c11_rp_cc.php?e=10611&r=999907995&v=15.25&c=PT&l=EN&p=1M&ep_k1=EF3C7E6F76E8C20652C100D47EFCEA2F301604382 https://www.easypay.pt/_s/c11_rp_dd.php?e=10611&r=999907995&v=15.25&c=PT&l=EN&p=1M&ep_k1=EF3C7E6F76E8C20652C100D47EFCEA2F301604382 EF3C7E6F76E8C20652C100D47EFCEA2F301604382 1M
string string integer string integer string double string string string string double string string string string
https://www.easypay.pt/_s/api_easypay_05AG.php?e=10611&r=999907994&v=15.25&mbway=yes&mbway_title=test&mbway_type=authorization&mbway_phone_indicative=351&mbway_phone=911234567&mbway_currency=EUR&t_key=3
Not available
10611
999907994
15.25
test
authoriztion
351
911234567
EUR
EF3C7E6F76E8C20652C100D47EFCEA2F30160438
3
success
Operation succeded
integer
string
double
string
string
integer
integer
string
string
string
string
string