API Reference

Create Transfer Request

post
https://api-uat.ncome.in/api/v1/transfer

The Create Transfer Request API enables merchants to initiate a single fund transfer from a specified Digital Escrow ID to a linked Payee. Transfers can be made to Payee's bank accounts via NEFT, RTGS, and IMPS, or to their VPA/UPI ID using "upi" as the payment mode.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

This is the Digital Escrow ID from which the transfer to be made

string
required

This is the Payee ID of the beneficiary to whom funds will be transferred

string
required

The mode to be used to create the transfer. Available modes: rtgs, neft, imps, ift (for same bank transfer), upi (for UPI Payout) The payout modes are case sensitive.

double
required

The request parameter "Amount" specifies the transfer amount, which must be a decimal value with up to 2 decimal places. The minimum allowable amount is Rs 1.

string

"purpose" is an optional field

notes
object

Maximum 15 key/value pairs allowed

string

The customerRefId field allows you to pass your unique transfer reference number, helping you track and manage transactions within your system.

Headers
string
Defaults to */*
string
Defaults to {{X-Client-Key}}

API key generated from Castler dashboard

string
Defaults to {{x-api-key}}

xAPI key shared separately by Castler

Responses

Updated 12 months ago

Language
Credentials
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 12 months ago