Praxis Wiki logo

Virtual Terminal vt-pay-out


vt-pay-out is the mechanism for a quick access to the cashier withdrawal section on behalf of the customer using REST API.

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.

This link should be embedded into iframe's src attribute

ENDPOINTS

Name URL
Sandbox https://gateway-test.praxispay.com/api/vt-pay-out
Live https://gateway.praxispay.com/api/vt-pay-out

CHECKLIST

Please contact your account manager or technical support representative in order to confirm the following merchant acccount settings.

Item Purpose
Cashier API v1.1 (or higher) Required for Cashier API to be allowed your CRM.
Dynamic Return URL Required. The URL that user will be redirected to after successful payment. For return_url there is a number of dynamic variables supported for this parameter.
Merchant ID and Merchant Secret Required. The merchant credentials will be provided by the Technical Support representative.
Customer Sync URL Required. Callback URL should be provided to Technical Support representative.

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
application_key varchar(32) Required. Identifier of your application (website)
agent_name varchar(50) Required. Name of the agent doing the VT login
payment_method varchar(50) Optional. This payment method will be opened by default and used for transaction processing. Note that the gateway variable has a higher priority, so if you have both of these variables - payment_method will be ignored
locale varchar(5) Optional. User locale. For ex.: en-GB (language_code-COUNTRY_CODE)
pin varchar(50) Required. Unique customer id in your system
requester_ip varchar(10) Optional. Customer's IP address
first_name varchar(25) Optional. Customer's first name
last_name varchar(25) Optional. Customer's last name
dob date Optional. Date of birth of the customer. MM/DD/YYYY format accepted.
email varchar(50) Optional. Customer's email
address varchar(50) Optional. Customer's address
city varchar(50) Optional. Customer's city
country varchar(2) Required. ISO 3166-1 alpha-2 (US, MT, IT, GB, DE etc)
currency varchar(10) Required. Customer currency
state varchar(3) Optional (Required for US, CA and AU). State/Province where the customer resides. 3 characters ISO format. Otherwise leave blank.
zip varchar(12) Optional. Customer's postal code. (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 9 digits long. Note that the phone variable can be declared as a required field on a PSP side
return_url varchar(256) Required. User will be redirected to a specified URL after successful deposit (except cases when there is another rule defined with higher priority)
validation_url varchar(256) Required. URL to which the deposit validation request will be sent. Please refer to Validation for more details.
notification_url varchar(256) Required. URL to which the 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
balance int(20) Optional. Current balance in cents.
Please note: for certain currencies (JPY, CLP, KRW, VND, BHD, IQD, JOD, LYD, OMR, TND) the amount is sent as-in without being converted to cents, this is important if you multiply by 100 to send the amount in cents
variable1 varchar(256) Optional. Your custom field which will consist some necessary information
variable2 varchar(256) Optional. Your custom field which will consist some necessary information
gateway varchar(32) Optional. HASH value of gateway that should processed transaction

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. API version
signature varchar(96) Required. sha384 HASH code of response (same as in request)
redirect_url varchar(256) 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

For example below: Merchant Secret = "MerchantSecretKey"

curl -X POST \ https://gateway-test.praxispay.com/api/vt-pay-out \
-H 'Content-Type: application/json' \
-d '{
    "address": "Green Street 1",
    "agent_name": "Compliance Shift 1",
    "application_key": "Sandbox",
    "city": "London",
    "country": "GB",
    "currency": "USD",
    "dob": "1981-09-05",
    "email": "[email protected]",
    "first_name": "Tom",
    "last_name": "Doe",
    "locale": "en-GB",
    "merchant_id": "Test-Integration-Merchant",
    "notification_url": "https:\/\/api.merchant.com\/v1\/payouts\/933399",
    "phone": "6712332112",
    "pin": "123",
    "requester_ip": "216.111.222.123",
    "return_url": "https:\/\/merchant.com\/payment_result\/933399",
    "timestamp": 1582325592,
    "validation_url": "https:\/\/api.merchant.com\/v1\/validate_deposits\/933399",
    "version": "1.2",
    "zip": "01234",
    "signature": "890816b1b394817254a20288e742484059c6f9944d83014a0c6ae12b318030d8fd3539caf8bf5577436d0cd979bf35aa"
}'

Response (OK)

{
    "auth_token": "eb2a7a96b3d5ff60c961062c6bedddb8",
    "description": "Success",
    "redirect_url": "https:\/\/compute.praxispay.com\/autologin-form\/eb2a7a96b3d5ff60c961062c6bedddb8",
    "status": 0,
    "version": "1.2",
    "signature": "ee501f0f7f7a93e4be879fb759ff68400f6202df58f88f80627d7da39cfb193e95a0a717a2e77016adf6f93c5da87522"
}

Response (ERR)

{
    "description": "Timestamp expired",
    "status": 1,
    "version": "1.2",
    "signature": "0f2538cb438bc3f173246f2fa80717e105a766575f880f940f9da8374b27ab092402023ac93d2f8d4e4042d6d8b927e6"
}