GetAccountEntryPaged

GetAccountEntryPaged

API Method = GetAccountEntryPaged

The "getAccountEntryPaged" endpoint is a powerful tool we offer to our clients to efficiently access their financial history. With this service, you can easily retrieve a comprehensive summary of transactions and the current balance of your account.

Key Benefits:

  • Access to Financial History: The endpoint allows you to access a detailed record of all transactions made in your account, facilitating financial audits and expense tracking.
  • Custom Filters: You can apply date filters to specify the period of interest, obtaining a specific financial statement that suits your needs.
  • Flexible Pagination: With the ability to control the number of entries per page, you can easily navigate through large volumes of financial data, ensuring a smooth user experience.
  • Current Balance: In addition to transactions, the service provides the current account balance, giving you an instant view of the current financial status.
  • Simple Integration: "getAccountEntryPaged" is designed for easy integration into your existing systems, allowing you to make the most of your account's financial data.

This endpoint is crucial to help our clients make informed decisions and maintain precise financial control. With it, you can access the financial information necessary to optimize your cash flow, identify spending trends, and make data-driven strategic decisions.

At Fitbank, we are committed to providing effective tools to enhance your financial experience, and "getAccountEntryPaged" is an essential part of that commitment. Combined with our stringent security and compliance, you can trust our services to reliably and efficiently meet your financial management needs.

{
  "Method": "GetAccountEntryPaged",
  "PartnerId": 93234,
  "BusinessUnitId": 40380,
  "TaxNumber": "30934646000107",
  "StartDate": "20/05/2022",
  "EndDate": "20/05/2022",
  "PageSize": 5,
  "PageIndex": 2,
  "DateTime": "2022-03-09T00:00:00",
  "OnlyBalance": true,
  "Bank": "621",
  "BankBranch": "3212",
  "BankAccount": "51351",
  "BankAccountDigit": "5"
}
{
  "Success": "true",
  "Entry": [
    {
      "InternalIdentifier": 0,
      "EntryId": 0,
      "Description": "debit purchase",
      "Subtype": 21,
      "EntryDate": "2022-03-09T00:00:00",
      "EntryValue": 50,
      "Type": "ManualCredit",
      "UsedGuaranteed": null,
      "GuaranteedValue": null,
      "Details": "Credit one",
      "ReceiptUrl": null,
      "BankDetails": null,
      "DocumentNumber": "134077",
      "TransactionId": 134569,
      "Bank": null,
      "BankBranch": null,
      "BankAccount": null,
      "BankAccountDigit": null,
      "OperationId": 0,
      "NoteId": 324553,
      "NoteEntry": 4334610,
      "OperationType": 0,
      "ManualEntryCategory": 0,
      "ReceiptFileName": null,
      "TotalRows": 0,
      "Tags": []
    }
  ],
  "Balance": 0,
  "BlockedBalance": 0
}

Definition of request fields

ParameterTypeDescription
MethodStringMethod name.
PartnerIdInt64Information Provied by Fitbank
BusinessUnitIdInt64Information Provied by Fitbank
TaxNumberStringTaxnumber account holder.
StartDateStringField used to perform the start date filter to delimit the statement.
EndDateStringField used to perform the end date filter to delimit the statement.
PageSizeIntegerThis field is responsible for specifying the number of entries per page to be returned.
PageIndexIntegerThis field is responsible for specifying which page will be returned
DateTimeStringIf the customer wants to search for the statement for a specific date, the use of startDate and endDate is not required.
OnlyBalanceBooleanIn scenarios where the customer solely intends to check the current account balance, there is no need to input the other fields
BankStringProvided for differentiation at the time of account opening.
BankBranchStringProvided for differentiation at the time of account opening.
BankAccountStringProvided for differentiation at the time of account opening.
BankAccountDigitStringProvided for differentiation at the time of account opening.

Definition of response fields

