Agent API {deposit-cancel}
DepositCancel API function lets you cancel the authorization and release the customer's funds.
Authorize and following Capture/Cancel API methods can be used by the merchant for automated capture or cancel operations upon the authorized transaction notification
{danger.fa-exclamation} IMPORTANT #1: This notification is only specific to payment card processors that support authorization and capture as two separate steps (the standard approach is a combined sale action).
{danger.fa-exclamation} IMPORTANT #2: Even if the PSP supports the authorize and capture steps, you should contact the support representative to confirm that the two-step processing is enabled for your channel within Backoffice.
ENDPOINTS
| Name | URL |
|---|---|
| Sandbox | https://pci-gw-test.praxispay.com/api/deposit-cancel |
| Live | https://gw.praxisgate.com/api/deposit-cancel |
REQUEST PARAMETERS
| Variable | Type | Description |
|---|---|---|
| merchant_id | varchar(50) | Required. Merchant API client account identifier |
| frontend | varchar(50) | Required. Cashier FrontEnd name, normally it is a common name of the website. Linked to a specific base currency. |
| trace_id | int(11) | Required. Transaction identifier at that is previously sent to CRM within authorized transaction notification. |
| 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. 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(3) | Required. API version |
| signature | varchar(96) | Required. sha384 HASH code of response (same algorithm as request signature) |
EXAMPLE
Request
For example below: Merchant Secret = "MerchantSecretKey"
curl -X POST \
https://gw.praxisgate.com/api/deposit-cancel \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
"frontend":"Integration TEST USD",
"merchant_id":"Test-Integration-Merchant",
"timestamp":1568763080,
"trace_id":752856,
"version":"1.1",
"signature":"1dc661c002e4335fa8554e6fe9d9d64ac29bc4a214817391faffa64ffeff8169457913a8c161153179d889703758d725"
}'Response (OK)
{
"description": "Successful cancel, the funds have been released: TraceID=752856",
"status": 0,
"version": "1.1",
"signature": "ead194eceb34b6e990029fe6921e1310e513241883048bf8dd329080759bd96ec48e30565e45f6743c0a23ac62b2f40d"
}Response (ERR)
{
"description": "Cancellation failed. Transaction not found: TraceID=752856",
"status": 1,
"version": "1.1",
"signature": "f64f958e1cf8b6f823e4f016487001d9436821c307979808b909267d2d37c864d84ec177b9d28f8c5767cda1f7aa8a27"
}Please refer to How to Build Signature for details on signing the request.
You are currently viewing version 3.3 Latest version here