Praxis Wiki logo

Cashier API | Notification


Notification request is sent upon Cashier login (see InitPayIn, InitCheckout, InitPayOut, InitPayOutOrder) when the customer has submitted the deposit and payout request form, your CRM confirmed the submission and the transaction status has changed during the actual proecssing.

{danger.fa-exclamation} IMPORTANT #1: In case if your API response contains "status":-1 or responds in unrecognized format, the notification will be resent automatically within approximately 5 minutes.

REQUEST PARAMETERS

Variable Type Description
transaction_type varchar(8) Required. Transaction type. Allowed values are:
sale (deposit)
payout (withdrawal)
refund (return deposit funds)
transaction_status varchar(16) Required.

Deposit
- pending - processing initiated, final response expected from PSP
- authorized - transaction authorized, capture is expected
- approved - processing was successful
- declined - processing failed
- chargeback - customer requested to get funds back
- reversed - refund done at PSP side

Payout
- requested - merchant action/approval expected
- authorized - transaction authorized by manager, manual processing is expected
- in progress - processing at PSP side
- approved - processing was successful
- rejected - processing cancelled by the merchant or client
- reversed - refund done at PSP side

transaction_id varchar(50) Optional. PSP transaction identifier
trace_id int(11) Required. Praxis transaction identifier
order_id varchar(50) sale - Optional. Transaction identifier in your system
payout - Required. Transaction identifier in your system
frontend varchar(50) Required. Cashier FrontEnd name, normally it is a common name of the website. Linked to a specific base currency.
pin varchar(50) Required. Unique customer id in your system
amount int(20) Required. Processed amount in cents.
Please note: for certain currencies (JPY, CLP, KRW, VND, BHD, IQD, JOD, LYD, OMR, TND) the amount is sent as-in without being converted to cents, this is important if you multiply by 100 to send the amount in cents
currency varchar(10) Required. Payment currency
payment_method varchar(50) Required. Payment method
payment_processor varchar(50) Required. Payment processor
created_by varchar(50) Optional. Transaction was created by
auth_token varchar(75) Optional. Auth token provided upon Cashier session init call
merchant_id varchar(50) Required. Merchant API client account identifier
card_number varchar(16) Optional. Customer card number (4444 **** **** 1233)
card_type varchar(10) Optional. Customer card type (VISA, MC)
card_exp varchar(8) Optional. Customer card exp (10/2023)
account_identifier varchar(256) Optional. CRM account identifier
cascade_level int(2) Optional. Transaction retry number
is_cascade int(1) Optional. Is this transaction goes through cascade
error_code int(10) Optional. Error code for rejected transactions
error_details varchar(256) Optional. Error description for rejected transactions
reference_id varchar(256) Optional. ID of transaction to reverse
version varchar(3) Required. API version
timestamp int(11) Required. Request time. URL will be active during 1 min after this time
signature varchar(96) Required. Request signature. Please refer to How to Build Signature for details on signing the request.

RESPONSE PARAMETERS

Variable Type Description
status int Required.
- 0 if the request was successful
- Negative integer if internal server/network error occurs
- Positive integer if application/logical error occurs
description varchar(256) Required. Accurate description of the result. Return the actual error for any exception as it helps to diagnose issues in production
signature varchar(96) Required. Hash of the response parameters

EXAMPLE

For example below: Merchant Secret = "MerchantSecretKey"

Request

curl -X POST \ https://merchant-site.com/praxis/notification \
-H 'Content-Type: application/json' \
-d '{
        "account_identifier":null,
        "amount":2500,
        "auth_token":"a60927468a5b32afe31468d780c57a32",
        "card_exp":"12/2024",
        "card_number":"411111******1111",
        "card_type":"VISA",
        "cascade_level":null,
        "created_by":"INTERNET",
        "currency":"EUR",
        "edited_by":"INTERNET",
        "error_code":null,
        "error_details":null,
        "frontend":"Praxis TEST USD",
        "merchant_id":"Test-Integration-Merchant",
        "order_id":null,
        "payment_method":null,
        "payment_processor":"TestPP",
        "pin":"7",
        "reference_id":null,
        "timestamp":1560932656,
        "trace_id":"756850",
        "transaction_id":"13348",
        "transaction_status":"approved",
        "transaction_type":"sale",
        "version":"1.1",
        "signature":"f996897731ed4704c073c58c500005af2c9993082ca026feedaff2f81d4bfb1f686e5521881a9d6b0f53d4a3052e63fc"
    }'    

Response (OK)

{
    "description":"Success",
    "status":0,
    "timestamp":1560861455,
    "version":"1.1",
    "signature":"449769a52977210706273133ff9dfb3709c6e2ad25980376d60820bc27b85d9a1df6a14e3bc4e42478851f26c07f8511"
}

Response (ERR)

{
    "description":"Deposit count exceeded",
    "status":1,
    "timestamp":1560861512,
    "version":"1.1",
    "signature":"5c96de757c0fa0ac6702d3860d878e140d0fdbceebcae73513d40aca297859d31d6cf62d0882403afedf00a778eb83f4"
}

You are currently viewing version 3.1 Latest version here