Get installments options
Returns the best installment options according to the parameters informed in the request.
Permissions
Any user or API key must have at least one of the appropriate License Manager resources to be able to successfully run this request. Otherwise they will receive a status code 403 error. These are the applicable resources for this endpoint:
| Product | Category | Resource |
|---|---|---|
| PCI Gateway | Payment-Make Payments | View Payment Data |
There are no applicable predefined roles for this resource list. You must create a custom role and add at least one of the resources above in order to use this endpoint. To learn more about machine authentication at VTEX, see Authentication overview.
❗ To prevent integrations from having excessive permissions, consider the best practices for managing API keys when assigning License Manager roles to integrations.
Query parameters
Value to be divided into installments.
Sales channel identification. Attribute created by the seller in their VTEX store configuration.
Payment system identification.
Total value paid in installments. If applied in the search, it must be equal to the request.value field.
First six digits of the card number.
Headers
Type of the content being sent.
HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.
Response
OK