Skip to main content
GET
/
v1
/
merchants
/
{merchantId}
/
public-settings
Get public settings for a merchant
curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/public-settings
import requests

url = "https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/public-settings"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/public-settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/public-settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/public-settings"

req, _ := http.NewRequest("GET", url, nil)

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/public-settings")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api-sandbox.rinne.com.br/core/v1/merchants/{merchantId}/public-settings")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body
{
  "merchant_id": "merchant_1234567890",
  "team_id": "team_1234567890",
  "app_id": "app_1234567890",
  "name": "Example Merchant",
  "available_methods": [
    "CREDIT_CARD",
    "DEBIT_CARD",
    "PIX"
  ]
}
{
"error": {
"code": "RESOURCE_NOT_FOUND",
"message": "Company with ID '123' not found",
"status": 404,
"path": "/companies/me",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}
{
"error": {
"code": "INTERNAL_SERVER_ERROR",
"message": "An unexpected error occurred",
"status": 500,
"path": "/companies",
"timestamp": "2023-12-01T10:00:00.000Z",
"requestId": "req_123456789"
}
}

Path Parameters

merchantId
string
required

Merchant ID

Response

Public settings retrieved successfully

Public settings for a merchant including encryption configuration and available payment methods. This endpoint is public and does not require authentication.

merchant_id
string
required

Merchant ID, required by rinne-js

Example:

"test-merchant-id"

team_id
string
required

Team ID, required by rinne-js

Example:

"test-team-id"

app_id
string
required

App ID, required by rinne-js

Example:

"test-app-id"

name
string
required

Merchant name (falls back to full_name if name is not available)

Example:

"Example Merchant"

available_methods
enum<string>[]
required

List of available payment methods from all active and enabled affiliations. Payment methods are deduplicated across all affiliations.

Available options:
CREDIT_CARD,
DEBIT_CARD,
PIX,
BOLEPIX
Example:
["CREDIT_CARD", "PIX"]