ParameterTypeDescription
InternalIdentifierIntegerInternal Identification
EntryIdIntegerInternal Identification (Entry ID)
DescriptionStringDescription of the transaction carried out
SubtypeIntegerThis field is enumerable, following the transaction model in the statement.
EntryDateStringExact time the transaction was settled
EntryValueDecimalValue of the transaction carried out
TypeString"The 'Type' field is used to describe the category of the bank transaction, providing additional text to complement the 'subtype' field."
UsedGuaranteedintegerThis field is responsible for granting permission to utilize the Guaranteed account balance.
GuaranteedValueDecimalThis field is responsible for specifying the withdrawal amount from the Guaranteed account.
DetailsStringThis field is responsible for providing transaction details.
ReceiptUrlStringfThis field contains a URL that can redirect the customer to a proof of the transaction.
BankDetailsObjectField responsible for returning bank details details
DocumentNumberLongControl Number Returned in the response of the generation Methods call
TransactionIdLongField responsible for returning the transaction identifier
OperationIdLongOperation Identification in the operation table
NoteIdLongInternal identification
NoteEntryLongInternal identification of the Note Entry
OperationTypeIntegerOperation Type
ManualEntryCategoryIntegerCategory of Manual entry/exit
ReceiptFileNameStringTransaction proof folder name
TagsThis field is responsible for returning created tags that are associated with the transaction.
BalanceDecimalCurrent account balance
BlockedBalanceDecimalBlocked balance under review

Types and Subtypes


