PIpismo
Statement minimum amount due

Get statement minimum amount due

Get the statement minimum amount due by account ID and statement ID.

get/statements-v2/v1/accounts/{accountId}/minimum-amount-due

Request

  • Base URL
    https://sandbox.pismolabs.io
  • URL
    https://sandbox.pismolabs.io/statements-v2/v1/accounts/{accountId}/minimum-amount-due
  • Auth
    HTTP bearer

Path parameters

accountIdinteger required
Example:101

Account ID

Query parameters

statementIdinteger
Example:30300

Statement ID. When passed, the accrualType, endDate and beginDate filters are canceled. The other filters can be used concurrently.

Headers

Authorizationstring required

Account token, not a regular access token. Account tokens are encoded with an account ID. Tokens can expire quickly, which can result in an Unauthorized message.

Response

OK

statement_idinteger

Statement ID

amount_type'FIXED_AMOUNT' | 'PERCENTAGE'

Amount type

  • If you set amount_type to FIXED_AMOUNT, then the value you enter for minimum_amount_due should represent that fixed amount.<br>
  • If you set amount_type to PERCENTAGE, then minimum_amount_due should represent a percentage of the current balance. For example, if you set minimum_amount_due to 0.1, then the Pismo platform calculates the MAD as 10% of the current balance.
cycleinteger

Statement cycle

current_balancenumber

Total amount you owe on the account right now. It updates as transactions post, so it can change many times during a billing cycle. current_balance = previous_balance + debits - credits.

minimum_amount_duenumber float

Minimum amount due for the current statement cycle

  • If amount_type is set to FIXED_AMOUNT, then minimum_amount_due represents that fixed amount.<br>
  • If amount_type is set to PERCENTAGE, then minimum_amount_due represents a percentage of the current balance. For example, 0.1 represents 10% of the current balance.
enabledboolean

Is statement minimum amount due enabled?

Example response

{
  "statement_id": 9497889,
  "amount_type": "FIXED_AMOUNT",
  "cycle": 7,
  "current_balance": 99.99,
  "minimum_amount_due": 100.07,
  "enabled": true
}

Changes

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