Presentation logo

RecordChargeBack DeprecatedDEPOSIT


This method is invoked when a chargeback transaction is recorded in the Cashier. A chargeback is a disputed transaction that has been deducted from a merchant’s processing account. This can cover payment methods like CreditCards, ACH/ECheck (returns) and eWallets. If a customer’s balance is zero or lower than the chargeback amount, then you could arrive at a negative balance for 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.
TraceID int Optional. Cashier’s unique transaction id
PP varchar(64) Recommended. Payment processor
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.
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.
TransactionDate datetime Recommended. The date and time the chargeback was registered by the payment processor. This could be a date back in time. Recording a timestamp on your Platform of when this chargeback record was added to your system is encouraged.
TransactionID varchar(50) Recommended. If you need to store the external payment processor’s transaction id. Useful for reconciliation purposes and troubleshooting.

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", 
    "TransactionID":"1526773664",
    "CreatedBy":"Backoffice_User", 
    "PP":"BankWire", 
    "Amount":1,
    "Currency":"EUR"}'

Response (OK)

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

Response (ERR)

{"Status":1, "Description":"Chargeback failed"}