Praxis Wiki logo

API Methods PrevalidatePayout Recommended


This method is invoked from the Cashier when the customer attempts to request a withdrawal from their account. You can use this call to permit or deny the payout request from proceeding within the Cashier and have the Cashier display to the customer any requirements that need to be met before they can proceed.

This can help reduce the volume of payout requests and provide a clear explanation to customers on what to do next. Examples include if KYC documentation is pending, missing credit card authorization forms, payout velocity exceeded, payout amount exceeded and more.

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.
PP varchar(64) Recommended. Payment processor
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.

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/PrevalidatePayout \
-H 'Content-Type: application/json' \
-d '{"SiteID":170,
    "FrontEndName":"TEST EUR", 
    "PIN":"7",
    "PP":"BankWire", 
    "Amount":1, 
    "Currency":"EUR"}

Response (OK)

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

Response (ERR)

{"Status":4, "Description":"Customer has a pending bonus promotion"}

You are currently viewing version 2.24b Latest API version here