The Accounts section displays financial operations. It includes endpoints for:

  • Accounts list including all your accounts details, including UID, account number and type.
  • Real-Time Balance Checking: Instantly view the current account balance to ensure sufficient funds for transactions.
  • Transaction History Review: Examine past account activities with detailed insights into credits and debits.
  • Operational Summary Reporting: Summarize transactional data over a specific time frame for auditing and performance analysis.

These tools enable effective financial monitoring, detailed transaction auditing, and periodic cash flow evaluations.

Multiple Bank Accounts and Information Recovery

Paybrokers lets you use multiple bank accounts with one API key. Settings are managed only in the admin panel, such as:

  • The creation and linking of new bank accounts to an existing API key.
  • The selection of which account will be used to process the requested transactions.

Account API

Allows access to existing bank account information and balance queries by period and account category. (Reference https://dev.paybrokers.com/docs/accounts-api)

Payment API

Allows payment requests. The access scope is limited to the account linked to the API key issued via admin portal. However, payments may be executed through a second transactional bank account configured for redundancy purposes. (Reference https://dev.paybrokers.com/docs/payments)

Transaction API

This API segment allows querying transaction request information.

View Transaction
This endpoint returns transaction details using the Paybrokers ID as the search parameter. The query is performed across all transactional bank accounts associated with the key and capable of operating.

This endpoint must be used for recovering the status of existing transactions, be it ongoing or in any final status. (Reference https://dev.paybrokers.com/reference/view-transaction)

List Transactions
This endpoint retrieves transactions based on multiple criteria, such as date range and Platform ID as search parameters.

This endpoint can be used in situations where the Paybrokers’ transaction id is unknown (eg. request timeout or HTTP response errors).

🚧

Before invoking this endpoint

Due to data processing constraints, we recommend introducing a short delay (5+ minutes) before invoking this endpoint, based on the transaction timestamp. (Reference https://dev.paybrokers.com/reference/list-transactions)

❗️

IMPORTANT

Currently, the endpoint searches only within the bank account for which the API key was created. A future update will enable cross-account queries across all transactional accounts, better aligning with the concept of multiple accounts.


What’s Next