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 tech support in order to get the available payout processor options.
ENDPOINTS
| Name | URL |
|---|---|
| Sandbox | https://pci-gw-test.praxispay.com/api/payout-complete |
| Live | https://gw.praxisgate.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 that is previously sent to CRM within requested payout notification. |
| application_key | varchar(32) | Required. Identifier of your application (website) |
| gateway | varchar(50) | Required. Gateway (processor configuration) hash to be used for processing (available options can be seen at Admin service, for more details please contact [email protected] for root account access) |
| 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 |
{danger.fa-exclamation} IMPORTANT #3: Split Payout and Complete Payout
gatewayvalue passed in the request will be ignored for payouts with APM. Gateway value will be taken from the original withdrawal request transaction initiated by the customer within the
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 algorithm as request signature) |
EXAMPLE
Request
For example below: Merchant Secret = "MerchantSecretKey"
curl -X POST \
https://gw.praxisgate.com/api/payout-complete \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
"application_key": "Sandbox",
"gateway": "dM-4p5ZORnROeCnnLmm3fBO-WkghMNhr",
"merchant_id": "Test-Integration-Merchant",
"timestamp": 1578879918,
"trace_id": 752856,
"version": "1.2",
"signature": "ab3b6bdafea698dda78c6ea893a9e6a260c64c9dc0d173025714b6413b0b4bd6e2270caf524c073d4938a4d9cbcb5a3e"
}'Response (OK)
{
"description": "Transaction complete: trace_id=752856",
"status": 0,
"version": "1.2",
"signature": "25c0c70994d751cc3c8b9f596d9fcd9da1138c949fa044292f8a8a5c451e3f807fc5b1927a837899d2c5413aa8137226"
}Response (ERR)
{
"description": "Transaction not found: trace_id=752856",
"status": 1,
"version": "1.2",
"signature": "5884c259d7313cce0330911751334a894369e3037f9843049937c057a4cdcc98fdca916b260f07cc00fd93a8b42d13ae"
}Please refer to How to Build Signature for details on signing the request.
You are currently viewing version 3.4 Latest version here