[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides faststore analytics implementing custom newsletter analytics events in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/sdk-overview)

[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-overview)

[sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-send-analytics-event)

[useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-use-analytics-event)

[Sending custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-sending-custom-events)

[Extending and customizing native types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-extending-and-customizing-native-types)

[Use case: Implementing custom newsletter analytics events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events)

[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/cart-overview)

[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/search-overview)

[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/session-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/sdk-overview)

[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-overview)

[sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-send-analytics-event)

[useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-use-analytics-event)

[Sending custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-sending-custom-events)

[Extending and customizing native types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-extending-and-customizing-native-types)

[Use case: Implementing custom newsletter analytics events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events)

[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/cart-overview)

[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/search-overview)

[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/session-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/storefront-best-practices)

---

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/storefront-development)

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/sdk-overview)

[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-overview)

Use case: Implementing custom newsletter analytics events

This guide walks you through the process of implementing custom analytics events in FastStore projects. The example in this guide explains how to track user subscriptions by implementing two custom analytics events for a custom newsletter section:

* `Submit newsletter`: Triggered when a user clicks `Subscribe`.
* `Submit newsletter success`: Triggered upon successful subscription.

![{"base64":"  ","img":{"width":1358,"height":607,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":338579,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/analytics-custom-newsletter-firing-event___45d3f6e3f8586ef7fbbb389128bb4460.gif"}}](https://read.calvincode.net/reader?url=https://vtexhelp.vtexassets.com/assets/docs/src/analytics-custom-newsletter-firing-event___45d3f6e3f8586ef7fbbb389128bb4460.gif)

> For a complete implementation example, check the [playground.store](https://read.calvincode.net/reader?url=https://github.com/vtex-sites/playground.store/tree/main/src/components/sections/CustomNewsletter) repository, which provides more in-depth details.

## Before you begin

To follow this guide, you should be familiar with the following topics:

* [FastStore Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview)
* [Sending custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events)
* [Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section)

## Instructions

### Creating a custom newsletter section

Create a new section to receive the two new custom events:

1. Open your store repository. If you don't have it, create a folder named `components` in the `src` directory.
2. In `components`, create the `sections` folder.
3. In the `sections` folder, create the `CustomNewsletter.tsx` file and add the following code. Below is an explanation of the code.

#### `NewsletterProps`

Defines the customizable properties of the newsletter.

* `title`: Heading of the newsletter.
* `description`: Subtitle or description text.
* `emailInputLabel`: Label for the email input field.
* `subscribeButtonLabel`: Text for the submit button.
* `toastSubscribe`: Success pop-up settings.
* `toastSubscribeError`: Error pop-up settings.
* `privacyPolicy`: Legal disclaimer text.
* `card`: Defines whether the newsletter should display in a card-style container.
* `colorVariant`: Styling theme (example: "primary", "secondary").

#### `onSubmit` function

Handles the newsletter subscription process.

* `event.preventDefault()`: Prevents default form submission.
   * [sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event): Tracks the submission attempt.
         * The `onSubmit` function calls the `subscribeUser()` with email and name.
                  * If successful:
                              * Shows a success toast (`pushToast`).
                              * Resets the form (`formRef.current?.reset()`).
                  * If the call fails, it shows an error toast.
   * `pushToast`: Displays temporary success/error messages.
   * [sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event): Tracks user interactions.
         * `Submit Newsletter` event: Tracks the form submission attempt when the user clicks the `Subscribe` button.
         * `Submit newsletter success` event: Tracks if the subscription was successful.
   * [useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-use-analytics-event) hook: Tracks and handles custom analytics events.

### Creating the section `index` file

To make the Newsletter section available in the project, create a file named `index.tsx` in the components folder and add the following:

### Styling the new section

To add styles to this new section, create a `section.module.scss` file and add the following:

### Updating the CMS folder

1. In the root directory of your storefront project, create a folder named `cms` if it doesn't exist.
2. In `cms`, create the `faststore` folder.
3. In the `cms/faststore` folder, create the `sections.json` file.
4. In the `sections.json` file, add the new section you want to display in Headless CMS. The schema below defines how Headless CMS renders a section:

CustomNewsletter.tsx

`` 1

import type {

2

 ToastProps,

3

 NewsletterAddendumProps as UINewsletterAddendumProps,

4

 NewsletterHeaderProps as UINewsletterHeaderProps,

5

 NewsletterProps as UINewsletterProps,

6

} from "@faststore/ui";

7

import { useUI } from "@faststore/ui";

8

import styles from "./section.module.scss";

9

10

import {

11

 Button,

12

 Icon,

13

 InputField,

14

 Newsletter,

15

 NewsletterAddendum,

16

 NewsletterContent,

17

 NewsletterForm,

18

 NewsletterHeader,

19

} from "@faststore/ui";

20

21

import { Section } from "@faststore/core";

22

import { useNewsletter_unstable as useNewsletter } from "@faststore/core/experimental";

23

import { type FormEvent, useRef } from "react";

24

import { sendAnalyticsEvent, useAnalyticsEvent } from "@faststore/sdk";

25

26

interface ArbitraryEvent {

27

 name: string;

28

 params: string;

29

}

30

31

type SubscribeMessage = {

32

 icon: string;

33

 title: string;

34

 message: string;

35

};

36

37

export interface NewsletterProps {

38

 title: UINewsletterHeaderProps["title"];

39

 card?: UINewsletterProps["card"];

40

 colorVariant?: UINewsletterProps["colorVariant"];

41

 description?: UINewsletterHeaderProps["description"];

42

 privacyPolicy?: UINewsletterAddendumProps["addendum"];

43

 emailInputLabel?: string;

44

 displayNameInput?: boolean;

45

 icon: {

46

 alt: string;

47

 icon: string;

48

 };

49

 nameInputLabel?: string;

50

 subscribeButtonLabel?: string;

51

 subscribeButtonLoadingLabel?: string;

52

 toastSubscribe?: SubscribeMessage;

53

 toastSubscribeError?: SubscribeMessage;

54

}

55

56

export const AnalyticsHandler = () => {

57

 useAnalyticsEvent((event: ArbitraryEvent) => {

58

 console.log("Received event", event);

59

 });

60

61

 /* ... */

62

63

 return null;

64

};

65

66

function CustomNewsletter({

67

 icon: { icon, alt: iconAlt },

68

 title,

69

 description,

70

 privacyPolicy,

71

 emailInputLabel,

72

 displayNameInput,

73

 nameInputLabel,

74

 subscribeButtonLabel,

75

 subscribeButtonLoadingLabel,

76

 card,

77

 toastSubscribe,

78

 toastSubscribeError,

79

 colorVariant,

80

 ...otherProps

81

}: NewsletterProps) {

82

 const { pushToast } = useUI();

83

 const { subscribeUser, loading } = useNewsletter();

84

85

 const formRef = useRef<HTMLFormElement>(null);

86

 const nameInputRef = useRef<HTMLInputElement>(null);

87

 const emailInputRef = useRef<HTMLInputElement>(null);

88

89

 const onSubmit = async (event: FormEvent) => {

90

 event.preventDefault();

91

92

 try {

93

 // send event start

94

 sendAnalyticsEvent<ArbitraryEvent>({

95

 name: "Submit Newsletter",

96

 params: "test",

97

 });

98

99

 const data = await subscribeUser({

100

 data: {

101

 name: nameInputRef.current?.value ?? "",

102

 email: emailInputRef.current?.value ?? "",

103

 },

104

 });

105

106

 if (data?.subscribeToNewsletter?.id) {

107

 // send event start

108

 sendAnalyticsEvent<ArbitraryEvent>({

109

 name: "Submit newsletter success",

110

 params: "test",

111

 });

112

113

 pushToast({

114

 ...toastSubscribe,

115

 status: "INFO",

116

 icon: (

117

 <Icon width={30} height={30} name={toastSubscribe?.icon ?? ""} />

118

 ),

119

 } as ToastProps);

120

121

 formRef?.current?.reset();

122

 }

123

 } catch (error) {

124

 pushToast({

125

 ...toastSubscribeError,

126

 status: "ERROR",

127

 icon: (

128

 <Icon width={30} height={30} name={toastSubscribeError?.icon ?? ""} />

129

 ),

130

 } as ToastProps);

131

 }

132

 };

133

134

 return (

135

 <Section className={`${styles.section} section-newsletter layout__section`}>

136

 <AnalyticsHandler />

137

 <Newsletter card={card ?? false} colorVariant={colorVariant}>

138

 <NewsletterForm ref={formRef} onSubmit={onSubmit}>

139

 <NewsletterHeader

140

 title={title}

141

 description={description}

142

 icon={

143

 <Icon width={32} height={32} name={icon} aria-label={iconAlt} />

144

 }

145

 />

146

147

 <NewsletterContent>

148

 {displayNameInput && (

149

 <InputField

150

 id="newsletter-name"

151

 required

152

 label={nameInputLabel ?? "Name"}

153

 inputRef={nameInputRef}

154

 />

155

 )}

156

 <InputField

157

 id="newsletter-email"

158

 type="email"

159

 required

160

 label={emailInputLabel ?? "Email"}

161

 inputRef={emailInputRef}

162

 />

163

 <NewsletterAddendum addendum={privacyPolicy} />

164

 <Button variant="secondary" inverse type="submit">

165

 {loading ? subscribeButtonLoadingLabel : subscribeButtonLabel}

166

 </Button>

167

 </NewsletterContent>

168

 </NewsletterForm>

169

 </Newsletter>

170

 </Section>

171

 );

172

}

173

174

export default CustomNewsletter;

 ``

### Syncing the new section with Headless CMS

1. In the terminal, log in to your VTEX account by running `vtex login {accountName}`.
> Replace `{accountName}` with the name of your account. For example, `vtex login store`.
2. Run `yarn cms-sync` to sync the new section you created with CMS.
3. Go to the VTEX Admin and navigate to **Storefront > Headless CMS**.
4. Click the **Home** Content Type.
5. In the Sections tab, click `+`, search for the new **Custom Newsletter** section, and add it to your page.
![{"base64":"  ","img":{"width":1358,"height":551,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":2814641,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/analytics-custom-newsletter-section___96abd10dc72c4f09c15f71a9e42651d7.gif"}}](https://read.calvincode.net/reader?url=https://vtexhelp.vtexassets.com/assets/docs/src/analytics-custom-newsletter-section___96abd10dc72c4f09c15f71a9e42651d7.gif)
6. Delete the **Newsletter** default section.
7. Click `Save`.
8. Click `Preview` to preview the new section before publishing it to the live store.

## Results

1. After opening the preview browser tab, open the browser's **Developer Tools** and go to the **Console** tab.
2. Go to the newsletter section on the store page and complete **Your Name** and **Your Email** fields.
3. Click `Subscribe`. You will notice in the **Console** tab that the two custom events were successfully triggered.
![{"base64":"  ","img":{"width":1358,"height":607,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":338579,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/analytics-custom-newsletter-firing-event___45d3f6e3f8586ef7fbbb389128bb4460.gif"}}](https://read.calvincode.net/reader?url=https://vtexhelp.vtexassets.com/assets/docs/src/analytics-custom-newsletter-firing-event___45d3f6e3f8586ef7fbbb389128bb4460.gif)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/sdk/analytics/implementing-custom-newsletter-analytics-events.mdx)

[Extending and customizing native types« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-extending-and-customizing-native-types)[CartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/cart-overview)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23before-you-begin)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23instructions)

[Creating a custom newsletter section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23creating-a-custom-newsletter-section)[Creating the section index file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23creating-the-section-index-file)[Styling the new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23styling-the-new-section)[Updating the CMS folder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23updating-the-cms-folder)[Syncing the new section with Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23syncing-the-new-section-with-headless-cms)

[Results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23results)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/sdk/analytics/implementing-custom-newsletter-analytics-events.mdx)

Copy page

On this page

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23before-you-begin)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23instructions)

