|
| 1 | +# Changelog |
| 2 | + |
| 3 | +## [Unreleased] |
| 4 | + |
| 5 | +## [1.0.0.beta.1] - 2026-05-25 |
| 6 | + |
| 7 | +Targets KOMOJU API version `2025-01-28`. |
| 8 | + |
| 9 | +### Changed |
| 10 | + |
| 11 | +- [`GET payments` endpoint] The response object for partially captured payments has been updated. |
| 12 | + |
| 13 | + - **Return value changes**: |
| 14 | + - `amount_refunded`: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments. |
| 15 | + - `refunds`: partially captured payments no longer show a refund for the difference between the authorized amount and captured amount. |
| 16 | + |
| 17 | +- [`POST payments` endpoint] The response object for partially captured payments has been updated. |
| 18 | + |
| 19 | + - **Return value changes**: |
| 20 | + - `amount_refunded`: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments. |
| 21 | + - `refunds`: a refund for the difference between the authorized amount and captured amount is not shown if the payment is a partially captured payment. |
| 22 | + |
| 23 | +- [`GET payments/:id` endpoint] The response object for a partially captured payment has been updated. |
| 24 | + |
| 25 | + - **Return value changes**: |
| 26 | + - `amount_refunded`: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments. |
| 27 | + - `refunds`: a refund for the difference between the authorized amount and captured amount is not shown if the payment is a partially captured payment. |
| 28 | + |
| 29 | +- [`PATCH payments/:id` endpoint] The response object for a partially captured payment has been updated. |
| 30 | + |
| 31 | + - **Return value changes**: |
| 32 | + - `amount_refunded`: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments. |
| 33 | + - `refunds`: a refund for the difference between the authorized amount and captured amount is not shown if the payment is a partially captured payment. |
| 34 | + |
| 35 | +- [`POST payments/:id/capture` endpoint] The response object for a partially captured payment has been updated. |
| 36 | + |
| 37 | + - **Return value changes**: |
| 38 | + - `amount_refunded`: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments. |
| 39 | + - `refunds`: a refund for the difference between the authorized amount and captured amount is not shown if the payment is a partially captured payment. |
| 40 | + |
| 41 | +- [`POST payments/:id/refund` endpoint] The response object for a partially captured payment has been updated. |
| 42 | + |
| 43 | + - **Return value changes**: |
| 44 | + - `amount_refunded`: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments. |
| 45 | + - `refunds`: a refund for the difference between the authorized amount and captured amount is not shown if the payment is a partially captured payment. |
| 46 | + |
| 47 | +- [`POST payments/:id/cancel` endpoint] The response object for a partially captured payment has been updated. |
| 48 | + |
| 49 | + - **Return value changes**: |
| 50 | + - `amount_refunded`: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments. |
| 51 | + - `refunds`: a refund for the difference between the authorized amount and captured amount is not shown if the payment is a partially captured payment. |
| 52 | + |
| 53 | +- [`POST payments/:id/finalize` endpoint] The response object for a partially captured payment has been updated. |
| 54 | + |
| 55 | + - `amount_refunded`: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments. |
| 56 | + - `refunds`: a refund for the difference between the authorized amount and captured amount is not shown if the payment is a partially captured payment. |
| 57 | + |
| 58 | +- [`GET merchants/{merchant_id}/payments` endpoint] The response object for a partially captured payment has been updated. |
| 59 | + |
| 60 | + - **Return value changes**: |
| 61 | + - `amount_refunded`: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments. |
| 62 | + - `refunds`: partially captured payments no longer show a refund for the difference between the authorized amount and captured amount. |
| 63 | + |
| 64 | +- [`GET balances/:id` endpoint] Transformed the response to a nested (2D) structure to match the Merchant dashboard's Payout Balance page. |
| 65 | + |
| 66 | + - **Renamed keys**: `balance_total` is now `total_balance_cents`. |
| 67 | + - **Removed keys**: `payment_fee_total`, `tax_total`. |
| 68 | + - **Structural changes**: Added new `payments`, `refunds`, `platform_model`, `corrections`, `komoju_card_charges` and `misc` sections. |
| 69 | + |
| 70 | +- [`GET settlements` endpoint] Renamed one key name, added a number of new keys, and made changes to several returned values. |
| 71 | + |
| 72 | + - **Renamed keys**: `amount` is now `settlement_amount_cents`. |
| 73 | + - **Return value changes**: `status`: "automatic_pending" is now returned as "pending". |
| 74 | + |
| 75 | +- [`GET settlements/:id` endpoint] Renamed two key names, added a number of new keys, made changes to several returned values, and transformed the response to a nested (2D) structure. |
| 76 | + |
| 77 | + - **Renamed keys**: `amount` is now `settlement_amount_cents`. |
| 78 | + - **Removed keys**: `payment_total`, `payment_fee_total`, `refund_total`, `refund_fee_total`, `refunded_customer_fee_total`, `correction_total`, `tax_total`, `balance_amount`. |
0 commit comments