Cashfree Payments icon

Cashfree Payments

Interact with Cashfree Payments API
Join our community

Actions9

Overview

This node interacts with the Cashfree Payments API to create a payment link. It allows users to generate a payment link for a customer with detailed customer information, payment amount, currency, purpose, and optional settings such as expiry time, notifications, payment methods, partial payments, and auto reminders. This is useful for businesses or individuals who want to send a secure payment link to customers for collecting payments online.

Use Case Examples

  1. A business wants to send a payment link to a customer via email or SMS to collect payment for an invoice.
  2. An online seller creates a payment link with a specific amount and purpose, allowing customers to pay using various payment methods including UPI, credit cards, or net banking.
  3. A service provider enables partial payments and auto reminders on the payment link to facilitate flexible payment options and timely notifications.

Properties

Name Meaning
Customer Email The email address of the customer to whom the payment link will be sent. Required.
Customer Name The name of the customer for identification purposes. Optional.
Customer Phone The phone number of the customer to send SMS notifications. Required.
Customer Bank Account Number The customer's bank account number, used optionally for bank-related payments.
Customer Bank IFSC Code The IFSC code of the customer's bank branch, used optionally for bank-related payments.
Customer Bank Code The bank code of the customer's bank, selected from predefined options. Optional.
Link ID Unique identifier for the payment link. Required.
Link Amount The amount to be collected via the payment link. Required.
Link Currency Currency code for the payment amount, default is INR.
Link Purpose Purpose or description of the payment link. Required.
Link Expiry Time Optional expiry time for the payment link in ISO 8601 format.
Link Notes (JSON Format) Optional JSON object containing additional notes for the payment link.
Notify URL Optional URL to notify on payment events.
Return URL Optional URL to redirect the customer after payment completion.
Payment Methods Comma-separated list of allowed payment methods for the link (e.g., cc, dc, upi). Leave blank to allow all.
Allow UPI Intent Boolean to allow UPI intent payments.
Send Email Notification Boolean to send email notification to the customer.
Send SMS Notification Boolean to send SMS notification to the customer.
Enable Partial Payments Boolean to enable partial payments on the link.
Minimum Partial Amount Minimum amount allowed for partial payments.
Enable Auto Reminders Boolean to enable automatic reminders for the payment link.

Output

JSON

  • link_id - The unique identifier of the created payment link.
  • link_amount - The amount set for the payment link.
  • link_currency - The currency of the payment link.
  • link_purpose - The purpose or description of the payment link.
  • link_expiry_time - The expiry time of the payment link, if set.
  • link_status - The current status of the payment link.
  • link_url - The URL of the payment link that can be shared with customers.
  • customer_details
    • customer_email - Customer's email address associated with the payment link.
    • customer_name - Customer's name associated with the payment link.
    • customer_phone - Customer's phone number associated with the payment link.

Dependencies

  • Cashfree Payments API
  • API credentials including Client ID and Client Secret

Troubleshooting

  • Ensure that the Client ID and Client Secret credentials are correctly configured for Payment Gateway operations.
  • For Cashgram operations, ensure the Payout Authorization Token is set in credentials.
  • Validate JSON format for the 'Link Notes' property to avoid JSON parsing errors.
  • Check that required fields such as Customer Email, Customer Phone, Link ID, Link Amount, and Link Purpose are provided.
  • If the API request fails, verify network connectivity and API endpoint URLs (sandbox or production).
  • Use idempotency keys for safe retries to avoid duplicate actions in case of timeouts or failures.

Links

Discussion