Get Balance Transactions Summary

Retrieves the Balance Transactions Summary for a given Balance.

The response contains useful recorded and calculated Transaction amounts created for a Balance during the time it is active for the Account, including amounts relevant to any rollover amount configured for a Balance:

• totalCreditAmount. The sum of all credits amounts created for the Balance.
• totalDebitAmount. The sum of all debit amounts created for the Balance.
• initialCreditAmount. The initial credit amount created for the Balance.
• expiredBalanceAmount. The amount of the Balance remaining at the time the Balance expires and which is not included in any configured Rollover amount. For example,suppose a Balance reaches its end date and 1000 credit remains unused. If the Balance is configured to rollover 800, then the expiredBalanceAmount is calculated as 1000 - 800 = 200.
• rolloverConsumed. The sum of debits made against the configured rollover amount. Note that this amount is dynamic relative to when the API call is made until either the rollover end date is reached or the cap configured for the rollover amount is reached, after which it will be unchanged. If no rollover is configured for a Balance, then this is ignored.
• balanceConsumed. The sum of debits made against the Balance. Note that this amount is dynamic relative to when the API call is made until either the Balance end date is reached or the available Balance amount reaches zero, after which it will be unchanged.

GET /organizations/{orgId}/balances/{balanceId}/transactions/summary

Get Balance Transactions Summary

cURL

curl --request GET \
  --url https://api.m3ter.com/organizations/{orgId}/balances/{balanceId}/transactions/summary \
  --header 'Authorization: Bearer <token>'

200

{
  "totalCreditAmount": 250,
  "totalDebitAmount": 125.5,
  "initialCreditAmount": 300,
  "expiredBalanceAmount": 50,
  "rolloverConsumed": 75,
  "balanceConsumed": 100
}

Authorizations

Authorization · string · header · required

m3ter supports machine to machine authentication using the clientCredentials OAuth2 flow.

The authorizationCode flow controls access for human users via the m3ter Console application.

FlowAuthorization Code

Authorization URL

https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/authorize

Token URL

https://m3ter.auth.us-east-1.amazoncognito.com/oauth2/token

FlowClient Credentials

Token URL

/oauth/token

Path Parameters

orgId · string · required

UUID of the organization

balanceId · string · required

The UUID of the Balance

Response

200

application/json

Summary of all Balance Transactions

totalCreditAmount · number

Example:

250

totalDebitAmount · number

Example:

125.5

initialCreditAmount · number

Example:

300

expiredBalanceAmount · number

Amount of the balance that expired without being used

Example:

50

rolloverConsumed · number

Amount consumed from rollover credit

Example:

75

balanceConsumed · number

Amount consumed from the original balance

Example:

100