Skip to main content
GET
/
payment-setting
Get Payment Settings
curl --request GET \
  --url https://server26-dot-royalti-project.uc.r.appspot.com/payment-setting \
  --header 'Authorization: Bearer <token>'
{
  "totalItems": 5,
  "paymentSettings": [
    {
      "id": "24d2c371-4a7a-4acd-b4aa-d3eb3bebd8fa",
      "name": "Primary Bank Account",
      "type": "BankWireTransfer",
      "settings": {
        "bankName": "Bank of Example",
        "accountNumber": "123456789",
        "currency": "USD"
      },
      "isDefault": true,
      "memo": "Main operational account",
      "createdAt": "2023-11-22T20:48:36.034Z",
      "updatedAt": "2023-11-22T20:48:36.034Z"
    }
  ]
}
/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
Query Parameters:
ParameterTypeDescription
qstringGlobal search parameter
pagenumberPage number for pagination (default: 1)
sizenumberNumber of items per page (default: 10)
orderstringSort order: ‘asc’ or ‘desc’ (default: ‘desc’)
sortstringField to sort by (default: ‘updatedAt’)
attributesstringComma-separated list of fields to return
typestringFilter by payment setting type
isDefaultbooleanFilter by default status

Authentication

This endpoint requires authentication. Include your bearer token in the Authorization header.

Query Parameters

ParameterTypeInRequiredDescription
qstringqueryGlobal search parameter
pageintegerqueryPage number for pagination
sizeintegerqueryNumber of items per page
orderstringquerySort order
sortstringqueryField to sort by
attributesstringqueryComma-separated list of fields to return
typestringqueryFilter by payment setting type
isDefaultbooleanqueryFilter by default status

Responses

✅ 200 - Successfully retrieved payment settings

⚠️ 401 - Unauthorized

❌ 500 - Internal Server Error

Tags

Payment Settings

Authorizations

Authorization
string
header
required

JWT Authorization header using the Bearer scheme. Format: "Bearer {token}"

Query Parameters

q
string

Global search parameter

page
integer
default:1

Page number for pagination

size
integer
default:10

Number of items per page

order
enum<string>
default:desc

Sort order

Available options:
asc,
desc
sort
string
default:updatedAt

Field to sort by

attributes
string

Comma-separated list of fields to return

type
enum<string>

Filter by payment setting type

Available options:
BankWireTransfer,
PayPal,
Card,
Crypto
isDefault
boolean

Filter by default status

Response

Successfully retrieved payment settings

totalItems
integer

Total number of payment settings

paymentSettings
object[]
I