Cashfree Payment Gateway integration
Yellow.ai Integration with Cashfree Payment Gateway allows you to generateTransaction ID and view payment status with the yellow.ai platform.
Connecting Cashfree with Yellow.ai
- Login to your Cashfree dashboard and copy the App ID and Secret.
- On the Cloud platform, navigate to the Development/Staging environment and click Extensions > Integrations > Payment > Cashfree. You can also search for the Cashfree app.
- In Give account name, enter a unique name for the integration. You can use only lowercase alphanumeric characters and underscores (_).
- Paste the App Id and Secret key.
- Choose the API base URL according to the type of Cashfree account that has been configured.
- To connect more accounts, click + Add account and follow the above mentioned steps to connect each account. You can add a maximum of 15 merchant accounts.
Enable Cashfree related events for the bot
The Cashfree payment status
event Indicates an update in the payment status. Each payment undergoes different status such as Pending, Processing, Completed, Failed, Refunded, or Cancelled.
- Activate the Cashfree Payment Status after configuring cashfree credentials at the integration page.
- If you have added multiple accounts in your platform, enable events for each of those accounts.
Manage Cashfree actions through bot conversation
This integration enables the bot to perform the following Cashfree actions:
- Generate transaction ID
When multiple accounts are added, select the appropriate account for each node, allowing you to leverage the unique functionalities of each account for their intended purposes.
Generate Transaction ID
This action sends a POST request for creating a new transaction and generates the transaction ID.
Node Input Params
Field Name | Description | Sample Input |
---|---|---|
Order ID | The unique identification for the order to be created | Order1234 |
Order Amount | The amount for the request. The minimum amount is 1 | 200 |
Order Currency* | The currency in which the order with the amount specified has to be created | INR |
Customer ID | The unique Identification for the Payer | 9999999999 |
Customer Email | Email of the payer | [email protected] |
Order Tags | Tags that are to be attached with the order | {‘comment’: ‘note to be appended’}’ |
Notify Url | Copy Webhook URL from cashfree card at integration page | Copy link |
Sample Success Response
{
"cf_order_id": 2678043,
"order_id": "order_1742302CCpwK00k2bp00fwIwblCVtyPqV",
"entity": "order",
"order_currency": "INR",
"order_amount": 1.00,
"order_expiry_time": "2022-08-19T17:00:57+05:30",
"customer_details": {
"customer_id": "123e344",
"customer_name": null,
"customer_email": "[email protected]",
"customer_phone": "1234567890"
},
"order_meta": {
"return_url": null,
"notify_url": null,
"payment_methods": null
},
"settlements": {
"url": "https://sandbox.cashfree.com/pg/orders/order_1742302CCpwK00k2bp00fwIwblCVtyPqV/settlements"
},
"payments": {
"url": "https://sandbox.cashfree.com/pg/orders/order_1742302CCpwK00k2bp00fwIwblCVtyPqV/payments"
},
"refunds": {
"url": "https://sandbox.cashfree.com/pg/orders/order_1742302CCpwK00k2bp00fwIwblCVtyPqV/refunds"
},
"order_status": "ACTIVE",
"order_token": "WKQXlA9jzfUIytw6adbA",
"order_note": null,
"payment_link": "https://payments-test.cashfree.com/order/#WKQXlA9jzfUIytw6adbA",
"order_tags": null,
"order_splits": []
}
Reference
For more information about action nodes to use in this integration, click here.