Praxis Wiki logo

API Notifications |CompletePayout Recommended


Complete Payout can be used for automatic processing of the customer’s payout request. Complete Payout is the API analogue of the payout authorization and processing routine within Backoffice.

{danger.fa-exclamation} IMPORTANT: The payout processor options depend on the payment method chosen by the customer, and on the payment processors configured in Backoffice for your frontend. Please contact the Praxis tech support in order to get the available payout processor options.

Please contact your account manager or technical support representative in order to confirm the following merchant acccount settings.

Item Purpose
Cashier API v1.0 Required for Cashier API to be allowed your CRM.
User Login and User Pass Required. The user credentials will be provided by the Praxis Technical Support representative.
WSPassCode Required. Used to build a signature. Will be provided by the Praxis Technical Support representative.
Frontend Name Required. Will be provided by the Praxis Technical Support representative.

REQUEST PARAMETERS

Variable Type Description
extpayoutid varchar(50) Required. Payout request identifier (received in CreatePayout response)
frontend varchar(256) Required. Frontend in which the payout has been requested and will be processed
pp varchar(50) Required. Processor name to be used for processing (available options can be seen at BO in a dropdown list of processors. given during the final step - payout processing form submission)
timestamp int(11) Required. Current timestamp
version varchar(10) Required. Script version
signature varchar(64) Required. Hash of the request parameters

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
version varchar(10) Required. Script version

EXAMPLE

Request

curl -X POST \
  curl -X POST \
    https://gateway-test.praxispay.com/api/completepayout \
    -H 'Accept: */*' \
    -H 'Authorization: Basic cHJheGlzX3Rlc3RfdXNlcjpSQkxEJCpLa2l8LCU=' \
    -H 'Content-Type: application/json' \
    -H 'Host: gateway-test.praxispay.com' \
    -d '{"ext_payout_id":331311,
    "frontend":"Integration TEST USD",
    "pp":"CCPayout",
    "timestamp":"1562234094",
    "version":"1.0",
    "signature":"a468b106fdc4e6241402fff19fb8b51f"}'

Response (OK)

{
    "description": "Transaction complete: ExtPayoutID=752856",
    "status": 0,
    "version": "1.0"
}

Response (ERR)

{
    "description": "Transaction not found: ExtPayoutID=752856",
    "status": 1,
    "version": "1.0"
}

Please refer to How to Build Signature for details on signing the request.

You are currently viewing version 3.0 Latest version here