Non‑breaking API update: New Response fields for /v2/transactions and /v2/balance-statements
Effective date: 31 October 2025
Overview We’re adding new aggregated fields to the v2 transactions response and a new summary object to the v2 balance statements response. These are additive, backward‑compatible changes. No request parameters, pagination, status codes, or rate limits are affected.
Endpoints impacted:
- GET /v2/transactions
- GET /v2/balance-statements
What’s changing
/v2/transactions
- New fields in the top‑level meta object:
"meta": {
"transaction_count": "0", // existing field
"total_amount": "0", // existing field
"total_price": "0", // existing field
"profit": "0", // new String field
"failed_count": "0", // new String field
"successful_count": "311", // new String field
"pending_count": "0", // new String field
"refund_count": "0", // new String field
}
"transaction_count": "0", // existing field
"total_amount": "0", // existing field
"total_price": "0", // existing field
"profit": "0", // new String field
"failed_count": "0", // new String field
"successful_count": "311", // new String field
"pending_count": "0", // new String field
"refund_count": "0", // new String field
}
/v2/balance-statements
- New object added to the response:
"summary": {
"total_transactions": {
"amount": -3444.4284, // Calculated total transaction amount for the statement period (signed decimal).
"count": 65000 // Calculated total number of transactions for the statement period.
},
"total_deposit": {
"amount": 5000.00, // Calculated total deposit amount for the statement period.
"count": 17 // Calculated total number of deposits for the statement period.
},
"total_refund": {
"amount": 150.00, // Calculated total refund amount for the statement period.
"count": 5 // Calculated total number of refunds for the statement period.
}
}
"total_transactions": {
"amount": -3444.4284, // Calculated total transaction amount for the statement period (signed decimal).
"count": 65000 // Calculated total number of transactions for the statement period.
},
"total_deposit": {
"amount": 5000.00, // Calculated total deposit amount for the statement period.
"count": 17 // Calculated total number of deposits for the statement period.
},
"total_refund": {
"amount": 150.00, // Calculated total refund amount for the statement period.
"count": 5 // Calculated total number of refunds for the statement period.
}
}
Backward compatibility
- Non‑breaking; existing fields and formats are unchanged.
- New fields are additive only. Responses that previously parsed will continue to parse.
- If you use strict JSON schema/model validation, update your models to include the new meta fields on /v2/transactions and the summary object on /v2/balance-statements, or configure them to ignore unknown properties.
Actions for integrators
- No action required to maintain existing functionality.
Should you require any further assistance or additional information, please do not hesitate to reach out to us via email at support@iimmpact.com.