Open Hosted Payment Fields Session API {open-hpf-session}

---

• ENDPOINTS
• REQUEST PARAMETERS
• RESPONSE PARAMETERS
• SIGNATURE
• EXAMPLE

ENDPOINTS

Name	URL
Sandbox	https://pci-gw-test.praxispay.com/api/open-hpf-session
Live	https://gw.praxisgate.com/api/open-hpf-session

Request Parameters

✓ - required value
? - optional, value or null
✕ - always appears as null

Variable	Type		Description
merchant_id	varchar(50)	✓	Merchant API client account identifier
application_key	varchar(32)	✓	Identifier of your application (website)
domain	varchar	✓	Merchant domain where HPF is going to be included
intent	varchar(32)	✓	Action to be taken within the HPF. Allowed values are: - payment for payment transaction - withdrawal for withdrawal request
cid	varchar(50)	✓	Unique customer id in your system. Note: Personally Identifiable Information such as an e-mail address are strictly forbidden; if your user identifier contains such PII you must hash/encrypt it before sending it to Praxis.
locale	varchar(5)	✓	User locale. See locales reference for the full list of supported locales
customer_data	<Object>	✓	Customer data object
session_configuration	<Object>	?	The object will contain overriding configuration rules for this session attempt.
override_styles	tinyint(1)	✓	If custom styles will be applied through SDK methods. Allowed values are: - 1 styles will be applied - 0 styles will not be applied
version	varchar(3)	✓	API version
timestamp	int(11)	✓	Request time (unix timestamp, seconds)

Response Parameters

Variable	Type		Description
status	int(1)	✓	API communication status - 0 if the request was successful - Negative integer if internal server/network error occurs - Positive integer if application/logical error occurs
description	varchar(256)	✓	Accurate description of the result. Return the actual error for any exception as it helps to diagnose issues in production
session_token	varchar	✓	HPF Session authentication token
version	varchar(3)	✓	API version
timestamp	int(11)	✓	Response time (unix timestamp, seconds)

Signature

The full signature generation algorithm can be found in the Authentication section.

Request signature parameters

1. merchant_id
2. application_key
3. timestamp
4. intent
5. cid

Response signature parameters

1. status
2. timestamp
3. session_token

Example

Request

{
    "merchant_id": "Test-Integration-Merchant",
    "application_key": "Sandbox",
    "domain": "https://example.com",
    "intent": "payment",
    "cid": "1",
    "locale": "en-GB",
    "customer_data": {
        "country": "GB",
        "first_name": "John",
        "last_name": "Johnson",
        "dob": "12\/31\/1980",
        "email": "[email protected]",
        "phone": "44201112222",
        "zip": "WC2N 5DU",
        "state": "JS",
        "city": "London",
        "address": "Random st., 12\/3"
    },
    "override_styles": 1,
    "version": "1.3",
    "timestamp": 1590611635
}

Response

{
    "status": 0,
    "description": "Ok",
    "session_token": "ZXhhbXBsZSBzZXNzaW9uIHRva2Vu",
    "version": "1.3",
    "timestamp": 1590611635
}