SubTypesTypes
0Pre-credit payment of boleto
1Payment confirmation of boleto
2Purchase with boleto
3Receipt of purchase with boleto
4Boleto receipt fee
5Request for redemption in account
6Redemption in account
7Pre-fee for boleto receipt
8Pre-debit of fee for boleto receipt
9Manual credit
10Transfer to guarantee account
11Automatic credit
12Restoration of guarantee account limit
13Pre-fee for transfer
14Transfer fee
15Credit reversal of boleto
16Debit reversal of boleto
17Credit reversal of redemption in account
18Debit reversal of redemption in account
19Automatic debit
20Manual debit
21Initial balance
22Final balance
23Reversal of debit fee for redemption in account
24Boleto interest
25Boleto fine
26Pre-credit MoneyTransferIn
27Reversal of pre-credit MoneyTransferIn
28Credit MoneyTransferIn
30Cancellation of BoletoOut
31Pre-debit of BoletoOut
32Cancellation of DarfOut
33Pre-debit of DarfOut
34Overpayment of boleto
35InternalDischargeAccount
36RateInternalDischargeAccount
37Pre-fee for receiving MoneyTransferIn
38Cancellation of pre-fee for receiving MoneyTransferIn
39Fee for receiving MoneyTransferIn
40Pre-fee for titles
41PreRateByDarfOut
42CancelRateBoletoOut - Cancellation of bank titles fee
43CancelRateDarfOut
44DebitBoletoOut
45DebitDarfOut
46RateByBoletoOut
47Tax for DARF tribute payment
48RateInternalTransferFromMoneyTransferIn
49InternalTransferFromMoneyTransferIn
50Boleto discharge fee
51Reversal of discharge fee for Boleto
52PreRateByGareOut
53PreDebitGareOut
54PreRateByGpsOut
55PreDebitGpsOut
56DebitGpsOut
57RateByGpsOut
58CancelGpsOut
59CancelRateGpsOut
60DebitGareOut
61RateByGareOut
62CancelGareOut
63CancelRateGareOut
64PreRateByFgtsOut
65PreDebitFgtsOut
66Cancellation of FGTS fee
67Cancellation of FGTS payment
68DebitFgtsOut
69RateByFgtsOut
70CancelDarj
71Cancellation of DARJ taxes
72PreRateByDarjOut
73PreDebitDarjOut
74DebitRateWithoutRegister
75DebitDarjOut
76RateByDarjOut
77PreRateSendMoneyVirtualAccount
78RateSendMoneyVirtualAccount
79PreSendMoneyVirtualAccount
80SendMoneyVirtualAccount
88CancelSendMoneyVirtualAccount
89CancelRateSendMoneyVirtualAccount
90Reversal of TED
91RechargePrepaidCard
92DischargePrepaidCard
93RateDischargePrepaidCard
94RateRechargePrepaidCard
97Credit MoneyTransferIn Neon
98PreTransferOverhang
100Advance
102Inter-account payment
105Pre-debit transfer
107Transfer
108PreRatePrepaidCard
109CancelRatePrepaidCard
110RatePrepaidCard
111DebitTransferOverhang
112CreditTransferOverhang
113LinkPrepaidCard
115Advance fee
116ChargeAccount
117ChargeAccountRate
118ChargeAccountCredit
119CancelRechargePrepaidCard
120CancelDischargePrepaidCard
121Debit of Advance
122ChargedCashbackInternalDischargeAccount
123ReceivedCashbackInternalDischargeAccount
124PreDigitalWithdrawal
125ChargeAccountCreditToPrimary
126Credit Reversal of Transfer
127Debit Reversal of Transfer
128DigitalWithdrawal
129CancelDigitalWithdrawal
130PreRateDigitalWithdrawal
131RateDigitalWithdrawal
132CancelRateDigitalWithdrawal
133RateFeeDigitalWithdrawal
134PreRateBankDigitalWithdrawal
135RateBankDigitalWithdrawal
136PreRateFeeDigitalWithdrawal
143PurchaseCardDebit
144PurchaseCardCredit
145WithdrawCardDebit
146WithdrawCardCredit
147PreDebitPurchaseCard
148PreCreditPurchaseCard
149PreDebitPurchaseCardRate
150PreCreditPurchaseCardRate
151PreDebitWithdrawCard
152PreCreditWithdrawCard
153PreDebitWithdrawCardRate
154PreCreditWithdrawCardRate
155CancelWithdrawCardPreDebit
156CancelWithdrawCardPreCredit
157CancelPurchaseCardPreDebit
158CancelPurchaseCardPreCredit
159ChargeCardCredit
160ChargeCardDebit
161PreDebitChargebackCard
162PreCreditChargebackCard
163CancelChargebackCardPreDebit
164CancelChargebackCardPreCredit
165PreDebitChargebackCardRate
166PreCreditChargebackCardRate
167DischargeCardCredit
168DischargeCardDebit
171ChargebackCardDebit
172ChargebackCardCredit
173TransferBalanceCardDebit
174TransferBalanceCardCredit
175RateMultibankBoletoOut
176CancelRateMultibankBoletoOut
177RateMultibankMoneyTransferOut
178CancelRateMultibankMoneyTransferOut
179PreRateMultibankBoletoOut
180PreRateMultibankMoneyTransferOut
181CancelRateBankDigitalWithdrawal
182CancelRateFeeDigitalWithdrawal
183RateCancelBoleto
184DebitBoletoOutDifference
185CreditBoletoOutDifference
186DebitWithdrawCardRate
187CreditWithdrawCardRate
188LimitGuaranteedCredit
189LimitGuaranteedDebit
190FuturePostingCapture
191FuturePostingRescue
192FuturePostingDebit
193FuturePostingCredit
194FuturePostingPreCredit
195CreditTedInSPB
197DebitRequestCardRate
198CreditRequestCardRate
199DebitActivateCardRate
200CreditActivateCardRate
201ReversalSPBCredit
202ReversalSPBDebit
203PreDebitTopUp
204PreCreditTopUp
205DebitTopUp
206CreditTopUp
207DebitRateTopUp
208CreditRateTopUp
209CancelDebitTopUp
210CancelCreditTopUp
211PreDebitRateTopUp
212PreCreditRateTopUp
213SPBMultibankTransaction
214MultibankTransaction
215PreDebitGruOut
216DebitGruOut
217RateByGruOut
218CancelGruOut
219CancelRateGruOut
220Credit for consolidation reversal due to lack of balance
221Debit for consolidation reversal due to lack of balance
222CreditPixIn
224FuturePostingRate
228CreditRefundPixOut
232RatePixOut
234RatePixIn
235PreDebitRefundPixIn
237DebitRefundPixIn
238CreditRefundPixIn
239RateRefundPixIn
242PreDebitPixOut
244DebitPixOut
246PreRateByPixOut
247RateByPixOut
249DebitCloseLoopCashBack
250CreditCloseLoopCashBack
251CancelDebitPixOut
252CancelCreditPixOut
253CreditReissueCardRate
254DebitReissueCardRate
255DebitBenefitTransfer
256CreditBenefitTransfer
259PreCreditCancelRefundFuturePosting
260CancelCreditRefundPixIn
261CancelDebitRefundPixIn
263DebitRateGeneratePaymentOrder
264CreditRateGeneratePaymentOrder
265CancelRateGeneratePaymentOrder
266ManualCreditCreditLock
267ManualCreditDebitLock
268ManualDebitCreditLock
269ManualDebitDebitLock
270DebitRateGenerateCollectionOrder
271PreDebitRateGenerateCollectionOrder
272CreditCollectionOrder
273DebitCollectionOrder
276CollectionOrderCancellationFee
277Pre-credit boleto payment with deductions
278CourtOrderCapture
280DebitGeneratePaymentOrder
281FuturePostingDebitCapture
282Pre-credit settlement of card shipment
283DischargeKeyAccount
284Effectuation of card settlement shipment
285WireTransferPreDebit
286WireTransferDebit
287WireTransferPreRate
288WireTransferRate
289JudicialOrderCredit
290JudicialOrderDebit
291WireTransferCredit
292ManualEntryClosedAccountDebit
293ManualEntryClosedAccountCredit
298BinSponsorDebit
299BinSponsorCredit
302Tariffing Service
303CancelWithdrawCardRatePreDebit
304CancelWithdrawCardRatePreCredit
305UnlockPreBinSponsorDebit
306UnlockPreBinSponsorCredit
307ResourceBlockade
308ResourceUnlock
309InternalBoletoPayment
310CancelRateTransferPIX
311DebitRateSPB
312RateCollectionOrder
313PreCreditBoletoWithOverpaid
314BoletoWithOverpaid
315RateByBoletoInSettlement
316CreditPaymentCollectionRate
317DischargePaymentCollectionKeyAccount
318DebitTransferCardRate
318PreDebitBoletoOutSTR
319CreditTransferCardRate
319DebitBoletoOutSTR
320CreditTedInSME
321PreDebitPurchaseCardIOFRate
322CancelPurchaseCardIOFRatePreDebit
323CancelPurchaseCardIOFRatePreCredit
324PurchaseCardIOFRateDebit
325PurchaseCardIOFRateCredit
326CancelWireTransferPreDebit
327PreRateCancelBoleto
328RefundPreRateCancelBoleto
329PreCreditPurchaseCardIOFRate
330PreDebitWithdrawalClosedLoop
331PreCreditWithdrawalClosedLoop
332UnlockDebitWithdrawalClosedLoop
333UnlockCreditWithdrawalClosedLoop
336PreDebitClosedLoopPreAuthDeposit
337PreCreditClosedLoopPreAuthDeposit
338UnlockDebitDepositClosedLoop
339UnlockCreditDepositClosedLoop
340DebitDepositClosedLoop
341CreditDepositClosedLoop
342PreDebitJointPayment
343PreCreditJointPayment
344DebitJointPayment
345CreditJointPayment
346CancelDebitJointPayment
347CancelCreditJointPayment
348Debit of boleto payment (STR0026)
349PreDebitBoletoOutSTR
350DebitBoletoOutSTR
358EntryOrderPreDebit
359EntryOrderPreCredit
360EntryOrderDebit
361EntryOrderCredit
362EntryOrderUnlockedDebit
363EntryOrderUnlockedCredit
364EntryOrderCancelDebit
365EntryOrderCancelCredit
366EntryOrderDebitSync
367EntryOrderPreDebitSync
368CourtOrderUnlock
369TransferBySTRPaymentTributes
370TransferByTESPaymentTributes
371CourtOrderCancel
372PreDebitToBlockBoletoSplit
373RatePixInSentQRCode
374PreDebitToBlockPixInSplit
375DebitPixInByCollectionOrder
376CreditPixInByCollectionOrder
377OverPaymentFinesOrAdditionalFees
378CancelPreDebitBoleto
379DebitReconCollectionBoleto