Yampi

https://docs.yampi.com.br/
Admin
Yampi provides APIs and tools for developers to create applications, customize e-commerce store...
Tokens:461,737
Snippets:844
Trust Score:9.3
Update:11 months ago
Show doc for...
Tokens:
Raw
### Checkout Payment Configuration Example

Source: https://docs.yampi.com.br/api-reference/checkout/configuracoes-de-pagamentos/criar-configuracao-de-pagamento

Provides an example of a successful checkout payment configuration. This includes details about payment, affiliation, installment plans, and timestamps. It serves as a reference for valid payment configuration data.

```json
{
  "id": 123,
  "payment_id": 123,
  "affiliation_id": 123,
  "active": true,
  "default_display": true,
  "spread": true,
  "ignore_promotions": true,
  "accumulate_discount": true,
  "percent_discount": 123,
  "min_installment_value": 123,
  "max_installments_without_tax": 123,
  "billet_expire_days": 123,
  "days_to_cancel_unpaid_billets": 123,
  "hours_to_cancel_unpaid_pix": 123,
  "billet_instructions": "<string>",
  "installments": {
    "data": [
      {
        "id": 1,
        "payment_id": 2,
        "installment": 1,
        "tax": 1.5,
        "percent_discount": 0,
        "start_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "end_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "created_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "updated_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        }
      }
    ]
  },
  "affiliation": {
    "data": {
      "id": 123,
      "active": true,
      "backup": true,
      "name": "Cielo Affiliation",
      "statement_descriptor": "<string>",
      "auto_capture": true,
      "has_payment_config": false,
      "capture_hour_delay": 123,
      "force_minimum_tax": true,
      "status": "<string>",
      "auth_type": "<string>",
      "gateway": {
        "data": [
          {
            "alias": "billet",
            "name": "Boleto Bancário",
            "icon_url": "<string>",
            "allow_backup": true,
            "installments_config": {
              "allow_custom_installments": true,
              "message": "<string>",
              "help_link": "<string>"
            },
            "auth_type": "Boleto Bancário",
            "gateway_exists": true,
            "params": {
              "data": [
                ["env", "merchant_id", "key"]
              ]
            }
          }
        ]
      }
    }
  },
  "payment": {
    "data": {
      "id": 123,
      "alias": "<string>",
      "name": "<string>",
      "has_config": true,
      "active_config": true,
      "is_credit_card": true,
      "is_deposit": true,
      "is_billet": true,
      "is_pix": true,
      "is_pix_in_installments": true,
      "is_wallet": true,
      "icon_url": "<string>"
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
```

--------------------------------

### Example Collection Response

Source: https://docs.yampi.com.br/api-reference/catalogo/colecoes/atualizar-colecao

Provides an example of a successful response when a collection is updated or retrieved. This example demonstrates the expected format and data types for each field within the collection object.

```json
{
  "id": 123,
  "parent_id": 123,
  "active": true,
  "show_banners": true,
  "featured": true,
  "is_promotional": true,
  "name": "<string>",
  "visible_products": 123,
  "home": true,
  "expired": true,
  "slug": "<string>",
  "description": "<string>",
  "seo_title": "<string>",
  "seo_keywords": "<string>",
  "seo_description": "<string>",
  "path": "<string>",
  "expire_in": "<string>",
  "total_products": 123
}
```

--------------------------------

### GET /{alias}/checkout/payments/{paymentId}/installments/simulate

Source: https://docs.yampi.com.br/api-reference/checkout/parcelamento/simular-parcelamento-de-um-pagamento

Simulates payment installments based on provided parameters.

