Init payment
We have implemented the Praxis-like API point, which is used for initiating new payments on Cashier side. Successful response will return you redirect link which you should follow up and be redirected to Cashier Hosted Payment Page
URL: {api_url}/cashier/cashier
HTTP Method: POST
Headers:
- Content-type:
application/json - Gt-Authentication: <calculated_hash>
Init Payment Request object parameters:
| Name | Type | Size/Format | Mandatory | Description |
|---|---|---|---|---|
merchant_id | string | 50 | true | Merchant ID provided by Cashier Technical Support team |
application_key | string | 50 | true | Application Key provided by Cashier Technical Support team |
intent | string | 50 | true | Only payment value is available, |
currency | string | 3 | true | Currency code https://en.wikipedia.org/wiki/ISO_4217 |
amount | int | 20 | false | Amount in minor units https://en.wikipedia.org/wiki/ISO_4217#Minor_unit_fractions |
cid | string | 50 | true | Unique customer ID in merchant system |
locale | string | 2 | true | User locale. https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes |
customer_data | Object | — | true | Please refer to Customer object |
notification_url | string | 256 | true | URL for deposit status notification |
return_url | string | 256 | true | Redirect URL after payment |
order_id | string | 50 | true | Transaction ID in merchant's system |
variable1 | string | 256 | false | Custom field 1 |
variable2 | string | 256 | false | Custom field 2 |
variable3 | string | 256 | false | Custom field 3 |
version | string | 3 | true | API version (1.3 should be used) |
timestamp | int | 11 | true | Unix timestamp (Epoch time): Number of seconds (or milliseconds) since January 1, 1970 (UTC). Example: 1716735600 |
Customer Object for Init payment request
| Name | Type | Size | Required | Description |
|---|---|---|---|---|
country | string | 2 | Yes | Country Code https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 |
first_name | string | 50 | Yes | Customer's first name |
last_name | string | 50 | Yes | Customer's last name |
dob | string | 100 | No | Date of birth (m/d/Y format) |
email | string | 50 | Yes | Customer's email address |
phone | string | 50 | Yes | Customer's phone number |
zip | string | 50 | No | ZIP or postal code |
state | string | 50 | No | State or province |
city | string | 100 | No | City |
address | string | 255 | No | Street address |
profile | int | 50 | No | Customer's profile value (e.g., level) |
Init Payment Response Object parameters:
| Name | Type | Mandatory | Description |
|---|---|---|---|
status | int | true | This field represents the status of API communication.
|
description | string | true | Provide a clear and detailed description of the results. In case of an exception, return the specific error message to aid in diagnosing issues during production |
version | string | true | 1.3 is the only value for now. |
timestamp | int | true | Unix timestamp (Epoch time): Number of seconds (or milliseconds) since January 1, 1970 (UTC). Example: 1716735600 |
redirect_url | string | true | Redirect URL which merchant side should follow to get to Cashier Payment Page |
customer | Object | true | Contains information about customer data used in payment initiation |
session | Object | true | Contains current payment session data |