Skip to main content
GET
/
v1
/
pricing
/
cost-policies
List cost policies
curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/pricing/cost-policies \
  --header 'x-api-key: <api-key>'
{
  "data": [
    {
      "id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
      "name": "celcoin-retail-costs",
      "description": "Cost structure for Celcoin retail transactions",
      "is_active": true,
      "mcc": "5411",
      "provider": "CELCOIN",
      "cashout_price": 300,
      "organization_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2794",
      "rules": [
        {
          "conditions": [
            {
              "field": "transaction.payment_method",
              "operator": "EQUALS",
              "value": "credit_card"
            }
          ],
          "price": {
            "percentage": 2.5,
            "flat": 50,
            "minimum_price": 100
          },
          "priority": 1,
          "id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
          "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",
      "metadata": {
        "industry": "retail",
        "tier": "premium"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 20,
    "total": 50,
    "totalPages": 3,
    "hasNext": true,
    "hasPrev": false
  }
}

Authorizations

​
x-api-key
string
header
required

Company API key for authentication

Query Parameters

​
name
string

Filter by cost policy name

​
is_active
boolean

Filter by active status

​
id
string

Filter by cost policy ID

​
mcc
string

Filter by MCC (4 digits)

​
provider
enum<string>

Filter by provider name (accepts lowercase and uppercase, returns uppercase)

Available options:
CELCOIN,
RINNE
​
page
integer
default:1

Page number

Required range: x >= 1
​
limit
integer
default:20

Number of items per page

Required range: 1 <= x <= 100

Response

List of cost policies

​
data
object[]
​
pagination
object