Skip to main content
POST
/
payout
/
v1
/
createCashgram
Create Cashgram
curl --request POST \
  --url https://payout-api.cashfree.com/payout/v1/createCashgram \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '
{
  "cashgramId": "<string>",
  "amount": 123,
  "name": "<string>",
  "phone": "<string>",
  "linkExpiry": "<string>",
  "email": "<string>",
  "remarks": "<string>",
  "notifyCustomer": true
}
'
{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "Cashgram Created",
  "data": {
    "referenceId": 123456,
    "cashgramLink": "http://csgr.am/abcdefg"
  }
}

Documentation Index

Fetch the complete documentation index at: https://telr-docs.cashfree.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
Authorization
string
required

Bearer auth token

​
Content-Type
string
required

application/json

Body

application/json
​
cashgramId
string
required

Unique Id of the Cashgram. Alphanumeric, underscore (_), and hyphen (-) allowed (35 character limit)

​
amount
number<float>
required

Amount to be transferred, >= 1.00

​
name
string
required

Name of the contact

​
phone
string
required

Phone number of the contact

​
linkExpiry
string
required

Date to expire the cashgram link, Date format YYYY/MM/DD, maximum 30 days from the date of creation.

​
email
string

Email of the contact

​
remarks
string

Specify remarks, if any.

​
notifyCustomer
boolean

If value is 1, a link is sent to customers phone and email.

Response

200

​
status
string
Example:

"SUCCESS"

​
subCode
string
Example:

"200"

​
message
string
Example:

"Cashgram Created"

​
data
object