Preauthorization
Use this API to capture or void a preauthorized payment
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
The id which uniquely identifies your order
Body
Request to capture or void transaction
Type of authorization to run. Can be one of 'CAPTURE' , 'VOID'
CAPTURE
, VOID
The amount if you are running a 'CAPTURE'
Response
payment entity full object
The error details are present only for failed payments
Order amount can be different from payment amount if you collect service fee from the customer
Type of payment group. One of ['prepaid_card', 'upi_ppi_offline', 'cash', 'upi_credit_card', 'paypal', 'net_banking', 'cardless_emi', 'credit_card', 'bank_transfer', 'pay_later', 'debit_card_emi', 'debit_card', 'wallet', 'upi_ppi', 'upi', 'credit_card_emi']
This is the time when the payment was initiated
This is the time when the payment reaches its terminal state
The transaction status can be one of ["SUCCESS", "NOT_ATTEMPTED", "FAILED", "USER_DROPPED", "VOID", "CANCELLED", "PENDING"]
SUCCESS
, NOT_ATTEMPTED
, FAILED
, USER_DROPPED
, VOID
, CANCELLED
, PENDING
If preauth enabled for account you will get this body
payment method card object in payment entity
Was this page helpful?