Skip to main content
GET
/
payment-setting
Get Payment Settings
curl --request GET \
  --url https://api.royalti.io/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"
    }
  ]
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

/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)
typestringFilter by payment setting type
defaultstringFilter by default status (“true” or “false”)
userstringFilter by TenantUserId

​
Code Examples

const response = await fetch('https://api.royalti.io/payment-setting', {
  method: 'GET',
  headers: {
    'Authorization': `Bearer ${token}`,
  },
});

const data = await response.json();
console.log(data);

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

​
type
enum<string>

Filter by payment setting type

Available options:
BankWireTransfer,
PayPal
​
default
enum<string>

Filter by default status

Available options:
true,
false
​
user
string

Filter by TenantUserId

Response

Successfully retrieved payment settings

​
totalItems
integer

Total number of payment settings

​
paymentSettings
object[]