Get merchant balance

The merchant balance endpoint provides an estimate of the available funds in the merchant account on a specified target date. It takes into account the scheduled merchant transactions in the specified marketplace to calculate the estimated values.

estimated_available_amount represents the forecasted amount that might be available to the merchant on the target date, based on the current scheduled transactions. This estimate is subject to change due to cancellations, new transactions, and advancements made by the merchant until the target date arrives.

If the merchant's scheduled balance is negative, the amount accumulates in the scheduled_amount field until it becomes positive and is available for settlement. Therefore, a negative scheduled_amount is not considered for settlement until it turns positive.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uint64
required
1 to 18446744073709552000

Marketplace ID

uint64
required
1 to 18446744073709552000

Merchant ID

Query Params
date

Target date to compose the balance amount. The date format used is ISO 8601. minLength: 10 maxLength: 10

The date must be the current or a future date. If not provided, it defaults to the current date of the target merchant timezone.

Headers
string
required

Authorization token

Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json