Praxis Wiki logo

Payment API {process} Payout (compatibility)

{danger.fa-exclamation} IMPORTANT: Present method is intended for compatibility purpose only. If you are looking for the details to get started with the Payment API integration, please refer to Payout - Encryption Enabled

The payout processing API lets the merchant send the funds from a specified merchant account to the customer's card.

{danger.fa-exclamation} IMPORTANT: Sometimes transaction_id (PSP transaction identifier) is empty, this may happen in due to input validation.


Name URL


Variable Type Description
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
card_number varchar(19) Required. Payment card number (PAN)
card_exp varchar(8) Required. Payment card expiration month/year in format MM/YYYY (ex. 12/2024)
pin varchar(50) Required. Unique customer id in your system
dob date Required. Date of birth of the customer. MM/DD/YYYY format accepted.
email varchar(50) Required. Customer's email
phone int(20) Required. Numeric only, includes country area code. Should not be a dummy sequence like 123456 or 111111, should be at least 6 digits long.
requester_ip varchar(10) Required. Customer's IP address
address varchar(100) Required. Customer's address
city varchar(50) Required. City of the customer
country varchar(2) Required. ISO 3166-1 alpha-2 (US, MT, IT, GB, DE etc)
first_name varchar(25) Required. Customer's first name
last_name varchar(25) Required. Customer's last name
state varchar(2) Required. State/Province where the customer resides. 2 characters ISO format. Otherwise leave blank.
zip varchar(12) Required. Postal Code of the customer. Can provide values for other countries. Limited to 12 alphanumeric characters only.
gateway varchar(32) Required. Gateway doing the processing
application_key varchar(32) Required. Identifier of your application (website)
merchant_id varchar(50) Required. Merchant API client account identifier
return_url varchar(256) Required. User will be redirected to a specified URL upon 3D Secure confirmation (in case of 3D Secure flow)
notification_url varchar(256) Required. URL to which the deposit status notification will be sent
order_id varchar(50) Required. Transaction identifier in your system
transaction_type varchar(8) Required. Transaction type. Must be set to payout for payout to customer's card
reference_id varchar(50) Optional. (Required on refund) Original transaction identifier from
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. Request signature. Please refer to How to Build Signature for details on signing the request.


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) Optional. Transaction identifier in PSP
transaction_status varchar(16) Required.
- pending - processing initiated, final response expected from PSP
- approved - processing was successful
- rejected - processing failed
- cancelled - processing cancelled by the merchant or client
- error - processing or configuration error
payment_processor varchar(25) Optional. Gateway doing the processing
error_code varchar(32) 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 algorithm as request signature)


For example below: Merchant Secret = "MerchantSecretKey"


curl -X POST \ \
-H 'Content-Type: application/json' \
-d '{
    "address": "Avenue 51\/2",
    "amount": "100",
    "application_key": "Sandbox",
    "card_exp": "12\/2028",
    "card_number": "4012888888881881",
    "city": "New York",
    "country": "US",
    "currency": "USD",
    "dob": "05\/15\/1980",
    "email": "[email protected]",
    "first_name": "Test",
    "gateway": "s-pTSZyK23E1Ee5KZpcNbX_aFl0HuhQ0",
    "last_name": "User",
    "merchant_id": "Test-Integration-Merchant",
    "notification_url": "https:\/\/\/v1\/deposits\/tx-1560610955",
    "order_id": "test-1560610955",
    "phone": "+1987987987987",
    "pin": "1",
    "requester_ip": "",
    "state": "LA",
    "timestamp": 1579218181,
    "transaction_type": "payout",
    "reference_id": null,
    "version": "1.2",
    "zip": "24123",
    "signature": "b4c29f26ffc7a118a80bea63579f27e10d6dc12c82832e771085c635762faaa8f463e3a348eafddc593d3e20d22a647d"

Response (Approved)

    "description": "Ok",
    "error_code": "0",
    "error_details": "[TEST] Transaction status: approved",
    "payment_processor": "TestPP",
    "status": 0,
    "trace_id": 1000000681,
    "transaction_id": "15607165967620",
    "transaction_status": "approved",
    "version": "1.2",
    "signature": "268ac58da717d65217c7957d7fde679c35c5b5fa58bac53d3cea8fec9739c5bb3acce42d90e11987db43305beadad0ac"

Response (Rejected)

    "description": "Ok",
    "error_code": "1",
    "error_details": "[TEST] Transaction status: rejected",
    "payment_processor": "TestPP",
    "status": 0,
    "trace_id": 1000000682,
    "transaction_id": "15607165967622",
    "transaction_status": "rejected",
    "version": "1.2",
    "signature": "2ee9f427c4940bd4dbb5d72f5414b868a90d507fd729d157a0b0338a87ad2a9e3c7fcd8c8263df89134d3a93cb889bda"

You are currently viewing version 3.4 Latest version here