[Creating a custom newsletter section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23creating-a-custom-newsletter-section)[Creating the section index file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23creating-the-section-index-file)[Styling the new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23styling-the-new-section)[Updating the CMS folder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23updating-the-cms-folder)[Syncing the new section with Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23syncing-the-new-section-with-headless-cms)

[Results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23results)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides google pay processing information for payment providers and anti fraud in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/getting-started)

---

Integration Guides

[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/erp-integration-guide)

[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/customer-credit-integration-guide)

[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/external-marketplace-integration-guide)

[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/external-seller-integration-guide)

[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/gift-card-integration-guide)

[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/headless-commerce)

[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/login-integration-guide)

[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/punchout)

[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/sent-offers-integration-guide-connectors)

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-guide)

[Integrating a new payment provider on VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/integrating-a-new-payment-provider-on-vtex)

[Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-payment-provider-protocol)

[Payment Provider Protocol for Point of Sale (POS) - VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-ppp-applied-to-pos)

[Implementing a Payment Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-implementing-a-payment-provider)

[Payment Provider Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-payment-provider-framework)

[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-purchase-flows)

[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-payment-app)

[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-payment-methods)

[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-payment-provider-homologation)

[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works)

[PCI - DSS Compliance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-pci-dss-compliance)

[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-secure-proxy)

