Easypay Web Service Integration - Extra API
Click here to load reader
-
Upload
trkic-amer -
Category
Documents
-
view
135 -
download
3
description
Transcript of Easypay Web Service Integration - Extra API
easypay Web Service Integration
Extra API’s (rev. 4 – 2011-‐01-‐14)
IMPORTANT: This document is ONLY an annex to the easypay integration.
Please read the “easypay Web Service Integration” for complete instructions.
_____________________________________________________________________________________________
rev. 4 – 2011-‐01-‐14 Page. 2
About these API’s This document contains a few web services that we have created for your convenience.
AVAILABLE LANGUAGES 3
UPDATE, DELETE OR INSERT A PAYMENT IDENTIFIER 4
_____________________________________________________________________________________________
rev. 4 – 2011-‐01-‐14 Page. 3
Available Languages You can access this API to get the currently available languages provided by our credit card payment gateway. It is useful if you want to show the nearest available language according to the member language on your website. API: 10AA Method: GET, POST Type: PUBLIC (no authentication needed) Request Data: type Data type: enum(json,xml)
Default: xml
No mndatory parameters. Example XML:
https://www.easypay.pt/_s/api_easypay_10AA.php?type=json
In response to your request, easypay will send you back the following XML string: <ep_languages>
<language>
<code>PT</code>
<name>Portuguese</name>
</language>
<language>
<code>EN</code>
<name>English</name>
</language>
<language>
<code>ES</code>
<name>Spanish</name>
</language>
</ep_languages>
Example JSON:
https://www.easypay.pt/_s/api_easypay_10AA.php?type=json
In response to your request, easypay will send you back the following JSON string: {"PT":"Portuguese","EN":"English","ES":"Spanish"}
_____________________________________________________________________________________________
rev. 4 – 2011-‐01-‐14 Page. 4
Update, Delete or Insert a Payment Identifier This API can be used to request all payment details done on your account. It will return a list on XML or JSON format for your convenience. API: 00BG Method: GET, POST Request Data: ep_cin Data type: int(9)
Your Client Identification Number
ep_user Data type: int(9)
Your Client Username
ep_entity Data type: enum(21098, 10611)
Unique payment number.
ep_ref The payment identifier that you would like to update, delete or insert.
ep_delete Set to ‘yes’ if you would like to delete the payment identifier.
The following parameters need to be sent if you would like to update or create a payment identifier
t_value The amount for this payment identifier.
o_name The name associated.
o_description The description.
o_obs Extra observations
o_email Email associated.
o_mobile The mobile phone associated
t_key The key that you would like to associate with this payment identifier
Parameters in BOLD are mandatory. Example XML: https://www.easypay.pt/_s/api_easypay_00BG.php?ep_entity=10611&ep_user=EASYTEST9&ep_cin=8889&ep_r
ef=888902154&t_value=150&t_key=100
_____________________________________________________________________________________________
rev. 4 – 2011-‐01-‐14 Page. 5
In response to your request, easypay will send you back the following XML string: <getautomb> <ep_status>ok0</ep_status> <ep_message>ep_country and ep_entity and ep_user and ep_cin ok and validation by ip;reference 888902154 was updated;</ep_message> <ep_cin>8889</ep_cin> <ep_user>EASYTEST4</ep_user> <ep_entity>10611</ep_entity> <ep_reference>400000045</ep_reference> <ep_value>150.00</ep_value> <ep_key>100</ep_key> </getautomb>