Praxis Wiki logo

Linking to the Cashier |Init Pay In Recommended


InitPayIn is the mechanism for a quick access to the cashier using REST API.

PayIn request should be sent to https://gateway.praxispay.com/client/init-pay-in. When executing the request, you receive json response that contains redirect_url parameter. The redirect_url parameter is a link that will automatically do the customer login to Cashier.

To ensure the API safety all requests should be signed according to the following algorithm:

  • signature is a HEX-perfomance SHA256-hash from a specially crafted string (ex: "19861f409729a42c2a8c0c636cfa0a4fb845e8fb");
  • all the request key parameters are sorted in ascending order of parameter (keys) names;
  • parameter names are in lower case and these are always strings;
  • all parameter values are consistently connected in one line;
  • secret key is added to the beginning of the string created this way;

Secret key is a WsPassCode for a selected front-end. When signing a request, the parameter with the signature name should always be excluded from the parameter set. The value of the generated signature should added to the general list of request parameters as the value of the signature parameter.

{danger.fa-exclamation-triangle} IMPORTANT #1: In order make sure that the return_url will work properly, please contact your account manager or Praxis technical support representative to enable Post Deposit Redirect URL for your frontends.


{danger.fa-exclamation-triangle} IMPORTANT #2: If you are using the Shopping Cart Interface SCI, please ask your account manager or technical support representative to enable SCI for your frontends.

REQUEST PARAMETERS

Variable Type Description
signature varchar(50) Required. sha256-encoded representation of the concatenation of request parameters and secret
frontend varchar(256) Required. Cashier FrontEnd name, normally it is a common name of the website. Linked to a specific base currency.
locale varchar(5) Required. User locale. For ex.: en-GB
payment_method varchar(10) Optional. For ShopPing Cart. Payment method that will be used for processing
order_id varchar(50) Optional. For ShopPing Cart. Order id in your system
amount varchar(10) Optional. For ShopPing Cart. Order amount
currency varchar(10) Required. Customer currency
pin varchar(50) Required. Unique customer id in your system
password varchar(256) Required. Password (See Customer Authentication)
requester_ip varchar(10) Optional. Customer's IP address
first_name varchar(25) Required. Customer's first name
last_name varchar(25) Required. Customer's last name
dob date Optional. Date of birth of the customer. MM/DD/YYYY format accepted.
email varchar(50) Required. Customer's email
address varchar(50) Optional. Customer's address
city varchar(50) Optional. City of the customer
country varchar(2) Required. ISO 3166-1 alpha-2 (US, MT, IT, GB, DE etc)
state varchar(2) State/Province where the customer resides. Only for US, CA and AU. 2 characters ISO format. Otherwise leave blank.
zip varchar(12) Required. Postal Code of the customer. Only required for US and CA. Can provide values for other countries. Limited to 12 alphanumeric characters only.
phone int(20) Optional. Numeric only, includes country area code. Should not be a dummy sequence like 123456 or 111111, should be at least 6 digits long.
return_url varchar(50) Required. User will be redirected to a specified URL after successful deposit (except cases when there is another rule defined with higher priority)
notification_url varchar(50) Optional. URL to which the deposit status notification will be sent
timestamp int(9) Required. Request time. URL will be active during 3 min after this time

RESPONSE PARAMETERS

Variable Type Description
status int Required.
- 0 if the request was successful
- Negative integer if internal server/network error occurs
- Positive integer if application/logical error occurs
description varchar(75) Required. Accurate description of the result. Return the actual error for any exception as it helps to diagnose issues in production
version varchar(3) Required. Request version
signature varchar(3) Required. sha256 HASH code of response (like in request)
redirect_url varchar(75) Required. Cashier Autologin URL. When redirected to this URL, the customer will be navigated further to the Cashier deposit page
auth_token varchar(75) Required. Special token that allows the customer to login during 15 min

EXAMPLE

Request

curl -X POST \ https://gateway.praxispay.com/client/init-pay-in \
-H 'Content-Type: application/json' \
-d '{
      "signature": "5b49e301ac15111d66795b5bdef4a0e6a1cdbe2464dcefffd6be5a39be0ccfff",
      "frontend": "Praxis TEST USD",
      "locale": "en-GB",
      "payment_method": "IDEAL",
      "order_id": "fxodWAQVvc9SRxhDaWSJJC21f",
      "amount": 25,
      "currency": "USD",
      "pin": "123",
      "password": "2838023a778dfaecdc212708f721b788",
      "requester_ip": "216.111.222.123",
      "first_name": "Tom",
      "last_name": "Doe",
      "dob": "1981-09-05",
      "email": "[email protected]",
      "address": "Green Street, 1",
      "city": "London",
      "country": "GB",
      "zip": "01234",
      "phone": "6712332112",
      "return_url": "https://merchant.com/payment_result/fxodWAQVvc9SRxhDaWSJJC21f",
      "notification_url": "https://mail.merchant.com/v1/deposits/fxodWAQVvc9SRxhDaWSJJC21f",
      "timestamp": 1557154161
    }'

Response (OK)

{
    "status":0,
    "description":"Success",
    "redirect_url":"https://compute.praxispay.com/autologin-form/eb2a7a96b3d5ff60c961062c6bedddb8",
    "auth_token":"eb2a7a96b3d5ff60c961062c6bedddb8",
    "version":"1.0",
    "signature":"5ce398fc3875667297067b8cf856c65146bb1308ca6294af9d6b6b10734f35d0"
} 

Response (ERR)

{
    "status": 1,
    "description": "Timestamp expired",
    "version": "1.0",
    "signature": "fe7adcf3adcb7d1e4127c53b79454911224164561f053a5291b20f881f95547c"
}

HOW TO GENERATE A SIGNATURE

Please refer to How to Build Signature for details on signing the request.

You are currently viewing version 3.0 Latest version here