You are on page 1of 12

Slydepay

Merchant API
Version 1.4
2

DreamOval Ltd

2nd Floor Crystal Plaza

Community 18, Lashibi

Tema

Ghana

Tel: +233 303 411045 Fax: +233 303 411045

Email: info@dreamoval.com

Disclaimer and Limitation of Liability

DreamOval, has made efforts to ensure the accuracy and completeness of the
information in this document. However, DreamOval Ltd. makes no warranties of any
kind (whether express, implied or statutory) with respect to the information contained
herein. DreamOval assumes no liability to any party for any loss or damage (whether
direct or indirect) caused by any errors, omissions, or statements of any kind
contained in this document.
Further, DreamOval assumes no liability arising from the application or use of the
product or service described herein and specifically disclaims any representation that
the products or services described herein do not infringe upon any existing or future
intellectual property rights. Nothing herein grants the reader any license to make, use,
or sell equipment or products constructed in accordance with this document.

Finally, all rights and privileges related to any intellectual property right described
herein are vested in the patent, trademark, or service mark owner, and no other
person may exercise such rights without express permission, authority, or license
secured from the patent, trademark, or service mark owner. DreamOval reserves the
right to make changes to any information herein without further notice.

Trademarks

DreamOval, the DreamOval logo, Slydepay, SlydepaylIve. Slydepay payLIVE, and


Slydepay logo and other trademarks, service marks, and logos are registered or
unregistered trademarks of DreamOval and its subsidiaries in Ghana.

Publication date: September 18, 2014


3

TABLE OF CONTENTS
Table of Contents ............................................................................................. 3

Introduction ....................................................................................................... 4

Configuring your i-MerchantAccount ........................................................... 4

Integration Mode .......................................................................................... 4

Integrating Slydepay........................................................................................ 5

API Web Service ............................................................................................ 5

payLIVE URLs .................................................................................................. 7

Parameter List ................................................................................................ 7

Service types ................................................................................................. 9

Response parameters ...................................................................................... 9

API Responses ................................................................................................ 9

Transaction Responses ............................................................................... 11


4

INTRODUCTION

This Application Programming Interface (API) describes how to integrate your website
with Slydepay online payments. Examples and other resources for integrating can be
found under the resources tab in your merchant account.

Slydepay uses a HTTP requests and SOAP web service calls to process payments. This
works by sending the required parameters and their values to a web service through
a SSL connection followed by a redirect to a merchant order page.

This works when Slydepay mandatory parameters and their corresponding values are
sent to a web-processing page secured by an SSL connection.

CONFIGURING YOUR I-MERCHANTACCOUNT


 Ensure your account has been verified. You can see this immediately you
login to your Slydepay account.

 Under the “Account Settings>>payLIVE Settings” section in your account, set:


o Integration Mode
o Merchant Name
o Merchant Key
o Call back URL. (HTTP redirect to merchant domain with transaction
status)

INTEGRATION MODE

Integration mode basically sets your account into a demo mode to help with
development and testing of the merchants integration with API.

When ON, you can test the account with a dummy wallet (credentials below).

Remember to set the ‘Integration header parameter to “1” when running in


integration mode.

When ready to go LIVE! Make sure the integration mode is OFF and set the
‘Integration parameter to “0.

INTEGRATION WALLET USER

Email: testpaddy@slydepay.com.gh
Password: paddypaddy
5

INTEGRATING SLYDEPAY
In order to receive payments from Slydepay, you are provided with a SOAP web
service to integrate your website or application with Slydepay API servers.

SLYDEPAY MERCHANT API WEB SERVICE

Required parameters are stored as values in hidden form fields and upon click, are
POSTed from the merchant’s site to the Slydepay Merchant! Order pages.

Note: Slydepay Merchant API Web service is the most secure method of processing
payments and is available for the Slydepay Merchant API version 1.4 and above.

How it works

1. Merchant makes a web service call to the Slydepay API Service passing
the required header and method parameters.

