Praxis Wiki logo

API Notifications |CreatePayout RequiredPAYOUT


This method is invoked when requesting a new withdraw transaction from either the Cashier or from the Backoffice. Your Platform can choose to debit the customer at this time or a later stage. See Payout Management section for more details.

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.
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.
IPAddress varchar(15) Optional. If you need to store the customer’s IP address
TransactionID varchar(50) Recommended. Unique transaction identifier or authorization code as provided from the payment processor. This value would be unknown at the time the payout is created, but is listed here to alert you it can be passed when the status changes to Approved Y. See UpdatePayout.
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.

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
ExtPayoutID varchar(50) Required. A numeric or string value that identifies the transaction in your system. This value can be used for subsequent calls that alter the status and details of the payout request.

EXAMPLE

Request

curl -X POST \ https://your.api.host/CreatePayout \
-H 'Content-Type: application/json' \
-d '{"SiteID":170,
    "FrontEndName":"TEST EUR", 
    "PIN":"7",
    "PP":"BankWire", 
    "TraceID":"751254", 
    "Amount":1, 
    "PP":"BankWire",
    "Fee":0, 
    "Currency":"EUR", 
    "CreatedBy":"INTERNET", 
    "IPAddress":"127.0.0.1"}'

Response (OK)

{"Status":0, "Description":"Create payout request success"}

Response (ERR)

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

You are currently viewing version 3.0 Latest version here