VyomPay
  1. Payin APIs
VyomPay
  • Introduction
  • Process Flow
  • Error Codes
  • Common APIs
    • Wallet Balance Check
      POST
  • Payout APIs
    • Add NEFT/IMPS Beneficiary
      POST
    • Add UPI Beneficiary
      POST
    • Delete Beneficiary
      POST
    • Get Beneficiary List
      POST
    • NEFT/IMPS Validate Beneficiary
      POST
    • Validate UPI Beneficiary
      POST
    • Payout Transaction Request
      POST
    • Direct Payout Transaction Request
      POST
    • Transaction Status
      POST
    • Transaction Status By Request ID
      POST
    • Payout Transaction Complain
      POST
    • Payout Callback
      POST
    • Virtual Account Wallet Credit Callback
      POST
    • Service Bank List
      POST
    • Service List
      POST
  • Payin APIs
    • Generate Merchant Payment Link
      POST
    • Generate Merchant PG Order
      POST
    • Generate Merchant UPI PG QR
      POST
    • Merchant UTR Process
      POST
    • Check Order Status
      POST
    • Payin Callback
      POST
  1. Payin APIs

Generate Merchant Payment Link

Testing
POST
/Payin/Action/generateMerchantPaymentLink

Request

Body Params application/json
requestid
string 
required
A unique id referencing the current request
api_key
string 
required
api_key
api_secret
string 
required
api_secret
amount
string 
required
Amount to Payin
partial_pay
string 
required
"YES" or "NO"
payment_description
string 
required
Description of the Payment
payment_email
string 
optional
Email
payment_mobile
string 
optional
Phone number
reference_no
string 
optional
expire_date
string 
optional
YYYY-MM-DD
webhook_url
string 
optional
send_reminder
string 
optional
"YES" or "NO"
reminder_details
object 
optional
Mandatory if send_reminder is 'YES'
reminder_notes
string 
required
reminder_interval
string 
required
reminder_on
string 
required
customer_email
string 
required
customer_mobile
string 
required
Example
{
    "requestid": "{{request_id}}",
    "api_key": "f68db941819657a1434b9bce0cd9811e",
    "api_secret": "cabfc6c85d2c1ec57905d6f230784ca8",
    "amount": "100.00",
    "partial_pay": "YES",
    "payment_description": "Payment Descripiton",
    "payment_email": "",
    "payment_mobile": "9865327410",
    "reference_no": "Q20240913151563LKOP",
    "expire_date": "2024-09-30",
    "webhook_url": "http://localhost.com/testPaymentLinkWebhook/",
    "send_reminder": "YES",
    "reminder_details": { // (Mandatory if Reminder status is 'YES')
        "reminder_notes": "", // (Optional)
        "reminder_interval": "30", // In minutes
        "reminder_on": "MOBILE", // "EMAIL","MOBILE"
        "customer_email": "test@test.com", // (Mandatory if reminder_on is 'EMAIL')
        "customer_mobile": "9865327410" // (Mandatory if reminder_on is 'MOBILE')
    }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://uat.nandishatech.com/WS/v1/Payin/Action/generateMerchantPaymentLink' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestid": "{{request_id}}",
    "api_key": "f68db941819657a1434b9bce0cd9811e",
    "api_secret": "cabfc6c85d2c1ec57905d6f230784ca8",
    "amount": "100.00",
    "partial_pay": "YES",
    "payment_description": "Payment Descripiton",
    "payment_email": "",
    "payment_mobile": "9865327410",
    "reference_no": "Q20240913151563LKOP",
    "expire_date": "2024-09-30",
    "webhook_url": "http://localhost.com/testPaymentLinkWebhook/",
    "send_reminder": "YES",
    "reminder_details": { // (Mandatory if Reminder status is '\''YES'\'')
        "reminder_notes": "", // (Optional)
        "reminder_interval": "30", // In minutes
        "reminder_on": "MOBILE", // "EMAIL","MOBILE"
        "customer_email": "test@test.com", // (Mandatory if reminder_on is '\''EMAIL'\'')
        "customer_mobile": "9865327410" // (Mandatory if reminder_on is '\''MOBILE'\'')
    }
}'

Responses

🟢200Generate Merchant Payment Link
application/json
Body
Resp_code
string 
required
Resp_desc
string 
required
requestid
string 
required
data
object 
required
payment_url
string 
required
link_created_on
string 
required
Example
{
  "Resp_code": "RCS",
  "Resp_desc": "Payment link generated successfully!!",
  "requestid": "722370c76be4471181d2c",
  "data": {
    "payment_url": "https://paym.letspe.com/paymentLink/DVzjtA%2Fyi2Rre1Z1dPVevjSIcaIfJSTgWXqE697F5LIRGISh4e6bPjT2hv4%2ByJYjDl0Jyokh70PNTZKW4ryH0KmFxhoCYQyb9jnjK2wNCsk%3D",
    "link_created_on": "2024-09-20 14:50:36"
  }
}
Previous
Service List
Next
Generate Merchant PG Order
Built with