Pular para o conteúdo

Transações

Requer scope READ_TRANSACTIONS. Lista as transações (sub-transações de pagamento) da empresa dona da chave, da mais recente para a mais antiga (paginação por cursor — ver seção 5).

Query:

CampoTipoObrigatórioRegras / Default
qstringnãobusca em ID da transação e nome/e-mail/documento do cliente
statusenum EnStatusTransactionnãoPENDING | PROCESSING | PAID | CONFIRMED | REFUNDED | PARTIALLY_REFUNDED | CANCELED | FAILED | EXPIRED
statusGroupenumnãoall | completed | pending | processing | failed | refunded — ignorado se status for informado
paymentMethodenum EnPaymentMethodnãoPIX | CARD_CREDIT | CARD_DEBIT | BOLETO | PIX_WITHDRAW
providerCodestringnãocódigo do PSP
minAmountCents / maxAmountCentsintnãofaixa de valor, em centavos
minFeeCents / maxFeeCentsintnãofaixa de taxa, em centavos
startDate / endDatestring (ISO 8601)nãofiltra por created_at
limitintnãomáx 100, default 50
cursorstringnãocursor opaco da página seguinte

Resposta (200):

{
"items": [
{
"id": "uuid",
"transactionId": "string",
"companyId": "uuid",
"companyName": "string",
"customerName": "Maria Souza",
"customerEmail": "maria@example.com",
"customerDocument": "12345678909",
"amountCents": 14990,
"feeCents": 450,
"netAmountCents": 14540,
"paymentMethod": "PIX",
"status": "PAID",
"subIntegration": "API_DIRECT",
"providerCode": "BEMPAGGO",
"providerName": "Bempaggo",
"createdAt": "2026-07-16T12:00:00.000Z",
"paidAt": "2026-07-16T12:03:00.000Z"
}
],
"nextCursor": null,
"hasMore": false
}

Exemplo — transações pagas em uma faixa de valor:

Listar transações
curl -s https://goldpay-goldpay-api.f0czp0.easypanel.host/api/merchant/transactions \
-H "X-Api-Key: <SECRET_KEY>" \
--get \
--data-urlencode "status=PAID" \
--data-urlencode "minAmountCents=10000" \
--data-urlencode "limit=50"