Skip to main content
PUT
/
payment-setting
/
{id}
Update Payment Setting
curl --request PUT \
  --url https://api.royalti.io/payment-setting/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "type": "<string>",
  "settings": {},
  "isDefault": true,
  "memo": "<string>"
}
'
{
  "message": "Payment setting updated successfully"
}
This endpoint requires authentication. Include your Bearer token in the Authorization header.

​
Description

Update Payment Setting Description:
The /payment-setting/{id} endpoint allows updating details of a specific payment setting. Method:
PUT Path Parameter:
ParameterTypeDescription
idstringThe unique identifier of the payment setting
Body Parameter:
ParameterTypeDescription
namestringThe name of the payment setting
typestringThe type of the payment setting
settingsobjectThe settings/configuration of the payment setting
isDefaultbooleanWhether this is the default payment setting
memostringAdditional notes or comments

​
Code Examples

const response = await fetch('https://api.royalti.io/payment-setting/example-id', {
  method: 'PUT',
  headers: {
    'Authorization': `Bearer ${token}`,
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "name": "sample-name",
    "type": "sample-type",
    "settings": {},
    "isDefault": true,
    "memo": "sample-memo"
  })
});

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

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string
required

Payment Setting ID

Body

application/json
​
name
string

The name of the payment setting

​
type
string

The type of the payment setting

​
settings
object

The settings/configuration of the payment setting

​
isDefault
boolean

Whether this is the default payment setting

​
memo
string

Additional notes or comments

Response

Success

​
message
string
​
paymentSetting
object