Praxis Wiki logo

Agent API | {payout-cancel}


Cancel Payout can be used to cancel the payout request, that was originally submitted by the customer within the Cashier. Reject Payout is the API analogue of the payout rejection routine within Backoffice.

ENDPOINTS

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

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
timestamp int(11) Required. Request time. URL will be active during 1 min after this time
version varchar(10) 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-cancel \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
    "frontend":"Integration TEST USD",
    "merchant_id":"Test-Integration-Merchant",
    "timestamp":1568763244,
    "trace_id":752856,
    "version":"1.1",
    "signature":"d055969f7069799fd0efec97a731b230396ce16f9a40a3dbe2f2b814948ba3d871d4ca021b986c18bf23a05377b24f2f"
}'

Response (OK)

{
    "description": "Transaction canceled successfully: ExtPayoutID=752856",
    "status": 0,
    "version": "1.1",
    "signature": "7fe49a061cec8d0ff01fe422d6ce1209a13523b75249f312d6e759bad4e6ddbd4514df79571d08ffd0636d2b9ac4b319"
}

Response (ERR)

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

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