Presentation logo

RecordFailedDeposit DeprecatedDEPOSIT


Your platform can be notified upon the failure of a customer to complete a successful deposit transaction. This is called when the deposit transaction reaches a final Approval state of “N” or “E”. We can pass some details about the transaction that failed including error codes and error messages.

Your platform should return an acknowledgement-response so our Cashier can log events where your system could not accept or process the calls. Our system will detect and prevent calling your system multiple times for the same transaction.

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.
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.
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.)
PaymentMethod varchar(32) Optional. Specific payment method within the processor
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.
TransactionID varchar(50) Recommended. If you need to store the external payment processor’s transaction id. Useful for reconciliation purposes and troubleshooting.
errorCode varchar(15) Optional. Processor API error code int or alpha-numeric
errorDesc varchar(250) Required. The processor’s decline reason.
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
CascadeLevel int Optional. Identifier to see whether the transaction is an original attempt (CascadeLevel=0) or re-attempt via cascade (CascadeLevel>=1)
PSPCurrency varchar(3) Optional. Currency from the PSP
PSPAmount money or int Optional. Amount from the PSP
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.
EditedBy varchar(50) Recommended. If you need to distinguish a transaction was edited by the customer via the Cashier or by a customer service representative via the Cashier’s Backoffice.

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

Response (OK)

{"Status":0, "Description":"Failed deposit success"}

Response (ERR)

{"Status":2, "Description":"User not found"}