PayZuDocs

Listar transações

Percorra o histórico de transações da conta filtrando por status, tipo, período ou pela sua própria referência.

Autorização

BearerAuth
AutorizaçãoBearer <token>

Em: header

Parâmetros de query

dateFrom?string

Data inicial (YYYY-MM-DD).

dateTo?string

Data final (YYYY-MM-DD).

limit?number

Itens por página (máximo 1000).

Padrão10
page?number

Número da página (padrão 1).

Padrão1
id?string

ID da transação.

status?string

Status da transação. Aceita CSV: PENDING,COMPLETED,etc.

type?string

Tipo da transação. Aceita CSV: DEPOSIT,WITHDRAW,COMMISSION.

method?string

Método/trilho da transação. Aceita CSV: PIX,BANK_SLIP,INTERNAL_TRANSFER.

amount?number

Filtro por valor. Mínimo 0.01.

Intervalo0.01 <= value
document?string

CPF (11 dígitos) ou CNPJ (14 dígitos), apenas números sem formatação.

Padrão regex^[0-9]{11,14}$
name?string

Filtro por nome.

endToEndId?string

ID end-to-end do Pix.

sortBy?string

Campo pelo qual ordenar

Padrão"createdAt"
Valor em"createdAt" | "updatedAt"
sortDirection?string

Direção da ordenação

Padrão"desc"
Valor em"asc" | "desc"
clientReference?string

Filtra por referência externa

virtualAccount?string

Subconta virtual (até 50 caracteres) usada na criação. Aceito como chave de busca alternativa.

Tamanholength <= 50

Corpo da resposta

application/json

application/json

application/json

application/json

curl --request GET \  --url 'https://api.payzu.processamento.com/v1/user/transactions' \  --header 'Authorization: Bearer $PAYZU_TOKEN'
{
"total": 104,
"pages": 2,
]
}