# Payments Method | HTTP request | Description ------------- | ------------- | ------------- [**PGOrderFetchPayment**](Payments.md#PGOrderFetchPayment) | **Get** /orders/{order_id}/payments/{cf_payment_id} | Get Payment by ID [**PGOrderFetchPayments**](Payments.md#PGOrderFetchPayments) | **Get** /orders/{order_id}/payments | Get Payments for an Order [**PGPayOrder**](Payments.md#PGPayOrder) | **Post** /orders/sessions | Order Pay [**PGAuthorizeOrder**](Payments.md#PGAuthorizeOrder) | **Post** /orders/{order_id}/authorization | Preauthorization [**PGOrderAuthenticatePayment**](Payments.md#PGOrderAuthenticatePayment) | **Post** /orders/pay/authenticate/{cf_payment_id} | Submit or Resend OTP ## PGOrderFetchPayment > PGOrderFetchPayment(x_api_version: string, order_id: string, cf_payment_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> Get Payment by ID ([Docs](https://docs.cashfree.com/reference/pgorderfetchpayment)) ### Example ```javascript Cashfree.PGOrderFetchPayment("2022-09-01", "order_342WhBoQTXIsQsc75BGEAVKY5QLWF", "2150153399").then((response) => { console.log('Payment fetched successfully:', response.data); }) .catch((error) => { console.error('Error fetching payment details', error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xApiVersion** | **string*** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] **orderId** | **string*** | The id which uniquely identifies your order | **cfPaymentId** | **string*** | The Cashfree payment or transaction ID. | **xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | ### Response ```json { "cf_payment_id": 12376123, "order_id": "order_8123", "entity": "payment", "payment_currency": "INR", "error_details": null, "order_amount": 10.01, "is_captured": true, "payment_group": "upi", "authorization": { "action": "CAPTURE", "status": "PENDING", "captured_amount": 100, "start_time": "2022-02-09T18:04:34+05:30", "end_time": "2022-02-19T18:04:34+05:30", "approve_by": "2022-02-09T18:04:34+05:30", "action_reference": "6595231908096894505959", "action_time": "2022-08-03T16:09:51" }, "payment_method": { "upi": { "channel": "collect", "upi_id": "rohit@xcxcx" } }, "payment_amount": 10.01, "payment_time": "2021-07-23T12:15:06+05:30", "payment_completion_time": "2021-07-23T12:18:59+05:30", "payment_status": "SUCCESS", "payment_message": "Transaction successful", "bank_reference": "P78112898712", "auth_id": "A898101" } ``` ## PGOrderFetchPayments > PGOrderFetchPayments(x_api_version: string, order_id: string, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> Get Payments for an Order ([Docs](https://docs.cashfree.com/reference/pgorderfetchpayments)) ### Example ```javascript Cashfree.PGOrderFetchPayments("2022-09-01", "order_342WhBoQTXIsQsc75BGEAVKY5QLWF").then((response) => { console.log('Payments fetched successfully:', response.data); }) .catch((error) => { console.error('Error fetching payment details', error.response.data); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xApiVersion** | **string*** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] **orderId** | **string*** | The id which uniquely identifies your order | **xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | ### Response ```json [ { "cf_payment_id": 12376123, "order_id": "order_8123", "entity": "payment", "payment_currency": "INR", "error_details": null, "order_amount": 10.01, "is_captured": true, "payment_group": "upi", "authorization": { "action": "CAPTURE", "status": "PENDING", "captured_amount": 100, "start_time": "2022-02-09T18:04:34+05:30", "end_time": "2022-02-19T18:04:34+05:30", "approve_by": "2022-02-09T18:04:34+05:30", "action_reference": "6595231908096894505959", "action_time": "2022-08-03T16:09:51" }, "payment_method": { "upi": { "channel": "collect", "upi_id": "rohit@xcxcx" } }, "payment_amount": 10.01, "payment_time": "2021-07-23T12:15:06+05:30", "payment_completion_time": "2021-07-23T12:18:59+05:30", "payment_status": "SUCCESS", "payment_message": "Transaction successful", "bank_reference": "P78112898712", "auth_id": "A898101" }, { "cf_payment_id": 12376124, "order_id": "order_8123", "entity": "payment", "payment_currency": "INR", "error_details": { "error_code": "TRANSACTION_DECLINED", "error_description": "issuer bank or payment service provider declined the transaction", "error_reason": "auth_declined", "error_source": "customer" }, "order_amount": 10.01, "is_captured": true, "payment_group": "credit_card", "authorization": null, "payment_method": { "card": { "channel": "link", "card_number": "xxxxxx1111" } }, "payment_amount": 10.01, "payment_time": "2021-07-23T12:15:06+05:30", "payment_completion_time": "2021-07-23T12:18:59+05:30", "payment_status": "FAILED", "payment_message": "Transaction failed", "bank_reference": "P78112898712", "auth_id": "A898101" } ] ``` ## PGPayOrder > PGPayOrder(x_api_version: string, PayOrderRequest: PayOrderRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> Order Pay ([Docs](https://docs.cashfree.com/reference/pgpayorder)) ## Example #### Card ```javascript const orderPayRequest = { "payment_session_id": "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", "payment_method": { "card": { "channel": "link", "card_holder_name": "Test", "card_number": "4111111111111111", "card_expiry_mm": "12", "card_expiry_yy": "30", "card_cvv": "123" } } } Cashfree.PGPayOrder("2022-09-01", orderPayRequest).then((response) => { console.log('Transaction Initiated successfully:', response.data); }) .catch((error) => { console.error('Error creating transaction:', error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **payOrderRequest** | **PayOrderRequest*** | Request body to create a transaction at cashfree using `payment_session_id` | **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] **xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | #### Netbanking ```javascript const orderPayRequest = { "payment_session_id": "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", "payment_method": { "netbanking": { "channel": "link", "netbanking_bank_code": 3021 } } } ``` #### UPI ```javascript const orderPayRequest = { "payment_session_id": "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", "payment_method": { "upi": { "channel": "collect", "upi_id": "testsuccess@gocash" } } } ``` #### UPI ```javascript const orderPayRequest = { "payment_session_id": "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", "payment_method": { "upi": { "channel": "link" } } } ``` #### QR ```javascript const orderPayRequest = { "payment_session_id": "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", "payment_method": { "upi": { "channel": "qrcode" } } } ``` #### Wallet ```javascript const orderPayRequest = { "payment_session_id": "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", "payment_method": { "app": { "provider": "phonepe", "channel": "link", "phone": "8474090589" } } } ``` #### Card (with saving it) ```javascript const orderPayRequest = { "payment_session_id": "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", "payment_method": { "card": { "channel": "link", "card_holder_name": "Test", "card_number": "4111111111111111", "card_expiry_mm": "12", "card_expiry_yy": "30", "card_cvv": "123" } }, "save_instrument": true } ``` #### Card with saved instrument ```javascript const orderPayRequest = { "payment_session_id": "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", "payment_method": { "card": { "channel": "link", "instrument_id": "54deabb4-ba45-4a60-9e6a-9c016fe7ab10", "card_cvv": "900" } } } ``` #### Card (with native otp) ```javascript const orderPayRequest = { "payment_session_id": "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", "payment_method": { "card": { "channel": "post", "card_number": "4111111111111111", "card_expiry_mm": "03", "card_expiry_yy": "25", "card_cvv": "326" } } } ``` #### EMI ```javascript const orderPayRequest = { "payment_session_id": "session_CLLC8TuxmB48U8pYJy4z8Ktk9Eh6IMnJzAScehfhKRarvab9KCl09YNxLsDjfeU104u4bqcKgk3ckbIsGsAWHBjvlv0XhRlJEzx4E5cLUHRC", "payment_method": { "emi": { "channel": "link", "card_number": "4748461111111111", "card_expiry_mm": "12", "card_expiry_yy": "24", "card_cvv": "123", "card_bank_name": "ICICI", "emi_tenure": 3 } } } ``` ### Response ```json { "payment_method": "card", "channel": "link", "action": "link", "cf_payment_id": 91235, "payment_amount": 22.42, "data": { "url": "https://sandbox.cashfree.com/pg/view/gateway/FHsuvhayLM5mmhINoqri7ba296e2ebca8b98e6119f6223021a13", "payload": { "name": "card" }, "content_type": "application/x-www-form-urlencoded", "method": "post" } } ``` ## PGAuthorizeOrder > PGAuthorizeOrder(x_api_version: string, order_id: string, AuthorizeOrderRequest: AuthorizeOrderRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> Preauthorization ([Docs](https://docs.cashfree.com/reference/pgauthorizeorder)) ### Example ```javascript const request = { "action": "CAPTURE", // or VOID "amount": 1 } Cashfree.PGAuthorizeOrder("2022-09-01", "order_342WhBoQTXIsQsc75BGEAVKY5QLWF", request).then((response) => { console.log('Authorize Order successful:', response.data); }) .catch((error) => { console.error('Error on authorize order call:', error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **string*** | The id which uniquely identifies your order | **authorizeOrderRequest** | **AuthorizeOrderRequest*** | Request to Capture or Void Transactions | **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] **xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | ### Response ```json { "cf_payment_id": 12376123, "order_id": "order_8123", "entity": "payment", "payment_currency": "INR", "error_details": null, "order_amount": 10.01, "is_captured": true, "payment_group": "upi", "authorization": { "action": "CAPTURE", "status": "PENDING", "captured_amount": 100, "start_time": "2022-02-09T18:04:34+05:30", "end_time": "2022-02-19T18:04:34+05:30", "approve_by": "2022-02-09T18:04:34+05:30", "action_reference": "6595231908096894505959", "action_time": "2022-08-03T16:09:51" }, "payment_method": { "upi": { "channel": "collect", "upi_id": "rohit@xcxcx" } }, "payment_amount": 10.01, "payment_time": "2021-07-23T12:15:06+05:30", "payment_completion_time": "2021-07-23T12:18:59+05:30", "payment_status": "SUCCESS", "payment_message": "Transaction successful", "bank_reference": "P78112898712", "auth_id": "A898101" } ``` ## PGOrderAuthenticatePayment > PGOrderAuthenticatePayment(x_api_version: string, cf_payment_id: string, OrderAuthenticatePaymentRequest: OrderAuthenticatePaymentRequest, x_request_id?: string, x_idempotency_key?: string, options?: AxiosRequestConfig): Promise> Submit or Resend OTP ([Docs](https://docs.cashfree.com/reference/pgorderauthenticatepayment)) ### Example ```javascript const request = { "otp": "111000", "action": "SUBMIT_OTP" // or RESEND_OTP } Cashfree.PGOrderAuthenticatePayment("2022-09-01", "14910204607", request).then((response) => { console.log('Authenticate Payment successful:', response.data); }) .catch((error) => { console.error('Error on payment authenticate:', error); }); ``` ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **cfPaymentId** | **string*** | The Cashfree payment or transaction ID. | **xApiVersion** | **string** | API version to be used. Format is in YYYY-MM-DD | [default to "2022-09-01"] **orderAuthenticatePaymentRequest** | **OrderAuthenticatePaymentRequest*** | Request body to submit/resend headless OTP. To use this API make sure you have headless OTP enabled for your account | **xRequestId** | **string** | Request id for the API call. Can be used to resolve tech issues. Communicate this in your tech related queries to cashfree | ### Response ```json { "cf_payment_id": 975654863, "authenticate_status": "FAILED", "action": "SUBMIT_OTP", "payment_message": "otp is invalid" } ```