Listar transações
Lista as transações da sua empresa, uma página por vez. Sem filtro nenhum, devolve todas, da mais recente pra mais antiga.
Todos os filtros são opcionais e somam (a transação tem que passar em todos):
referenceId: a referência que você mandou ao criar a intenção. Como ela é única por empresa entre transações, a lista devolve 0 ou 1 item.status: um ou mais, separados por vírgula (?status=PAID,PENDING). Passa a transação que estiver em qualquer um deles. Os valores são os deTransactionStatus:PENDING,AUTHORIZED,PAID,FAILED,CANCELED,REFUNDED.paymentMethod: um ou mais, separados por vírgula (?paymentMethod=PIX,BOLETO). Os valores são os dePaymentMethod:CREDIT_CARD,PIX,BOLETO.frometo: período em que a transação foi criada (createdAt), com as duas pontas incluídas. Pode mandar só um dos dois.
Filtro que não acha nada devolve lista vazia, não 404. Só aparecem transações da sua
empresa. Os itens saem no mesmo formato da consulta por id, sem a imagem do QR do Pix.
total é a quantidade de transações que passam nos filtros, não a da página.
Chave de API da sua empresa. Por enquanto a SwitchPay gera a chave e entrega à sua empresa; em breve será possível criar pelo painel.
In: header
Query Parameters
A referência que você mandou ao criar a intenção.
length <= 128Um ou mais status, separados por vírgula (status=PAID,PENDING). Passa a transação que estiver em qualquer um deles.
1 <= itemsUma ou mais formas de pagamento, separadas por vírgula (paymentMethod=PIX,BOLETO). Passa a transação que for de qualquer uma delas.
1 <= itemsCriadas a partir deste instante (ISO 8601, com fuso; ex. 2026-10-01T00:00:00.000Z).
date-timeCriadas até este instante (ISO 8601, com fuso). Não pode ser antes de from.
date-timeCampo da ordenação — data de criação ou valor cobrado.
"createdAt""createdAt" | "amountCents"Sentido da ordenação. desc = da mais recente (ou maior valor) pra mais antiga (ou menor).
"desc""asc" | "desc"11 <= value201 <= value <= 100Response Body
curl -X GET "https://api.sandbox.switchpay.app.br/v2/transactions?referenceId=string&status=PAID%2CPENDING&paymentMethod=PIX%2CBOLETO&from=2019-08-24T14%3A15%3A22Z&to=2019-08-24T14%3A15%3A22Z&orderBy=createdAt&direction=asc&page=1&limit=20"{
"data": [
{
"id": "trx_6f1a2b3c-4d5e-4f60-8a7b-9c0d1e2f3a4b",
"status": "PENDING",
"paymentMethod": "PIX",
"installments": 1,
"amountCents": 15000,
"feeCents": 149,
"netAmountCents": 14851,
"currency": "BRL",
"sellerId": "cmp_8f2a1c3d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",
"sellerName": "Loja Exemplo",
"paymentIntentId": "pi_7b2f9c1e-4d3a-4c6b-9e1f-2a3b4c5d6e7f",
"referenceId": "pedido-8842",
"buyer": {
"name": "Maria Souza",
"document": "12345678909",
"email": "maria@exemplo.com",
"phone": {
"country": "55",
"area": "11",
"number": "987654321"
}
},
"paymentDetails": {
"pix": {
"qrCode": "00020126580014br.gov.bcb.pix0136a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d5204000053039865406150.005802BR5913LOJA EXEMPLO6009SAO PAULO62070503***6304ABCD",
"expiresAt": "2026-10-06T17:00:00.000Z"
}
},
"split": {
"receivables": [
{
"recipientDocument": "11222333000181",
"role": "CUSTOM_SPLIT_RECIPIENT",
"installment": 1,
"grossAmountCents": 1500,
"feeCents": 0,
"amountCents": 1500,
"expectedOn": "2026-10-07",
"status": "PENDING"
},
{
"recipientDocument": "99888777000166",
"role": "SELLER",
"installment": 1,
"grossAmountCents": 13500,
"feeCents": 149,
"amountCents": 13351,
"expectedOn": "2026-10-07",
"status": "PENDING"
}
]
},
"createdAt": "2026-10-06T14:01:10.000Z",
"updatedAt": "2026-10-06T14:01:10.000Z"
}
],
"page": 1,
"limit": 20,
"total": 1
}{
"code": "VALIDATION_ERROR",
"message": "Há campos inválidos na requisição.",
"details": [
{
"field": "status",
"message": "valor desconhecido"
},
{
"field": "to",
"message": "não pode ser antes de from"
}
]
}{
"code": "UNAUTHORIZED",
"message": "Chave de API ausente, inválida ou de outro ambiente."
}{
"code": "FORBIDDEN",
"message": "Sua chave não tem permissão para esta operação."
}{
"code": "RATE_LIMITED",
"message": "Limite de chamadas atingido. Aguarde e tente de novo."
}{
"code": "SERVICE_UNAVAILABLE",
"message": "Serviço de autorização indisponível. Tente novamente em instantes."
}