[Split Payouts on Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/split-payouts-on-payment-provider-protocol)

[Layout Development Guide for payment methods in Smart Checkout VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex)

[Custom Auto Capture Feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/custom-auto-capture-feature)

[Pix: Instant Payments in Brazil](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-pix-instant-payments-in-brazil)

[PSE Payment Method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/pse-payment-method)

[Google Pay: processing information for payment providers and anti-fraud](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud)

[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/search-integration-guide)

[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/session-manager)

[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/tax-service-integration-guide)

[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/pricing-hub)

[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/recaptcha)

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/getting-started)

---

Integration Guides

[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/erp-integration-guide)

[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/customer-credit-integration-guide)

[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/external-marketplace-integration-guide)

[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/external-seller-integration-guide)

[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/gift-card-integration-guide)

[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/headless-commerce)

[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/login-integration-guide)

[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/punchout)

[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/sent-offers-integration-guide-connectors)

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-guide)

[Integrating a new payment provider on VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/integrating-a-new-payment-provider-on-vtex)

[Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-payment-provider-protocol)

[Payment Provider Protocol for Point of Sale (POS) - VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-ppp-applied-to-pos)

[Implementing a Payment Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-implementing-a-payment-provider)

[Payment Provider Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-payment-provider-framework)

[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-purchase-flows)

