API Documentation. Version 2.0

Transcription

1 API Documentation Version 2.0

2 Table of Contents 1. Overview Test Merchant Account v/s Live Merchant Account Target Audience Assistance Technical Architecture Getting started Web Service URLs Definitions Authentication Request Response Error Codes Create Pay Page Request Response Response Codes Error Codes Example: Validate API Key Request Response Error Codes Verify Payment Request Response Response Codes Error Codes Example Expire API Key Request Response Error Codes REST API Call Behavior Response & Error Codes Response Codes PayTabs API Documentation V e r s i o n 2. 0

3 9.2 Error Codes Test Credit Card Numbers Example PayTabs API Documentation V e r s i o n 2. 0

4 Revision History Version Description of Change Date New Document 21/11/ Added Architecture Diagram & return_url in create PayPage 24/11/ Added Definitions of Terms 25/11/ Added Test Cards 27/11/ Added Error Code 0006 for invalid country 07/01/ Added MDD (Merchant Defined Data) structure in the calls 29/01/ Updated Response Code 22/06/ Removed All Staging Links - Removed Service Calls section - Removed Prepare Transaction API - Added API Key in subsequent API calls to authenticate requests - Added discount and Currency Fields - Added Reference Number added create PayPage - Transaction Logs API removed - Inventory API removed - Complete Transaction API removed. - Added Examples for each call - Added full Example for API - Change of Format of Documentation - Added Test Account v/s Live Account description - Added support address - Added updated technical Architecture Diagram - Added msg_lang to create PayPage to set language - Removed User Roles - Added constraint of 9 characters for Postcode - Changed description in paypage to products_per_title - Added a note in create PayPage example. - Improved Section Numbering - Changed all API Calls from paytabs.co to paytabs.com - Changed example to include spaces between separators - Added note to include spaces between separators - Added comments to the example code and note for test cards - Unused Response Code 1 and 3 removed from document. - Added Comment for successful transaction response code - Corrected merchant_password variable in example code - Changed description variable to product_per_title in example - Supported Platforms included - Code Syntax Highlighted 26/07/ /08/ /09/ /01/ PayTabs API Documentation V e r s i o n 2. 0

5 1. Overview At PayTabs, we are committed to providing the most secure, reliable and user-friendly payment processing solutions. By partnering with us for your payment processing needs, you can be confident that payment transactions will be processed quickly and efficiently, and your customers information will be safe. You ll enjoy our easy set-up using our Plugins and easy integration with our APIs. Our twolevel fraud protection system protects transaction data throughout the payment process. With PayTabs as your payment processor, you ll benefit from the fastest, most secure, and cost-effective payment processing in the industry. PayTabs API is a RESTful resource. In order to integrate with PayTabs API, you will need the credentials of your PayTabs Merchant Account. If you do not have a merchant account, you can sign up for one here. It's important to note that the PayTabs APIs are constantly evolving, and updates are usually done every quarter, if required. PayTabs will intimate any major API change, so it s important that you check your merchant dashboard notification or , frequently to be updated. 1.1 Test Merchant Account v/s Live Merchant Account PayTabs does not offer an explicit Sandbox / Testing environment. But using a demo account, you can freely test all the functionalities and integrate our API and Plugin without any hassle. In order to move to LIVE PRODUCTION environment, you will need to activate your LIVE MERCHANT ACCOUNT by clicking on GO LIVE through your PayTabs Merchant Account. PayTabs requires some personal information, documents and other details related to your business to validate your business. Once your Merchant Account is activated, you will have been moved to the LIVE PRODUCTION environment. 1.2 Target Audience This document is intended for developers who want to write applications that interact with PayTabs.com. This document assumes that you understand general networking and programming ideas. Even though code examples are built using PHP, any programming language of your choice can be used to interact with this API. This API supports PHP and.net platforms. 5 PayTabs API Documentation V e r s i o n 2. 0

6 1.3 Assistance If you require assistance, please check out our Frequently Asked Questions or chat live with our support staff or us at 1.4 Technical Architecture 6 PayTabs API Documentation V e r s i o n 2. 0

