Presentation logo

Agent API | {payout-complete}


Complete Payout can be used for automatic processing of the payout request, that was originally submitted by the customer within the Cashier. 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.

ENDPOINTS

Name URL
Sandbox https://gateway-test.praxispay.com/api/payout-complete
Live https://gateway.praxispay.com/api/payout-complete

REQUEST PARAMETERS

Variable Type Description
merchant_id varchar(50) Required. Merchant API client account identifier
trace_id int(11) Required. Transaction identifier at Praxis that is previously sent to CRM within requested payout notification.
frontend varchar(50) 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. Request time. URL will be active during 1 min after this time
version varchar(3) Required. API version
signature varchar(96) Required. Required. sha256-encoded representation of the concatenation of request parameters and secret

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. API version
signature varchar(96) Required. sha384 HASH code of response (same as in request)

EXAMPLE

Request

For example below: Merchant Secret = "MerchantSecretKey"

curl -X POST \
https://gateway.praxispay.com/api/payout-complete \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
    "frontend":"Integration TEST USD",
    "merchant_id":"Test-Integration-Merchant",
    "pp":"TestPP",
    "timestamp":1568763275,
    "trace_id":752856,
    "version":"1.1",
    "signature":"aba72bdaa1f41fcd4a500209aa60fad4d0443927f61b3714482e761929ade7887411db9b974ad59356c23e2325675907"
}'

Response (OK)

{
    "description": "Transaction complete: trace_id=752856",
    "status": 0,
    "version": "1.1",
    "signature": "b5f02263511a8689814c9b4f0f740ad3863f91514cd13ce6136c3aeff4d0792c9aefbfa5e7982a3da40e0722c7a4bf3e"
}

Response (ERR)

{
    "description": "Transaction not found: trace_id=752856",
    "status": 1,
    "version": "1.1",
    "signature": "c9885a088a69d5eb2828c49564456e2b6f483a6e8b2969a56996a759d142fdbaec463c405c90fa5a6ee252de74177b93"
}

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