[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-payment-app)

[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-payment-methods)

[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-payment-provider-homologation)

[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works)

[PCI - DSS Compliance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-pci-dss-compliance)

[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-secure-proxy)

[Split Payouts on Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/split-payouts-on-payment-provider-protocol)

[Layout Development Guide for payment methods in Smart Checkout VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex)

[Custom Auto Capture Feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/custom-auto-capture-feature)

[Pix: Instant Payments in Brazil](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-pix-instant-payments-in-brazil)

[PSE Payment Method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/pse-payment-method)

[Google Pay: processing information for payment providers and anti-fraud](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud)

[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/search-integration-guide)

[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/session-manager)

[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/tax-service-integration-guide)

[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/pricing-hub)

[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/recaptcha)

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides)

Integration Guides

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-guide)

[Google Pay: processing information for payment providers and anti-fraud](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud)

FAQ - Google Pay: processing information for payment providers and anti-fraud

Here are some answers to questions you may have about transactions with Google Pay:

## What are the differences between the payload used for a standard credit card payment and the one used for Google Pay [DPAN](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/dpan-and-fpan-understanding-security-in-the-online-tokenized-payment-flow--3RM7RvhKZ057wja5xVEOqb)?

Besides the original fields for a credit or debit card payment transaction, the Google Pay DPAN transaction has three additional fields:

* `cryptogram`: 3DS cryptogram information (previously called `3DS_criptogram`).
* `eci`: Electronic Commerce Indicator (previously called `ECI_Indicador`). This field is sent only for Visa transactions and indicates the result of the authentication attempt made by the 3DS system.
* `paymentOrigin` (optional): Identifies the type of card used for payment. To enable this field in Google Pay (DPAN) transactions or FPAN transactions and receive the information in the [Create payment endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments) payload, open a ticket with [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/support).

In the VTEX Admin, go to **Orders > Transactions** to check if a transaction has been made with Google Pay.