```APIDOC
## GET /{alias}/checkout/payments/{paymentId}/installments/simulate

### Description
Simulates payment installments for a given payment.

### Method
GET

### Endpoint
https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/installments/simulate

### Parameters
#### Path Parameters
- **alias** (string) - Required - Alias da loja
- **paymentId** (integer) - Required - ID da forma de pagamento

#### Query Parameters
- **amount** (number) - Required - Valor total do pagamento
- **min_installment_value** (number) - Required - Valor mínimo da parcela
- **max_installments_without_tax** (integer) - Required - Número máximo de parcelas sem juros
- **taxes** (array) - Required - Taxa aplicada nas parcelas
  - **tax** (number) - Taxa aplicada na parcela
  - **installment** (integer) - Número da parcela
  - **percent_discount** (number) - Desconto percentual aplicado na parcela
- **currency** (string) - Optional - Moeda do pagamento

#### Request Body
None

### Request Example
None

### Response
#### Success Response (200)
- **data** (object) - Simulação de parcelamento realizada com sucesso
  - **max_installment** (integer) - Número máximo de parcelas
  - **max_installment_value** (number) - Valor máximo da parcela
  - **amount** (number) - Valor total do pagamento
  - **text** (string) - Texto formatado da parcela sem juros
  - **text_with_tax** (string) - Texto formatado da parcela com juros
  - **installments** (array) - Detalhes das parcelas
    - **amount** (number) - Valor da parcela
    - **amount_formated** (string) - Valor da parcela formatado
    - **base_value** (number) - Valor base da parcela
    - **tax** (string) - Taxa aplicada na parcela
    - **tax_value** (number) - Valor da taxa aplicada
    - **discount_percent** (number) - Desconto percentual aplicado na parcela
    - **discount_value** (number) - Valor do desconto aplicado na parcela
    - **discount_value_formated** (string) - Valor do desconto formatado
    - **installment** (string) - Número da parcela
    - **installment_value** (number) - Valor da parcela
    - **installment_value_formated** (string) - Valor da parcela formatado
    - **text** (string) - Texto formatado da parcela sem juros
    - **text_with_tax** (string) - Texto formatado da parcela com juros

#### Response Example
```json
{
  "data": {
    "max_installment": 1,
    "max_installment_value": 500,
    "amount": 500,
    "text": "1x de R$ 500,00 sem juros",
    "text_with_tax": "1x de R$ 500,00",
    "installments": [
      {
        "amount": 500,
        "amount_formated": "R$ 500,00",
        "base_value": 500,
        "tax": "0",
        "tax_value": 0,
        "discount_percent": 0,
        "discount_value": 0,
        "discount_value_formated": "R$ 0,00",
        "installment": "1",
        "installment_value": 500,
        "installment_value_formated": "R$ 500,00",
        "text": "1x de R$ 500,00 sem juros",
        "text_with_tax": "1x de R$ 500,00"
      }
    ]
  }
}
```

#### Error Response (400)
Requisição inválida

#### Error Response (404)
Forma de pagamento não encontrada
```

--------------------------------

### Bundle Schema Example

Source: https://docs.yampi.com.br/api-reference/catalogo/kits/atualizar-um-kit

This example demonstrates the structure of a product bundle object, including its properties, associated items, and pricing details. It's useful for understanding how to format requests or interpret responses related to bundles.

```json
{
  "id": 123,
  "active": true,
  "modifiable": true,
  "name": "<string>",
  "purchase_url": "<string>",
  "custom_shipping": true,
  "shipping_type": "<string>",
  "shipping_price": 123,
  "shipping_days": 123,
  "image_url": "<string>",
  "created_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "updated_at": {
    "date": "2000-08-17 10:24:24",
    "timezone_type": 3,
    "timezone": "America/Sao_Paulo"
  },
  "items": {
    "data": [
      {
        "id": 123,
        "bundle_id": 123,
        "sku_id": 123,
        "price_type": "<string>",
        "price": 123,
        "discount": 123,
        "quantity": 123,
        "created_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "updated_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        }
      }
    ]
  }
}
```

--------------------------------

### Create Bundle

Source: https://docs.yampi.com.br/api-reference/catalogo/kits/atualizar-um-kit

Creates a new bundle with the provided details. Requires name, image_url, and items.

