Create Payment Link
Use this API to create a new payment link. The created payment link url will be available in the API response parameter link_url.
Authorizations
Client app ID. You can find your app id in the Merchant Dashboard.
Client secret key. You can find your secret in the Merchant Dashboard.
Headers
API version to be used. Format is in YYYY-MM-DD
Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.
Body
Request paramenters for link creation
Unique Identifier (provided by merchant) for the Link. Alphanumeric and only - and _ allowed (50 character limit). Use this for other link-related APIs.
50Amount to be collected using this link. Provide upto two decimals for paise.
Currency for the payment link. Default is INR. Contact care@cashfree.com to enable new currencies.
A brief description for which payment must be collected. This is shown to the customer.
500Payment link customer entity
If "true", customer can make partial payments for the link.
Minimum amount in first installment that needs to be paid by the customer if partial payments are enabled. This should be less than the link_amount.
Time after which the link expires. Customers will not be able to make the payment beyond the time specified here. You can provide them in a valid ISO 8601 time format. Default is 30 days.
Payment link Notify Object for SMS and Email
If "true", reminders will be sent to customers for collecting payments.
Key-value pair that can be used to store additional information about the entity. Maximum 5 key-value pairs
Payment link meta information object
If you have Easy split enabled in your Cashfree account then you can use this option to split the order amount.
Response
Payment link success creation response object
Payment link customer entity
Payment link meta information object
Key-value pair that can be used to store additional information about the entity. Maximum 5 key-value pairs
Payment link Notify Object for SMS and Email
Base64 encoded string for payment link. You can scan with camera to open a link in the browser to complete the payment.
Was this page helpful?