Configuração de saque
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/withdrawals/config \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/withdrawals/config', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/withdrawals/config"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"feePercentage": 1.5,
"feeFixed": 367,
"minimumAmount": 5000
}{
"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)"
}
]
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}Saques
Configuração de saque
As taxas e o valor mínimo que se aplicam aos saques da sua conta.
GET
/
withdrawals
/
config
Configuração de saque
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/withdrawals/config \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/withdrawals/config', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/withdrawals/config"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"feePercentage": 1.5,
"feeFixed": 367,
"minimumAmount": 5000
}{
"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)"
}
]
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "Invalid API key"
}
}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 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
curl -G https://api.sandbox.z2pay.com/v1/withdrawals/config \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX" \
-d currency=BRL
Resposta 200
{
"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%.Authorizations
API Key da Credential (gerada no Backoffice)
Query Parameters
Moeda no padrão ISO 4217. Hoje o único valor aceito é 'BRL'. Omitida, usa a moeda padrão da sua conta.
Available options:
BRL