Presentation logo

Virtual Terminal | Customer Sync


Customer Sync is the mechanism that allows the agent to manage the customers, their deposits and payouts within Praxis Virtual Terminal.

When the agent attempts to access the virtual terminal for customer, Praxis Backoffice will attempt to retrieve the customer details from CRM. In order to have the retrieval working, the CRM will need to implement the API callback that will be available to receive the request from Praxis and respond with the custome details.

{danger.fa-exclamation-triangle} IMPORTANT: Please make sure that you have provided the callback URL to Praxis technical support representative before you attempt to use Virtual Terminal.

REQUEST PARAMETERS

Variable Type Description
signature varchar(96) Required. Request signature. Please refer to How to Build Signature for details on signing the request.
merchant_id varchar(50) Required. Merchant API client account identifier
frontend varchar(256) Required. Cashier FrontEnd name, normally it is a common name of the website. Linked to a specific base currency.
pin varchar(50) Required. Unique customer id in your system
timestamp int(11) Required. Request time. URL will be active during 1 min after this time
version varchar(3) Required. API version

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(256) Required. Accurate description of the result. Return the actual error for any exception as it helps to diagnose issues in production
signature varchar(96) Required. sha384 HASH code of response (same as in request)
frontend varchar(256) Required. Cashier FrontEnd name, normally it is a common name of the website. Linked to a specific base currency.
currency varchar(10) Required. Customer currency
pin varchar(50) Required. Unique customer id in your system
balance int(20) Required. Customer's current available balance.
Please note: for certain currencies (JPY, CLP, KRW, VND) the amount is sent in yen, this is important if you multiply by 100 to send the amount in cents
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(1) 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.
manual_validation_url varchar(50) Required. URL to which the manual deposit validation request will be sent. Please refer to Validation for more details.
manual_notification_url varchar(50) Required. URL to which the manual deposit status notification will be sent. Please refer to Notification for more details.
timestamp int(11) Required. Request time. URL will be active during 1 min after this time
version varchar(3) Required. API version

EXAMPLE

Request

curl -X POST \ https://api.merchant.com/v1/sync/ \
-H 'Content-Type: application/json' \
-d '{
    "frontend":"Praxis TEST USD",
    "merchant_id":"Test-Integration-Merchant",
    "pin":"123",
    "timestamp":1561206408,
    "version":"1.1",
    "signature":"01df06c501fe74ddede3c3dafe3f2cbfce3c19c2c213962017a7e83321f392e03eb55e0753a4a23b4405980bdbb3c962"
}'

Response (OK)

{
    "address":"Themes ST",
    "balance":32500,
    "city":"Sydney",
    "country":"AU",
    "currency":"EUR",
    "description":"OK",
    "dob":"1986/04/05",
    "email":"[email protected]",
    "first_name":"eur",
    "frontend":"Praxis TEST USD",
    "last_name":"eur",
    "manual_notification_url":"https://api.merchant.com/v1/deposits/fxodWAQVvc9SRxhDaWSJJC21f",
    "manual_validation_url":"https://api.merchant.com/v1/validate_deposits/fxodWAQVvc9SRxhDaWSJJC21f",
    "phone":"6721467841",
    "pin":"7",
    "state":"NSW",
    "status":0,
    "timestamp":1561279426,
    "version":"1.1",
    "zip":"0123",
    "signature":"faada41d13d832983aec1d23ddcf175fe6513e094cd29b6a3c51b4d29856cedf0eda91d3c872c9578a3613210069a86f"
}

Response (ERR)

{
    "description":"Customer not found",
    "status":1,
    "timestamp":1561207146,
    "version":"1.1",
    "signature":"3084adb6dcd68cd83acf8fca66cd0436df197d9d14721ea814e34b92b2ab9b81c900f9631b94506c9133fd56cdb6cd6d"
}