/payment-setting
The endpoint /payment-settings
allows users to retrieve all payment settings available in the system. Payment settings define various configurations for payment methods, such as bank transfers, credit card payments, etc.
Request Method
GET
Parameter | Type | Description |
---|---|---|
q | string | Global search parameter |
page | number | Page number for pagination (default: 1) |
size | number | Number of items per page (default: 10) |
order | string | Sort order: ‘asc’ or ‘desc’ (default: ‘desc’) |
sort | string | Field to sort by (default: ‘updatedAt’) |
attributes | string | Comma-separated list of fields to return |
type | string | Filter by payment setting type |
isDefault | boolean | Filter by default status |
Authentication
This endpoint requires authentication. Include your bearer token in the Authorization header.Query Parameters
Parameter | Type | In | Required | Description |
---|---|---|---|---|
q | string | query | ❌ | Global search parameter |
page | integer | query | ❌ | Page number for pagination |
size | integer | query | ❌ | Number of items per page |
order | string | query | ❌ | Sort order |
sort | string | query | ❌ | Field to sort by |
attributes | string | query | ❌ | Comma-separated list of fields to return |
type | string | query | ❌ | Filter by payment setting type |
isDefault | boolean | query | ❌ | Filter by default status |
Responses
✅ 200 - Successfully retrieved payment settings
⚠️ 401 - Unauthorized
❌ 500 - Internal Server Error
Tags
Payment Settings
Authorizations
JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"
Query Parameters
Global search parameter
Page number for pagination
Number of items per page
Sort order
Available options:
asc
, desc
Field to sort by
Comma-separated list of fields to return
Filter by payment setting type
Available options:
BankWireTransfer
, PayPal
, Card
, Crypto
Filter by default status