Presentation logo

Earlier Integrations |ReversePayout DeprecatedPAYOUT


This method is invoked to correct an issue when a payout failed to reach the customer either due to a technical issue or payment issue. Since we cannot delete a payout transaction, we need to make sure a corresponding adjustment is made to nullify the effects of the original payout while ensuring a transaction record exists to explain what happened. You should consider both the Amount and the Fee that was charged to the customer for their payout as part of the reversal.

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 Optional. Cashier’s unique transaction id
PP varchar(64) Recommended. Payment processor
UpdatedBy varchar(50) Recommended. If you need to distinguish a transaction was updated by the customer via the Cashier or by a customer service representative via the Cashier’s Backoffice.
Amount money or int Recommended. Amount of original payout
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.
Fee money or int Optional. If you want the Cashier to provide the fee for processing the payout and pass it to your system. The fee can be changed during the payout process. See UpdatePayout.
ExtPayoutID varchar(50) Required. Unique transaction id in your Platform
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/ReversePayout \
-H 'Content-Type: application/json' \
-d '{"SiteID":170,
    "FrontEndName":"TEST EUR", 
    "PIN":"7", 
    "TraceID":"751254", 
    "RefTraceID":"751001",
    "ExtPayoutID":"1526773664", 
    "UpdatedBy":"Backoffice_User", 
    "Amount":1,
    "Currency":"EUR"}'

Response (OK)

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

Response (ERR)

{"Status":7, "Description":"Reverse payout failed"}