Skip to main content

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:

NameTypeSize/FormatMandatoryDescription
merchant_idstring50trueMerchant ID provided by Cashier Technical Support team
application_keystring50trueApplication Key provided by Cashier Technical Support team
intentstring50trueOnly payment value is available,
currencystring3trueCurrency code https://en.wikipedia.org/wiki/ISO_4217
amountint20falseAmount in minor units https://en.wikipedia.org/wiki/ISO_4217#Minor_unit_fractions
cidstring50trueUnique customer ID in merchant system
localestring2trueUser locale. https://en.wikipedia.org/wiki/List_of_ISO_639_language_codes
customer_dataObjecttruePlease refer to Customer object
notification_urlstring256trueURL for deposit status notification
return_urlstring256trueRedirect URL after payment
order_idstring50trueTransaction ID in merchant's system
variable1string256falseCustom field 1
variable2string256falseCustom field 2
variable3string256falseCustom field 3
versionstring3trueAPI version (1.3 should be used)
timestampint11trueUnix timestamp (Epoch time): Number of seconds (or milliseconds) since January 1, 1970 (UTC). Example: 1716735600

Customer Object for Init payment request

NameTypeSizeRequiredDescription
countrystring2YesCountry Code https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
first_namestring50YesCustomer's first name
last_namestring50YesCustomer's last name
dobstring100NoDate of birth (m/d/Y format)
emailstring50YesCustomer's email address
phonestring50YesCustomer's phone number
zipstring50NoZIP or postal code
statestring50NoState or province
citystring100NoCity
addressstring255NoStreet address
profileint50NoCustomer's profile value (e.g., level)

Init Payment Response Object parameters:

NameTypeMandatoryDescription
statusinttrueThis field represents the status of API communication.
  • 0 - The request was successful.
  • All other values -Indicate internal server or network errors.
descriptionstringtrueProvide 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
versionstringtrue1.3 is the only value for now.
timestampinttrueUnix timestamp (Epoch time): Number of seconds (or milliseconds) since January 1, 1970 (UTC). Example: 1716735600
redirect_urlstringtrueRedirect URL which merchant side should follow to get to Cashier Payment Page
customerObjecttrueContains information about customer data used in payment initiation
sessionObjecttrueContains current payment session data