VTEX Purchase Information API

openapi: 3.0.0
info:
  title: VTex Anti-fraud Provider Account Purchase Information API
  description: ">ℹ️ Onboarding guide\r\n>\r\n> Check the new [Payments onboarding guide](https://developers.vtex.com/docs/guides/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey.\r\n\r\nThe Anti-fraud Provider Protocol is a set of definitions to help you integrate your anti-fraud service API into VTEX platform.\r\n\r\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\r\n\r\n>⚠️ You can also access our [template on GitHub](https://github.com/vtex-apps/antifraud-provider-example) to help you quickly develop your anti-fraud connector using the Anti-fraud Provider Protocol and VTEX IO.\r\n\r\nTo learn more about the Anti-fraud Provider Protocol, check our [developer guide](https://developers.vtex.com/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works).\r\n\r\n## Anti-fraud Provider API Index\r\n\r\n### Anti-fraud  Flow\r\n\r\n- `POST` [Send Anti-fraud Pre-Analysis Data (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/pre-analysis)\r\n- `POST` [Send Anti-fraud Data](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/transactions)\r\n- `PUT` [Update Anti-fraud Transactions (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#put-/transactions/-transactionId-)\r\n- `GET` [List Anti-fraud Provider Manifest](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/manifest)\r\n- `GET` [Get Anti-fraud Status](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/transactions/-transactions.id-)\r\n- `DELETE` [Stop Anti-fraud Analysis (optional)](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#delete-/transactions/-transactions.Id-)\r\n\r\n### OAuth Flow\r\n\r\n1. `POST` [Retrieve Token](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#post-/authorization/token)\r\n2. `GET` [Redirect](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/redirect)\r\n3. `GET` [Return to VTEX](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorizationCode)\r\n4. `GET` [Get Credentials](https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol#get-/authorization/credentials)"
  version: '1.0'
servers:
- url: https://{providerApiEndpoint}
  description: Anti-fraud provider endpoint URL.
  variables:
    providerApiEndpoint:
      description: Anti-fraud provider endpoint URL.
      default: '{providerApiEndpoint}'