7 2 Getting started Here is a listing of all the APIs provided by PayTabs. S. No. API FUNCTION API CALL 1 Authentication 2 Create PayPage 3 Validate API Key 4 Verify Payment 5 Expire API Key 7 PayTabs API Documentation V e r s i o n 2. 0

8 2.1 Web Service URLs PayTabs does not offer an explicit Sandbox / Testing environment. But using a demo account, you can freely test all the functionalities and integrate our API and Plugin without any hassle. In order to move to LIVE PRODUCTION environment, you will need to activate your LIVE MERCHANT ACCOUNT Production Environment : Definitions The following are some of the terms that are used in this document and their respective definitions. TERM Merchant Customers Banks Payment processor Masked number Issuer Bank DEFINITION PayTabs customer who will use the PayTabs system in their shops/counters. The customer that the merchant will charge. They are also called cardholders. The banks to which PayTabs will interact. The 3rd party payment gateway that PayTabs is using to capture payments The first 6 and last 4 numbers of the card number with*(asterisk in the middle) The bank which has issued the credit card being used. Settlement Bank The bank where PayTabs will settle money after clearance. 8 PayTabs API Documentation V e r s i o n 2. 0

9 3 Authentication This method uses the merchant_id and merchant_password to authenticate the request and receive an API Key to validate all subsequent requests. The same API Key can be used to validate multiple requests provided that the requests take place within 15 minutes. After 15 minutes the API Key will expire and a new one will have to be obtained by making the authentication call again. Authentication is the only API call that accepts merchant_id and merchant_password. The other API calls validate each request using the API Key obtained from the authentication response. PATH REQUEST METHOD PRODUCTION POST LIVE 3.1 Request Element Description Format merchant_id merchant_password The merchant s valid Username, i.e. the merchant s address used at the time of sign up. Valid password of the Merchant s PayTabs Account. > 4 characters E.g.: foo@bar.com 6 to 64 characters E.g.: testpassword 3.2 Response Element Description Format access Status of Authentication: granted / denied E.g.: granted / denied api_key The current API Key of the merchant. This Key will expire in 15 minutes. E.g.: W87egrw8egh error_code The error code is present in the response only if there is an error. 4 characters E.g.: PayTabs API Documentation V e r s i o n 2. 0

10 3.3 Error Codes Error Code Description 001 Merchant ID and password do not match 10 PayTabs API Documentation V e r s i o n 2. 0

11 4 Create Pay Page This method uses the API Key obtained from the authentication API Call to validate the request. This method will accept all the parameters required to create a PayPage and then return the response as well as the link where the customer can enter the credit card information and make the payment. PATH REQUEST METHOD PRODUCTION POST LIVE 4.1 Request Element Description Format api_key API Key received from authentication API call or a valid API key E.g.: Mao8sdhasfyahosdap9sd cc_first_name First Name of the Customer 32 characters E.g.: John cc_last_name Last Name of the Customer 32 characters E.g.: John phone_number Phone Number of the Customer 32 characters E.g.: billing_address Complete Address of the customer. Multiple address lines will be merged into one single line. 64 characters E.g.: Flat 11 Building 222 Block 333 Road 444 Manama Bahrain 11 PayTabs API Documentation V e r s i o n 2. 0

12 state *** State (part of the address) entered by the customer 32 characters E.g.: Manama city Name of the city selected by customer 3-4 characters E.g.: Manama postal_code Postal code provided by the customer Up to 9 characters E.g.: country Country of the customer of the customer 3 character ISO country code E.g.: BHR 32 characters E.g.: customer@domain.com amount discount Amount of the transaction which should be the total Invoice amount, the API doesn t calculate this amount from unit prices & quantity of each item Optional Discount of the transaction Decimal Up to 3 Decimal places E.g.: Decimal Up to 3 Decimal places E.g.: reference_no Optional Invoice reference number 11 characters E.g.: Abc-5566 *** When the country is selected as USA or CANADA, the state field should contain a of 2 characters containing the ISO state code otherwise the payments may be rejected. For other countries, the state can be a string of up to 32 characters. 12 PayTabs API Documentation V e r s i o n 2. 0

