Praxis Wiki logo

Earlier Integrations |AuthorizedDeposit DeprecatedDEPOSIT


This method is invoked from the Cashier when the deposit transaction has been authorized by the acquirer, meaning that the funds have been frozen on the credit card but the additional capture step is required in order to send the amount to merchant's account.

Your server response will not affect the operation, but rather sending a valid response is required in order to know that the CRM will reflect the transaction as well as the need to do the checkout.

{danger.fa-exclamation} IMPORTANT #1: This notification is only specific to payment card processors that support authorization and capture as two separate steps (the standard approach is a combined sale action).


{danger.fa-exclamation} IMPORTANT #2: Even if the PSP supports the authorize and capture steps, you should contact the Praxis support representative to confirm that the two-step processing is enabled for your channel within Praxis Backoffice.

REQUEST PARAMETERS

Variable Type Description
PIN varchar(50) Required. Unique customer id in your system
SiteID int Optional. Only used to identify a brand or company the customer belongs to.
FrontEndName varchar(256) Required. Cashier front end name, normally common name of the website. Linked to a specific base currency.
TraceID int Required. Cashier’s unique transaction id
PP varchar(64) Required. Payment processor selected by Customer. In case of credit cards, the actual payment processor that will be used is unknown, so the generic name of “CreditCard” can be passed or the actual card brand (i.e. VISA, MasterCard etc.)
Amount money or int Required. Amount the customer intents to deposit. Currency can be assumed to be that of the Front End or can also be passed as an optional variable.
Currency char(3) Recommended. Currency sometimes can be inferred from customer’s base currency in your system or from the Cashier’s FrontEnd base currency.
CreatedBy varchar(50) Recommended. If you need to distinguish a transaction was made by the customer via the Cashier or by a customer service representative via the Cashier’s Backoffice.
Password varchar(256) Optional. Equals the Password provided in the autologin form and sent back later in AuthCust. Exists only for the Cashier deposits, not included for MOTO
SCOrderID varchar(50) Optional. Equals the SCOrderID provided in the autologin form. Exists only for the Cashier deposits, not included for MOTO

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

EXAMPLE

Request

curl -X POST \ https://your.api.host/AuthorizedDeposit \
-H 'Content-Type: application/json' \
-d '{"SiteID":170,
    "FrontEndName":"TEST EUR", 
    "PIN":"7",
    "TraceID":"751255", 
    "CreatedBy":"INTERNET", 
    "Amount":1,
    "Currency":"EUR", 
    "PP":"PraxisCC22_SC"}'    

Response (OK)

{"Status":0, "Description":"authorized deposit registered"}

Response (ERR)

{"Status":404, "Description":"Not found"}

You are currently viewing version 3.1 Latest version here