tags:
- name: Purchase Information
paths:
  /api/storage/profile-system/profiles/{profileId}/purchase-info:
    post:
      tags:
      - Purchase Information
      summary: VTex Create purchase information
      description: "Creates purchase information for a given client profile.\n\r\n\rLearn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.\r\n\r\n>⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.\r\n>\r\n> This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Profile System | Documents | **Get Item** |\r\n| Profile System | Documents | **Save and Update Item** |\r\n| Profile System | Documents | **Delete Item** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: CreatePurchaseInformation
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/profileId'
      - $ref: '#/components/parameters/alternativeKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseInfo'
            example:
              paymentData:
                availableAccounts:
                - accountId: D09F5E3F01054C959CFC4CB357961ADE
                  paymentSystem: '2'
                  paymentSystemName: Visa
                  cardNumber: '************1111'
                  bin: '44443334'
                  availableAddresses:
                  - db267dcc53c14fb2b9a985532dd287bc
                  expirationDate: 01/2032
                  isExpired: false
                  accountStatus: null
                availableTokens: []
                transactions: null
                giftCards: []
                giftCardMessages: []
                numberOfPaymentErrors: 0
                numberOfDeniedTransactions: 0
                lastDeniedTransaction: null
              clientPreferences:
                userId: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                localeDefault: pt-BR
                isNewsletterOptIn: true
              isToSavePersonalData: true
              lastUserPurchases:
              - creationDate: '2023-10-23T19:22:12.8989883Z'
                orderId: 1370990595750-01
                orderGroup: '1370990595750'
                value: 3498
              lastPurchasesAddressId: db267dcc53c14fb2b9a985532dd287bc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaskedPurchaseInfoResponse'
              example:
                id: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                document:
                  paymentData:
                    availableAccounts:
                    - accountId: D09F5E3F01054C959CFC4CB357961ADE
                      paymentSystem: '2'
                      paymentSystemName: Visa
                      cardNumber: '************1111'
                      bin: '44443334'
                      availableAddresses:
                      - db267dcc53c14fb2b9a985532dd287bc
                      expirationDate: 01/2032
                      isExpired: false
                      accountStatus: null
                    availableTokens: []
                    transactions: null
                    giftCards: []
                    giftCardMessages: []
                    numberOfPaymentErrors: 0
                    numberOfDeniedTransactions: 0
                    lastDeniedTransaction: null
                  clientPreferences:
                    userId: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                    localeDefault: pt-BR
                    isNewsletterOptIn: true
                  isToSavePersonalData: true
                  lastUserPurchases:
                  - creationDate: '2023-10-23T19:22:12.8989883Z'
                    orderId: 1370990595750-01
                    orderGroup: '1370990595750'
                    value: 3498
                  lastPurchasesAddressId: db267dcc53c14fb2b9a985532dd287bc
                meta:
                  version: 6f693feb-7354-4a44-af96-3693ed282a2e
                  author: 7b95bb3d-b567-48b2-b6fa-48b0b6c7f112
                  creationDate: '2023-10-23T19:22:23.6716469+00:00'
                  lastUpdateDate: '2023-10-24T16:18:25.7338837+00:00'
                  expirationDate: null
      deprecated: false
    get:
      tags:
      - Purchase Information
      summary: VTex Get purchase information
      description: "Retrieves purchase information of a given client, by its `profileId`.\n\r\n\r> For security and privacy reasons, this request returns masked data. For unmasked information, see [Get unmasked purchase information](https://developers.vtex.com/docs/api-reference/profile-system#get-/api/storage/profile-system/profiles/-profileId-/purchase-info/unmask).\n\r\n\rLearn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.\r\n\r\n>⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.\r\n>\r\n> This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Profile System | Documents | **Get Item** |\r\n| Profile System | Documents | **Save and Update Item** |\r\n| Profile System | Documents | **Delete Item** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: GetPurchaseInformation
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/profileId'
      - $ref: '#/components/parameters/alternativeKey'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MaskedPurchaseInfoResponse'
              example:
              - id: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                document:
                  paymentData:
                    availableAccounts:
                    - accountId: D09F5E3F01054C959CFC4CB357961ADE
                      paymentSystem: '2'
                      paymentSystemName: Visa
                      cardNumber: '************1111'
                      bin: '44443333'
                      availableAddresses:
                      - db267dcc53c14fb2b9a985532dd287bc
                      expirationDate: 01/2032
                      isExpired: false
                      accountStatus: null
                    availableTokens: []
                    transactions: null
                    giftCards: []
                    giftCardMessages: []
                    numberOfPaymentErrors: 0
                    numberOfDeniedTransactions: 0
                    lastDeniedTransaction: null
                  clientPreferences:
                    userId: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                    localeDefault: pt-BR
                    isNewsletterOptIn: true
                  isToSavePersonalData: true
                  lastUserPurchases:
                  - creationDate: '2023-10-23T19:22:12.8989883Z'
                    orderId: 1370990595750-01
                    orderGroup: '1370990595750'
                    value: 3498
                  lastPurchasesAddressId: db267dcc53c14fb2b9a985532dd287bc
                meta:
                  version: 3117771f-8ea6-4297-a487-07e9b5497bc5
                  author: 6fd337ba-1e6c-4d3e-aceb-1d8993432193
                  creationDate: '2023-10-23T19:22:23.6716469+00:00'
                  lastUpdateDate: '2023-10-23T19:22:25.5466348+00:00'
                  expirationDate: null
      deprecated: false
    patch:
      tags:
      - Purchase Information
      summary: VTex Update purchase information
      description: "Updates one or more fields of existing purchase information for a given client profile.\n\r\n\rLearn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.\r\n\r\n>⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.\r\n>\r\n> This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/).\r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Profile System | Documents | **Get Item** |\r\n| Profile System | Documents | **Save and Update Item** |\r\n| Profile System | Documents | **Delete Item** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: UpdatePurchaseInformation
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/profileId'
      - $ref: '#/components/parameters/alternativeKey'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PurchaseInfo'
            example:
              paymentData:
                availableAccounts:
                - accountId: D09F5E3F01054C959CFC4CB357961ADE
                  paymentSystem: '2'
                  paymentSystemName: Visa
                  cardNumber: '************1111'
                  bin: '44443334'
                  availableAddresses:
                  - db267dcc53c14fb2b9a985532dd287bc
                  expirationDate: 01/2032
                  isExpired: false
                  accountStatus: null
                availableTokens: []
                transactions: null
                giftCards: []
                giftCardMessages: []
                numberOfPaymentErrors: 0
                numberOfDeniedTransactions: 0
                lastDeniedTransaction: null
              clientPreferences:
                userId: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                localeDefault: pt-BR
                isNewsletterOptIn: true
              isToSavePersonalData: true
              lastUserPurchases:
              - creationDate: '2023-10-23T19:22:12.8989883Z'
                orderId: 1370990595750-01
                orderGroup: '1370990595750'
                value: 3498
              lastPurchasesAddressId: db267dcc53c14fb2b9a985532dd287bc
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaskedPurchaseInfoResponse'
              example:
                id: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                document:
                  paymentData:
                    availableAccounts:
                    - accountId: D09F5E3F01054C959CFC4CB357961ADE
                      paymentSystem: '2'
                      paymentSystemName: Visa
                      cardNumber: '************1111'
                      bin: '44443334'
                      availableAddresses:
                      - db267dcc53c14fb2b9a985532dd287bc
                      expirationDate: 01/2032
                      isExpired: false
                      accountStatus: null
                    availableTokens: []
                    transactions: null
                    giftCards: []
                    giftCardMessages: []
                    numberOfPaymentErrors: 0
                    numberOfDeniedTransactions: 0
                    lastDeniedTransaction: null
                  clientPreferences:
                    userId: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                    localeDefault: pt-BR
                    isNewsletterOptIn: true
                  isToSavePersonalData: true
                  lastUserPurchases:
                  - creationDate: '2023-10-23T19:22:12.8989883Z'
                    orderId: 1370990595750-01
                    orderGroup: '1370990595750'
                    value: 3498
                  lastPurchasesAddressId: db267dcc53c14fb2b9a985532dd287bc
                meta:
                  version: 6f693feb-7354-4a44-af96-3693ed282a2e
                  author: 7b95bb3d-b567-48b2-b6fa-48b0b6c7f112
                  creationDate: '2023-10-23T19:22:23.6716469+00:00'
                  lastUpdateDate: '2023-10-24T16:18:25.7338837+00:00'
                  expirationDate: null
      deprecated: false
    delete:
      tags:
      - Purchase Information
      summary: VTex Delete purchase information
      description: "Deletes purchase informaiton by `profileId`.\n\r\n\rLearn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.\r\n\r\n>⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.\r\n>\r\n> This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/). \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Profile System | Documents | **Get Item** |\r\n| Profile System | Documents | **Save and Update Item** |\r\n| Profile System | Documents | **Delete Item** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: DeletePurchaseInformation
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/profileId'
      - $ref: '#/components/parameters/alternativeKey'
      responses:
        '204':
          description: No content
      deprecated: false
  /api/storage/profile-system/profiles/{profileId}/purchase-info/unmask:
    get:
      tags:
      - Purchase Information
      summary: VTex Get unmasked purchase information
      description: "Retrieves unmasked purchase information of a given client, by its `profileId`.\n\r\n\rLearn more about the [Profile System](https://developers.vtex.com/vtex-rest-api/docs/profile-system) and its other API endpoints.\r\n\r\n>⚠️ The Profile System is only compatible with stores using the PII data architecture from [Data Protection Plus](https://developers.vtex.com/docs/guides/data-protection-plus), which is in closed beta phase, only available in select regions.\r\n>\r\n> This feature is part of [VTEX Shield](https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://vtex.com/us-en/contact/). \r\n\r\n## Permissions\r\n\r\nAny user or [application key](https://developers.vtex.com/docs/guides/api-authentication-using-application-keys) must have at least one of the appropriate [License Manager resources](https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) to be able to successfully run this request. Otherwise they will receive a status code `403` error. These are the applicable resources for this endpoint:\r\n\r\n| **Product** | **Category** | **Resource** |\r\n| --------------- | ----------------- | ----------------- |\r\n| Profile System | Documents | **Get Item** |\r\n| Profile System | Documents | **Save and Update Item** |\r\n| Profile System | Documents | **Delete Item** |\r\n\r\nThere are no applicable [predefined roles](https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy) for this resource list. You must [create a custom role](https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc#creating-a-role) and add at least one of the resources above in order to use this endpoint.To learn more about machine authentication at VTEX, see [Authentication overview](https://developers.vtex.com/docs/guides/authentication).\r\n\r\n>❗ To prevent integrations from having excessive permissions, consider the [best practices for managing app keys](https://help.vtex.com/en/tutorial/best-practices-application-keys--7b6nD1VMHa49aI5brlOvJm) when assigning License Manager roles to integrations."
      operationId: GetUnmaskedPurchaseInformation
      parameters:
      - $ref: '#/components/parameters/Content-Type'
      - $ref: '#/components/parameters/Accept'
      - $ref: '#/components/parameters/profileId'
      - $ref: '#/components/parameters/reason'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                description: List of purchase information.
                items:
                  $ref: '#/components/schemas/MaskedPurchaseInfoResponse'
              example:
              - id: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                document:
                  paymentData:
                    availableAccounts:
                    - accountId: D09F5E3F01054C959CFC4CB357961ADE
                      paymentSystem: '2'
                      paymentSystemName: Visa
                      cardNumber: '************1111'
                      bin: '44443333'
                      availableAddresses:
                      - db267dcc53c14fb2b9a985532dd287bc
                      expirationDate: 01/2032
                      isExpired: false
                      accountStatus: null
                    availableTokens: []
                    transactions: null
                    giftCards: []
                    giftCardMessages: []
                    numberOfPaymentErrors: 0
                    numberOfDeniedTransactions: 0
                    lastDeniedTransaction: null
                  clientPreferences:
                    userId: d9b946b8-9524-4b2d-96ec-b35d0625c0a7
                    localeDefault: pt-BR
                    isNewsletterOptIn: true
                  isToSavePersonalData: true
                  lastUserPurchases:
                  - creationDate: '2023-10-23T19:22:12.8989883Z'
                    orderId: 1370990595750-01
                    orderGroup: '1370990595750'
                    value: 3498
                  lastPurchasesAddressId: db267dcc53c14fb2b9a985532dd287bc
                meta:
                  version: cea5fcd2-7444-492d-9d63-1c05713e6776
                  author: 7b95bb3d-b567-48b2-b6fa-48b0b6c7f112
                  creationDate: '2023-10-24T16:22:55.0252384+00:00'
                  lastUpdateDate: '2023-10-24T16:22:55.0252384+00:00'
                  expirationDate: null
      deprecated: false
