Skip to content

PayOut UPI (INR) h2h

The request contains certain fields:

Field Description
merchant unique merchant ID;
method payout method, integer number:
26 – Payout UPI INR;
payout_id the number of the outgoing payment in the merchant’s system;
account bank account number;
full_name first name, last name of the client. Maximum length 30 characters;
customs_phone customer's phone number, +91XXXXXXXXX;
customs_email customer's e-mail;
customs_ifsc IFSC (Indian Financial System Code);
customs_ip client IP address;
amount amount of the transaction in currency, separator character is a period “.”;
currency transaction currency “INR”;
sign digital signature with the merchant’s key. Available fields are: merchant, method, payout_id, account, amount, currency, customs_phone, customs_email, customs_ifsc, customs_ip. Hashed using the MD5 method (for more details read the “Digital signature in requests” section).
POST /merchant/api/payout_send
https://<provided_url>
/merchant/api/payout_send

Example of the request:

Example of the request

application/json

{
    "merchant" : "M1VJDHSI6DYXS",
    "method" : 26,
    "payout_id" : "000002",
    "account" : "1111111122222",
    "full_name" : "CARD HOLDER",
    "customs_email" : "test@test.com",
    "customs_phone" : "+9100000000",
    "customs_ifsc" : "ICIC0001818",
    "customs_ip" : "127.0.0.1",
    "amount" : "102.81",
    "currency" : "INR",
    "sign" : "XXXXXXXXXXXXXXXXXX"
}

The response contains the fields:

Field Description
status transaction status:
Success – the payment was made successfully (the status is final)
Pending – the payment is new or is in the line for processing. The Pending status requires an additional request (for more details read the “Payment Status Request (payment)” section).
Blocked – payment rejected (final status)
Error – received data error. The response contains a signature with an empty key (the status is not final and is the basis for finding out the reason of this status);
code transaction status code;
payout_id the number of the outgoing payment in the merchant’s system;
description status description;
sign digital signature with the merchant’s key.

An example of a response is a Success status:

Example of the response

application/json

{
    "status" : "Success",
    "code" : "0",
    "payout_id" : 000002,
    "description" : "Payment successful. Status final",
    "sign" : "XXXXXXXXXXXXXXXXXX"
}

An example of a response is the Pending status:

Example of the response

application/json

{
    "status" : "Pending",
    "code" : "40",
    "payout_id" : 000002,
    "description" : "Payment in order",
    "sign" : "XXXXXXXXXXXXXXXXXX"
}

An example of a response is the Error status:

Example of the response

application/json

{
    "status" : "Error",
    "code" : "99",
    "payout_id" : "",
    "description" : "Sign error",
    "sign" : "XXXXXXXXXXXXXXXXXX"
}

Final status (callback)

To notify the merchant that the transaction has received the final status (for example, from “Pending” to “Success”), the callback mechanism is used.

For more information read the Callbacks section.