```APIDOC
## POST /websites/yampi_br/bundles

### Description
Creates a new bundle with the provided details. Requires name, image_url, and items.

### Method
POST

### Endpoint
/websites/yampi_br/bundles

### Parameters
#### Request Body
- **active** (boolean) - Optional - Indicates if the bundle is active.
- **modifiable** (boolean) - Optional - Indicates if the bundle is modifiable.
- **name** (string) - Required - The name of the bundle.
- **purchase_url** (string) - Optional - The URL to purchase the bundle.
- **custom_shipping** (boolean) - Optional - Indicates if custom shipping is available.
- **shipping_type** (string) - Optional - The type of shipping.
- **shipping_price** (float) - Optional - The price of shipping.
- **shipping_days** (integer) - Optional - The number of shipping days.
- **image_url** (string) - Required - The URL of the bundle image.
- **items** (object) - Required - Details of items included in the bundle.
  - **data** (array) - An array of item objects.
    - **sku_id** (integer) - Required - The SKU ID of the product.
    - **price_type** (string) - Required - The pricing type for the item.
    - **price** (float) - Required - The price of the item.
    - **discount** (float) - Optional - The discount applied to the item.
    - **quantity** (integer) - Required - The quantity of the item.

### Request Example
```json
{
  "example": "{\n  \"active\": true,\n  \"modifiable\": true,\n  \"name\": \"New Bundle\",\n  \"purchase_url\": \"http://example.com/purchase\",\n  \"custom_shipping\": false,\n  \"shipping_type\": \"standard\",\n  \"shipping_price\": 10.50,\n  \"shipping_days\": 3,\n  \"image_url\": \"http://example.com/image.jpg\",\n  \"items\": {\n    \"data\": [\n      {\n        \"sku_id\": 456,\n        \"price_type\": \"fixed\",\n        \"price\": 25.00,\n        \"discount\": 2.00,\n        \"quantity\": 2\n      }\n    ]\n  }\n}"
}
```

### Response
#### Success Response (200)
- **id** (integer) - The unique identifier of the created bundle.
- **active** (boolean) - Indicates if the bundle is currently active.
- **modifiable** (boolean) - Indicates if the bundle can be modified.
- **name** (string) - The name of the bundle.
- **purchase_url** (string) - The URL to purchase the bundle.
- **custom_shipping** (boolean) - Indicates if custom shipping options are available.
- **shipping_type** (string) - The type of shipping.
- **shipping_price** (float) - The price of shipping.
- **shipping_days** (integer) - The number of shipping days.
- **image_url** (string) - The URL of the bundle image.
- **created_at** (object) - Timestamp of creation.
- **updated_at** (object) - Timestamp of last update.
- **items** (object) - Details of items included in the bundle.
  - **data** (array) - An array of item objects.
    - **id** (integer) - The unique identifier of the item.
    - **bundle_id** (integer) - The ID of the bundle this item belongs to.
    - **sku_id** (integer) - The SKU ID of the product.
    - **price_type** (string) - The pricing type for the item.
    - **price** (float) - The price of the item.
    - **discount** (float) - The discount applied to the item.
    - **quantity** (integer) - The quantity of the item.
    - **created_at** (object) - Timestamp of creation.
    - **updated_at** (object) - Timestamp of last update.

#### Response Example
```json
{
  "example": "{\n  \"id\": 789,\n  \"active\": true,\n  \"modifiable\": true,\n  \"name\": \"New Bundle\",\n  \"purchase_url\": \"http://example.com/purchase\",\n  \"custom_shipping\": false,\n  \"shipping_type\": \"standard\",\n  \"shipping_price\": 10.50,\n  \"shipping_days\": 3,\n  \"image_url\": \"http://example.com/image.jpg\",\n  \"created_at\": {\n    \"date\": \"2000-08-17 10:24:24\",\n    \"timezone_type\": 3,\n    \"timezone\": \"America/Sao_Paulo\"\n  },\n  \"updated_at\": {\n    \"date\": \"2000-08-17 10:24:24\",\n    \"timezone_type\": 3,\n    \"timezone\": \"America/Sao_Paulo\"\n  },\n  \"items\": {\n    \"data\": [\n      {\n        \"id\": 987,\n        \"bundle_id\": 789,\n        \"sku_id\": 456,\n        \"price_type\": \"fixed\",\n        \"price\": 25.00,\n        \"discount\": 2.00,\n        \"quantity\": 2,\n        \"created_at\": {\n          \"date\": \"2000-08-17 10:24:24\",\n          \"timezone_type\": 3,\n          \"timezone\": \"America/Sao_Paulo\"\n        },\n        \"updated_at\": {\n          \"date\": \"2000-08-17 10:24:24\",\n          \"timezone_type\": 3,\n          \"timezone\": \"America/Sao_Paulo\"\n        }\n      }\n    ]\n  }\n}"
}
```

#### Error Response (400)
- Description: Requisição inválida

#### Error Response (422)
- Description: 'Verifique os campos obrigatórios: name, image_url e items'
```

--------------------------------

### GET /checkout/payments/{paymentId}/installments

Source: https://docs.yampi.com.br/api-reference/checkout/parcelamento/listar-parcelamentos-de-um-pagamento

Lists the installments for a specific payment ID within a given store alias.

