List Payment Methods

Retrieves a list of payment methods with optional filtering and pagination.

HTTP Request

GET/api/payment/methods

Authorization

Required: Yes
Permission: Staff with PaymentMethodPermission or Admin
Permission Code: 2402
Authentication: Token-based (Authorization: Token <your_api_key>)

Query Parameters

Parameter	Type	Default	Description
limit	integer	10	Number of results per page
offset	integer	0	Number of results to skip
ordering	string	-created_at	Sort order (`id`, `name`, `order`, `active`, `created_at`, `updated_at`)
search	string	—	Search in (`id`, `name`, `description`)
id_min	integer	—	Minimum ID filter
id_max	integer	—	Maximum ID filter
created_date	string	—	Filter by creation date (e.g., 2023-01-01)
updated_date	string	—	Filter by last updated date (e.g., 2023-01-01)
created_from	string	—	Filter by creation date range start
created_to	string	—	Filter by creation date range end
updated_from	string	—	Filter by last updated date range start
updated_to	string	—	Filter by last updated date range end
backend	string	—	Filter by backend type (`zarinpal`, `pay-on-delivery`)
active	boolean	—	Filter by active status
order_min	integer	—	Minimum row-order value filter
order_max	integer	—	Maximum row-order value filter
has_image	boolean	—	Filter payment methods with/without an associated image

Example Requests

🐍 Python
🌐 Curl

1import requests
2
3# List all payment methods
4response = requests.get('http://www.example.com/api/payment/methods',
5  headers={'Authorization': 'Token <your_api_key>'}
6)
7print(response.json())
8
9# List active payment methods only
10response = requests.get('http://www.example.com/api/payment/methods', params={
11  'active': True,
12  'ordering': 'order'
13}, headers={'Authorization': 'Token <your_api_key>'})
14print(response.json())
15
16# Filter by backend type
17response = requests.get('http://www.example.com/api/payment/methods', params={
18  'backend': 'zarinpal',
19  'active': True
20}, headers={'Authorization': 'Token <your_api_key>'})
21print(response.json())

1# List all payment methods
2curl "http://www.example.com/api/payment/methods" \
3-H "Authorization: Token <your_api_key>"
4
5# List active payment methods only
6curl "http://www.example.com/api/payment/methods?active=true&ordering=order" \
7-H "Authorization: Token <your_api_key>"
8
9# Filter by backend type
10curl "http://www.example.com/api/payment/methods?backend=zarinpal&active=true" \
11-H "Authorization: Token <your_api_key>"

Response Fields

Field	Type	Description
count	Integer	Total number of categories
next	String	URL for the next page of results
previous	String	URL for the previous page of results
results	Array[Object]	Array of payment method objects

PaymentMethod Object Structure

Field	Type	Description
id	Integer	Unique ID of the payment method
backend	String	Backend identifier for the payment method (choices: ZaringPal, Zibal, PayOnDelivery)
active	Boolean	Whether the payment method is active
order	Integer	Row-order of the payment method in the list(nullable)
name	String	Name of the payment method (unique)
image_data	Object	Image details (read-only)
description	String	Description of the payment method (nullable)
settings	JsonField	Additional settings for the payment method (default=dict)
auto_approve_payments	Boolean	Whether auto approve the paied bill or not
created_at	String (ISO 8601)	Timestamp when the payment method was created
updated_at	String (ISO 8601)	Timestamp when the payment method was last updated

Image Data Structure

Field	Type	Description
id	Integer	Unique ID of the image
type	String	File type (e.g., image)
mime_type	String	Mime type of the File (e.g., image/jpeg) (nullable)
name	String	Original file name
size	Integer	File size in bytes
human_readable_size	String	Human readable file size (e.g., 2.5 MB)
f	String	URL to access the image file
width	Integer	Image width in pixels
height	Integer	Image height in pixels
mode	String	Color mode (e.g., RGB, CMYK)
thumbnails	List of thumbnail objects	Imgae thumbnails

Thumbnail Data Structure

Field	Type	Description
id	Integer	Unique ID of the thumbnail (unique)
f	String	URL to access the thumbnail file
size	Integer	File size in bytes (nullable)

Example Response

{
    "count": 2,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 2,
            "active": true,
            "backend": "zarinpal",
            "order": 3,
            "name": "زرین پال",
            "image_data": {
                "id": 5,
                "type": "image",
                "mime_type": "image/jpeg",
                "name": "keyboard",
                "size": 2131742,
                "human_readable_size": "2.03 MB",
                "f": "http://127.0.0.1:8000/media/core_media/2025/11/29/Fantasticheskie_kartinki_dlja_monitora_68_96.jpg",
                "width": 2560,
                "height": 1600,
                "mode": "RGB",
                "thumbnails": [
                  {
                      "id": 213,
                      "f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_64x64.jpg",
                      "size": 64
                  },
                  {
                      "id": 214,
                      "f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_128x128.jpg",
                      "size": 128
                  },
                  {
                      "id": 215,
                      "f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_512x512.jpg",
                      "size": 512
                  },
                  {
                      "id": 216,
                      "f": "http://127.0.0.1:8000/media/core_media/2026/02/02/thumbnails/test2_ecH0zVV_thumbnail_1080x1080.jpg",
                      "size": 1080
                  }
              ]
            },
            "description": "پرداخت با درگاه آنلاین زرین پال",
            "settings": {
                "token": "some-very-hard-token"
            },
            "auto_approve_payments": true,
            "created_at": "2025-12-20T17:55:44.361021Z",
            "updated_at": "2025-12-20T17:55:44.361027Z"
        },
        {
            "id": 1,
            "active": true,
            "backend": "pay-on-delivery",
            "order": null,
            "name": "پرداخت در محل",
            "image_data": null,
            "description": "",
            "settings": {},
            "auto_approve_payments": true,
            "created_at": "2025-12-20T17:54:59.658436Z",
            "updated_at": "2025-12-20T17:54:59.658441Z"
        }
    ]
}

HTTP Request​

Authorization​

Authorization

Query Parameters​

Example Requests​

Response Fields​

PaymentMethod Object Structure​

Example Response​

HTTP Request

Authorization

Query Parameters

Example Requests

Response Fields

PaymentMethod Object Structure

Example Response