Listar Transações

Este endpoint é utilizado para listar e consultar o histórico de transações financeiras processadas na sua conta. Através dele, é possível retornar informações detalhadas de cada operação realizada no ecossistema (como pagamentos via boleto, cartão de crédito e Pix).

Para realizar a consulta do histórico de transações, é necessário possuir um token válido e utilizar o endpoint Listar Transações.

Atributos da Resposta

1. Campos da Raiz (Root)

Campo	Tipo	Descrição
`totalQtdFoundInPage`	Int	Quantidade total de registros retornados na página atual.
`Transactions`	Array	Lista contendo os objetos de transações encontrados.

2. Objeto Principal de Transação (`Transactions[]`)

Campo	Tipo	Descrição
`galaxPayId`	Int	Identificador único da transação no sistema.
`myId`	String	Identificador de referência da transação no seu sistema.
`value`	Int	Valor da transação informado em centavos (ex: 100 = R$ 1,00).
`paydayDate`	Date	Data de vencimento original do pagamento (YYYY-MM-DD).
`paydayDateDateTime`	DateTime	Data e hora em que o pagamento foi efetivamente realizado (retorna `null` se pendente).
`installment`	Int	Número da parcela referente a esta transação.
`status`	String	Código do status atual da transação (Ex: `captured`, `cancelByContract`).
`statusDescription`	String	Detalhamento amigável sobre o status atual da transação.
`statusDate`	DateTime	Data e hora da última alteração de status da transação.
`createdAt`	DateTime	Data e hora em que a transação foi criada.
`additionalInfo`	Text	Informações adicionais sobre a transação que são exibidas no boleto do cliente.
`datetimeLastSentToOperator`	DateTime	Data e hora do último envio ou tentativa de processamento na operadora de cartão.
`chargeGalaxPayId`	Int	ID da cobrança avulsa no sistema (retornado apenas se a transação for de cobrança avulsa).
`chargeMyId`	String	ID da cobrança avulsa no seu sistema (retornado apenas se a transação for de cobrança avulsa).
`subscriptionGalaxPayId`	Int	ID da assinatura no sistema (retornado apenas se for vinculado a uma assinatura).
`subscriptionMyId`	String	ID da assinatura no seu sistema (retornado apenas se for vinculado a uma assinatura).
`payedOutsideGalaxPay`	Boolean	Indica se a transação foi marcada como paga fora do ecossistema do sistema (ex: via pix manual, dinheiro).
`tid`	String	Identificador único (TID) da transação junto à operadora de cartão.
`authorizationCode`	String	Código de autorização devolvido pela operadora de cartão.
`cardOperatorId`	String	Código identificador da operadora de cartão responsável pelo processamento.
`ConciliationOccurrences`	Array	Lista de dados relacionados à conciliação bancária da transação.
`Charge`	Object	Detalhes da Cobrança Avulsa vinculada à transação (veja tabela abaixo).
`Subscription`	Object	Detalhes da Assinatura vinculada à transação (veja tabela abaixo).
`CreditCard`	Object	Informações do Cartão de Crédito processado na transação (veja tabela abaixo).

3. Objeto de Cobrança (`Transactions[].Charge`)

Campo	Tipo	Descrição
`galaxPayId`	Int	Identificador da cobrança avulsa.
`myId`	String	Identificador da cobrança avulsa no seu sistema.
`value`	Int	Valor total configurado para a cobrança em centavos.
`paymentLink`	String	URL gerada para que o cliente acesse a tela de pagamento.
`mainPaymentMethodId`	String	Método principal de pagamento configurado (`creditcard`, `boleto`, `pix`).
`status`	String	Status atual da cobrança (`active`, `canceled`, `closed`, `waitingPayment`).
`additionalInfo`	Text	Notas livres dedicadas a informações adicionais de controle interno.
`createdAt`	DateTime	Data e hora de criação da cobrança.
`updatedAt`	DateTime	Data e hora da última alteração da cobrança.
`payedOutsideGalaxPay`	Boolean	Informa se a cobrança como um todo foi quitada por fora do sistema.
`Customer`	Object	Dicionário contendo os dados cadastrais do cliente associado.
`PaymentMethodCreditCard`	Object	Regras e configurações estipuladas para a modalidade de cartão.

