Skip to main content
GET

Parâmetros de query

number
Página (padrão 1).
number
Itens por página (padrão 50, máx. 100).
string
ISO 8601 — início (createdAt).
string
ISO 8601 — fim (createdAt).
string
PENDING, CONFIRMED, RECEIVED, OVERDUE, CANCELED, REFUNDED, FAILED, etc.
string
BOLETO, CARD_CREDIT, CARD_DEBIT, CARD_VOUCHER ou PIX.
string
Alias de method (mesmos valores).
string
Filtrar por cliente cadastrado.
string
Referência externa informada no create.
Busca em id, externalReference, externalId (pay_...) ou descrição.

Authorizations

X-API-Key
string
header
required

Chave wp_live_... criada em Integrações → Chaves de API no dashboard.

Query Parameters

page
integer
default:1
Required range: x >= 1
pageSize
integer
default:50
Required range: 1 <= x <= 100
dateFrom
string<date-time>
dateTo
string<date-time>
status
enum<string>
Available options:
PENDING,
PROCESSING,
CONFIRMED,
RECEIVED,
SETTLED,
OVERDUE,
CANCELED,
FAILED,
REFUNDED,
PARTIALLY_REFUNDED,
CHARGEBACK
method
enum<string>
Available options:
BOLETO,
CARD_CREDIT,
CARD_DEBIT,
CARD_VOUCHER,
PIX
billingType
enum<string>
Available options:
BOLETO,
CARD_CREDIT,
CARD_DEBIT,
CARD_VOUCHER,
PIX
salesCustomerId
string
externalReference
string

Response

200 - application/json

Operação concluída.

success
boolean
required
Example:

true

message
string
required
Example:

"Operação concluída com sucesso"

data
object
required
requestId
string