Praxis Wiki logo

Agent API {payout-split}


Split Payout is a way to process the customer's payout request in several payouts having the smaller amounts.

{danger.fa-exclamation} IMPORTANT #1: Split payout is not compatible with some PSPs.


{danger.fa-exclamation} IMPORTANT #2: Split payout creates a new payout request having the same payment method and using the same customer's payment details.

ENDPOINTS

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

REQUEST PARAMETERS

Variable Type Description
merchant_id varchar(50) Required. Merchant API client account identifier
frontend varchar(50) Required. Frontend in which the payout has been requested and will be processed
amount int(20) Required. Payment amount in cents.
Please note: for certain currencies (see full list here) there is a fraction other than 100 cents per unit, this is important if you multiply by 100 to send the amount in cents
currency varchar(10) Required. Payment currency
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)
reference_id varchar(50) Required. Original transaction identifier from
order_id varchar(50) Required. Transaction identifier in your system
pp varchar(50) Required. Processor name to be used for processing (available options can be seen at BO in a dropdown list of processors. given during the final step - payout processing form submission)
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. 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
trace_id int(11) Required. Transaction identifier in
transaction_id varchar(50) Required. Transaction identifier in PSP
transaction_status varchar(16) Required.
- pending - processing initiated, final response expected from PSP
- approved - processing was successful
- declined retry - processing failed and will be reattempted
- declined - processing failed
- cancelled - processing cancelled by the merchant or client
- pending async - customer action expected (3D Secure, etc.)
- requested - merchant action expected (approval)
payment_processor varchar(25) Required. Gateway doing the processing
error_code int(10) Optional. Error code for rejected transactions
error_details varchar(256) Optional. Error description for rejected transactions
version varchar(3) 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-split \
-H 'Content-Type: application/json' \
-H 'cache-control: no-cache' \
-d '{
    "amount":1000,
    "currency":"USD",
    "frontend":"Integration TEST USD",
    "merchant_id":"Test-Integration-Merchant",
    "gateway": "dM-4p5ZORnROeCnnLmm3fBO-WkghMNhr",
    "order_id":"test-1560610955",
    "pp":"TestPP",
    "reference_id":752856,
    "timestamp":1575626868,
    "version":"1.1",
    "signature":"445c127a178fd73539706110b941b8cbe0171e2661ba09da95a0be6bf69aadc4e510602e4019d77afe1173dc599902dc"
}'

Response (OK)

{
    "description":"Ok",
    "error_code":1,
    "error_details":"[TEST] Transaction status: approved",
    "payment_processor":"TestPP",
    "status":0,
    "trace_id":1000000681,
    "transaction_id":"15607165967620",
    "transaction_status":"approved",
    "version":"1.1",
    "signature":"e6441bedce5fd3f26e7834f7bfbff091c8781e35f119e65ec4aa6ed32f44652549bebbd846eac240bac5c62670ab277f"
}

Response (Declined)

{
    "description":"Ok",
    "error_code":1,
    "error_details":"[TEST] Transaction status: declined",
    "payment_processor":"TestPP",
    "status":0,
    "trace_id":1000000682,
    "transaction_id":"15607165967622",
    "transaction_status":"declined",
    "version":"1.1",
    "signature":"f7a05d4ead2f00d731116b005bb5d8186574611f2818bfc405ad9061d61bc8393b49cc8d7fdd11299cea95c75e9da2e3"
}

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

You are currently viewing version 3.3 Latest version here