Skip to main content
POST
Create Cashgram

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 (36 character limit).

amount
number<float>
required

Amount to be transferred, >= 1.00.

name
string
required

Name of the contact. Only alphabets (a–z, A–Z) and spaces are allowed. Digits and special characters (including . - / &) are not supported. Maximum 100 characters.

phone
string
required

Phone number of the contact. Exactly 10 digits. Enter an Indian mobile number without the country code or +91 prefix.

Date to expire the Cashgram link, in the format YYYY/MM/DD. Maximum 31 days from the date of creation. Defaults to 7 days if omitted.

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. Only alphabets (a–z, A–Z) and spaces are allowed. Digits and special characters are not supported. Maximum 20 characters. Examples: Refund, Repayment. Validation errors for this field refer to it as type.

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