Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
developer:api_specification [2019/05/17 14:40]
127.0.0.1 external edit
developer:api_specification [2019/09/19 13:51] (current)
branko
Line 1: Line 1:
 +====== API Specification ======
  
 +~~TOC~~
 +
 +\\
 +Welcome to the API Specification. Here you will find all necessary information to help you understand your integration to our Payment gateway.
 +
 +===== Things You Should Know First =====
 +
 +\\
 +This section helps you to understand the elements for your solution'​s integration such as which integration method to use, how to configure your account to perform each integration,​ how to use the custom fields, how to calculate the hash parameters of requests and responses, etc.
 +
 +<​html> ​
 +<div class="​boxes">​
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​special_fields_and_parameters"​ class="​box">​
 +<i class="​fa fa-puzzle-piece"></​i>​
 +<​h3>​Special Fields and Parameters</​h3>​
 +<​p>​HASH Calculation,​ Card Types, Custom Fields, Dynamic Descriptors,​ Multi-currency Terminal ID, Signature Field</​p>​
 +</a>
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​response_codes_and_messages"​ class="​box">​
 +<i class="​fa fa-list"></​i>​
 +<​h3>​Response Codes and Messages</​h3>​
 +<​p>​Specific response codes and messages which may be returned in different features...</​p>​
 +</a>
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​account_updater"​ class="​box">​
 +<i class="​fa fa-exclamation-circle"></​i>​
 +<​h3>​Account Updater Background Notification</​h3>​
 +<p>A longer and more detailed explanation of how this important mechanism works...</​p>​
 +</a>
 +
 +</​div>​
 +</​html>​
 +
 +===== The Hosted Page Integration Method =====
 +
 +\\
 +The Hosted Page (HP) is an integration method where the entry of some sensitive data is handled by the Payment Gateway so the merchant’s servers are not exposed to this data. This is advisable so as to reduce the security overhead of the integrated solution. For this scenario, %CompanyName becomes the responsible party for maintaining the security and integrity of the sensitive data sent to these pages.
 +
 +These Hosted Pages are also highly stylized so that they look more appealing to the customers and improves their overall experience. For more details on that consult **[[merchant:​existing_merchant:​selfcare_system:​settings:​pay_pages|Pay Pages]]**.
 +
 +Cardholders are redirected to a page at the Payment Gateway. Upon the customer clicking the ‘submit’ button on that page, all data are collected, processed and the Payment Gateway sends the processing result back to the Merchant'​s site, also redirecting the Account Holder to the Merchant'​s result page, in a transparent way.
 +
 +The following features are available for this integration method:
 +
 +<​html> ​
 +<div class="​boxes">​
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​hpp_payment_features"​ class="​box">​
 +<i class="​fa fa-money"></​i>​
 +<​h3>​Payment</​h3>​
 +<​p>​Payment and pre-authorization</​p>​
 +</a>
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​hpp_background_validation"​ class="​box">​
 +<i class="​fa fa-check"></​i>​
 +<​h3>​Background Validation</​h3>​
 +<​p>​Checks the transaction</​p>​
 +</a>
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​hpp_payment_features_applepay"​ class="​box">​
 +<i class="​fa fa-apple"></​i>​
 +<​h3>​Payment</​h3>​
 +<​p>​Payment using Apple Pay technology</​p>​
 +</a>
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​hpp_payment_features_googlepay"​ class="​box">​
 +<i class="​fa fa-google"></​i>​
 +<​h3>​Payment</​h3>​
 +<​p>​Payment using Google Pay technology</​p>​
 +</a>
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​hpp_secure_card_features"​ class="​box">​
 +<i class="​fa fa-credit-card"></​i>​
 +<​h3>​Secure Card</​h3>​
 +<​p>​Secure card registration and update</​p>​
 +</a>
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​hpp_subscription_features"​ class="​box">​
 +<i class="​fa fa-repeat"></​i>​
 +<​h3>​Subscription</​h3>​
 +<​p>​Subscription and stored subscription registration</​p>​
 +</a>
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​hpp_bulk_payments_features"​ class="​box">​
 +<i class="​fa fa-clone"></​i>​
 +<​h3>​Bulk Payments</​h3>​
 +<​p>​Large payment file submission and result request</​p>​
 +</a>
 +
 +</​div>​
 +</​html>​
 +
 +===== The XML Integration Method =====
 +
 +\\
 +The XML integration method allows a Merchant'​s solution to integrate directly with the Payment Gateway, perform specific “feature modeled” calls whereby the Payment Gateway processes a request and sends back a response showing the result of the transaction requested or the errors related to it.
 +
 +The following features are available for this integration method:
 +
 +<​html> ​
 +<div class="​boxes">​
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​xml_payment_features"​ class="​box">​
 +<i class="​fa fa-money"></​i>​
 +<​h3>​Payment</​h3>​
 +<​p>​Payment,​ pre-auth, pre-auth completion, refund, unreferenced refund, transaction status update, and more...</​p>​
 +</a>
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​xml_payment_features_applepay"​ class="​box">​
 +<i class="​fa fa-apple"></​i>​
 +<​h3>​Payment</​h3>​
 +<​p>​Payment using Apple Pay technology</​p>​
 +</a>
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​xml_payment_features_googlepay"​ class="​box">​
 +<i class="​fa fa-google"></​i>​
 +<​h3>​Payment</​h3>​
 +<​p>​Payment using Google Pay technology</​p>​
 +</a>
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​xml_payment_paylink_features"​ class="​box">​
 +<i class="​fa fa-link"></​i>​
 +<​h3>​Pay Link</​h3>​
 +<​p>​Management of pay links. Create, retrieve links and send them to customers.</​p>​
 +</a>
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​xml_payment_features_einvoice"​ class="​box">​
 +<i class="​fa fa-link"></​i>​
 +<​h3>​eInvoice</​h3>​
 +<​p>​Management of eInvoices. Create, cancel, retrieve links and send them to customers.</​p>​
 +</a>
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​xml_account_verification_features"​ class="​box">​
 +<i class="​fa fa-credit-card"></​i>​
 +<​h3>​Account Verification</​h3>​
 +<​p>​Verification of card accounts'​ validity</​p>​
 +</a>
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​xml_secure_card_features"​ class="​box">​
 +<i class="​fa fa-credit-card"></​i>​
 +<​h3>​Secure Card</​h3>​
 +<​p>​Secure card registration,​ update, delete, consult and search</​p>​
 +</a>
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​xml_subscription_features"​ class="​box">​
 +<i class="​fa fa-repeat"></​i>​
 +<​h3>​Subscription</​h3>​
 +<​p>​Stored subscription registration,​ update and delete. Subscription registration,​ update, delete and pay. Subscription notification</​p>​
 +</a>
 +
 +<br/>
 +<a href="/​doku.php?​id=developer:​api_specification:​xml_3d_secure"​ class="​box">​
 +<i class="​fa fa-shield"></​i>​
 +<​h3>​3D Secure</​h3>​
 +<p>3D Secure transaction check</​p>​
 +</a>
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​xml_terminal_features"​ class="​box">​
 +<i class="​fa fa-desktop"></​i>​
 +<​h3>​Terminal</​h3>​
 +<​p>​Consult terminals'​ configurations</​p>​
 +</a>
 +
 +</​div>​
 +</​html>​
 +===== Other Information =====
 +
 +<​html> ​
 +<div class="​boxes">​
 +
 +<​html> ​
 +<div class="​boxes">​
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​video_tutorials"​ class="​box">​
 +<i class="​fa fa-video-camera"></​i>​
 +<​h3>​Video Tutorials</​h3>​
 +<​p>​Examples and tutorials on how to use our API</​p>​
 +</a>
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​change_log"​ class="​box">​
 +<i class="​fa fa-database"></​i>​
 +<​h3>​Changes</​h3>​
 +<​p>​Change control history of the API</​p>​
 +</a>
 +
 +<a href="/​doku.php?​id=developer:​api_specification:​glossary"​ class="​box">​
 +<i class="​fa fa-sort-alpha-asc"></​i>​
 +<​h3>​Glossary</​h3>​
 +<​p>​Guide'​s glossary</​p>​
 +</a>
 +
 +</​div>​
 +</​html>​
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Share Alike 4.0 International