Documentation
Feedback
Guides

Release Notes
Release Notes
Improved
Replace "Capture" term for "Settlement" in the Payment Provider Protocol documentation
March, 30

{"base64":"  ","img":{"width":65,"height":20,"type":"svg","mime":"image/svg+xml","wUnits":"px","hUnits":"px","length":925,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/replace-capture-term-for-settlement-in-the-payment-provider-protocol-0.png"}}

The "Capture" term was replaced by "Settlement" in our Payment Provider Protocol (PPP), including similar forms (e.g.: "to capture" was replaced by "to settle"). This change in nomenclature is applied throughout our documentation, including in our API reference. The Capture Payment endpoint is now called Settle Payment. You can check the changes in our API Reference and in the Payment Provider Protocol article.

No changes were made to how the API works, including its parameters. The Settle Payment endpoint still uses the same path /settlements.

There were also some improvements in the PPP API documentation:

  • Improved examples of successful responses for Settle Payment and Refund Payment endpoints.
  • Changed the default value of some parameters (value, verificationOnly and installments in the request body of Create Payment).
  • Changed the type of document parameter in recipients of the request body of Settle Payment and Refund Payment endpoints from number to string. The number type was incorrectly documented.
  • Improved schema of the response body in the List Payment Provider Manifest endpoint.
Was this helpful?
Yes
No
On this page