Sign in
Configuration

List all available payment methods

Returns all payment methods (such as Visa, Master, among others) that can be used in your store.

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:

ProductCategoryResource
PCI GatewayPayment-Make PaymentsView 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.

get/api/pvt/merchants/payment-systems

Query parameters

salesChannelinteger
Example:1

Sales channel (trade policy) identification. This parameter must be filled in if you wish to obtain information on payment methods available in a specific store sales channel.

Headers

Content-Typestring required
Example:application/json

Type of the content being sent.

Acceptstring required
Example:application/json

HTTP Client Negotiation Accept Header. Indicates the types of responses the client can understand.

Response

OK

idnumber required

Payment method identification.

namestring required

Payment method name.

requiresDocumentboolean required

Indicates whether a document is required.

implementationstring required

Payment method implementation class name.

connectorImplementationstring required

Connector (payment provider) implementation class name.

antifraudConnectorImplementationstring nullable required

Connector (anti-fraud provider) implementation class name.

groupNamestring required

Payment group name.

redirectboolean required

Indicates whether the payment method allows redirection.

isCustomboolean required

Indicates whether it is custom.

isSelfAuthorizedboolean required

Indicates whether the payment is automatically authorized.

requiresAuthenticationboolean required

Indicates whether it is necessary to log in to make the payment.

allowInstallmentsboolean required

Indicates whether the payment method allows installments.

allowBinExclusionboolean required

Indicates whether it is possible to restrict the use of specific BIN codes (only applicable for cards).

allowMultipleboolean required

Indicates whether the method allows multiple payments. Example of false: debit card.

allowIssuerboolean required

Indicates whether it is possible to identify the name of the bank responsible for issuing the card.

allowCountryboolean required

Indicates whether it is possible to restrict a payment rule by the country where the purchase is made.

allowCommercialPolicyboolean required

Indicates whether to restrict a payment rule by commercial policy type.

allowCommercialConditionboolean required

Indicates whether to restrict a payment rule by commercial condition type.

allowPeriodboolean required

Indicates whether it is possible to restrict a period for making the payment.

isAvailableboolean required

Indicates whether the payment method is available for use.

descriptionstring nullable required

Description of the payment method.

supportRecurrenceboolean required

Indicates whether the payment method supports recurrence.

appDependenciesstring nullable required

App dependencies information.

displayDocumentboolean required

Indicates whether a document is shown.

dueDatestring required

Payment due date.

allowNotificationboolean required

Indicates the possibility of payment notification (used by bank invoices and notes payable).

affiliationIdstring nullable required

Affiliation connector (payment provider) identification.

availablePaymentsstring nullable required

Information about payment availability.

dueDateMinutesnumber required

Amount of time (in minutes) until the payment date (dueDate).

Changes

Changed in 3 of the 52 revisions of this API.13

  • 39526dd7405c1See the full diff
    • ○

      added the new optional query request parameter salesChannel

      new-optional-request-parameter

  • aca4931fa22b2See the full diff
    • ○

      the endpoint scheme security VtexIdclientAutCookie was added to the API

      api-security-added

    • ○

      the endpoint scheme security appKey AND appToken was added to the API

      api-security-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e6bea95b9c181See the full diff
    • ▲

      the items/id response's property type/format changed from string/ to number/ for status 200

      response-property-type-changed