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 |
| application_key | varchar(32) | Required. Identifier of your application (website) |
| 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 '{
"application_key": "Sandbox",
"merchant_id": "Test-Integration-Merchant",
"timestamp": 1578880005,
"trace_id": 752856,
"version": "1.2",
"signature": "96d5baef40b19e4ab1ec12457537de84d0c795f0b6a7b0a4a91a0751a24456b61f80e4fd8e498998862ad33a53f92d1e"
}'Response (OK)
{
"description": "Successful cancel, the funds have been released: TraceID=752856",
"status": 0,
"version": "1.2",
"signature": "78fda88ebff7a23c09822c95ca9a636cba8d2117509dacc462adab9f76a2e108b1213e8291ce28286b713a0dc2eb14e5"
}Response (ERR)
{
"description": "Cancellation failed. Transaction not found: TraceID=752856",
"status": 1,
"version": "1.2",
"signature": "3f25e5129aa9b3f463adf0fa93d0fd13b3af37a3b26e82bc97e517f78a1beade513cd679400a888dfda0d4f5e4c13851"
}Please refer to How to Build Signature for details on signing the request.
You are currently viewing version 3.4 Latest version here