Skip to main content
GET
Configuração de saque
GET /withdrawals/config Faz parte do recurso Saques — os estados e o fluxo de aprovação estão lá. Devolve o que a sua conta cobra e exige para sacar: taxa percentual, taxa fixa e valor mínimo. É a leitura que permite calcular o líquido antes de pedir.
As duas taxas se somam. O desconto é a parte percentual do valor mais a parte fixa — não é uma ou outra. Com percentual de 1,5% e fixa de R3,50,umsaquedeR 3,50, um saque de R 1.000,00 desconta R$ 18,50.
A configuração é da conta, não do recebedor. Todos os recebedores vinculados sacam sob as mesmas regras. O parâmetro currency restringe a resposta a uma moeda; sem ele, vêm todas as configuradas.
Leia antes de calcular, não depois. As taxas mudam por acordo comercial, e um valor fixado no código da sua integração vai divergir do que a Z2Pay descontar. O líquido confirmado vem no netAmount da solicitação.

Exemplo

Resposta 200
feeFixed e minimumAmount vêm em centavos; feePercentage é o percentual em si — 1.5 significa 1,5%.

Authorizations

x-api-key
string
header
required

API Key da Credential (gerada no Backoffice)

Query Parameters

currency
enum<string>

Moeda no padrão ISO 4217. Hoje o único valor aceito é 'BRL'. Omitida, usa a moeda padrão da sua conta.

Available options:
BRL

Response

Configuração de saque

feePercentage
number

Taxa percentual de saque

feeFixed
integer

Taxa fixa de saque em centavos

minimumAmount
integer

Valor mínimo de saque em centavos