POST
/
subscriptions
/
pay
curl --request POST \
  --url https://sandbox.cashfree.com/pg/subscriptions/pay \
  --header 'Content-Type: application/json' \
  --header 'x-api-version: <x-api-version>' \
  --header 'x-client-id: <api-key>' \
  --header 'x-client-secret: <api-key>' \
  --data '{
  "subscription_id": "test-subscription-id",
  "payment_id": "test-payment-id",
  "payment_amount": 10,
  "payment_schedule_date": "2024-04-18T16:40:00",
  "payment_remarks": "2nd EMI payment",
  "payment_type": "CHARGE",
  "payment_method": {
    "upi": {
      "upi_id": "john@upi",
      "channel": "COLLECT"
    }
  }
}'

Authorizations

ā€‹
x-client-id
string
headerrequired

Client app ID. You can find your app id in the Merchant Dashboard.

ā€‹
x-client-secret
string
headerrequired

Client secret key. You can find your secret in the Merchant Dashboard.

Headers

ā€‹
x-api-version
string
default: 2023-08-01required

API version to be used. Format is in YYYY-MM-DD

ā€‹
x-request-id
string

Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree

ā€‹
x-idempotency-key
string

An idempotency key is a unique identifier you include with your API call. If the request fails or times out, you can safely retry it using the same key to avoid duplicate actions.

Body

application/json

The request to be passed for the create subscription payment API.

ā€‹
subscription_id
string
required

A unique ID passed by merchant for identifying the subscription.

ā€‹
payment_id
string
required

A unique ID passed by merchant for identifying the subscription payment.

ā€‹
payment_type
string
required

Payment type. Can be AUTH or CHARGE.

ā€‹
subscription_session_id
string

Session ID for the subscription. Required only for Auth.

ā€‹
payment_amount
number

The charge amount of the payment. Required in case of charge.

ā€‹
payment_schedule_date
string

The date on which the payment is scheduled to be processed. Required for UPI and CARD payment modes.

ā€‹
payment_remarks
string

Payment remarks.

ā€‹
payment_method
object

Payment method. Can be one of ["upi", "enach", "pnach", "card"]

Response

200 - application/json

The response returned is Create Subscription Auth or Charge APIs.

ā€‹
cf_payment_id
string

Cashfree subscription payment reference number

ā€‹
failure_details
object
ā€‹
payment_amount
number

The charge amount of the payment.

ā€‹
payment_id
string

A unique ID passed by merchant for identifying the transaction.

ā€‹
payment_initiated_date
string

The date on which the payment was initiated.

ā€‹
payment_status
string

Status of the payment.

ā€‹
payment_type
string

Payment type. Can be AUTH or CHARGE.

ā€‹
subscription_id
string

A unique ID passed by merchant for identifying the subscription.

ā€‹
data
object

Contains a payload for auth app links in case of AUTH. For charge, the payload is empty.

ā€‹
payment_method
string

Payment method used for the authorization.

Was this page helpful?

API to get all the payment method details available for subscription payments.Fetch details of a single payment.