![{"base64":"  ","img":{"width":582,"height":199,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":19329,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Integration-Guides/payments-integration-guide/dpan-transaction-fields-1.png"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Integration-Guides/payments-integration-guide/dpan-transaction-fields-1.png)

> The `paymentOrigin`, `panType`, and `cryptogram` fields aren't sent in standard credit or debit card transactions (without using a digital wallet).

## What are the possible values for the `paymentOrigin` field in the payload?

The `paymentOrigin` field is always sent with the "Google Pay" value. Payment transactions using other payment methods don't have the `paymentOrigin` field in the payload.

## Is the Card Verification Value (CVV) sent in Google Pay transactions?

No. The card CVV is sent in certain FPAN-type transactions. DPAN payment transactions do not require the card CVV number.

> Transactions processed in subscription or recurring operations do not use the card CVV as well.

## How can I simulate a DPAN test transaction?

To run a DPAN test transaction, follow these steps:

1. Add a new card in the Google Pay digital wallet app or via redirection from the bank app (Android).
2. Open the Chrome browser using the same Android device you used to add the card.
3. Simulate buying a product, and on the checkout screen, select the option to pay using Google Pay.
> Make sure to select the card that displays the actual card image, as it defines the transaction will use DPAN. If you select the card displaying the flag image, the transaction will use the FPAN method.
4. Complete the payment and check the DPAN transaction data in your system.

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F87548049%3Fv%3D4%26w=64%26q=75)](https://github.com/ricardoaerobr)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F13488025%3Fv%3D4%26w=64%26q=75)](https://github.com/jadsonluan)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/google-pay-processing-information-for-payment-providers-and-anti-fraud.md)

[PSE Payment Method« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud//docs/guides/pse-payment-method)[Search ProtocolNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud//docs/guides/search-integration-guide)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F87548049%3Fv%3D4%26w=64%26q=75)](https://github.com/ricardoaerobr)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F13488025%3Fv%3D4%26w=64%26q=75)](https://github.com/jadsonluan)

ON THIS PAGE

[What are the differences between the payload used for a standard credit card payment and the one used for Google Pay DPAN?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud%23what-are-the-differences-between-the-payload-used-for-a-standard-credit-card-payment-and-the-one-used-for-google-pay-dpan)

[What are the possible values for the paymentOrigin field in the payload?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud%23what-are-the-possible-values-for-the-paymentorigin-field-in-the-payload)

[Is the Card Verification Value (CVV) sent in Google Pay transactions?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud%23is-the-card-verification-value-cvv-sent-in-google-pay-transactions)

[How can I simulate a DPAN test transaction?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud%23how-can-i-simulate-a-dpan-test-transaction)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/google-pay-processing-information-for-payment-providers-and-anti-fraud.md)

Copy page

On this page

ON THIS PAGE

[What are the differences between the payload used for a standard credit card payment and the one used for Google Pay DPAN?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud%23what-are-the-differences-between-the-payload-used-for-a-standard-credit-card-payment-and-the-one-used-for-google-pay-dpan)

[What are the possible values for the paymentOrigin field in the payload?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud%23what-are-the-possible-values-for-the-paymentorigin-field-in-the-payload)

[Is the Card Verification Value (CVV) sent in Google Pay transactions?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud%23is-the-card-verification-value-cvv-sent-in-google-pay-transactions)

[How can I simulate a DPAN test transaction?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud%23how-can-i-simulate-a-dpan-test-transaction)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides getting started list of rest apis in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/api-usage)

[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/getting-started-list-of-rest-apis)

[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/making-your-first-request)

[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/authentication)

[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/api-response-codes)

Error handling and best practices

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/api-usage)

[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/getting-started-list-of-rest-apis)

[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/making-your-first-request)

[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/authentication)

[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/api-response-codes)

Error handling and best practices

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides)

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/api-usage)

[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/getting-started-list-of-rest-apis)

List of REST APIs

See how to use our APIs to integrate third-party solutions with a single platform for all experiences.

