Pular para o conteúdo principal
GET
/
transactions
Listar transações
curl --request GET \
  --url https://api.sandbox.z2pay.com/transactions \
  --header 'x-api-key: <api-key>'

Autorizações

​
x-api-key
string
header
obrigatório

API Key da Credential (gerada no Backoffice)

Parâmetros de consulta

​
page
integer
padrão:1
Intervalo obrigatório: x >= 1
​
limit
integer
padrão:20
Intervalo obrigatório: 1 <= x <= 100
​
currency
string | null
​
status
string | null
​
customerName
string | null
​
customerEmail
string | null
​
customerDocument
string | null
​
customerSearch
string | null
​
id
string | null
​
referenceCode
string | null
​
recipientIds
string | null
​
metadataSearch
string | null
​
startDate
string<date-time> | null
​
endDate
string<date-time> | null
​
paymentMethod
string | null
​
search
string | null
​
dateField
enum<string> | null
Opções disponíveis:
createdAt,
paidAt,
refundedAt,
canceledAt,
chargedbackAt,
protestedAt
​
sortBy
enum<string> | null
Opções disponíveis:
createdAt,
paidAt,
amount,
status,
customerName
​
sortDir
enum<string> | null
Opções disponíveis:
asc,
desc

Resposta

Lista paginada de transações