Manage a single payment.
Use this API to manage a payment of a subscription. A payment can be cancelled or retried with this API.
Authorizations
Client app ID. You can find your app id in the Merchant Dashboard.
Client secret key. You can find your secret in the Merchant Dashboard.
Headers
API version to be used. Format is in YYYY-MM-DD
Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree
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.
Path Parameters
Provide the SubscriptionId using which the subscription was created.
Provide the PaymentId using which the payment was created.
Body
Request body to manage a subscription payment.
The unique ID which was used to create subscription.
The unique ID which was used to create payment.
Action to be performed on the payment. Possible values - CANCEL, RETRY.
Details of the action to be performed. Needed for retry action.
Response
The response returned in Get, Create or Manage Subscription Payment APIs.
Details of the authorization done for the subscription. Returned in Get subscription and auth payments.
Cashfree subscription payment reference number
Cashfree subscription reference number
Cashfree subscription payment transaction ID
Cashfree subscription payment order ID
The charge amount of the payment.
A unique ID passed by merchant for identifying the transaction.
The date on which the payment was initiated.
Payment remarks.
The date on which the payment is scheduled to be processed.
Status of the payment.
Payment type. Can be AUTH or CHARGE.
Retry attempts.
A unique ID passed by merchant for identifying the subscription.
Was this page helpful?