Skip to main content
GET
Listar regras de platform fee

Authorizations

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

Path Parameters

merchantId
string<uuid>
required

Identificador do merchant

Query Parameters

simulationAmount
integer

Valor da venda simulada, em centavos, usado para calcular fee, sellerNet e buyerInstallmentAmount. Inteiro de 1 a 100000000000. Quando enviado, a resposta traz também simulation, methods e sellerRules[].methods, e coverage passa a incluir os avisos que dependem do valor.

Required range: 1 <= x <= 100000000000

Response

Regras de platform fee, flag de ativação do merchant e taxa calculada por método e por parcela

platformFeeEnabled
boolean
required

Indica se o platform fee está ativo para o merchant

Example:

true

rules
object[]
required

Regras de platform fee ativas da subconta. No crédito, uma regra por parcela. As regras de seller estão em sellerRules.

sellerRules
object[]
required

Sellers com ao menos uma regra própria ativa, ordenados por sellerId. Vazia quando nenhum seller tem regra própria.

coverage
object
required

Estado de cada método e parcela, e avisos sobre a configuração de platform fee

simulation
object

Valor de venda usado nas contas em dinheiro de methods

methods
object[]

Taxa calculada por método de pagamento, na ordem pix, boleto e credit.