Skip to main content
GET
Buscar transações (v2)

Authorizations

apiKey
string
header
required

API key no formato keyId.secret.

Query Parameters

endLastUpdate
string<date-time>

End date for last update filter (format: ISO date)

startLastUpdate
string<date-time>

Start date for last update filter (format: ISO date)

endDate
string<date-time>

End date filter (format: ISO date)

startDate
string<date-time>

Start date filter (format: ISO date)

status
string[]

Transaction status

clientDoc
string

Client document Documento do cliente, CPF ou CNPJ.

clientId
string

Client ID

subscriptionId
string

Subscription ID

tid
string

Transaction TID

id
string

Transaction ID

companyId
string
required

Company ID

Example:

"company_id"

Response

Lista de transacoes.

_id
string

ID da transacao.

companyId
string

ID da empresa vinculada a transacao.

clientId
string

ID do cliente vinculado, quando houver.

productId
string

ID do produto vinculado, quando houver.

subscriptionId
string

ID da assinatura vinculada, quando houver.

chargeId
string

ID da cobranca vinculada, quando houver.

amount
number

Valor da transacao, normalmente com value em centavos e currency BRL.

installments
number

Parcelamento da transacao.

paymentMethod
enum<string>

Meio de pagamento usado na transacao.

Available options:
CREDIT_CARD,
DEBIT_CARD,
BOLETO,
PIX
status
enum<string>

Status atual da transacao.

Available options:
PAID,
PROCESSING,
DECLINED,
CANCELED,
DISCARDED,
AUTHORIZED,
IN_ANALYSIS,
ERROR_PAYMENT,
DISPUTE,
STANDBY,
CHARGEBACK,
PENDING_REVIEW,
PENDING_3DS,
BLOCKED,
INVALID_PAYMENT,
NO_PAYMENT_ROUTE,
PENDING_PAYMENT,
ERROR_REFUNDED
message
string

Mensagem principal retornada pelo processamento.

message2
string

Mensagem complementar retornada pelo processamento.

card
object

Dados de cartao salvos internamente, quando houver.

acquirer
object

Dados da adquirente vinculada a transacao.

boleto
object | null

Dados de boleto, quando gerados.

qrCode
object | null

Dados de Pix, quando gerados.

metadata
object

Metadados livres vinculados a transacao.

createdAt
string<date-time>

Data de criacao da transacao.

lastUpdate
string<date-time>

Data da ultima atualizacao da transacao.