Skip to main content
GET
/
api
/
payment
/
methods
Payment Methods
curl --request GET \
  --url https://api.example.com/api/payment/methods
[
  {
    "id": 1,
    "name": "Cash on Delivery",
    "value": "cod",
    "payment_type": "cod",
    "image": "https://cdn.example.com/cod-icon.png"
  },
  {
    "id": 2,
    "name": "UPI",
    "value": "upi",
    "payment_type": "prepaid",
    "image": "https://cdn.example.com/upi-icon.png"
  },
  {
    "id": 3,
    "name": "Credit/Debit Card",
    "value": "card",
    "payment_type": "prepaid",
    "image": "https://cdn.example.com/card-icon.png"
  }
]
This endpoint returns all active payment methods based on cart eligibility and amount.

​
Authentication

Requires user authentication token in the request header.

​
Query Parameters

​
platform
string
Platform identifier (web/app)

​
Response

Returns an array of available payment methods.
​
id
integer
Unique payment method identifier
​
name
string
Display name of the payment method
​
value
string
Payment method value/code (e.g., “cod”, “upi”, “card”)
​
payment_type
string
Type of payment (prepaid/cod)
​
image
string
Image URL for the payment method icon
[
  {
    "id": 1,
    "name": "Cash on Delivery",
    "value": "cod",
    "payment_type": "cod",
    "image": "https://cdn.example.com/cod-icon.png"
  },
  {
    "id": 2,
    "name": "UPI",
    "value": "upi",
    "payment_type": "prepaid",
    "image": "https://cdn.example.com/upi-icon.png"
  },
  {
    "id": 3,
    "name": "Credit/Debit Card",
    "value": "card",
    "payment_type": "prepaid",
    "image": "https://cdn.example.com/card-icon.png"
  }
]

​
Eligibility Check

The endpoint automatically filters out payment methods that are ineligible based on:
  • Cart total amount
  • User’s payment history
  • Geographic restrictions
  • Product-specific limitations

​
COD Restrictions

Cash on Delivery may be restricted based on:
  • Maximum order value (configured in settings)
  • Minimum order value requirements
  • Pincode/location eligibility
  • Gift vouchers in cart (COD not applicable)
  • User’s previous order history (RTO cases)
  • Product-level COD restrictions

​
Error Responses

​
title
string
Error title
​
description
string
Detailed error message
{
  "title": "Bad Request",
  "description": "Authentication required"
}

Build docs developers (and LLMs) love

Get started for freeTalk to us