PIpismo
Balance

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.

get/v1/marketplaces/{marketplaceId}/merchants/{merchantId}/balance

Request

  • Base URL
    https://sandbox.pismolabs.io/sellers
  • URL
    https://sandbox.pismolabs.io/sellers/v1/marketplaces/{marketplaceId}/merchants/{merchantId}/balance
  • Auth
    HTTP bearer

Path parameters

marketplaceIdinteger required

Marketplace ID

merchantIdinteger required

Merchant ID

Query parameters

datestring 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

Authorizationstring required

Authorization token

Response

Successfully get merchant balance

datestring date

Target date to estimate the merchant balance

current_available_amountnumber float

Amount available in the merchant account. It is always the exact amount in that account, regardless of the target date

estimated_available_amountnumber float

Estimated available amount in the merchant account on the target date. This includes all scheduled amounts that are projected to be settled and available in the merchant account by that date.

scheduled_amountnumber float

Scheduled amount on the target date. The scheduled amount is the amount that is not yet available, but is scheduled to be settled on the target date.

currency_codestring nullable

ISO 4217 alphanumeric currency code. null when no currency is recorded.

Example response

{
  "currency_code": "BRL"
}

Changes

No recorded changes to this operation across all 1 revision of this API.