Payment Link

The Payment Link endpoint allows merchants to generate a custom payment link that can be shared with customers to collect payments via UPI.


Endpoint

POST /v1/payments/createPaymentLink

🔧 Example: Axios POST Request

await axios.post(
  "https://api.upitranzact.com/v1/payments/createPaymentLink",
  {
    mid: "Your Merchant ID", // Example: ABC
    amount: "Numeric value between 1-100000", // Example: 200
    note: "Rent from customer", // Payment remark
    customer_name: "John",
    customer_email: "[email protected]",
    customer_mobile: "Your Customer Mobile", // Must be a valid phone number
  },
  {
    headers: {
      Authorization: "Basic base64(public_key:secret_key)"
    }
  }
);

🧾 Key Parameters

  • mid: Your merchant identifier.
  • amount: Must be a numeric value between 1 and 100000.
  • note: Remark or purpose of the payment.
  • customer_name: Full name of the customer.
  • customer_email: A valid email address.
  • customer_mobile: A valid mobile number.
  • Authorization: Must be in the format Basic base64(public_key:secret_key).

Ensure all placeholder values are replaced before executing.


📨 Headers

NameValue
Content-Typeapplication/x-www-form-urlencoded
AuthorizationBasic base64(public_key:secret_key)

📥 Request Body Parameters

NameTypeDescriptionExampleRequired
midstringMerchant ID assigned by UPITranzactABCYes
amountintegerThe total amount200Yes
notestringRemark for the paymentRent from customerYes
customer_namestringCustomer's full nameJohnYes
customer_emailstringCustomer's email address[email protected]Yes
customer_mobilestringCustomer's mobile number0123456789Yes

🔐 Authorization

Requests must include the Authorization header with a Base64-encoded string of public_key:secret_key.

Example Format:

Authorization: Basic base64(public_key:secret_key)

Example Encoded Header:

Authorization: Basic eW91cl9wdWJsaWNfa2V5OnlvdXJfc2VjcmV0X2tleQ==

Successful Response

{
    "status": true,
    "statusCode": 200,
    "msg": "Payment link created successfully",
    "data": {
        "payment_link": "https://upitranzact.com/paylink/xyz123"
    }
}

Error Example (Missing Auth Header)

{
    "status": false,
    "message": "Authorization header is required."
}