Skip to main content

Get All Payment Methods

Retrieves a list of all available payment methods.

HTTP Request

GET/api/shop/payment/methods

Authorization

Authorization

  • Required: No
  • Permission: Public
  • Authentication: None

Query Parameters

ParameterTypeDefaultDescription
limitintegerNumber of results to return per page.
offsetintegerNumber of results to skip before returning results.
searchstringSearch term to filter results by (`id`, `name`, `description`).
orderingstringField to order results by (`id`, `name`).

Example Requests

1import requests
2response = requests.get('http://www.example.com/api/shop/payment/methods', params={
3  'limit': 5,
4  'ordering': 'name',
5  'search': 'credit'
6})
7print(response.json())

Status Codes

CodeDescription
200List retrieved successfully
400Bad request — invalid input
500Internal server error

Response Fields

FieldTypeDescription
idintegerUnique ID of the payment method.
namestringName of the payment method.
imagestringURL of the payment method's logo image.
descriptionstringDescription of the payment method.