| Name                                                                                | Description                                                                                |
| --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol)                             | Defines the requirements to integrate an anti-fraud service into VTEX.                                                                                |
| [Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/legacy-cms-portal-api)                                     | Manages Legacy CMS Portal via API.                                                                                |
| [Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal)                           | Creates, edits, and retrieves products and their variations, brands, and categories in the Seller Portal.                                                                  |
| [Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api)                                                         | Allows performing operations on your store sales channels, categories, brands, products, SKUs, and specifications.                                                         |
| [Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api)                                                       | Allows access and operations on data from items in a shopping cart.                                                                                |
| [Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api)                                         | Enables credit payments on your store and controls invoices and credit limits.                                                                                |
| [GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api)                                                       | Retrieves and updates gift cards from our native gift card system.                                                                                |
| [GiftCard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol)                       | Defines the requirements to become a gift card provider on VTEX.                                                                                |
| [GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-hub-api)                                               | Interacts with all gift card providers in a store from a single place.                                                                                |
| [Headless CMS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api)                                               | Structures a no-code management system for storefront content.                                                                                |
| [Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api)                                   | Helps customers in their buying journey through search results.                                                                                |
| [Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless) | Collects search events to improve your search results, such as page interactions and conversion, in a headless implementation.                                             |
| [License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api%23overview)                                | Manages users, roles, hosts, AppKeys, and AppTokens from a VTEX store.                                                                                |
| [Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api)                                                     | Manages all store logistics data by allowing access to warehouses, docks, pickup points, carriers, and shipping rates. Gets or updates the inventory of each SKU.          |
| [Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis)                                                | Enables marketplaces and sellers hosted on VTEX to perform operations related to collaboration.                                                                            |
| [Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol)                                       | Connects external sellers to a VTEX marketplace and external marketplaces to VTEX sellers.                                                                                |
| [Master Data API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2)                                           | Manages and retrieves all data entities, applications, and records from the Master Data database.                                                                          |
| [Master Data API v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2)                                           | Manages and retrieves all data entities, applications, and records from the Master Data database.                                                                          |
| [Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api)                                           | Manages settings for VTEX mail servers.                                                                                |
| [Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api)                                                           | Receives, processes, and manages all orders through our APIs.                                                                                |
| [Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol)                         | Defines the requirements to integrate a payment processing API with VTEX.                                                                                |
| [Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api)                                       | Retrieves payment data and processes your transactions.                                                                                |
| [Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/policies-system-api)                                         | Creates promotion alarms when selling products with undesired prices and promotions.                                                                                |
| [Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api)                                                         | Creates, reads, and edits prices for each SKU, sales channel or price table.                                                                                |
| [Pricing Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-hub)                                                     | Connects with external pricing systems using Pricing Hub.                                                                                |
| [Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api)                                 | Manages and retrieves all promotions, coupons, and tax rules from a VTEX store.                                                                                |
| [Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/reviews-and-ratings-api)                                 | Allows customers to submit product reviews and ratings.                                                                                |
| [SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/sku-bindings-api)                                               | Links shared SKUs between sellers and marketplaces.                                                                                |
| [Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api)                                                           | Searches and sorts products in the catalog using full-text, category, and brand search terms. Retrieves product information to create custom searches and product shelves. |
| [Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/session-manager-api)                                         | Tracks relevant information about the customer's current browsing session and integrates with several VTEX systems using a single call.                                    |
| [Subscriptions API v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/subscriptions-api-v3)                                  | Manages store subscription rules to maximize revenue and reduce bounce and churn rates.                                                                                |
| [VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api)                             | Sets up your app to integrate with VTEX Shipping Network.                                                                                |
| [VTEX Tracking API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/tracking)                                                      | Manages all delivery solutions powered by a VTEX Tracking service.                                                                                |
| [VTEX Do API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-do-api)                                                         | Manages and retrieves notes or tasks from VTEX Do.                                                                                |
| [VTEX ID API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api)                                                         | Manages tokens from a given app key and app token pair.                                                                                |

Contributors

5

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F106821144%3Fv%3D4%26w=64%26q=75)](https://github.com/GeorgeLimaDev)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F83723439%3Fv%3D4%26w=64%26q=75)](https://github.com/jumeyermattosarruda)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7108339%3Fv%3D4%26w=64%26q=75)](https://github.com/brunoamui)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/getting-started/getting-started-list-of-rest-apis.md)

[API usage« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis//docs/guides/api-usage)[Making your first requestNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis//docs/guides/making-your-first-request)

Contributors

5

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F106821144%3Fv%3D4%26w=64%26q=75)](https://github.com/GeorgeLimaDev)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F83723439%3Fv%3D4%26w=64%26q=75)](https://github.com/jumeyermattosarruda)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7108339%3Fv%3D4%26w=64%26q=75)](https://github.com/brunoamui)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/getting-started/getting-started-list-of-rest-apis.md)

Copy page

On this page

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)