Cashier API {cashier}

• ENDPOINTS
• CHECKLIST
• REQUEST PARAMETERS
• RESPONSE PARAMETERS
• SIGNATURE
• EXAMPLE
• VISIBILITY

This section explains how to interact with Cashier API.

In some cases, customer activity within the Cashier requires an agent’s interaction — such as payout request approval, finalizing (capturing) an authorized deposit transaction, and other things.

Often, it is critical for business operations to respond to customer actions in real-time. However, it may not always be possible for an agent to react instantly.
To address this, the CRM system can call Cashier API functions to perform the same actions an agent would normally take. This ensures that necessary actions are executed instantly upon customer activity, while still complying with regulatory requirements.

{danger.fa-exclamation-triangle} IMPORTANT 1:
The validation callback will only be triggered if the validation_url is provided in the Cashier session request.

The Cashier session enables the customer to access the Cashier UI — an interface that presents the available payment methods, based on the merchant’s visibility rules, limits, and priorities.

{danger.fa-exclamation-triangle} IMPORTANT 2:
It is crucial that the redirect to the Cashier is performed from a browser, either by following the redirect link or embedding it in an iframe. This ensures the browser includes required headers such as Origin and Referer, which our system uses to validate the request against the list of allowed domains for the application.

When you send a request to the Cashier API, you will receive a JSON response containing the redirect_url parameter.

This redirect_url should be used as the src attribute of an iframe on your payment page within the merchant’s website. It will automatically authenticate the customer and display the Cashier interface.

ENDPOINTS

Request Parameters

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

Response Parameters

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
6. order_id

Response signature parameters

1. status
2. timestamp
3. redirect_url
4. customer.customer_token

Example

{
    "merchant_id": "Test-Integration-Merchant",
    "application_key": "Sandbox",
    "intent": "payment",
    "currency": "USD",
    "amount": 100,
    "cid": "1",
    "locale": "en-GB",
    "customer_token": null,
    "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"
    },
    "payment_method": null,
    "gateway": null,
    "validation_url": null,
    "notification_url": "https:\/\/api.merchant.com\/v1\/deposits\/tx-1560610955",
    "return_url": "https:\/\/merchant.com\/payment_result\/tx-1560610955",
    "order_id": "test-1560610955",
    "variable1": "your variable",
    "variable2": "if that is not enough, you can pass even one more variable",
    "variable3": null,
    "version": "1.3",
    "timestamp": 1590611635
}

{
    "status": 0,
    "description": "Ok",
    "redirect_url": "https:\/\/compute.praxispay.com\/login\/8a7sd87a8sd778ac961062c6bedddb8",
    "customer": {
        "customer_token": "87cfb23a8f1e68e162c276b754d9c061",
        "country": "GB",
        "first_name": "John",
        "last_name": "Johnson",
        "avs_alert": 0,
        "verification_alert": 0
    },
    "session": {
        "auth_token": "8a7sd87a8sd778ac961062c6bedddb8",
        "intent": "payment",
        "session_status": "created",
        "order_id": "test-1560610955",
        "currency": "EUR",
        "amount": 100,
        "conversion_rate": 1.000000,
        "processed_currency": "EUR",
        "processed_amount": 100,
        "payment_method": "WireOnline",
        "gateway": null,
        "cid": "1",
        "variable1": "your variable",
        "variable2": "if that is not enough, you can pass even one more variable",
        "variable3": null
    },
    "version": "1.3",
    "timestamp": 1590611635
}

Visibility

If the merchant prefers to open the Cashier in an iframe instead of a new window or full-page view, the following information may be helpful:

• Minimum dimensions (in pixels) for desktop to display the Cashier frame without scrollbars:

  • Width is static
  • Height is dynamic (may vary based on additional fields)

• The examples below are based on the Deposit Credit Card payment method (which includes a fixed set of additional fields):

  • Dark: 922 × 643
  • Mosaic: 710 × 727
  • Panoramic: 800 × 725
  • Table: 620 × 920
  • Tiles: 620 × 810
  • PowerSlide: 600 × 800

The display of elements inside the frame is fully adaptive.