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,
  "payoutType": "<string>"
}
'
{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "Cashgram Created",
  "data": {
    "referenceId": 123456,
    "cashgramLink": "http://csgr.am/abcdefg"
  }
}

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. Only alphanumeric, whitespace ( ), period (.), hyphen ( - ), slash (/), and ampersand ( & ) are allowed - (100 character limit).

​
phone
string
required

Phone number of the contact. Phone number registered in India (only digits, 8 - 12 characters after stripping +91).

​
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. String in email id format should contain @ and dot(.) - (200 character limit).

​
remarks
string

Specify remarks, if any. Only alphanumeric and whitespaces ( ) are allowed.

​
notifyCustomer
boolean

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

​
payoutType
string

Specifies the type of payout to the customer. Example: Refund, Repayment, etc.

Response

200

​
status
string

It represents the status of the API request.

Example:

"SUCCESS"

​
subCode
string

It represents the subcode of the API request.

Example:

"200"

​
message
string

It displays details about the success or failure of the API request.

Example:

"Cashgram Created"

​
data
object