Skip to content

Logo

Cashfree Payments

Your Business is One of a Kind. Your Payments Should Be Too.

Supports in this guide: Payouts

Provider website: cashfree.com

What you need to do for start processing transactions (brief summary)

  1. Choose account type
  2. Get your credentials (from Cashfree Payments)
  3. Connect in Dashboard
  4. Send an API request

Choose account type

Cashfree Payments can be connected in different ways (depending on your needs):

  • If you do payouts -> choose Provider account

If you're not sure which one to use, confirm with your Corefy account manager.

Prerequisites: get from Cashfree Payments

Sign up for a Cashfree Payments Payouts account and get the following values.

  • Client ID -> Corefy field client_id -> where to find: Cashfree Payments merchant dashboard (Payouts product)
  • Secret Key -> Corefy field secret_key -> where to find: Cashfree Payments merchant dashboard (Payouts product)
Payouts processing (connect Provider account, create payout-invoice)

Connect Provider account in Corefy Dashboard

Step 1 - Open connection form

Open Cashfree Payments in the provider directory and press Connect at Cashfree Payments Provider Overview page in the New connection section. Choose Provider account.

Step 2 - Fill in fields (provider -> Corefy)

  • Client ID -> client_id
  • Secret Key -> secret_key
  • Test Mode -> (enable if you are using sandbox credentials)

Success

You have connected Cashfree Payments Provider account!

First request to Corefy API (Actual)

What it does: creates a payout-invoice and sends funds via bank transfer.

Payout - Actual

POST /api/payout-invoices 

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "3f1b1a88-2e9c-4b7d-9a2e-7b7b7d5f6a21",
      "service": "cashfree_bank_transfer_inr",
      "currency": "INR",
      "amount": 100,
      "customer": {
        "reference_id": "cus_123"
      },
      "fields": {
        "name": "John Smith",
        "email": "johnsmith@gmail.com",
        "phone": "9876543210",
        "address": "221B Baker Street, Mumbai",
        "bank_account": "000123456789",
        "ifsc": "HDFC0000001"
      }
    }
  }
}

Important

fields.name, fields.email, fields.phone, and fields.address are required by Cashfree Payments' own API to create the beneficiary. fields.bank_account and fields.ifsc are additionally required by this connector for every payout, including UPI ones - see below.

Cashfree Payments also supports the cashfree_upi_inr service for payouts via UPI - in that case, additionally send fields.vpa (the beneficiary's UPI ID, e.g. johnsmith@okhdfcbank). fields.bank_account/fields.ifsc are still required even when paying out via UPI: this connector always looks up/creates the beneficiary's bank details first, regardless of which service is used.

Extended request

Why add extra fields (typical reasons):

  • Provide additional customer details for compliance/reconciliation
  • Positively influence conversion rate
  • Include optional fields required by your specific flow

No Options are configured for this connector.

Additional info

  1. Payouts only - this connector only supports payouts through Corefy, not incoming payments (no payment_method exists for this connector).

  2. Callback endpoint - for asynchronous payout status notifications (signed with HMAC-SHA256), set up the webhook URL in your Cashfree Payments dashboard pointing to Corefy's /cashfree/payout-callback endpoint. Corefy also reconciles payout status actively, independent of the callback.

  3. Only INR - both payout methods (cashfree_bank_transfer_inr, cashfree_upi_inr) are available in Indian Rupees (INR) only.

FAQ / Troubleshooting

  • Payout rejected / beneficiary creation fails -> make sure fields.name, fields.email, fields.phone, fields.address, fields.bank_account, and fields.ifsc are all present - bank_account/ifsc are required even for UPI payouts (cashfree_upi_inr + fields.vpa)
  • Invalid credentials / auth error -> verify Client ID/Secret Key for the selected environment (test vs live)
  • Currency or service is not supported -> Cashfree Payments payouts are INR-only; confirm the selected service with your Corefy account manager

Question

Still looking for help connecting your Cashfree Payments account? Please contact our support team!