POST
/
payout
/
v1
/
cardpay
curl --request POST \
  --url https://payout-api.cashfree.com/payout/v1/cardpay \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: <content-type>' \
  --data '{
  "token": "<string>",
  "amount": "<string>",
  "transferId": "<string>",
  "remarks": "<string>",
  "name": "<string>",
  "networkType": "<string>",
  "cryptogram": "<string>",
  "tokenExpiry": "<string>",
  "cardType": "<string>",
  "tokenPANSequenceNumber": "<string>"
}'
{
  "status": "SUCCESS",
  "subCode": "200",
  "message": "Transfer completed successfully",
  "data": {
    "referenceId": "10023",
    "utr": "P16111765023806",
    "acknowledged": 1
  }
}

Please use this Authorization token in headers to call any payout API (Refresh this page if the token is expired)

Headers

​
Authorization
string
required

Bearer Auth Token

​
Content-Type
string
required

application/json

Body

application/json
​
token
string
required

It is the tokenised card number or card token for this transfer.

​
amount
string
required

Amount you want to transfer. Amount should be >= 1.00. Decimals are allowed.

​
transferId
string
required

Unique transfer ID to identify the transfer. Alphanumeric characters and underscore are allowed. The maximum character limit is 40.

​
cardType
string
required

Specify if it is a debit or credit card. Values allowed: DEBIT/CREDIT. CREDIT is the default value if the parameter does not exist or is not specified.

​
remarks
string

Remarks for your reference. Alphanumeric characters and whitespace are allowed. The maximum character limit is 70.

​
name
string

The name of the beneficiary who receives the transfer amount.

​
networkType
string

Specify the card type - VISA/MASTERCARD.

​
cryptogram
string

It ​contains formatted chip/cryptogram data relating to the token cryptogram. The maximum character limit is 600. It is optional for MASTERCARD and not required for VISA.

​
tokenExpiry
string

Applicable only for MASTERCARD. The format for the valid token expiry date should be YYYY-MM. It cannot be null. Provide a valid tokenExpiry if collected from the customers. If unavailable, populate a static value with a forward year and month in the correct format (YYYY-MM). The maximum character limit is 10.

​
tokenPANSequenceNumber
string

A maximum of 3 alphanumeric characters are allowed. It is optional for MASTERCARD and not required for VISA.

Response

200
text/plain
200
​
status
string
Example:

"SUCCESS"

​
subCode
string
Example:

"200"

​
message
string
Example:

"Transfer completed successfully"

​
data
object

Was this page helpful?