VTEX · Example Payload
Vtex Availablepaymentmethods Example
CommerceE-CommerceRetailMarketplacePayments
Vtex Availablepaymentmethods Example is an example object payload from VTEX, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.
Top-level fields
operationIdmethodpathsummaryrequestExamplesresponseExamples
Example Payload
{
"operationId": "AvailablePaymentMethods",
"method": "GET",
"path": "/api/pvt/merchants/payment-systems",
"summary": "VTex List all available payment methods",
"requestExamples": [],
"responseExamples": [
{
"status": "200",
"contentType": "application/json",
"example": [
{
"id": 1,
"name": "American Express",
"requiresDocument": false,
"implementation": "Vtex.PaymentGateway.CreditCard.Amex",
"connectorImplementation": "Vtex.PaymentGateway.Connectors.AuthorizeDotNet.AuthorizeDotNetConnector",
"antifraudConnectorImplementation": null,
"groupName": "creditCard",
"redirect": false,
"isCustom": false,
"isSelfAuthorized": false,
"requiresAuthentication": false,
"allowInstallments": true,
"allowBinExclusion": false,
"allowMultiple": true,
"allowIssuer": true,
"allowCountry": false,
"allowCommercialPolicy": true,
"allowCommercialCondition": true,
"allowPeriod": true,
"isAvailable": true,
"description": null,
"supportRecurrence": true,
"validator": {
"regex": "^3[47][0-9]{13}$",
"mask": "9999 999999 99999",
"cardCodeMask": "9999",
"cardCodeRegex": "^[0-9]{4}$",
"weights": [
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1
],
"useCvv": true,
"useExpirationDate": true,
"useCardHolderName": true,
"useBillingAddress": true,
"validCardLengths": null
},
"appDependencies": null,
"displayDocument": false,
"dueDate": "2023-12-20T11:46:27.2993428Z",
"allowNotification": false,
"affiliationId": null,
"availablePayments": null,
"dueDateMinutes": 10079
},
{
"id": 72,
"name": "PicPay",
"requiresDocument": false,
"implementation": "Vtex.PaymentGateway.RedirectPayments.PicPayPayment",
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_PicPay",
"antifraudConnectorImplementation": null,
"groupName": "picPay",
"redirect": true,
"isCustom": false,
"isSelfAuthorized": false,
"requiresAuthentication": false,
"allowInstallments": true,
"allowBinExclusion": false,
"allowMultiple": true,
"allowIssuer": false,
"allowCountry": true,
"allowCommercialPolicy": true,
"allowCommercialCondition": true,
"allowPeriod": true,
"isAvailable": true,
"description": null,
"supportRecurrence": false,
"validator": {
"regex": null,
"mask": null,
"cardCodeMask": null,
"cardCodeRegex": null,
"weights": null,
"useCvv": false,
"useExpirationDate": false,
"useCardHolderName": false,
"useBillingAddress": false,
"validCardLengths": null
},
"appDependencies": null,
"displayDocument": false,
"dueDate": "2023-12-20T11:46:27.2993428Z",
"allowNotification": false,
"affiliationId": null,
"availablePayments": null,
"dueDateMinutes": 10079
},
{
"id": 64,
"name": "Customer Credit",
"requiresDocument": false,
"implementation": "Vtex.PaymentGateway.Promissory.CreditControlPayment",
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_CreditControlV2",
"antifraudConnectorImplementation": null,
"groupName": "creditControl",
"redirect": false,
"isCustom": false,
"isSelfAuthorized": false,
"requiresAuthentication": false,
"allowInstallments": true,
"allowBinExclusion": false,
"allowMultiple": true,
"allowIssuer": false,
"allowCountry": false,
"allowCommercialPolicy": true,
"allowCommercialCondition": true,
"allowPeriod": true,
"isAvailable": true,
"description": null,
"supportRecurrence": false,
"validator": {
"regex": null,
"mask": null,
"cardCodeMask": null,
"cardCodeRegex": null,
"weights": null,
"useCvv": false,
"useExpirationDate": false,
"useCardHolderName": false,
"useBillingAddress": false,
"validCardLengths": null
},
"appDependencies": null,
"displayDocument": false,
"dueDate": "2023-12-20T11:46:27.2993428Z",
"allowNotification": false,
"affiliationId": null,
"availablePayments": null,
"dueDateMinutes": 10079
},
{
"id": 16,
"name": "Vale",
"requiresDocument": true,
"implementation": "Vtex.PaymentGateway.GiftCard.VtexGiftCard",
"connectorImplementation": "Vtex.PaymentGateway.Connectors.VtexGiftCardHub.VtexGiftCardHubConnector",
"antifraudConnectorImplementation": null,
"groupName": "giftCard",
"redirect": false,
"isCustom": false,
"isSelfAuthorized": false,
"requiresAuthentication": false,
"allowInstallments": false,
"allowBinExclusion": false,
"allowMultiple": true,
"allowIssuer": false,
"allowCountry": false,
"allowCommercialPolicy": true,
"allowCommercialCondition": true,
"allowPeriod": true,
"isAvailable": true,
"description": null,
"supportRecurrence": false,
"validator": {
"regex": null,
"mask": null,
"cardCodeMask": null,
"cardCodeRegex": null,
"weights": null,
"useCvv": false,
"useExpirationDate": false,
"useCardHolderName": false,
"useBillingAddress": false,
"validCardLengths": null
},
"appDependencies": null,
"displayDocument": true,
"dueDate": "2023-12-20T11:46:27.2993428Z",
"allowNotification": false,
"affiliationId": null,
"availablePayments": null,
"dueDateMinutes": 10079
},
{
"id": 39,
"name": "Maestro",
"requiresDocument": false,
"implementation": "Vtex.PaymentGateway.Card.Maestro",
"connectorImplementation": "Vtex.PaymentGateway.Connectors.AdyenConnector",
"antifraudConnectorImplementation": null,
"groupName": "debitCard",
"redirect": false,
"isCustom": false,
"isSelfAuthorized": false,
"requiresAuthentication": false,
"allowInstallments": false,
"allowBinExclusion": false,
"allowMultiple": false,
"allowIssuer": true,
"allowCountry": false,
"allowCommercialPolicy": true,
"allowCommercialCondition": true,
"allowPeriod": true,
"isAvailable": true,
"description": null,
"supportRecurrence": false,
"validator": {
"regex": "^((5(([1-2]|[4-5])[0-9]{8}|0((1|6)([0-9]{7}))|3(0(4((0|[2-9])[0-9]{5})|([0-3]|[5-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\\d{4,10})|((502121)\\d{4,10})|((589916)\\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\\d{4,10})",
"mask": "9999 9999 9999 9999",
"cardCodeMask": "999",
"cardCodeRegex": "^[0-9]{3}$",
"weights": [
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2
],
"useCvv": true,
"useExpirationDate": true,
"useCardHolderName": true,
"useBillingAddress": true,
"validCardLengths": null
},
"appDependencies": null,
"displayDocument": false,
"dueDate": "2023-12-20T11:46:27.2993428Z",
"allowNotification": false,
"affiliationId": null,
"availablePayments": null,
"dueDateMinutes": 10079
},
{
"id": 169,
"name": "Google Pay",
"requiresDocument": false,
"implementation": "Vtex.PaymentGateway.RedirectPayments.GooglePayPayment",
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_stripe-payment-provider-connector-v3",
"antifraudConnectorImplementation": null,
"groupName": "Google Pay",
"redirect": true,
"isCustom": false,
"isSelfAuthorized": false,
"requiresAuthentication": false,
"allowInstallments": false,
"allowBinExclusion": false,
"allowMultiple": true,
"allowIssuer": false,
"allowCountry": true,
"allowCommercialPolicy": true,
"allowCommercialCondition": true,
"allowPeriod": true,
"isAvailable": true,
"description": null,
"supportRecurrence": false,
"validator": {
"regex": null,
"mask": null,
"cardCodeMask": null,
"cardCodeRegex": null,
"weights": null,
"useCvv": false,
"useExpirationDate": false,
"useCardHolderName": false,
"useBillingAddress": false,
"validCardLengths": null
},
"appDependencies": null,
"displayDocument": false,
"dueDate": "2023-12-20T11:46:27.2993428Z",
"allowNotification": false,
"affiliationId": null,
"availablePayments": null,
"dueDateMinutes": 10079
},
{
"id": 4,
"name": "Mastercard",
"requiresDocument": true,
"implementation": "Vtex.PaymentGateway.CreditCard.Mastercard",
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_cosmetics2-payment-provider-v0",
"antifraudConnectorImplementation": null,
"groupName": "creditCard",
"redirect": false,
"isCustom": false,
"isSelfAuthorized": false,
"requiresAuthentication": false,
"allowInstallments": true,
"allowBinExclusion": false,
"allowMultiple": true,
"allowIssuer": true,
"allowCountry": false,
"allowCommercialPolicy": true,
"allowCommercialCondition": true,
"allowPeriod": true,
"isAvailable": true,
"description": null,
"supportRecurrence": true,
"validator": {
"regex": "^((5(([1-2]|[4-5])[0-9]{8}|0((1|6)([0-9]{7}))|3(0(4((0|[2-9])[0-9]{5})|([0-3]|[5-9])[0-9]{6})|[1-9][0-9]{7})))|((508116)\\d{4,10})|((502121)\\d{4,10})|((589916)\\d{4,10})|(2[0-9]{15})|(67[0-9]{14})|(506387)\\d{4,10})",
"mask": "9999 9999 9999 9999",
"cardCodeMask": "999",
"cardCodeRegex": "^[0-9]{3}$",
"weights": [
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2
],
"useCvv": true,
"useExpirationDate": true,
"useCardHolderName": true,
"useBillingAddress": true,
"validCardLengths": null
},
"appDependencies": null,
"displayDocument": true,
"dueDate": "2023-12-20T11:46:27.2993428Z",
"allowNotification": false,
"affiliationId": null,
"availablePayments": null,
"dueDateMinutes": 10079
},
{
"id": 401,
"name": "PaymentApp",
"requiresDocument": false,
"implementation": "Vtex.PaymentGateway.CreditCard.PrivateLabelPayment",
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_cosmetics2-payment-provider-v0",
"antifraudConnectorImplementation": null,
"groupName": "customPrivate_401",
"redirect": false,
"isCustom": true,
"isSelfAuthorized": false,
"requiresAuthentication": false,
"allowInstallments": true,
"allowBinExclusion": false,
"allowMultiple": true,
"allowIssuer": true,
"allowCountry": false,
"allowCommercialPolicy": true,
"allowCommercialCondition": true,
"allowPeriod": true,
"isAvailable": true,
"description": "",
"supportRecurrence": true,
"validator": {
"regex": "1(0(0(0(0([0-9])|[1-9][0-9]{11})|[1-9][0-9]{12})|[1-9][0-9]{13})|[1-9][0-9]{14})|9(9(9(9(9([0-9])|[0-8][0-9]{11})|[0-8][0-9]{12})|[0-8][0-9]{13})|[0-8][0-9]{14})|[2-8][0-9]{15}",
"mask": "9999 9999 9999 9999",
"cardCodeMask": "999",
"cardCodeRegex": "^[0-9]{3}$",
"weights": [],
"useCvv": true,
"useExpirationDate": true,
"useCardHolderName": true,
"useBillingAddress": false,
"validCardLengths": null
},
"appDependencies": null,
"displayDocument": false,
"dueDate": "2023-12-23T11:46:27.2993428Z",
"allowNotification": false,
"affiliationId": null,
"availablePayments": null,
"dueDateMinutes": 14399
},
{
"id": 2,
"name": "Visa",
"requiresDocument": false,
"implementation": "Vtex.PaymentGateway.CreditCard.Visa",
"connectorImplementation": "Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_cosmetics2-payment-provider-v0",
"antifraudConnectorImplementation": null,
"groupName": "creditCard",
"redirect": false,
"isCustom": false,
"isSelfAuthorized": false,
"requiresAuthentication": false,
"allowInstallments": true,
"allowBinExclusion": false,
"allowMultiple": true,
"allowIssuer": true,
"allowCountry": false,
"allowCommercialPolicy": true,
"allowCommercialCondition": true,
"allowPeriod": true,
"isAvailable": true,
"description": null,
"supportRecurrence": true,
"validator": {
"regex": "^4[0-9]{15}$",
"mask": "9999 9999 9999 9999",
"cardCodeMask": "999",
"cardCodeRegex": "^[0-9]{3}$",
"weights": [
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2,
1,
2
],
"useCvv": true,
"useExpirationDate": true,
"useCardHolderName": true,
"useBillingAddress": true,
"validCardLengths": null
},
"appDependencies": null,
"displayDocument": false,
"dueDate": "2023-12-20T11:46:27.2993428Z",
"allowNotification": false,
"affiliationId": null,
"availablePayments": null,
"dueDateMinutes": 10079
}
]
}
]
}