Get Started

Payout Solution is the best way to do payouts and wallet transfers. It gives you the way to manage your payouts in a very efficient manner and keeps records of each transaction.

Payout api's can be accessible from whitelisted IP's only. Contact our tech support team to whitelist your IP address.

Payment Transafer

This API will transfer money to the beneficiary account from merchant’s payout account.

              
                curl --location --request POST 'http://BASE URL/api/pay/payout/transfer' \
                --header 'mid: 9c87xxxxxxxxxd3f' \
                --header 'password: c873xxxxxxxxxecadc3' \
                --header 'Content-Type: application/json' \
                --data-raw '{
                  "amount": 100,
                  "curr_code": "INR",
                  "purpose": "Salary",
                  "queue_if_low_balance": false,
                  "reference_id": "xxxxxxx123459994",
                  "narration": "xxxx Corp Fund Transfer",
                  "customer_id":"",
                  "phonenumber":"99xxxxxx98",
                  "transfer_type":{
                    "type":"bank",
                    "account_number": "05xxxxxxxxx59",
                    "ifsc_code":"ICIxxxxxxx85",
                    "beneficiary_name":"NXXXX XXXXXT",
                    "mode": "NEFT"
                  }
                }'

Header Authentication

Enter valid MID and Password

Parameter Details Is mandatory
mid Enter valid MID available in the Developer’s section. Yes
password Enter valid password available in developer section. Yes

Request Parameters

Enter all the mandatory parameters and valid api key

Parameter Details Is mandatory
curr_code The code of the currency. One of currency code is required. Yes
amount Charge amount with 100 multiplier. e.g capture amount is 300.50 then enter amount as 30050. Yes
purpose Enter description to identify your transaction. Yes
queue_if_low_balance Enter true if want to schedule transaction if account balance if low. Yes
reference_id Enter unique identification value to track transaction. Yes
narration Detailed information about your transation. Yes
customer_id Customer details if fund wants to transfer to your stored customer. No
phonenumber Customer contact number. Yes
transfer_type Enter your fund transfer mode and beneficiary details Yes
type Enter transfer type mode. Possible values "bank","upi", "wallet" Yes
account_number Eneter valid account number if transfer type is bank. Yes
ifsc_code Eneter valid IFSC code if transfer type is bank. Yes
beneficiary_name Enter valid beneficiary name if transfer type is bank Yes
mode Enter valid bank transfer mode. Possible values "NEFT", "RTGS" and "IMPS" Yes

Response

API response details

              
                {
                  "amount": 100,
                  "currency": "INR",
                  "transactionId": "2269165736087729887",
                  "pay_id": "",
                  "purpose": "refund",
                  "reference_id": "TID1234599993",
                  "payment_details": {
                    "type": "bank",
                    "account_number": "********0159",
                    "ifsc_code": "ICxxxxxxx585",
                    "beneficiary_name": "Nxxxx xxxxxxT",
                    "mode": "NEFT"
                      },
                      "status": "ACCEPTED",
                      "message": "Transaction is successfully accepted but not processed."
                }

Response Parameters

Response parameter details

Parameter Details
amount Transaction amount.
currency Transaction currency code
transactionId Unique identification code
pay_id Bank UTR number
purpose Purpose of the transaction
reference_id Merchant reference id
payment_details Payment transfer mode and masked details
status Transaction status
message Transaction descriptive detailes

Status Check API

Status check api details.

              
                curl --location --request POST 'https://BASE URL/api/pay/payout/status/xxxx05500' \
                --header 'mid: ac879xxxxxxxxxx406' \
                --header 'password: c879cxxxxxxxxfec'

Pass your transaction id which your received in payment transfer api. Status check api response same as payment transfer api

Webhook Configuration

Configure your webhook URL from mercnaht panel. Configure POST method and your API should respond back true status. Webhook parameters same as payment transfer api response.

Status Codes

Code Message
CREATED Transaction created.
ACCEPTED Transaction is successfully accepted but not processed.
PENDING Transaction in progress
FAILED Transaction failed
FAILURE Transaction failed
SUCCESS Transaction is successfully processed
IP_WHITELIST Ip address is not whitelist
INSUFFICIENT_BALANCE Insufficient balance
UNAUTHORIZED Unauthorized request