curl --request GET \
--url https://api.sandbox.z2pay.com/v1/wallets/owner/{ownerId}/transactions \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/wallets/owner/{ownerId}/transactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/wallets/owner/{ownerId}/transactions"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": "wtx_ehhx0od2vo18mq28n9h9npcjx",
"type": "sale",
"flow": "credit",
"amount": 49900,
"currency": "BRL",
"scheduledFor": "2025-07-15T13:45:30.000Z",
"entityId": "rcv_h2wq8tz4mxk9rpf5snc7ydv3b",
"entityType": "receivable",
"description": null,
"installmentNumber": 1,
"createdAt": "2025-06-29T13:45:30.000Z"
},
{
"id": "wtx_ovpw4jyq10b8pn6n07elun2de",
"type": "withdrawal",
"flow": "debit",
"amount": -25000,
"currency": "BRL",
"scheduledFor": null,
"entityId": "wdr_z4hq8wt2mxk9rpf5snc7ydv3b",
"entityType": "withdrawal",
"description": null,
"installmentNumber": null,
"createdAt": "2025-06-29T13:45:30.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 87,
"totalPages": 5
}
}{
"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"
}
}Extrato do recebedor
Extrato paginado do recebedor, com filtros por natureza do lançamento, direção, origem, moeda, disponibilidade e período.
curl --request GET \
--url https://api.sandbox.z2pay.com/v1/wallets/owner/{ownerId}/transactions \
--header 'x-api-key: <api-key>'const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.sandbox.z2pay.com/v1/wallets/owner/{ownerId}/transactions', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.sandbox.z2pay.com/v1/wallets/owner/{ownerId}/transactions"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"data": [
{
"id": "wtx_ehhx0od2vo18mq28n9h9npcjx",
"type": "sale",
"flow": "credit",
"amount": 49900,
"currency": "BRL",
"scheduledFor": "2025-07-15T13:45:30.000Z",
"entityId": "rcv_h2wq8tz4mxk9rpf5snc7ydv3b",
"entityType": "receivable",
"description": null,
"installmentNumber": 1,
"createdAt": "2025-06-29T13:45:30.000Z"
},
{
"id": "wtx_ovpw4jyq10b8pn6n07elun2de",
"type": "withdrawal",
"flow": "debit",
"amount": -25000,
"currency": "BRL",
"scheduledFor": null,
"entityId": "wdr_z4hq8wt2mxk9rpf5snc7ydv3b",
"entityType": "withdrawal",
"description": null,
"installmentNumber": null,
"createdAt": "2025-06-29T13:45:30.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 87,
"totalPages": 5
}
}{
"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 /wallets/owner/{ownerId}/transactions
Faz parte do recurso Carteiras — o que cada saldo significa está lá.
Retorna o extrato do lançamento mais recente para o mais antigo, consolidando todas as
carteiras do recebedor; cada lançamento traz a própria moeda. A página vem com limit 20 por
padrão e aceita até 100 — confira pagination.totalPages antes de concluir que o extrato
acabou. Todos os filtros são opcionais e podem ser combinados; as datas seguem ISO 8601 com
timezone (veja Convenções).
400, não é ignorado. ?flow=entrada recusa a
requisição inteira, sem devolver resultado parcial.amount negativo. O sinal acompanha o flow: credit é positivo, debit
é negativo — uma taxa aparece como flow: "debit" com amount: -12500. Somar o amount de
todos os lançamentos dá o efeito líquido direto; não aplique o flow por cima do sinal, ou
todo débito conta em dobro.releaseStatus separa o que já dá para sacar. released é o que está disponível;
pending ainda está no prazo de liberação e o campo scheduledFor diz quando cai. O saldo
sacável não é a soma do extrato inteiro.transactionId: a venda, as taxas e eventuais
estornos daquela transação vêm juntos, e é assim que se explica a diferença entre o valor da
venda e o que entrou na carteira.Exemplo
curl -G https://api.sandbox.z2pay.com/v1/wallets/owner/rec_tazseadvfg6aym95njwzvc6fs/transactions \
-H "x-api-key: SUA_CHAVE_DE_SANDBOX" \
--data-urlencode "releaseStatus=released" \
--data-urlencode "limit=20"
{
"data": [
{
"id": "wtx_rjxtclwyb5pq7jzios7kgonna",
"type": "sale",
"flow": "credit",
"amount": 250000,
"currency": "BRL",
"scheduledFor": "2026-06-25T00:00:00.000Z",
"entityId": "txn_behjghpqfcnfp2ufpi33kei4v",
"entityType": "transaction",
"description": "Venda - pedido #1042",
"installmentNumber": null,
"createdAt": "2026-06-10T14:32:00.000Z"
},
{
"id": "wtx_egdpubba2i9ucnwxgopbo1dp4",
"type": "fee",
"flow": "debit",
"amount": -12500,
"currency": "BRL",
"scheduledFor": null,
"entityId": "txn_behjghpqfcnfp2ufpi33kei4v",
"entityType": "transaction",
"description": "Taxa de processamento",
"installmentNumber": null,
"createdAt": "2026-06-10T14:32:00.000Z"
}
],
"pagination": {
"page": 1,
"limit": 20,
"total": 84,
"totalPages": 5
}
}
Authorizations
API Key da Credential (gerada no Backoffice)
Path Parameters
ID do recebedor
Query Parameters
Natureza do lançamento: sale, refund, chargeback, chargeback_reversal, pending_refund, pending_refund_reversal, anticipation, fee, withdrawal, adjustment, manual ou transfer. Aceita vários valores separados por vírgula e tem precedência sobre type.
sale, refund, chargeback, chargeback_reversal, pending_refund, pending_refund_reversal, anticipation, fee, withdrawal, adjustment, manual, transfer Direção do lançamento: credit (entrada) ou debit (saída). Débitos vêm com amount negativo — o sinal e o flow contam a mesma coisa.
credit, debit Origem do lançamento: psp_import (recebido do adquirente), platform_calc (calculado na liquidação) ou manual (ajuste lançado por um operador).
psp_import, platform_calc, manual Moeda no padrão ISO 4217 (ex.: BRL). Um valor por requisição.
Disponibilidade do valor: released (já disponível para saque) ou pending (ainda a liberar).
released, pending Traz lançamentos criados a partir deste instante (ISO 8601 com timezone), inclusive.
Traz lançamentos criados até este instante (ISO 8601 com timezone), inclusive.
Retorna os lançamentos originados desta transação (txn_). Correspondência exata — útil para reconstruir venda, taxas e estornos de um mesmo pedido.
1Página da listagem. Padrão: 1.
x >= 1Itens por página. Padrão: 20. Máximo: 100.
1 <= x <= 100