components:
  schemas:
    MaskedPurchaseInfoResponse:
      title: Masked purchase information response.
      type: object
      description: Masked purchase information.
      properties:
        id:
          $ref: '#/components/schemas/PurchaseInfoId'
        document:
          $ref: '#/components/schemas/PurchaseInfo'
        meta:
          $ref: '#/components/schemas/PurchaseInfoMeta'
    PurchaseInfoId:
      title: id
      type: string
      description: ID of purchase information.
      example: c2cbebba-214e-40b2-b68f-98f862e755d5
    PurchaseInfoMeta:
      title: Purchase information metadata.
      type: object
      description: Purchase information metadata.
      required:
      - version
      - author
      - creationDate
      - lastUpdateDate
      properties:
        version:
          type: string
          description: Unique identifier of the purchase information version.
          example: 27112371-a71b-45d6-b3bc-93436a3a0b4f
        author:
          type: string
          description: Unique identifier of the user who created the purchase information.
          example: 82a2b53d-39be-4f49-bb7c-8971b58cb7dc
        creationDate:
          type: string
          description: Date when the purchase information was created in ISO 8601 format.
          example: '2022-01-05T15:41:37.5009471+00:00'
        lastUpdateDate:
          type: string
          description: Date when the purchase information was last updated in ISO 8601 format.
          example: '2022-01-05T15:41:37.5009471+00:00'
        expirationDate:
          type: string
          description: Date when the purchase information expires in ISO 8601 format.
          example: '2022-01-05T15:41:37.5009471+00:00'
          nullable: true
    PurchaseInfo:
      title: Purchase information.
      type: object
      description: Purchase information object.
      properties:
        paymentData:
          $ref: '#/components/schemas/PaymentData'
        clientPreferences:
          type: object
          description: Client preferences.
          properties: {}
        isToSavePersonalData:
          type: boolean
          description: Defines if personal data will be saved (`true`) or not (`false`).
        lastUserPurchases:
          type: array
          description: Array with latest purchases from the client.
          items:
            type: object
            description: Purchase information.
            properties:
              creationDate:
                type: string
                description: Purchase date in the ISO 8601 format.
              orderId:
                type: string
                description: Unique identifier of the order.
              orderGroup:
                type: string
                description: Unique identifier of the order group.
              value:
                type: number
                description: Purchase value.
        lastPurchasesAddressId:
          type: string
          description: Unique identifier of the client address.
    PaymentData:
      title: paymentData
      type: object
      description: Payment data.
      properties:
        availableAccounts:
          type: array
          description: List of available payment accounts.
          items:
            type: object
            description: Information about an available payment account.
            properties:
              accountId:
                type: string
                description: Payment account ID.
                example: D09F5E3F01054C959CFC4CB357961ADE
              paymentSystem:
                type: string
                description: Payment system code.
                example: '2'
              paymentSystemName:
                type: string
                description: Payment system name.
                example: Visa
              cardNumber:
                type: string
                description: Masked card number.
                example: '************1111'
              bin:
                type: string
                description: Card bin.
                example: '44443334'
              availableAddresses:


# --- truncated at 32 KB (40 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/vtex/refs/heads/main/openapi/vtex-purchase-information-api-openapi.yml