2024-01-23

Documentation

Whats New

  1. POST/customers Create Customer at Cashfree
  2. PATCH/orders/{order_id} Terminate Order

Whats Deleted

    Whats Deprecated

      Whats Changed

      1. GET/customers/{customer_id}/instruments

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.
      2. GET/customers/{customer_id}/instruments/{instrument_id}

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.
      3. DELETE/customers/{customer_id}/instruments/{instrument_id}

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.
      4. GET/customers/{customer_id}/instruments/{instrument_id}/cryptogram

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.
      5. POST/eligibility/cardlessemi Get Eligible Cardless EMI Payment Methods for a customer on an order

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.
      6. POST/eligibility/offers Get Eligible Offers for an Order

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Missing property: [n].entity_details.offer_validations.max_allowed (number)

      7. POST/eligibility/paylater Get Eligible Paylater for a customer on an order

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.
      8. POST/eligibility/payment_methods Get eligible Payment Methods

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Request

          • Schema

            Changed body: application/json
      9. POST/links

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Changed property type: cf_link_id (integer to string)

      10. GET/links/{link_id}

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Changed property type: cf_link_id (integer to string)

      11. POST/links/{link_id}/cancel

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Changed property type: cf_link_id (integer to string)

      12. GET/links/{link_id}/orders

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Missing property: [n].payments (object)

              Missing property: [n].settlements (object)

              Missing property: [n].refunds (object)

              Changed property type: [n].cf_order_id (integer to string)

      13. POST/offers

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Request

          • Schema

            Changed body: application/json

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Missing property: offer_validations.max_allowed (number)

      14. GET/offers/{offer_id}

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Missing property: offer_validations.max_allowed (number)

      15. POST/orders

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Request

          • Schema incompatible

            Changed body: application/json

            Changed property type: terminal.cf_terminal_id (integer to string)

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Missing property: payments (object)

              Missing property: settlements (object)

              Missing property: refunds (object)

              Changed property type: cf_order_id (integer to string)

      16. POST/orders/pay/authenticate/{cf_payment_id}

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Changed property type: cf_payment_id (number to string)

      17. POST/orders/sessions

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Changed property type: cf_payment_id (integer to string)

      18. GET/orders/{order_id}

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Missing property: payments (object)

              Missing property: settlements (object)

              Missing property: refunds (object)

              Changed property type: cf_order_id (integer to string)

      19. POST/orders/{order_id}/authorization

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Changed property type: cf_payment_id (integer to string)

      20. GET/orders/{order_id}/payments

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Response

          • Changed response : [200]//List of payment enttity

            • Schema incompatible

              Changed body: application/json

              Changed property type: [n].cf_payment_id (integer to string)

      21. GET/orders/{order_id}/payments/{cf_payment_id}

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Changed property type: cf_payment_id (integer to string)

      22. GET/orders/{order_id}/refunds

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Changed property type: [n].cf_payment_id (integer to string)

      23. POST/orders/{order_id}/refunds

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Response

          • Changed response : [200]//Refund created

            • Schema incompatible

              Changed body: application/json

              Changed property type: cf_payment_id (integer to string)

      24. GET/orders/{order_id}/refunds/{refund_id}

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Changed property type: cf_payment_id (integer to string)

      25. GET/orders/{order_id}/settlements

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Changed property type: cf_payment_id (integer to string)

              Changed property type: cf_settlement_id (integer to string)

      26. POST/recon

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Changed property type: data[n].cf_payment_id (integer to string)

              Changed property type: data[n].cf_settlement_id (integer to string)

      27. POST/settlement/recon

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Request

          • Schema incompatible

            Changed body: application/json

            Changed property type: filters.cf_settlement_ids[n] (integer to string)

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Changed property type: data[n].cf_payment_id (integer to string)

              Changed property type: data[n].cf_settlement_id (integer to string)

      28. POST/settlements

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Request

          • Schema incompatible

            Changed body: application/json

            Changed property type: filters.cf_settlement_ids[n] (integer to string)

        • Response

          • Changed response : [200]//OK

            • Schema incompatible

              Changed body: application/json

              Changed property type: cf_payment_id (integer to string)

              Changed property type: cf_settlement_id (integer to string)

      29. POST/terminal

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.
      30. GET/terminal/qrcodes

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.
      31. POST/terminal/transactions Create Terminal Transaction

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.

        • Request

          • Schema incompatible

            Changed body: application/json

            Changed property type: cf_order_id (integer to string)

            Changed property type: cf_terminal_id (integer to string)

        • Response

          • Changed response : [200]//Terminal Transaction created

            • Schema incompatible

              Changed body: application/json

              Changed property type: cf_payment_id (integer to string)

      32. GET/terminal/{terminal_phone_no}

        • Parameters

          • x-idempotency-key in header Notes 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. change into 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.