Cashier API {cashier}

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

The section explains how to interact with API.

In some cases the customer activity within the Cashier requires the agent's interaction: payout request approval, finalizing (capture) of the authorized deposit transaction, etc.

Often it is critical for the business flow to interact with the customer in time, whereas it is not always possible for the agent to react instantly. For that purpose the CRM can call API functions in order to follow the same steps as the agent would do, so you will know that a certain action is taken instantly upon the customer's activity, with all the regulatory considerations.

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

Cashier session allows the customer to access the Cashier UI - an interface where the customer may choose one of the payment methods, offered according to the merchant's visibility rules, limits and priorities.

{danger.fa-exclamation-triangle} IMPORTANT #2: It is crutial to perform the redirect from a browser by following the redirect link or in the iframe, thus the browser adds the needed headers with Origin/Refer need for our system to compare the request with the list of allowed domains for an application.

Upon sending the request to Cashier API, you receive json response that contains redirect_url parameter. The redirect_url parameter is a link that will automatically perform the customer login to Cashier.

This redirect_url value should be set as src attribute of an iframe within the payment page at the merchant website.

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

In case the merchant wants to open iframe and not in a new window or full page, below might be useful for you:

• Min dimensions for desktop to display Cashier Frame without scroll. Width static, height - dynamic (add fields differ).

• Example below was taken for Deposit CC PM (due to static add fields setup)

  • Dark: 922 х 643

  • Mosaic: 710 x 727

  • Panoramic: 800 x 725

  • Table: 620 x 920

  • Tiles: 620 x 810

  • PowerSlide: 600 x 800

The display of elements inside the frame is adaptive