Skip to main content
GET
/
v1
/
merchants
/
{merchantId}
/
platform-fee
Listar regras de platform fee
curl --request GET \
  --url https://api.malga.io/v1/merchants/{merchantId}/platform-fee \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Client-Id: <api-key>'
import requests

url = "https://api.malga.io/v1/merchants/{merchantId}/platform-fee"

headers = {
"X-Client-Id": "<api-key>",
"X-Api-Key": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'X-Client-Id': '<api-key>', 'X-Api-Key': '<api-key>'}};

fetch('https://api.malga.io/v1/merchants/{merchantId}/platform-fee', 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.malga.io/v1/merchants/{merchantId}/platform-fee",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-Api-Key: <api-key>",
"X-Client-Id: <api-key>"
],
]);

$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.malga.io/v1/merchants/{merchantId}/platform-fee"

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

req.Header.Add("X-Client-Id", "<api-key>")
req.Header.Add("X-Api-Key", "<api-key>")

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.malga.io/v1/merchants/{merchantId}/platform-fee")
.header("X-Client-Id", "<api-key>")
.header("X-Api-Key", "<api-key>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.malga.io/v1/merchants/{merchantId}/platform-fee")

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

request = Net::HTTP::Get.new(url)
request["X-Client-Id"] = '<api-key>'
request["X-Api-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "platformFeeEnabled": true,
  "rules": [
    {
      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "paymentMethod": "credit",
      "percentage": 3.5,
      "fixedAmount": 50,
      "installment": 3,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
      "paymentMethod": "pix",
      "percentage": null,
      "fixedAmount": 50,
      "installment": null,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    },
    {
      "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
      "paymentMethod": "boleto",
      "percentage": 1,
      "fixedAmount": 100,
      "installment": null,
      "createdAt": "2024-01-15T10:30:00.000Z",
      "updatedAt": "2024-01-15T10:30:00.000Z"
    }
  ]
}

Authorizations

X-Client-Id
string
header
required
X-Api-Key
string
header
required

Path Parameters

merchantId
string<uuid>
required

Identificador do merchant

Response

Lista de regras de platform fee e flag de ativação do merchant

platformFeeEnabled
boolean
required

Indica se o platform fee está ativo para o merchant

Example:

true

rules
object[]
required

Regras de platform fee ativas cadastradas para o merchant