INTEGRATION MANUAL DOCUMENTATION E-COMMERCE

Transcription

1 INTEGRATION MANUAL DOCUMENTATION E-COMMERCE

2 LOGIN: In order to use Inkapay's e-commerce payment API you should be registered and verified on Inkapay, otherwise you can do this by entering to If you are already registered and verified, you should enter to where you can sign in with your Inkapay credentials. Sign in with your Inkapay account credentials or you can sign in through Google and Facebook accounts in case your Bitinka/Inkapay accounts are linked to these.

3 CREDENTIAL GENERATION: Inkapay's e-commerce payment API uses Oauth protocol (Open Authorization) in order to allow the clients to authorize web applications (e-commerce), to access their Bitinka/Inkapay account information safely. In order to use this protocol, its necessary to generate Client ID and Secret ID credentials, to do so, you should click on Create New Client. When clicking on Create New Client, a modal will appear requesting the necessary information for the credentials generation.

4 Name: store s name. Oauth redirection URL: the Store address where it will receive the autorization token. Final redirection URL: the Store address where it will receive the response of the payment transaction. Currency: currency in which the payment will be received. Once the form has been completed, select Create option and the system will create the credentials and show the Client ID and the Secret ID asigned to the store.

5 AUTHORIZATION: For the virtual store (e-commerce) to request the client s authorization, it is necessary to make a redirection to sending in the query string the following parameters: Client ID: Id generated when creating the credentials. Redirect_uri: redirection URL to receive the authorization. Response_type: code* Scope: Allow all* Example: When making the redirection, the system will allow the client to sign in with the access information associated with its Bitinka/Inkapay s account, and will show the window requesting for the system access authorization, in which the client can accept or decline the petition. When accepting the request, the system will return the authorization code through GET method, in the code parameter to the store through the Authorization s Redirection URL, with whom you must make a petition using the POST request method to get the the application s access token.

6 The parameters that should be sent are: grant_type: authorization_code*. client_id: ID assigned to the store. client_secret: Secret assigned to the store. redirect_uri: Authorization s redirection URL. code: Code returned from the server through GET method. For Example: curl -X POST -H "Content-Type: application/json" -d '{ "grant_type":"authorization_code"*, "client_id":"12", "client_secret":"9ywscrnccoguj7bzayrwsrs7ffx4aohshdy5yc8k", "redirect_uri":" "code":"code"* }' Once the petition is done, in case the information sent is correct, it will return the next response parameters: token_type: token type (Bearer) expires_in: token s expiration time in milliseconds. access_token: access token. refresh_token: it is a special token that contains the necessary information to request for a new access token, once this one has expired. In case of error, an expired code or some wrong data, the API s endpoint will return the following: error: name of the generated error. message: description of the generated error. hint: motive suggestion that generated the error.

7 API Once realized the authorization process and after obtained the access token, you should send to a form through POST method with the necessary information for the Inkapay s e-commerce payment API, this should contain the following values: norder: order s number / Bill / order of purchase. create: date of purchase. total: total transaction amount in the user s selected currency when creating the credentials. token: access token obtained in the authorization process. For Example: <form action=" method='post' > <input type="text" name="token" value="eyj0exaioij..."> <input type="text" name="norder" value="1"> <input type="text" name="create" value=" :00:00"> <input type="text" name="total" value="2000"> </form> Once the form has been sent, you will be redirected to InkaPay in order to make the payment process through Inkapay. A screen will be shown with the available currencies to make the payment with the current client s balance, so the user can select his origin currency and make the normal Send Money process. Once the transaction is done, a screen will be shown with the result of these, automatically redirecting to the Final Redirection URL, sending through POST the response parameters.

8 In case the transaction is successful the sent parameters are the following: response: transaction s response description. Code: result code. Token: Send Money s token In case the client cancels the transaction or the response is not satisfying the sent parameters are: response: transaction s response description. code: result code.

9 In the next table the possible codes are shown with their respective informative messages: code response Descripción 0 Succesful transaction Transaction succesfully completed. 1 Buyer and seller can not be the same The client can not be the same seller. 2 Invalid Credentials Invalid credentials, the authentication failed. 3 Transaction Error An error occurred while processing the transaction.

10 In order to visualize the transaction summary it is necessary to use the API showtransaction. For this you must realize a request using the requesting method POST to the URL with the following parameters: tokenacceso: access token obtained when generating the authorization. tokensm: transaction's identifier obtained by Inkapay's e-commerce payment API. This will show the following results: TX: transaction's ID. Amount_Client: source amount. Amount_Store: destination amount. Currency_Client: source currency. Currency_Store: destination currency. msg: message. In case of failing obtaining the information, this will return the response in the following format: resp: false transaction: error description. For example: curl -X POST -H "Content-Type: application/json" -d '{ "tokenacceso":"eyj0exaioij...", "tokensm":"6m4pfdm1" }' LEGEND: *: Fixed parameters.