2022
May
Improvements to the Payment Provider Protocol API and Redirect flow documentation
The [Payment Provider Protocol (PPP) API documentation](https://developers.vtex.com/vtex-rest-api/reference/payment-provider-protocol-api-overview) and the [Redirect section of the Purchase Flows article](https://developers.vtex.com/vtex-rest-api/docs/payments-integration-purchase-flows#redirect) have just been updated.

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
andipAddress
parameters in the request body. - Added description of
card
parameter in the request body. document
field is now properly located inside thecard
parameter in the request body. Before, it was incorrectly located insidecard.expiration
.- Added description of
isCorporate
,corporateName
,tradeName
andcorporateDocument
fields of theminiCard.buyer
parameter in the request body. - Removed requirement of
complement
field of theminiCart.shippingAddress
andminiCart.billingAddress
parameters in the request body. - Removed requirement of
categoryId
andsellerId
fields of theminiCard.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.
- Removed requirement of
- GET List Payment Provider Manifest endpoint.
- Improved description of
paymentMethods[].allowsSplit
field in the response body to include reference to the Split Payouts on the Payment Provider Protocol article. - Improved description of
autoSettleDelay
parameter in the response body to include reference to the Custom Auto Capture Feature article and added requirement ofminimum
andmaximum
fields.
- Improved description of
- 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.
- Added
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.