Documentation
Feedback
Guides

Release Notes
Release Notes
Improved
Improvements to the Payment Provider Protocol API and Redirect flow documentation
June, 2

{"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/improvements-to-the-payment-provider-protocol-api-and-redirect-flow-documentation-0.png"}}

The Payment Provider Protocol (PPP) API documentation and the Redirect section of the Purchase Flows article have just been updated. The changes in the PPP API documentation are:

  • POST Create Payment endpoint.
    • Removed requirement of installmentsInterestRate, installmentsValue and ipAddress parameters in the request body.
    • Added description of card parameter in the request body.
    • document field is now properly located inside the card parameter in the request body. Before, it was incorrectly located inside card.expiration.
    • Added description of isCorporate, corporateName, tradeName and corporateDocument fields of the miniCard.buyer parameter in the request body.
    • Removed requirement of complement field of the miniCart.shippingAddress and miniCart.billingAddress parameters in the request body.
    • Removed requirement of categoryId and sellerId fields of the miniCard.items parameter in the request body.
    • Corrected type of miniCart.merchantSettings parameter in the request body from object to array of objects and added description.
    • Added response examples for Redirect and Callback cases.
    • Added examples for multiple request body fields.
  • GET List Payment Provider Manifest endpoint.
  • POST Settle Payment, POST Cancel Payment, POST Refund Payment and POST Inbound Request endpoints.
    • Added merchantSettings parameter in the request body with all the parameters.

Also, we improved the Redirect section of the Purchase Flows article by adding an image with a sequence diagram and a detailed explanation of the steps that occur when the Redirect flow is used for payments.

Was this helpful?
Yes
No
On this page