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.


Name URL


Variable Type Description
merchant_id varchar(50) Required. Merchant API client account identifier
trace_id int(11) Required. Transaction identifier at that is previously sent to CRM within requested payout notification.
application_key varchar(32) Required. Identifier of your application (website)
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. sha256-encoded representation of the concatenation of request parameters and secret


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 algorithm as request signature)



For example below: Merchant Secret = "MerchantSecretKey"

curl -X POST \ \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
    "application_key": "Sandbox",
    "merchant_id": "Test-Integration-Merchant",
    "timestamp": 1578879941,
    "trace_id": 752856,
    "version": "1.2",
    "signature": "68d044bf60b52684f0abe0a0d1e9050bf6a5472b0b33073c4aef744c2f527321b5a260462f338b0381d9eeef3eec7e0b"

Response (OK)

    "description": "Transaction canceled successfully: order_id=752856",
    "status": 0,
    "version": "1.2",
    "signature": "83f0ff712478792bc89f15647abb19b3c8d75c9e1575d87f70cb6b1e2e5d67c9da10e6b3a8953ddcd0ef8ff0f6f78d97"

Response (ERR)

    "description": "Transaction not found: order_id=752856",
    "status": 1,
    "version": "1.2",
    "signature": "e8b396f67bbcd4a5033368aa880b1df9edebee21918a94a908666c11a2e6987d3670adf44317b66f578c85f63456635e"

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

You are currently viewing version 3.4 Latest version here