> ## Documentation Index
> Fetch the complete documentation index at: https://docs.z2pay.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Configuração de saque
> As taxas e o valor mínimo que se aplicam aos saques da sua conta.
`GET /withdrawals/config`
Faz parte do recurso [Saques](/pt-BR/withdrawals) — 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 R$ 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](/pt-BR/withdrawals/create).
## Exemplo
```bash theme={null}
curl -G https://api.sandbox.z2pay.com/v1/withdrawals/config \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX" \
-d currency=BRL
```
```json Resposta 200 theme={null}
{
"currency": "BRL",
"feePercentage": 1.5,
"feeFixed": 350,
"minimumAmount": 5000
}
```
`feeFixed` e `minimumAmount` vêm em centavos; `feePercentage` é o percentual em si — `1.5`
significa 1,5%.
## OpenAPI
````yaml openapi/psp.json GET /withdrawals/config
openapi: 3.0.3
info:
title: Z2Pay PSP API
version: 1.0.0
description: API pública do PSP — autenticação via API Key (Credential)
servers:
- url: https://api.sandbox.z2pay.com/v1
description: Sandbox
- url: https://api.z2pay.com/v1
description: Produção
security: []
tags:
- name: Cards
description: Cartões salvos de um cliente
- name: Chargebacks
description: Gerenciamento de chargebacks
- name: Customers
description: Gerenciamento de clientes (compradores)
- name: Fees
description: Tabela de taxas da conta (pix, boleto, cartão, saque, refund, chargeback)
- name: Recipients
description: Gerenciamento de recebedores (sellers/merchants que recebem repasses)
- name: Refunds
description: Gerenciamento de reembolsos e estornos
- name: Splits
description: Regras de divisão do valor de uma venda entre recebedores
- name: Transactions
description: Gerenciamento de transações e payments
- name: Wallets
description: Saldo, extrato e resumo da carteira de um recebedor, agrupados por moeda
- name: Webhooks
description: Configuração, gerenciamento e histórico de entregas de webhooks
- name: Withdrawals
description: Solicitação e acompanhamento de saques (payouts) por recipient
paths:
/withdrawals/config:
get:
tags:
- Withdrawals
summary: Configuração de saque
description: >-
Retorna taxas (percentual e fixa) e valor mínimo de saque da company,
opcionalmente por moeda
operationId: WithdrawalController_getConfig
parameters:
- name: currency
in: query
required: false
description: >-
Moeda no padrão ISO 4217. Hoje o único valor aceito é 'BRL'.
Omitida, usa a moeda padrão da sua conta.
schema:
type: string
enum:
- BRL
description: >-
Moeda no padrão ISO 4217. Hoje o único valor aceito é 'BRL'.
Omitida, usa a moeda padrão da sua conta.
responses:
'200':
description: Configuração de saque
content:
application/json:
schema:
type: object
properties:
feePercentage:
type: number
description: Taxa percentual de saque
feeFixed:
type: integer
description: Taxa fixa de saque em centavos
minimumAmount:
type: integer
description: Valor mínimo de saque em centavos
example:
feePercentage: 1.5
feeFixed: 367
minimumAmount: 5000
'400':
description: >-
Requisição inválida — algum parâmetro ou campo do corpo não passou
na validação
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
issues:
type: array
description: >-
Um item por campo rejeitado. Nunca vem vazio: se há
400 de validação, há pelo menos um.
items:
type: object
properties:
path:
type: string
description: >-
Campo que falhou. Vem vazio quando o erro é do
corpo como um todo.
message:
type: string
description: O que há de errado com esse campo.
example:
error:
code: VALIDATION_ERROR
message: Validation failed
issues:
- path: status
message: >-
Status inválido. Valores aceitos: pending,
waiting_payment, paid, refused, canceled, refunded
- path: startDate
message: >-
Data deve ser ISO 8601 com timezone (ex.:
2026-06-24T00:00:00Z)
'401':
description: Chave de API ausente, malformada ou inválida
content:
application/json:
schema:
type: object
properties:
error:
type: object
properties:
code:
type: string
description: >-
Identificador estável do erro. É por ele que você deve
ramificar, não pela mensagem.
message:
type: string
description: >-
Descrição legível. Pode mudar sem aviso e não deve ser
usada em condicional.
example:
error:
code: UNAUTHORIZED
message: Invalid API key
security:
- apiKey: []
components:
securitySchemes:
apiKey:
type: apiKey
in: header
name: x-api-key
description: API Key da Credential (gerada no Backoffice)
````