4. Objeto de Assinatura (`Transactions[].Subscription`)

Campo	Tipo	Descrição
`galaxPayId`	Int	Identificador único da assinatura.
`myId`	String	Identificador da assinatura mapeado no seu sistema.
`value`	Int	Valor recorrente cobrado na assinatura em centavos.
`paymentLink`	String	Link para o checkout/página de pagamento da assinatura.
`mainPaymentMethodId`	String	Meio de pagamento padrão definido para a recorrência.
`status`	String	Situação da assinatura (`active`, `canceled`, `stopped`, etc.).
`periodicity`	String	Intervalo de cobrança recorrente (ex: `monthly`, `weekly`, `manual`).
`firstPayDayDate`	Date	Data base estipulada para o primeiro pagamento da recorrência.
`additionalInfo`	Text	Informações adicionais internas salvas na assinatura.
`createdAt`	DateTime	Data de criação da assinatura.
`updatedAt`	DateTime	Data da última alteração na assinatura.

5. Objeto do Cliente (`...Customer`)

Campo	Tipo	Descrição
`galaxPayId`	Int	Código de identificação do cliente.
`myId`	String	Código do cliente definido no seu banco de dados.
`name`	String	Nome completo ou Razão Social cadastrada para o cliente.
`document`	String	Documento de identificação simplificado (apenas números do CPF ou CNPJ).
`emails`	Array	Lista contendo os endereços eletrônicos (e-mails) informados pelo cliente.
`phones`	Array	Lista com os números de telefone registrados para contato.
`Address`	Object	Dados estruturados do endereço de cobrança do cliente.

6. Detalhes do Endereço (`...Address`)

Campo	Tipo	Descrição
`zipCode`	String	CEP formatado ou numérico do local (8 caracteres).
`street`	String	Nome do logradouro (rua, avenida, etc.).
`number`	String	Número da residência ou estabelecimento comercial.
`complement`	String	Dados complementares do endereço (apartamento, bloco, referências).
`neighborhood`	String	Bairro correspondente.
`city`	String	Cidade do endereço.
`state`	String	Sigla da unidade federativa / estado (ex: SP, RJ) (2 caracteres).

7. Dados do Cartão de Crédito (`...CreditCard.Card` ou `...Card`)

Campo	Tipo	Descrição
`galaxPayId`	Int	Identificador do token/cartão armazenado no ambiente seguro.
`myId`	String	Identificador personalizado do cartão atribuído pelo seu sistema.
`number`	String	Número do cartão de crédito de forma mascarada/truncada (ex: `411111******1111`).
`status`	String	Status operacional do cartão (ex: `active`).
`expiresAt`	String	Mês e ano indicando a validade impressa no cartão no formato `YYYY-MM`.
`createdAt`	DateTime	Data em que o cartão foi inicialmente adicionado à base.
`updatedAt`	DateTime	Data da última alteração no registro do dispositivo de pagamento.
`isBackup`	Boolean	Sinaliza se este cartão está parametrizado como opção de contingência/reserva.
`Brand`	Object	Dicionário com informações proprietárias da bandeira do cartão.

8. Informações da Bandeira (`...Brand`)

Campo	Tipo	Descrição
`id`	String	Identificador interno em letras minúsculas da bandeira (ex: `visa`, `mastercard`).
`name`	String	Nome fantasia oficial da bandeira (ex: `Visa`).
`maxInstallment`	Int	Quantidade máxima de parcelas permitidas de acordo com essa bandeira.
`operatorIds`	String/Text	Relação das operadoras parceiras que aceitam transações com essa bandeira.

Updated about 1 hour ago