In API version v.2025-01-28, we’ve improved how partial captures are represented, expanded the available information on settlements (including a revamped CSV and XLS format), and introduced updates for Platform Model. Review this changelog for more information on what endpoints have changed.

Updated Endpoints

Partial Captures improvements:

GET payments
POST payments
GET payments/:id
PATCH payments/:id
POST payments/:id/capture
POST payments/:id/refund
POST payments/:id/cancel
POST payments/:id/finalize
GET merchants/merchant_id/payments

Settlements & Platform Model improvements:

GET balances/:id
GET settlements
GET settlements/:id
GET settlements/:id/csv
GET settlements/:id/xls

Partial Captures improvements

Partial captures are now represented using a new "captures" array on payment object, instead of being shown as partial refunds, simplifying reporting and reconciliation.

`GET payments`

The response object for partially captured payments has been updated.

Return value changes:
- amount_refunded: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments.
- refunds: partially captured payments no longer show a refund for the difference between the authorized amount and captured amount.

Full API Reference for this endpoint

`POST payments`

The response object for partially captured payments has been updated.

Return value changes:
- amount_refunded: the refund amount for the difference between the authorized amount and captured amount is no longer included for partially captured payments.
- refunds: a refund for the difference between the authorized amount and captured amount is not shown if the payment is a partially captured payment.

Full API Reference for this endpoint