Skip to main content
PATCH
/
v1
/
pricing
/
fee-policies
/
{id}
curl --request PATCH \
--url https://api-sandbox.rinne.com.br/core/v1/pricing/fee-policies/{id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"name": "updated-fee-policy",
"is_active": false
}'
{
  "id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
  "name": "standard-card-fees",
  "description": "Standard fee structure for card transactions",
  "is_active": true,
  "cashout_price": 350,
  "organization_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2794",
  "rules": [
    {
      "id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
      "conditions": [
        {
          "field": "transaction.payment_method",
          "operator": "EQUALS",
          "value": "credit_card"
        }
      ],
      "price": {
        "percentage": 2.5,
        "flat": 50,
        "minimum_price": 100
      },
      "priority": 1,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

Company API key for authentication

Path Parameters

id
string<uuid>
required

The ID of the fee policy to update

Body

application/json

Fee policy update request. All fields are optional. Rules can be selectively updated by including their ID, or new rules can be added by omitting the ID.

name
string
Required string length: 1 - 100
description
string
Maximum length: 500
is_active
boolean
cashout_price
integer

Cashout price in cents (fixed fee for cashout operations)

Required range: x >= 0
Example:

350

rules
object[]

Rules to update or add. Rules with IDs update existing rules (others preserved). Rules without IDs create new rules. Omitted rules remain unchanged.

Minimum length: 1

Response

Fee policy updated successfully

Fee policy response

id
string

Policy ID

Example:

"a3dbd0c2-9f79-4f86-8caa-47779b3f2793"

name
string
Example:

"standard-card-fees"

description
string | null
Example:

"Standard fee structure for card transactions"

is_active
boolean
Example:

true

cashout_price
integer

Cashout price in cents (fixed fee for cashout operations)

Example:

350

organization_id
string

Organization company ID

Example:

"a3dbd0c2-9f79-4f86-8caa-47779b3f2794"

rules
object[]
created_at
string<date-time>
updated_at
string<date-time>