Presentation logo

PrevalidateDeposit DeprecatedDEPOSIT


This method is invoked from the Cashier when the customer attempts a deposit, but before the transaction is routed to the payment processor. If your business requires conducting specific checks before a customer is allowed to make a deposit, for example if your company needs to review if there are pending actions or restrictions on a customer account, or when you need to comply with a regulation and set specific limits to a customer; then you can centralize those checks in this routine.

Your service will respond if the customer is allowed to attempt a deposit based on the chosen amount and payment method. In case the customer is not allowed, the Cashier can optionally display the error description from your platform to the customer.

REQUEST PARAMETERS

Variable Type Description
PIN varchar(50) Required. Unique customer id in your system
SiteID int Optional. Only used if you need to identify a brand or company to which this customer belongs.
FrontEndName varchar(256) Required. Cashier front end name, normally common name of the website. Linked to a specific base currency.
PP varchar(64) Required. Payment processor the customer selected. In the 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.
CascadeLevel int Optional. Identifier to see whether the transaction is an original attempt (CascadeLevel=0) or re-attempt via cascade (CascadeLevel>=1)
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/PrevalidateDeposit \
-H 'Content-Type: application/json' \
-d '{"SiteID":170,
    "FrontEndName":"TEST EUR", 
    "PIN":"7",
    "CreatedBy":"Backoffice_User", 
    "Amount":1,
    "Currency":"EUR", 
    "PP":"CreditCard"}'    

Response (OK)

{"status":0, "description":"Prevalidate success"}

Response (ERR)

{"status":4, "description":" Customer has a pending bonus promotion"}