13 currency title Currency of the amount stated. Description or title of the transaction done by the customer 3 character ISO country code E.g.: BHD 32 characters E.g.: Order # 3321 ip_customer The client IP with which the order is placed. 16 characters E.g.: ip_merchant Server IP where the order is coming from 16 characters E.g.: return_url The URL to which the customer will be returned to. E.g.: yment_completed.php address_shipping Shipping address of the customer 64 characters E.g.: Flat abc road 123 city_shipping Shipping City of the customer 32 characters E.g.: Manama state_shipping *** Shipping State of the customer 32 characters E.g.: Manama *** When the country is selected as USA or CANADA, the state field should contain a of 2 characters containing the ISO state code otherwise the payments may be rejected. For other countries, the state can be a string of up to 32 characters. 13 PayTabs API Documentation V e r s i o n 2. 0

14 postal_code_shipping Shipping postal code of the customer Up to 9 characters E.g.: country_shipping quantity Shipping country of the customer Quantity of a products. If multiple products then add separator. 3 character ISO country code E.g.: BHR 256 characters E.g.: unit_price products_per_title ChannelOfOperations ProductCategory Unit price of the product. If multiple products then add separator. Product title of the product. If multiple products then add separator Type of Products covered by the Merchant Broad Spectrum category of the product 256 characters E.g.: characters E.g.: IPhone Samsung S5 Samsung S4 32 characters E.g.: Software or Non- Physical, Physical Goods, Travel Related Services 32 characters E.g.: Electronics ProductName ShippingMethod Product names with separated Shipping method 256 characters E.g.: IPhone Samsung S5 Samsung S4 16 characters E.g.: Cash on Delivery 14 PayTabs API Documentation V e r s i o n 2. 0

15 DeliveryType Delivery Type 16 characters E.g.: Fedex CustomerId Any ID Number assigned to the customer by the merchant. 16 characters E.g.: T msg_lang Optional Language of the PayPage to be created. Any other parameter or no parameter will be taken as English by default. E.g.: English / Arabic To ensure that you get multiple line items in your PayPage, please make sure to add a space before and after two continuous pipeline separator. E.g. IPhone Samsung S5 Samsung S4 4.2 Response Element Description Format result The string representation for result about the supplied data E.g.: Pay Page is created. User must go to the page to complete the payment. error_code This is present in the response, only if there is any error. 4 characters E.g.: 0002 response The response code of the processor, If the parameters are accepted. Up to 2 characters E.g.: 10 p_id PayPage ID E.g.: PayTabs API Documentation V e r s i o n 2. 0

16 api_key The current API key of the merchant. This API Key will expire within 15 minutes. E.g.: W87egrw8egh payment_url The URL for the payment E.g.: age/ Response Codes Code Description 10 Pay Page is created. User must go to the page to complete the payment. 4.4 Error Codes Error Code Description 0002 API Key not valid 0404 You don't have permissions to create an Invoice. 16 PayTabs API Documentation V e r s i o n 2. 0

