Praxis Wiki logo

API Notifications |ReverseDeposit RecommendedDEPOSIT


This method is invoked to correct an issue when a deposit was erroneously recorded to a customer’s account. Since we would not delete an incorrect transaction, we need to make sure a corresponding adjustment is made to nullify the effects of the original deposit while ensuring a transaction record exists to explain what happened. The typical example is entering a manual transaction via the Backoffice for the wrong amount or for the wrong 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.
TraceID int Required. Cashier’s unique transaction id
PP varchar(64) Recommended. Payment processor
Amount money or int Recommended. Amount of original deposit
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.
RefTraceID int Recommended. The reference to the original TraceID that is being reversed in the Cashier.

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/ReverseDeposit \
-H 'Content-Type: application/json' \
-d '{"SiteID":170,
    "FrontEndName":"TEST EUR", 
    "PIN":"7", 
    "TraceID":"751256", 
    "TransactionID":"1526773664",
    "PP":"CreditCard", 
    "Amount":1,
    "Currency":"AUD", 
    "RefTraceID":751001}'    

Response (OK)

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

Response (ERR)

{"Status":5, "Description":"Wrong currency"}

You are currently viewing version 3.0 Latest version here