Simular Taxa

Disponibilizamos um endpoint específico para simulação de taxas, permitindo calcular previamente os valores envolvidos em uma transação.

Certifique-se de que o valor esteja sempre no formato inteiro (int), representado em centavos.

Parâmetros de entrada

Nome

amount *

Tipo

int

Descrição

Especifique o valor a ser simulado, em centavos. Por exemplo, para simular R$ 10,00, utilize o valor 1000.

Dados da resposta

Nome

gross_amount *

Tipo

int

Descrição

Valor bruto a ser recebido. Valor pago pelo cliente.
Nome

net_amount *

Tipo

int

Descrição

Valor líquido a ser recebido. Seu lucro final da transação.
Nome

fee_total *

Tipo

int

Descrição

Valor total da taxa a ser cobrada. Esse valor é o somatório de todas as taxas aplicadas.
Nome

fee_percent *

Tipo

int

Descrição

Percentual da taxa cobrada. Esse valor é o percentual aplicado sobre o valor bruto.
Nome

fee_fixed *

Tipo

int

Descrição

Valor fixo da taxa cobrada. Esse valor é o valor fixo aplicado sobre o valor bruto.
Nome

currency *

Tipo

string

Descrição

Moeda utilizada na transação. [BRL, USDT, BTC ...]
Nome

direction *

Tipo

string

Descrição

Direção da transação. [in, out]

GET /api/v1/account/simulate-fee/{amount}

$client = new Client();

$amount = 1000; // valor em centavos

$headers = [
    'Accept' => 'application/json',
    'Content-Type' => 'application/json',
    'x-client-id' => '20d80764-69da-4ce9-ac32-2c91c4772a2e',
    'x-client-secret' => 'MTIwZDgwNzY0LTY53GMtNGNjOS1hYuYyLThaOTNjNDc9M2EyZQ=='
];

$request = new Request('GET', 'https://api.grupay.app/v1/simulate-fee/'.$amount, $headers);
$res = $client->sendAsync($request)->wait();
echo $res->getBody();

200 Sucesso

[
    {
        "gross_amount": 1000,
        "net_amount": 891,
        "fee_total": 109,
        "fee_percent": 20,
        "fee_fixed": 89,
        "currency": "BRL",
        "direction": "in"
    },
    {
        "gross_amount": 1000,
        "net_amount": 1000,
        "fee_total": 50,
        "fee_percent": 0,
        "fee_fixed": 50,
        "currency": "BRL",
        "direction": "out"
    }
]

402 Saldo insuficiente para cobrir taxas

{
    "message": "Insufficient balance to cover cashout and fees",
}