2. The API server processes requests and validates the header and
parameters. If validation is successful, a session ID is generated and
returned to the Merchant. This ID is called a pay Token.
If there is an error in the request from the Merchant, an error code is
returned to the Merchant.
Note: Error codes are listed on page [#] in this API

3. Merchant after receiving the Pay Token can now do an HTTP redirect to
the Slydepay Merchant order page passing the Token
https://app.slydepay.com.gh/paylive/detailsnew.aspx?pay_token=
IWA19389

4. Order summary is presented to Customer and Customer is requested to


input Account credentials to continue payment.

5. After a successful transaction, Slydepay API then redirects to Merchant


call-back URL with:
 status of transaction
 transaction ID
 customer reference ID.

6. Merchant makes a webservice call to confirm completion of payment


and receipt of transaction information. The web service method returns an
integer value to indicate the success or failure of transaction confirmation.
6

Step Detail

1 Initiate payment request session (ProcessPaymentOrder)

2 PAYLIVE Token or error response is returned

3 HTTPS Redirect to Slydepay order form page with payment token

4 Transaction is processed and money credited to merchant Slydepay

account

5 Payment Notification Sent to merchant app (HTTP Redirect –

success/failure)

6 Payment notification acknowledgement (Confirmation / Cancellation of

transaction (ConfirmTransaction or CancelTransaction)


7

PAYLIVE URLS

payLIVE Web https://app.slydepay.com.gh/webservices/paymentservice.asmx


Service:
Web Service https://app.slydepay.com.gh/webservices/paymentservice.asmx
WSDL: ?wsdl
Web Service ProcessPaymentOrder, ConfirmTransaction, CancelTransaction
Methods:
Merchant https://app.slydepay.com.gh/paylive/detailsnew.aspx
Order Page:

PARAMETER LIST

HEADER
Parameter Description Req. Type Max Length
Specify the API version from which you
Alpha -
APIVersion are integrating your application. For this YES 10
Numeric
API version specify “1.3”
Merchant generated key from i-
Alpha-
MerchantKey Merchant account. YES 32
Numeric
Alpha-
MerchantEmail Merchant Slydepay login email YES 128
Numeric
Specify the type of service the payment
is for. The list of allowed service type Alpha-
SvcType YES 128
codes are provided below. Choose the Numeric
one that suites your transactions.
Set this “1” if you are running in
integration mode. Set to “0” or omit if
UseIntMode YES Boolean 1
you are running your merchant account
on LIVE! Mode.

PROCESSPAYMENTORDER
Parameter Description Req. Type Max Length
Defined by Merchant and may be used
for auditing and reporting. This could be a Alpha-
orderId YES 128
unique number for transactions on your Numeric
site or application.
Total cost of all items minus shipping and
subTotal tax. YES Numeric 10

Cost of shipping/delivery of order.


shippingCost YES Numeric 10
8

Total amount of tax charged on order.


taxAmount YES Numeric 10
Total cost of order including shipping and
amount YES Numeric 10
tax.
Defined by Merchant and may be used
for auditing and reporting. This could be Alpha-
comment1 YES 255
the category of the item or service being Numeric
provided (E.g. Credit Transfer)
Defined by Merchant and may be used
for auditing and reporting. This could be Alpha-
comment2 NO 255
the exact item or service being provided Numeric
(E.g. Phone Credit)
An array describing each individual item Array of
orderItems in the order. The format for order item YES order
descriptions is given below. items
Note: Amounts MUST be specified in Ghana Cedis. Do not use or include comma separators or cedi(¢)
symbols.

ORDERITEM
Parameter Description Req. Type Max Length
Defined by Merchant and may be used
for auditing and reporting. This could be a Alpha-
itemCode YES 128
unique number for items on your site or Numeric
application.
Name or short description of item being Alpha –
itemName YES 128
purchased Numeric
Specify the unit price of the item being
unitPrice YES Numeric 10
paid for
quantity Specify the quantity of the items YES Numeric 5
The sub or line total for a specific item. It is
subTotal equal to the unit price times the quantity YES Numeric 10
of the specific item being purchased

CONFIRMTRANSACTION
Parameter Description Req. Type Max Length
The session id or pay token returned by Alpha-
payToken YES 36
the ProcessPaymentOrder method. Numeric
The unique id passed to the merchant
Alpha -
transactionId redirect url on completion of payment. YES 36
Numeric

CANCELTRANSACTION
Parameter Description Req. Type Max Length
The session id or pay token returned by Alpha-
payToken YES 36
the ProcessPaymentOrder method. Numeric
The unique id passed to the merchant
Alpha -
transactionId redirect url on completion of payment. YES 36
Numeric
9

SERVICE TYPES

Value Description
For consumer to business transactions. This can be used as a default service
C2B
type for merchants selling to Slydepay wallet holders

RESPONSE PARAMETERS

API RESPONSES
Response parameters in this section refer to responses that are sent to the Merchant
when an API call is made for a Token.

Please note that for API calls, responses are printed on the request page. Your
application should read the response and continue processing. For those using PHP
lib curl and file, it is returned in an array after the request has been made.

FOR A SUCCESSFUL API CALL


Usage: IWPL919387462H625Fh289472G

FOR AN UNSUCCESSFUL API CALL


Usage: Error: -1

Response Explanation

-1 Technical error contact Slydepay support

1 Merchant Credentials wrong check email or merchant key

2 Merchant not confirmed

3 Merchant account not verified

Integration Mode set to OFF in account. Set UseIntMode param to


4
“0” or switch integration mode on in account.
10

Integration Mode set to ON in account. Set UseIntMode param to


5
“1” or set account to go LIVE!

9 Invalid Parameter

INVALID PARAMETERS DESCRIPTION


Usage: Error: 9: T1

This error means there is a Parameter with an invalid type causing it to throw an
invalid parameter response, which is 9. The exact parameter is identified by T1 which
is the amount parameters. The table below can help identify the exact parameter
that causes an error with response 9.

Parameter Error code


T1
amount R1
L1
T2
orderId R2
L2
T3
R3
comment1
L3

T4
comment2 R4
L4
T5
MerchantEmail R5
L5
T6
MerchantKey R6
L6
T7
SvcType R7
L7
T8
unitPrice R8
L8
T9
quantity R9
L9
T 10
orderItems R 10
L 10
T 11
APIVersion R 11
L 11
T 12
UseToken
R 12
(deprecated)
L 12
T 13
UseIntMode R 13
L 13
11

T = wrong data type

R = parameter required

L = wrong data length

TRANSACTION RESPONSES
Response parameters send information on the status of a transaction to the link
provided by the Merchant for responses. This set of responses is sent using a get
command to the Merchant’s page.

E.g.

https://www.merchantdomain.com/secure/merchantlink.aspx?status=0&transac_id=
12938&cust_ref=124134&pay_token=345667335678

TRANSACTION RESPONSE PARAMETERS


Field Description Type length
The result of the transaction. For
example, a response of 0 means
the transaction was successful.
status Numeric 1
Full list of response codes are
available in the response codes
section.
This is a unique number
generated for the transaction
transac_id Numeric 36
that will take place. This helps
the Merchant with auditing
This is the reference provided by
the Merchant to be used for
cust_ref Alpha-Numeric 128
reconciliation or to identify which
payment has been made
Payment token for payment
pay_token Alpha-Numeric 36
request session

TRANSACTION STATUS CODES


Status Explanation
Transaction successful and approved
0

Technical error contact Slydepay support


-1

-2 User cancelled transaction


12

CONFIRMATION RESPONSE CODES


Response Explanation

1 Confirmation Successful

0 Confirmation failed: Invalid transaction Id

-1 Confirmation Failed: Invalid pay token