Account Listing Methods

GetAccount

API Method = GetAccount

The getAccount method is an endpoint that is part of an API and is used to retrieve information about a specific account in a system, in this case, in Fitbank. It allows the user to obtain a set of information about the account, such as the current balance, the account status, the account type, account owner information, among other relevant information. It is an important functionality for account management and monitoring, as it allows the user to access real-time updated data.

{
"Method":"", Required
"PartnerId":"", Required
"BusinessUnitId":"", Required
"Identifier":"",
"AccountKey":"",
"TaxNumber":"",
"Bank":"",
"BankBranch":"",
"BankAccount":"",
"BankAccountDigit":""

{
"Method": "GetAccount",
"PartnerId": 510,
"BusinessUnitId": 518,
"AccountKey": "615103-527898-3642786-1"
}

View GetAccount on API Reference

GetAccountList

API Method = GetAccountList

The getAccountList method is an endpoint within the Fitbank API that retrieves information about a set of accounts within a specific Business Unit. This method provides the user with a comprehensive set of information about each account, including the account status, account type, and account owner details. With this functionality, users can easily manage and monitor multiple accounts in real-time, making it an essential tool for effective account management.

{
  "Method": "GetAccountList",
  "PartnerId": 30589,
  "BusinessUnitId": 60797,
  "PageSize": "3",
  "Index": "2",
  "DateFilterGE": "2023-01-02"
}
{
  "Success": true,
  "AccountListData": [
    {
      "Name": "Name",
      "NickName": null,
      "Mail": "[email protected]",
      "Phone": "(99) 99999-9999",
      "Identifier": 182211,
      "AccountKey": null,
      "TradingName": "name",
      "TaxNumber": "30934646000107",
      "Bank": null,
      "BankAccount": null,
      "BankBranch": null,
      "BankAccountDigit": null,
      "AccountValue": 0,
      "LastTransactionDate": "2022-08-18 04:48:34"
    }
  ],
  "TotalAccountsValue": 0
}

View GetAccountList on API Reference

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,
      "Tags": []
    }
  ],
  "Balance": 0,
  "BlockedBalance": 0
}

Definition of request fields

FieldTypeDescription
MethodStringMethod name.
PartnerIdInt64
BusinessUnitIdInt64
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
BankString
BankBranchString
BankAccountString
BankAccountDigitString

Definition of response fields

FieldTypeDescription
InternalIdentifierInteger
EntryIdInteger
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."
UsedGuaranteedThis field is responsible for granting permission to utilize the Guaranteed account balance.
GuaranteedValueThis field is responsible for specifying the withdrawal amount from the Guaranteed account.
DetailsThis field is responsible for providing transaction details.
ReceiptUrlThis field contains a URL that can redirect the customer to a proof of the transaction.
BankDetailsField responsible for returning bank details details
DocumentNumber
TransactionIdField responsible for returning the transaction identifier
OperationId
NoteId
NoteEntry
OperationType
ManualEntryCategory
ReceiptFileName
TagsThis field is responsible for returning created tags that are associated with the transaction.
BalanceCurrent account balance
BlockedBalanceBlocked balance under review

GetAccountEntry

API Method = GetAccountEntry

The getAccountEntry method enables the listing of information regarding a specific account's statement, providing users with the ability to choose the period, index, and pagination of the statement. This functionality allows for efficient management and monitoring of account activity, as users can easily access and review relevant transaction data. With the flexibility to select specific timeframes and adjust the display of information, the getAccountEntry method is a valuable tool for accurate and streamlined account management.

This method can return the statement information for a specific account. It has the return of 2 responses:

JSON response delivers values referring to Entry, following the example below:

OnlyBalance Field: true

{
    "Success": "true",
    "Balance": 0.00
}

OnlyBalance field: false

{
  "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,
      "Tags": []
    }
  ],
  "Balance": 0,
  "BlockedBalance": 0
}

View GetAccountEntry on API Reference

{
  “Success”: true,
  “ExistsAccountValid”: true,
  “PersonName”: “Luiz Fernando”
}
{“Success”: true,
 “ExistsAccountValid”: false,
 “PersonName”: “”
}

CheckAccountPerson

API Method = CheckAccountPerson

The CheckAccountPerson method verifies if there is a person associated with a given account, using filters such as CPF or phone number. This method allows users to quickly and accurately confirm the identity of individuals associated with specific accounts, ensuring secure and reliable account management. By leveraging the CPF and phone number filters, users can efficiently identify and address any discrepancies or issues related to account ownership or activity. The CheckAccountPerson method is an important tool for ensuring the integrity and security of account management processes.

{
  “Success”: true,
  “ExistsAccountValid”: true,
  “PersonName”: “Luiz Fernando”
}
{“Success”: true,
 “ExistsAccountValid”: false,
 “PersonName”: “”
}

GetAccountAddress

API Method = GetAccountAddress

The GetAccountAddress method retrieves the address associated with a specific account. This method provides users with accurate and up-to-date information on the physical location of the account holder, facilitating effective communication and ensuring efficient account management.

Displays the address registered for that account.

{
    "Success": "true",
    "Message": [
        {
            "AddressLine": "Avenida Cidade Jardim",
            "AddressLine2": "400",
            "ZipCode": "01448090",
            "Neighborhood": "Jardim Europa",
            "CityName": "São Paulo",
            "State": "SP",
            "Country": "Brasil",
            "Complement": "20 º andar",
            "Reference": null
        }
    ]
}