InícioReferência

[GET] /transactions

Busca os detalhes de todas as transações

Para saber mais

Consultar transação

Endpoint de produção

Método GET

https://api-gateway.firebanking.com.br/pix/v1/transactions

Headers

Campo

Valor

Tipo

Descrição

Content-Type

application/json

string

Define o conteúdo como JSON

x-api-key

123

string

Sua chave API

Parâmetros da rota

Campo

Obrigatório

Tipo

Descrição

period

Sim

number

Período em número de dias. Compara a data no momento atual menos os dias.

O valor padrão é 15. O valor máximo é 90.

page

Não

number

Número da página escolhida dentro da paginação.

limit

Não

number

Limite de transações retornada na busca.

O valor padrão é 10. O valor máximo é 50.

order

Não

enum

Ordenação das transações baseado na data de criação.

Os valores permitidos são:

  • ASC (ascendente)

  • DESC (decrescente)

O valor padrão é DESC (decrescente).

cURL 

curl --request GET \
  --url 'https://api-gateway.firebanking.com.br/pix/v1/transactions?period=15&page=1&limit=10&order=DESC' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <sua-chave-api>'

Exemplo de resposta

Campos a serem recebidos

JSON 

{
	"items": [
		{
			"id": "cb3e7f07-e7fd-4785-92c2-1abc281cd46e",
			"value": 0.5,
			"fee": 0.01,
			"netValue": 0.49,
			"operationStatus": "ERROR",
			"endToEnd": null,
			"externalId": null,
			"paymentSettlementDate": null,
			"createdAt": "2025-06-06T14:12:50.598Z",
			"updatedAt": "2025-06-06T14:18:51.882Z"
		},
		{
			"id": "1b501dd6-9182-49a6-8080-a9d2112b5c7c",
			"value": 0.1,
			"fee": 0.01,
			"netValue": 0.09,
			"operationStatus": "WAITING_CONFIRMATION",
			"endToEnd": null,
			"externalId": null,
			"paymentSettlementDate": null,
			"createdAt": "2025-06-06T14:39:24.001Z",
			"updatedAt": "2025-06-06T14:39:24.001Z"
		},
		{
			"id": "2bcef4e9-5bf9-4859-b586-b8e74220af84",
			"value": 0.5,
			"fee": 0.01,
			"netValue": 0.49,
			"operationStatus": "WAITING_PAYMENT",
			"endToEnd": null,
			"externalId": null,
			"paymentSettlementDate": null,
			"createdAt": "2025-06-06T14:39:55.607Z",
			"updatedAt": "2025-06-06T14:39:57.087Z"
		},
		{
			"id": "fdb3dc9f-94bd-47a3-8231-703ffc45fe75",
			"value": 0.5,
			"fee": 0.01,
			"netValue": 0.49,
			"operationStatus": "REFUND_IN",
			"endToEnd": "E228964312025060614779nsL34pvQ9mJ",
			"externalId": null,
			"paymentSettlementDate": "2025-06-06T14:42:54.215Z",
			"createdAt": "2025-06-06T14:40:26.015Z",
			"updatedAt": "2025-06-06T14:53:46.006Z"
		},
		{
			"id": "f9b047a2-4bf4-4f32-8177-fba872718f19",
			"value": 0.5,
			"fee": 0.01,
			"netValue": 0.49,
			"operationStatus": "PAID",
			"endToEnd": "E22896431202502632609hiqKU2OU09P",
			"externalId": null,
			"paymentSettlementDate": "2025-06-06T15:10:07.254Z",
			"createdAt": "2025-06-06T15:09:52.042Z",
			"updatedAt": "2025-06-06T15:28:50.818Z"
		}
	],
	"total": 15,
	"totalPages": 3
}