```APIDOC
## GET /{alias}/checkout/payments/{paymentId}/installments

### Description
Lists the installments for a specific payment ID within a given store alias.

### Method
GET

### Endpoint
`https://api.dooki.com.br/v2/{alias}/checkout/payments/{paymentId}/installments`

### Parameters

#### Path Parameters
- **alias** (string) - Required - Alias da loja
- **paymentId** (integer) - Required - ID da forma de pagamento

#### Query Parameters
None

#### Request Body
None

### Request Example
None

### Response

#### Success Response (200)
- **data** (object) - Contains the payment installment details.
  - **id** (integer) - The installment ID.
  - **payment_id** (integer) - The ID of the payment.
  - **installment** (integer) - The installment number.
  - **tax** (number) - The tax applied to the installment.
  - **percent_discount** (number) - The percentage discount applied.
  - **start_at** (object) - The start date and time of the installment.
    - **date** (string) - Date and time in YYYY-MM-DD H:MM:SS format.
    - **timezone_type** (integer) - Timezone representation number.
    - **timezone** (string) - Associated timezone.
  - **end_at** (object) - The end date and time of the installment.
    - **date** (string) - Date and time in YYYY-MM-DD H:MM:SS format.
    - **timezone_type** (integer) - Timezone representation number.
    - **timezone** (string) - Associated timezone.
  - **created_at** (object) - The creation date and time.
    - **date** (string) - Date and time in YYYY-MM-DD H:MM:SS format.
    - **timezone_type** (integer) - Timezone representation number.
    - **timezone** (string) - Associated timezone.
  - **updated_at** (object) - The update date and time.
    - **date** (string) - Date and time in YYYY-MM-DD H:MM:SS format.
    - **timezone_type** (integer) - Timezone representation number.
    - **timezone** (string) - Associated timezone.

#### Response Example
```json
{
  "data": {
    "id": 1,
    "payment_id": 2,
    "installment": 1,
    "tax": 1.5,
    "percent_discount": 0,
    "start_at": {
      "date": "2000-08-17 10:24:24",
      "timezone_type": 3,
      "timezone": "America/Sao_Paulo"
    },
    "end_at": {
      "date": "2000-08-17 10:24:24",
      "timezone_type": 3,
      "timezone": "America/Sao_Paulo"
    },
    "created_at": {
      "date": "2000-08-17 10:24:24",
      "timezone_type": 3,
      "timezone": "America/Sao_Paulo"
    },
    "updated_at": {
      "date": "2000-08-17 10:24:24",
      "timezone_type": 3,
      "timezone": "America/Sao_Paulo"
    }
  }
}
```

#### Error Response (400)
- **description**: Dados inválidos fornecidos

#### Error Response (404)
- **description**: Forma de pagamento não encontrada
```

--------------------------------

### GET /products/{id}/installments

Source: https://docs.yampi.com.br/api-reference/publico/catalogo/visualizar-informacoes-dos-parcelas-do-produto

Retrieves the installment information for a specific product.

```APIDOC
## GET /{alias}/public/catalog/products/{id}/installments

### Description
Returns the installment information for a product.

### Method
GET

### Endpoint
`/v2/{alias}/public/catalog/products/{id}/installments`

### Parameters
#### Path Parameters
- **alias** (string) - Required - Alias of the store
- **id** (string) - Required - Product ID

#### Query Parameters
None

#### Request Body
- **amount** (number) - Required - The amount to calculate installments for. Example: 0

### Request Example
```json
{
  "amount": 0
}
```

### Response
#### Success Response (200)
- **max_installment** (integer) - Maximum number of installments available. Example: 6
- **max_installment_value** (number) - The value of the maximum installment. Example: 0
- **amount** (number) - The total amount. Example: 0
- **text** (string) - Formatted text describing installments with interest. Example: "6x de R$ 0,00 com juros"
- **text_with_tax** (string) - Formatted text describing installments with tax. Example: "6x de R$ 0,00"
- **text_discount_percent** (string) - Formatted text describing discount percentage. Example: null
- **text_discount** (string) - Formatted text describing discount amount. Example: null

#### Response Example
```json
{
  "max_installment": 6,
  "max_installment_value": 0,
  "amount": 0,
  "text": "6x de R$ 0,00 com juros",
  "text_with_tax": "6x de R$ 0,00",
  "text_discount_percent": null,
  "text_discount": null
}
```