17 4.5 Example: <?php $pt->create_pay_page(array( "api_key " => sds3aqmkol21314 "cc_first_name" => "John", "cc_last_name" => "Doe", "phone_number" => " ", "billing_address" => "TEST BILL ADDRESS", "city" => "TEST CITY", "state" => "TEST STATE", "postal_code" => "12345", "country" => "BHR", " " => "amount" => "224", "discount " => "123.1" "reference_no " => "ABC-123 " "currency" => "BHD", "title" => "TEST TITLE", "ip_customer" =>" ", "ip_merchant" =>" ", "unit_price" => , "quantity" => 2 3 1, "address_shipping" => "Flat 3021 Manama Bahrain", "state_shipping" => "Manama", "city_shipping" =>"Manama", "postal_code_shipping"=>"1234", "country_shipping" => "BHR", "product_per_title" =>"MobilePhone Charger Camera", "channelofoperations"=>"physical Goods", "Product Category" =>"Electronics", "ProductName" => "MobilePhone Charger Camera", "ShippingMethod" => "Cash on Delivery", "DeliveryType" =>"FedEx", "CustomerID" =>"t ", "msg_lang => English, "return_url" => "Your site URL" ));?> Note: $pt represents your own class name and IS NOT any class library provided by PayTabs. It is used here just to illustrate the example. 17 PayTabs API Documentation V e r s i o n 2. 0

18 5 Validate API Key This method can be used at any time to validate the API Key. It is especially beneficial just before verifying a payment. If the API Key is invalid (usually after 15 minutes), a new one needs to be generated by passing the merchant credentials to the authentication API Call. PATH REQUEST METHOD PRODUCTION POST LIVE 5.1 Request Element Description Format api_key API Key received from authentication API call or a valid API key E.g.: Mao8sdhasfyahosdap9sd 5.2 Response Element Description Format result Result after checking the validity of the API Key. E.g.: valid for valid API key invalid for invalid API key error_code This is present in the response, only if there is any error. E.g.: Error Codes Error Code Description 0002 API Key not valid 18 PayTabs API Documentation V e r s i o n 2. 0

19 6 Verify Payment This method verifies the result of the payment. It is recommended that you first verify that your API Key is still valid before verifying the payment. If the API Key has expired ( usually after 15 minutes), a new API Key has to be obtained by passing the merchant_id and password to the authentication call and then use that key to verify the payment. When you create a PayPage, you will receive p_id in the response. When the customer completed a payment and is referred back to your website, there is a payment_reference that is sent with a POST method. The payment_reference is used to verify the status of the payment whether it is a successful transaction or a failed transaction. In addition to that you can compare the payment_reference and the p_id, inorder to match the payment with its respective PayPage. PATH REQUEST METHOD PRODUCTION POST LIVE 6.1 Request Element Description Format api_key API Key received from authentication API call or a valid API key Up to 64 characters E.g.: Mao8sdhasfyahosdap9sd payment_reference This is a payment reference that is sent with a POST method when the customer is returned from payment page. Up to 64 characters E.g.: t2938yh202tu0 6.2 Response Element Description Format result The string representation for result, whether transaction has succeeded or failed. E.g.: Payment is completed. 19 PayTabs API Documentation V e r s i o n 2. 0

20 error_code This is present in the response, only if there is any error. 4 characters E.g.: 0002 response The response code of the processor, If the parameters are accepted. Up to 2 characters E.g.: Response Codes Code Description 0 The payment is rejected 2 PIN rejected, payment rejected 6 Payment is completed. 3D secure is also approved (if applicable) 7 Unknown status * Response Code 6 is the response code for a successful transaction. 6.4 Error Codes Error Code Description 0002 API Key not valid There are no transactions available. 20 PayTabs API Documentation V e r s i o n 2. 0

21 6.5 Example <?php function verify_payment($api_key, $payment_reference) { $values['api_key'] = $api_key; $values['payment_reference'] = $payment_reference; return json_decode(mypostdatafunction(" $values)); }?> 21 PayTabs API Documentation V e r s i o n 2. 0

22 7 Expire API Key This API call will expire the API Key after all API Calls are complete. PATH REQUEST METHOD PRODUCTION POST LIVE 7.1 Request Element Description Format api_key API Key received from authentication API call or a valid API key E.g.: Mao8sdhasfyahosdap9sd 7.2 Response Element Description Format result The result of the transaction E.g.: Logged Out 7.3 Error Codes Error Code Description 0002 API Key not valid 22 PayTabs API Documentation V e r s i o n 2. 0

23 8 REST API Call Behavior Once the API Call for creating pay page is called and the customer is redirected to the pay page, after completing the payment, it will be redirected to return_url. While returning back to that URL, it will send a POST request to that page explained as below: Element Description Format payment_reference This is a payment reference that is sent with a POST call when the customer is returned from payment page. Up to 64 characters E.g.: t2938yh202tu0 Now you have two key values to see the status of the payment: 1. api_key : generated from the authentication call 2. payment_reference: that is sent as a POST request when customer is redirected back to the merchant website. These two parameters can provide you details about the payment if sent to verify_payment. Payment can be verified and the order status can be set accordingly in shopping carts. Security Tip: Ensure that the referrer response is originating from PayTabs.com 23 PayTabs API Documentation V e r s i o n 2. 0

24 9 Response & Error Codes The following table describes all the response code and error codes which may appear when working with the API. 9.1 Response Codes Code Description 0 The payment is rejected 1 The payment is prepared 2 PIN rejected, payment rejected 3 PIN accepted, payment approved 6 Payment is completed. 3D secure is also approved (if applicable) 7 Unknown status 10 Pay Page is created. User must go to the page to complete the payment. 9.2 Error Codes Code Description 0001 Merchant ID and password does not match API Key not valid Transaction ID not found Unknown transaction error occurred The currency code is not available for this merchant You don t have permissions to create an Invoice. 24 PayTabs API Documentation V e r s i o n 2. 0

25 10 Test Credit Card Numbers To test your payment process, you can typically use any valid credit card number or you can use the ones listed below. Please do not use test cards in a live environment. This will cause your transactions to be rejected. Card Number Description CVV Expiry Date With authentication window / Card enrollment option during purchase process / With authentication window / Without authentication window Card enrollment option during purchase process / / NON-KSA AMEX CARD / KSA AMEX CARD DETAILS / PayTabs API Documentation V e r s i o n 2. 0

26 11 Example // Defining Variables for the API CALLS define("testing", " define("authentication"," define("paypage_url", " // Your own class class paytabs{ private $merchant_id; private $merchant_password; private $api_key; // Function to Initiate Class Variables function paytabs($merchant_id, $merchant_password) { $this->merchant_id = $merchant_id; $this->merchant_password = $merchant_password; $this->api_key = ""; } // Function to Authenticate Merchant ID & Password and obtain API Key function my_function_to_authentication() { $obj = json_decode(my_function_to_post_data(authentication, array("merchant_id"=> $this->merchant_id, "merchant_password"=> $this->merchant_password))); // On successful authentication, an API Key is returned. if($obj->access == "granted") { $this->api_key = $obj->api_key; } else { $this->api_key = ""; } return $this->api_key; } 26 PayTabs API Documentation V e r s i o n 2. 0

27 // Function to Create PayPage function my_function_to_create_paypage ($values) { $values['api_key'] = $this->api_key; $values['cc_first_name'] = "John"; $values['cc_last_name'] = "Doe"; $values['phone_number'] = " "; $values['billing_address'] = "Flat 3021 Manama Bahrain"; $values['state'] = "Manama"; $values['city'] = "Manama"; $values['postal_code'] = "12345"; $values['country'] = "BHR"; $values[' '] = "customer@domain.com"; $values['amount'] = " "; $values['discount'] = "34.699"; $values['reference_no'] = "ABC-5542"; $values['currency'] = "BHD"; $values['title'] = "Order No 1223"; $values['ip_customer'] = " "; $values['ip_merchant'] = " "; $values['return_url'] = " $values['address_shipping'] = "Flat 3021 Manama Bahrain"; $values['state_shipping'] = "Manama"; $values['city_shipping'] = "Manama"; $values['postal_code_shipping'] = "12345"; $values['country_shipping'] = "BHR"; $values['quantity'] = "1 2 1 "; $values['unit_price'] = " "; $values['products_per_title']= "MobilePhone Charger Camera"; $values['channelofoperations'] = "Physical Goods"; $values['product Category'] = "Electronics"; $values['productname'] = "MobilePhone Charger Camera"; 27 PayTabs API Documentation V e r s i o n 2. 0

28 $values['shippingmethod'] = "Cash On Delivery"; $values['deliverytype'] = "FedEx"; $values['customerid'] = "t "; $values['msg_lang'] = "English"; return json_decode(my_function_to_post_data(paypage_url, $values)); } // Create your own function to post the data to PayTabs. function my_function_to_post_data($url, $fields) { // Send Data to PayTabs // Here you need to write a function to send the data prepared in the // previous function to PayTabs via curl or any other method. } }?> 28 PayTabs API Documentation V e r s i o n 2. 0