Praxis Wiki logo

API Notifications |UpdatePayoutRequiredPAYOUT


This method is invoked when an existing payout transaction changes status. As the payout transaction can progress and move to different statuses in the Cashier, this web method can alert your Platform for each of those status changes, or only the status changes you are interested in receiving. See Payout Management for more considerations of this method. You must also consider that when a payout is rejected or cancelled, and the customer’s balance was already debited, that your system must release the funds back to 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
ExtPayoutID varchar(50) Required. Unique transaction id in your Platform
Status char(1) Required. Cashier’s new transaction status
PP varchar(64) Recommended. Payment processor
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.
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.

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 (Canceled)

curl -X POST \ https://your.api.host/CreatePayout \
-H 'Content-Type: application/json' \
-d '{"SiteID":170,
    "FrontEndName":"TEST EUR", 
    "PIN":"7",
    "TraceID":"751254", 
    "PP":"BankWire", 
    "Status":"C", 
    "ExtPayoutID":"1526773664", 
    "UpdatedBy":"Backoffice_User", 
    "Amount":1,
    "Currency":"EUR"}'

Request (Authorized)

curl -X POST \ https://your.api.host/CreatePayout \
-H 'Content-Type: application/json' \
-d '{"SiteID":170,
    "FrontEndName":"TEST EUR", 
    "PIN":"7",
    "TraceID":"751254", 
    "PP":"BankWire", 
    "Status":"A", 
    "ExtPayoutID":"1526773664", 
    "UpdatedBy":"Backoffice_User", 
    "Amount":1,
    "Currency":"EUR"}'

Request (In_Progress)

curl -X POST \ https://your.api.host/CreatePayout \
-H 'Content-Type: application/json' \
-d '{"SiteID":170,
    "FrontEndName":"TEST EUR", 
    "PIN":"7",
    "TraceID":"751254", 
    "PP":"BankWire", 
    "Status":"P", 
    "ExtPayoutID":"1526773664", 
    "UpdatedBy":"Backoffice_User", 
    "Amount":1,
    "Currency":"EUR"}'

Request (Approved)

curl -X POST \ https://your.api.host/CreatePayout \
-H 'Content-Type: application/json' \
-d '{"SiteID":170,
    "FrontEndName":"TEST EUR", 
    "PIN":"7",
    "TraceID":"751254", 
    "PP":"BankWire", 
    "Status":"Y", 
    "ExtPayoutID":"1526773664", 
    "UpdatedBy":"Backoffice_User", 
    "Amount":1,
    "Currency":"EUR"}'

Request (Rejected)

curl -X POST \ https://your.api.host/CreatePayout \
-H 'Content-Type: application/json' \
-d '{"SiteID":170,
    "FrontEndName":"TEST EUR", 
    "PIN":"7",
    "TraceID":"751254", 
    "PP":"BankWire", 
    "Status":"J", 
    "ExtPayoutID":"1526773664", 
    "UpdatedBy":"Backoffice_User", 
    "Amount":1,
    "Currency":"EUR"}'

Response (OK)

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

Response (ERR)

{"Status":4, "Description":"Update payout request failed"}

You are currently viewing version 3.0 Latest version here