#### Error Response (404)
- **description**: Product not found
```

--------------------------------

### Product Pricing and Promotion Details

Source: https://docs.yampi.com.br/api-reference/publico/catalogo/visualizar-informacoes-de-banners

Retrieves detailed pricing information for products, including original price, sale price, discount percentages, and formatted price strings. It also includes details on promotional offers and installment plans.

```APIDOC
## GET /websites/yampi_br/products

### Description
Retrieves detailed pricing and promotion information for products on the Yampi BR website.

### Method
GET

### Endpoint
/websites/yampi_br/products

### Parameters
#### Query Parameters
* **productId** (string) - Optional - The ID of the product to retrieve details for.

### Request Example
```json
{
  "example": "GET /websites/yampi_br/products?productId=12345"
}
```

### Response
#### Success Response (200)
- **price_sale_formated** (string) - The sale price of the product, formatted as a string (e.g., 'R$ 1,11').
- **price_discount** (number) - The discount amount for the product (e.g., 0).
- **price_discount_formated** (string) - The discount amount, formatted as a string (e.g., 'R$ 0,00').
- **has_promotion** (boolean) - Indicates if the product is currently on promotion (true/false).
- **percent_discount** (number) - The percentage discount applied to the product (e.g., 9.91).
- **billet** (object) - Details about payment via bank slip:
    - **price** (number) - The price when paying with a bank slip.
    - **price_formated** (string) - Formatted price for bank slip payment.
    - **base_amount** (string) - Base amount for bank slip calculation.
    - **fraction_amount** (string) - Fractional amount for bank slip calculation.
    - **discount_value** (number) - Discount value for bank slip payment.
    - **discount_percent** (string) - Discount percentage for bank slip payment.
    - **discount_text** (string) - Text describing the bank slip discount.
- **pix** (object) - Details about payment via Pix:
    - **price** (number) - The price when paying with Pix.
    - **price_formatted** (string) - Formatted price for Pix payment.
    - **base_amount** (string) - Base amount for Pix calculation.
    - **fraction_amount** (string) - Fractional amount for Pix calculation.
    - **discount_value** (number) - Discount value for Pix payment.
    - **discount_percent** (string) - Discount percentage for Pix payment.
    - **discount_text** (string) - Text describing the Pix discount.
- **installments** (object) - Details about installment payment options:
    - **data** (object) - Array of available installment plans:
        - **max_installment** (integer) - Maximum number of installments.
        - **max_installment_value** (number) - The value of the maximum installment.
        - **amount** (number) - The total amount for installments.
        - **text** (string) - Text describing the installment plan without interest.
        - **text_with_tax** (string) - Text describing the installment plan with tax.
        - **text_discount_percent** (string or null) - Discount percentage text, if applicable.
        - **text_discount** (string or null) - Discount amount text, if applicable.

#### Response Example
```json
{
  "price_sale_formated": "R$ 1,11",
  "price_discount": 0,
  "price_discount_formated": "R$ 0,00",
  "has_promotion": true,
  "percent_discount": 9.91,
  "billet": {
    "price": 1,
    "price_formated": "R$ 1,00",
    "base_amount": "1",
    "fraction_amount": "00",
    "discount_value": 0,
    "discount_percent": "0.00",
    "discount_text": "R$ 1,00 à vista com 0.00% de desconto"
  },
  "pix": {
    "price": 0.9,
    "price_formatted": "R$ 0,90",
    "base_amount": "0",
    "fraction_amount": "90",
    "discount_value": 0.1,
    "discount_percent": "10.00",
    "discount_text": "R$ 0,90 à vista com 10.00% de desconto"
  },
  "installments": {
    "data": [
      {
        "max_installment": 1,
        "max_installment_value": 1.11,
        "amount": 1.11,
        "text": "1x de R$ 1,11 sem juros",
        "text_with_tax": "1x de R$ 1,11",
        "text_discount_percent": null,
        "text_discount": null
      }
    ]
  }
}
```
```

--------------------------------

### Product Information

Source: https://docs.yampi.com.br/api-reference/publico/catalogo/visualizar-informacoes-publicas-do-produto

Retrieve detailed information about products, including pricing, images, reviews, and flags.

```APIDOC
## GET /websites/yampi_br/products

### Description
This endpoint retrieves detailed information about products available on the Yampi platform. It includes product specifics, pricing, images, reviews, and promotional flags.

### Method
GET

### Endpoint
/websites/yampi_br/products

### Parameters
#### Query Parameters
- **id** (integer) - Optional - The unique identifier for the product.
- **sku_id** (integer) - Optional - The stock keeping unit identifier for the product.

