Changelog
Introduction

Sections

Theme switcher

Get Deposits

With this endpoint, you can retrieve information about deposits made in the system. You can also request deposits for a specific account using query.

Transaction Statuses in Broker API

Success/Final Statuses

  • DONE – Transaction completed successfully
  • FULLY_PAID – Final status, equivalent to DONE, introduced with the "Fixed Amount Book" mechanism for Prop Trading. Indicates that the user deposited the exact or higher amount than declared.
  • PARTIALLY_PAID – Final status, equivalent to DONE, used when the deposited amount is lower than declared in "Fixed Amount Book" mode
  • BOOKED – Funds have been booked to the account

Pending/In Progress Statuses

  • NEW – New transaction request
  • PROCESSING – Transaction is in progress
  • PROCESSING_PAYMENT – Transaction is being processed by the payment provider
  • AWAITING_CONFIRMATION – Transaction awaits broker confirmation
  • ADMIN_CONFIRMATION – Transaction awaits administrator confirmation (e.g., for crypto withdrawals)

Failure/Cancellation Statuses

  • FAILED – Transaction failed (internal system error)
  • FAILED_PAYMENT – Payment failed (payment provider error)
  • REJECTED – Transaction rejected by the broker
  • CANCELLED_BY_USER – Transaction cancelled by the user
  • REFUNDED – Funds were refunded

Header Parameters

Authorizationstring

Query Parameters

querystring

Search term to filter the deposits.

pageinteger

Specifies the page number of the deposit list.

Default value
0
sizeinteger

Determines the number of deposit records per page.

Default value
10
sortstring

Specifies the sorting order of the results, such as by creation date in descending order (created,desc).

Default value
created,desc
fromstring

Filters the deposits starting from this date.

tostring

Filters the deposits up to this date.

Response

200
Object
OK

Response Attributes

contentarray

Contains the deposit records.

Show child attributes

totalPagesinteger

Total number of pages available.

totalElementsinteger

Total number of deposit entries available.

numberinteger

Current page number.

sizeinteger

Number of records per page.

Was this section helpful?

What made this section unhelpful for you?

GET

/

Select
1

Response

Was this section helpful?

What made this section unhelpful for you?