> ## Documentation Index
> Fetch the complete documentation index at: https://apidocs.royalti.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Update Payment Setting

> **Update Payment Setting**

<Note>
  This endpoint requires authentication. Include your Bearer token in the Authorization header.
</Note>

## Description

**Update Payment Setting**

**Description:**\
The `/payment-setting/{id}` endpoint allows updating details of a specific payment setting.

**Method:**\
`PUT`

**Path Parameter:**

| Parameter | Type   | Description                                  |
| --------- | ------ | -------------------------------------------- |
| id        | string | The unique identifier of the payment setting |

**Body Parameter:**

| Parameter | Type    | Description                                       |
| --------- | ------- | ------------------------------------------------- |
| 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                      |

## Code Examples

<CodeGroup>
  ```javascript Node.js theme={null}
  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);
  ```

  ```python Python theme={null}
  import requests

  response = requests.put(
    'https://api.royalti.io/payment-setting/example-id',
    headers={
      'Authorization': f'Bearer {token}'
    },
    json={"name":"sample-name","type":"sample-type","settings":{},"isDefault":true,"memo":"sample-memo"}
  )

  data = response.json()
  print(data)
  ```

  ```bash cURL theme={null}
  curl -X PUT https://api.royalti.io/payment-setting/example-id \
    -H "Authorization: Bearer YOUR_TOKEN" \
    -H "Content-Type: application/json" \
    -d '{"name":"sample-name","type":"sample-type","settings":{},"isDefault":true,"memo":"sample-memo"}'

  ```
</CodeGroup>


## OpenAPI

````yaml put /payment-setting/{id}
openapi: 3.0.0
info:
  title: Royalti.io API
  description: "# Royalti API\r\n\r\nThis is the Royalti music royalty management platform API server.\r\n\r\n## Overview\r\n\r\nThe Royalti API provides comprehensive music royalty management services including:\r\n- Music publishing and writer management\r\n- Royalty processing and analytics\r\n- DDEX integration for music industry standards\r\n- File processing and pattern recognition\r\n- Payment processing and distribution\r\n\r\n## Authentication\r\n\r\nThe API uses JWT-based authentication with multiple protection levels:\r\n- Public endpoints for basic operations\r\n- Protected endpoints requiring valid JWT tokens\r\n- Admin endpoints for administrative functions\r\n\r\n## Features\r\n\r\n- Multi-dimensional royalty analytics\r\n- CWR (Collective Works Registration) support\r\n- DDEX integration for music metadata\r\n- Advanced file processing with pattern recognition\r\n- Real-time data processing with queue system"
  version: 2.6.0
  contact:
    name: Royalti.io Support
    email: support@royalti.io
    url: https://royalti.io
  license:
    name: Proprietary
    url: https://royalti.io/terms
servers:
  - url: https://api.royalti.io
    description: Production server
  - url: https://api-dev.royalti.io
    description: Development server
  - url: http://localhost:8084
    description: Local development
security:
  - bearerAuth: []
tags:
  - name: Accounting
    description: Accounting and financial transaction operations
  - name: DDEX
    description: DDEX operations (ERN/MEAD, messages, delivery, providers)
  - name: Label
    description: Label management operations
  - name: Internal Webhooks
    description: Internal system webhooks for royalty processing and downloads
  - name: Payment Webhooks
    description: Payment processor webhook endpoints
  - name: Billing Webhooks
    description: Stripe billing and subscription webhooks
  - name: Infrastructure Webhooks
    description: Cloudflare domain and SSL webhooks
  - name: Distribution Webhooks
    description: Digital distribution platform webhooks (FUGA)
paths:
  /payment-setting/{id}:
    put:
      tags:
        - Payment Settings
      summary: Update Payment Setting
      description: >-
        **Update Payment Setting**


        **Description:**  

        The `/payment-setting/{id}` endpoint allows updating details of a
        specific payment setting.


        **Method:**  

        `PUT`


        **Path Parameter:**


        | Parameter | Type | Description |

        | --- | --- | --- |

        | id | string | The unique identifier of the payment setting |



        **Body Parameter:**

        | Parameter | Type | Description |

        | --- | --- | --- |

        | 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 |
      parameters:
        - name: id
          in: path
          required: true
          description: Payment Setting ID
          schema:
            type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the payment setting
                type:
                  type: string
                  description: The type of the payment setting
                settings:
                  type: object
                  description: The settings/configuration of the payment setting
                isDefault:
                  type: boolean
                  description: Whether this is the default payment setting
                memo:
                  type: string
                  description: Additional notes or comments
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  paymentSetting:
                    type: object
              example:
                message: Payment setting updated successfully
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - bearerAuth: []
components:
  schemas:
    Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: array
              items:
                type: string
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        JWT Authorization header using the Bearer scheme. Format: "Bearer
        {token}"

````