### Request Example
```json
{
  "example": "GET /websites/yampi_br/products?id=17790530"
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of product objects.
  - **id** (integer) - The product's unique identifier.
  - **sku_id** (integer) - The product's SKU.
  - **gift_value** (integer) - Indicates if the product is a gift.
  - **simple** (boolean) - Indicates if the product is a simple product.
  - **has_variations** (boolean) - Indicates if the product has variations.
  - **is_digital** (boolean) - Indicates if the product is digital.
  - **warranty** (integer) - The product's warranty period.
  - **custom_shipping** (boolean) - Indicates if custom shipping is applicable.
  - **shipping_price** (number) - The price of shipping.
  - **name** (string) - The name of the product.
  - **slug** (string) - The URL-friendly slug for the product.
  - **sku** (string) - The detailed SKU string.
  - **blocked_sale** (boolean) - Indicates if the product sale is blocked.
  - **rating** (string) - The average rating of the product.
  - **total_approved_reviews** (integer) - The total number of approved reviews.
  - **url** (string) - The URL to the product page.
  - **url_path** (string) - The URL path to the product.
  - **use_different_images** (integer) - Flag for using different images.
  - **brand** (object) - Information about the product's brand.
    - **data** (object)
      - **id** (integer) - The brand's unique identifier.
      - **name** (string) - The brand's name.
      - **logo_url** (string, nullable) - The URL of the brand's logo.
  - **images** (object) - An array of product image objects.
    - **data** (array)
      - **url** (string) - The URL of the product image.
  - **prices** (object) - Pricing information for the product.
    - **currency** (string) - The currency symbol.
    - **price_cost** (number) - The cost price of the product.
    - **price_cost_formated** (string) - The formatted cost price.
    - **price** (number) - The regular price of the product.
    - **price_formated** (string) - The formatted regular price.
    - **base_amount** (string) - The base amount for calculations.
    - **fraction_amount** (string) - The fractional part of the amount.
    - **price_sale** (number) - The sale price of the product.
    - **price_sale_formated** (string) - The formatted sale price.
    - **price_discount** (number) - The discount amount.
    - **price_discount_formated** (string) - The formatted discount amount.
    - **has_promotion** (boolean) - Indicates if the product is on promotion.
    - **percent_discount** (number) - The percentage discount.
    - **billet** (object) - Pricing information for the billet payment method.
      - **price** (number) - The billet price.
      - **price_formated** (string) - The formatted billet price.
  - **installments** (object) - Information about installment payment options.
    - **max_installment** (integer) - The maximum number of installments.
    - **max_installment_value** (number) - The maximum value per installment.
    - **amount** (number) - The total installment amount.
    - **text** (string) - Text describing installments without interest.
    - **text_with_tax** (string) - Text describing installments with tax.
    - **text_discount_percent** (string, nullable) - Text describing discount percentage.
    - **text_discount** (string, nullable) - Text describing discount amount.
  - **flags** (object) - An array of flag objects associated with the product.
    - **data** (array)
      - **id** (integer) - The flag's unique identifier.
      - **name** (string) - The name of the flag.
      - **slug** (string) - The URL-friendly slug for the flag.
      - **text_color** (string) - The text color for the flag.
      - **background_color** (string) - The background color for the flag.
      - **image_url** (string, nullable) - The URL of the flag's image.

#### Response Example
```json
{
  "example": "{\n  \"data\": [\n    {\n      \"id\": 17790530,\n      \"sku_id\": 262573372,\n      \"gift_value\": 0,\n      \"simple\": false,\n      \"has_variations\": true,\n      \"is_digital\": false,\n      \"warranty\": 0,\n      \"custom_shipping\": false,\n      \"shipping_price\": 0,\n      \"name\": \"GTA V Premium 10Uni.\",\n      \"slug\": \"gta-v-premium-10uni\",\n      \"sku\": \"GQVQLNP34,69SQH26GU,QWNVUZHMQ,EPSHDEZPT,K89BHGYNV,SKU-TEST-API,LLKUD2KAM,E7K48R248\",\n      \"blocked_sale\": false,\n      \"rating\": \"4.7\",\n      \"total_approved_reviews\": 3,\n      \"url\": \"https://www.mytems.com/gta-v-premium-10uni/p\",\n      \"url_path\": \"/gta-v-premium-10uni/p\",\n      \"use_different_images\": 1,\n      \"brand\": {\n        \"data\": {\n          \"id\": 733502,\n          \"name\": \"Rockstar Games\",\n          \"logo_url\": null\n        \n      }},\n      \"images\": {\n        \"data\": [\n          {\n            \"url\": \"https://images.yampi.me/assets/stores/mytems/uploads/images/gta-v-premium-10uni-ps5-dvd-67939caf6a3ac-large.jpg\"\n          }\n        ]\n      },\n      \"prices\": {\n        \"currency\": \"R$\",\n        \"price_cost\": 0,\n        \"price_cost_formated\": \"R$ 0,00\",\n        \"price\": 1,\n        \"price_formated\": \"R$ 1,00\",\n        \"base_amount\": \"1\",\n        \"fraction_amount\": \"00\",\n        \"price_sale\": 1.11,\n        \"price_sale_formated\": \"R$ 1,11\",\n        \"price_discount\": 0,\n        \"price_discount_formated\": \"R$ 0,00\",\n        \"has_promotion\": true,\n        \"percent_discount\": 9.91,\n        \"billet\": {\n          \"price\": 1,\n          \"price_formated\": \"R$ 1,00\"\n        }\n      },\n      \"installments\": {\n        \"max_installment\": 1,\n        \"max_installment_value\": 1.11,\n        \"amount\": 1.11,\n        \"text\": \"1x de R$ 1,11 sem juros\",\n        \"text_with_tax\": \"1x de R$ 1,11\",\n        \"text_discount_percent\": null,\n        \"text_discount\": null\n      },\n      \"flags\": {\n        \"data\": [\n          {\n            \"id\": 24875,\n            \"name\": \"Pronta Entrega\",\n            \"slug\": \"pronta-entrega\",\n            \"text_color\": \"#333333\",\n            \"background_color\": \"#D0D0D0\",\n            \"image_url\": null\n          }\n        ]\n      }\n    }\n  ]\n}"
}
```
```

