Praxis Wiki logo

API Notifications |ProcessDeposit RequiredDEPOSIT


This method is invoked after a successful deposit has occurred within the Cashier and the Platform needs to be notified in order to credit the customer’s balance. Your service will respond if the customer’s balance was successfully adjusted or not.

{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
PIN varchar(50) Required. Unique customer id in your system
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 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.
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.
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.
TransactionID varchar(50) Recommended. If you need to store the external payment processor’s transaction id. Useful for reconciliation purposes and troubleshooting.
PaymentMethod varchar(32) Optional. Specific payment method within the processor
PromoID varchar(50) Optional. If you need to honor a bonus/promotional code from the customer in the Cashier to apply some business rule in your Platform.
IPAddress varchar(15) Optional. if you need to store the customer’s IP address
Bonus money or int Optional. If you want the Cashier to calculate an automatic bonus amount and pass it to your system (not recommended)
Fee money or int Optional. If you want the Cashier to calculate and automatic fee for processing the deposit and pass it to your system (not recommended)
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
Udef1 varchar(50) Optional. Equals the Udef1 provided in the autologin form. Exists only for the Cashier deposits, not included for MOTO
Udef2 varchar(50) Optional. Equals the Udef2 provided in the autologin form. Exists only for the Cashier deposits, not included for MOTO
CardNumber varchar(50) Optional. Masked credit card number
CardExp varchar(10) Optional. Credit card expiry MM/YYYY
CardType varchar(32) Optional. Credit card type (VISA, MC, etc.)
AccountIdentifier varchar(50) Optional. E-wallet login or any other account ID if the deposit is made with e-wallet
PSPCurrency varchar(3) Optional. Currency from the PSP
PSPAmount money or int Optional. Amount from the PSP
PP_Init varchar(50) Optional. Payment processor chosen by user

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/ProcessDeposit \
-H 'Content-Type: application/json' \
-d '{"SiteID":170,
    "FrontEndName":"TEST EUR", 
    "PIN":"7",
    "TraceID":"751255", 
    "TransactionID":"1526773664", 
    "CreatedBy":" Backoffice_User", 
    "Amount":1,
    "Currency":"EUR", 
    "PP":"CreditCard", 
    "IPAddress":"127.0.0.1", 
    "Bonus":0,
    "Fee":0}'

Response (OK)

{"Status":0, "Description":"Deposit success"}

Response (ERR)

{"Status":3, "Description":"Wrong input data"}

You are currently viewing version 3.0 Latest version here