--------------------------------

### Checkout Payment Configuration

Source: https://docs.yampi.com.br/api-reference/checkout/configuracoes-de-pagamentos/criar-configuracao-de-pagamento

This section details the structure and examples for payment configurations, including payment methods, affiliations, and installment plans.

```APIDOC
## Checkout Payment Configuration

### Description
Provides details about payment configurations, including associated payment methods, affiliation information, and installment settings. This schema is used for creating and retrieving payment configurations.

### Method
GET

### Endpoint
/websites/yampi_br/checkout/payments/config

### Parameters
#### Query Parameters
- **payment_id** (integer) - Required - The ID of the payment configuration to retrieve.

### Request Example
```json
{
  "payment_id": 123
}
```

### Response
#### Success Response (200)
- **id** (integer) - Unique identifier for the payment configuration.
- **payment_id** (integer) - The ID of the payment method.
- **affiliation_id** (integer) - The ID of the affiliation.
- **active** (boolean) - Indicates if the configuration is active.
- **default_display** (boolean) - Indicates if this is the default display configuration.
- **spread** (boolean) - Whether discounts are spread across installments.
- **ignore_promotions** (boolean) - Whether to ignore promotions.
- **accumulate_discount** (boolean) - Whether to accumulate discounts.
- **percent_discount** (integer) - Percentage discount applied.
- **min_installment_value** (integer) - Minimum value for an installment.
- **max_installments_without_tax** (integer) - Maximum number of installments without tax.
- **billet_expire_days** (integer) - Number of days for billet expiration.
- **days_to_cancel_unpaid_billets** (integer) - Number of days to cancel unpaid billets.
- **hours_to_cancel_unpaid_pix** (integer) - Number of hours to cancel unpaid Pix.
- **billet_instructions** (string) - Instructions for billet payments.
- **installments** (object) - Details about payment installments.
  - **data** (array) - Array of installment objects.
    - **id** (integer) - Installment ID.
    - **payment_id** (integer) - Payment ID.
    - **installment** (integer) - Installment number.
    - **tax** (number) - Tax rate for the installment.
    - **percent_discount** (integer) - Discount percentage for the installment.
    - **start_at** (object) - Start date and time for the installment.
    - **end_at** (object) - End date and time for the installment.
    - **created_at** (object) - Creation date and time.
    - **updated_at** (object) - Update date and time.
- **affiliation** (object) - Details about the affiliation.
  - **data** (object) - Affiliation data.
    - **id** (integer) - Affiliation ID.
    - **active** (boolean) - Whether the affiliation is active.
    - **backup** (boolean) - Whether it's a backup affiliation.
    - **name** (string) - Name of the affiliation.
    - **statement_descriptor** (string) - Statement descriptor for the affiliation.
    - **auto_capture** (boolean) - Whether to auto-capture payments.
    - **has_payment_config** (boolean) - Whether the affiliation has payment configurations.
    - **capture_hour_delay** (integer) - Delay in hours for capture.
    - **force_minimum_tax** (boolean) - Whether to force minimum tax.
    - **status** (string) - Status of the affiliation.
    - **auth_type** (string) - Authentication type.
    - **gateway** (object) - Gateway details.
      - **data** (array) - Array of gateway objects.
        - **alias** (string) - Gateway alias.
        - **name** (string) - Gateway name.
        - **icon_url** (string) - URL of the gateway icon.
        - **allow_backup** (boolean) - Whether backup is allowed.
        - **installments_config** (object) - Installment configuration for the gateway.
        - **auth_type** (string) - Authentication type for the gateway.
        - **gateway_exists** (boolean) - Whether the gateway exists.
        - **params** (object) - Gateway parameters.
- **payment** (object) - Details about the payment method.
  - **data** (object) - Payment method data.
    - **id** (integer) - Payment method ID.
    - **alias** (string) - Payment method alias.
    - **name** (string) - Name of the payment method.
    - **has_config** (boolean) - Whether the payment method has configuration.
    - **active_config** (boolean) - Whether the payment method configuration is active.
    - **is_credit_card** (boolean) - Whether it's a credit card.
    - **is_deposit** (boolean) - Whether it's a deposit.
    - **is_billet** (boolean) - Whether it's a billet.
    - **is_pix** (boolean) - Whether it's Pix.
    - **is_pix_in_installments** (boolean) - Whether Pix is available in installments.
    - **is_wallet** (boolean) - Whether it's a digital wallet.
    - **icon_url** (string) - URL of the payment method icon.
- **created_at** (string) - Date and time of creation.
- **updated_at** (string) - Date and time of the last update.

#### Response Example
```json
{
  "id": 123,
  "payment_id": 123,
  "affiliation_id": 123,
  "active": true,
  "default_display": true,
  "spread": true,
  "ignore_promotions": true,
  "accumulate_discount": true,
  "percent_discount": 123,
  "min_installment_value": 123,
  "max_installments_without_tax": 123,
  "billet_expire_days": 123,
  "days_to_cancel_unpaid_billets": 123,
  "hours_to_cancel_unpaid_pix": 123,
  "billet_instructions": "<string>",
  "installments": {
    "data": [
      {
        "id": 1,
        "payment_id": 2,
        "installment": 1,
        "tax": 1.5,
        "percent_discount": 0,
        "start_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "end_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "created_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        },
        "updated_at": {
          "date": "2000-08-17 10:24:24",
          "timezone_type": 3,
          "timezone": "America/Sao_Paulo"
        }
      }
    ]
  },
  "affiliation": {
    "data": {
      "id": 123,
      "active": true,
      "backup": true,
      "name": "Cielo Affiliation",
      "statement_descriptor": "<string>",
      "auto_capture": true,
      "has_payment_config": false,
      "capture_hour_delay": 123,
      "force_minimum_tax": true,
      "status": "<string>",
      "auth_type": "<string>",
      "gateway": {
        "data": [
          {
            "alias": "billet",
            "name": "Boleto Bancário",
            "icon_url": "<string>",
            "allow_backup": true,
            "installments_config": {
              "allow_custom_installments": true,
              "message": "<string>",
              "help_link": "<string>"
            },
            "auth_type": "Boleto Bancário",
            "gateway_exists": true,
            "params": {
              "data": [
                ["env", "merchant_id", "key"]
              ]
            }
          }
        ]
      }
    }
  },
  "payment": {
    "data": {
      "id": 123,
      "alias": "<string>",
      "name": "<string>",
      "has_config": true,
      "active_config": true,
      "is_credit_card": true,
      "is_deposit": true,
      "is_billet": true,
      "is_pix": true,
      "is_pix_in_installments": true,
      "is_wallet": true,
      "icon_url": "<string>"
    }
  },
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}
```

#### Error Response (400)
- **description**: Dados inválidos fornecidos

#### Error Response (404)
- **description**: Forma de pagamento não encontrada
```
Tokens:
Raw