Pepper API

https://docs.pepper.com.br
Admin
A Pepper API permite integrar sistemas e soluções para gerenciar transações PIX, listar transações,...
Tokens:38,755
Snippets:74
Trust Score:8.6
Update:9 months ago
Show doc for...
Tokens:
Raw
### Transaction Response Example

Source: https://docs.pepper.com.br/api-reference/obter-transacao-especifica

Provides an example of a successful transaction response, detailing all fields returned upon completion of a transaction.

```APIDOC
## Transaction Response Example

### Description
This example illustrates a successful transaction response, including details about the event, payment, customer, and product.

### Method
(Not applicable for a response example)

### Endpoint
(Not applicable for a response example)

### Parameters
(Not applicable for a response example)

### Request Example
(Not applicable for a response example)

### Response
#### Success Response (200)
- **event** (string) - The type of event that occurred.
- **hash** (string) - The hash identifier for the transaction.
- **payment_method** (string) - The method used for payment.
- **payment_status** (string) - The status of the payment.
- **installments** (integer) - The number of installments for the payment.
- **pix** (null) - Details for Pix payment (null if not applicable).
- **billet** (null) - Details for billet payment (null if not applicable).
- **amount** (integer) - The total transaction amount.
- **amount_liquid** (integer) - The net amount after deductions.
- **transaction** (string) - The transaction ID.
- **utm_source** (string) - UTM parameter for source.
- **utm_campaign** (string) - UTM parameter for campaign.
- **utm_content** (string) - UTM parameter for content.
- **utm_term** (string) - UTM parameter for term.
- **utm_medium** (string) - UTM parameter for medium.
- **customer** (object) - Information about the customer.
  - **hash** (string) - Customer hash.
  - **name** (string) - Customer name.
  - **email** (string) - Customer email.
  - **phone_number** (string) - Customer phone number.
  - **document** (string) - Customer document number.
- **producer** (object) - Information about the producer.
  - **hash** (string) - Producer hash.
  - **name** (string) - Producer name.
  - **email** (string) - Producer email.
- **affiliate** (null) - Affiliate details (null if not applicable).
- **split_recipients** (array) - Details of how the amount is split among recipients.
  - **recipient_type** (string) - Type of recipient (e.g., 'producer', 'platform').
  - **amount** (string) - The amount allocated to the recipient.
- **offer** (object) - Information about the offer.
  - **hash** (string) - Offer hash.
  - **title** (string) - Offer title.
  - **price** (integer) - Offer price.
  - **installments** (integer) - Offer installments.
- **product** (object) - Information about the product.
  - **hash** (string) - Product hash.
  - **title** (string) - Product title.
  - **cover** (string) - URL of the product cover image.
  - **status** (string) - Product status.
- **items** (array) - List of items in the transaction.
  - **hash** (string) - Item hash.
  - **product_id** (integer) - ID of the product.
  - **operation_type** (integer) - Type of operation for the item.
- **balance** (object) - Information about the balance after the transaction.
  - **amount** (integer) - The balance amount.
  - **status** (string) - The status of the balance.
- **postback_url** (string) - URL for webhook notifications.
- **created_at** (string) - The creation date.
- **updated_at** (string) - The last update date.

#### Response Example
```json
{
  "event": "transaction",
  "hash": "abc123def456",
  "payment_method": "credit_card",
  "payment_status": "paid",
  "installments": 1,
  "pix": null,
  "billet": null,
  "amount": 10000,
  "amount_liquid": 9500,
  "transaction": "txn_123456",
  "utm_source": "google",
  "utm_campaign": null,
  "utm_content": null,
  "utm_term": "pagamento",
  "utm_medium": "cpc",
  "customer": {
    "hash": "cust_123",
    "name": "João Silva",
    "email": "joao@email.com",
    "phone_number": "11999999999",
    "document": "12345678901"
  },
  "producer": {
    "hash": "prod_123",
    "name": "Produtor XYZ",
    "email": "produtor@email.com"
  },
  "affiliate": null,
  "split_recipients": [
    {
      "recipient_type": "producer",
      "amount": "8000"
    },
    {
      "recipient_type": "platform",
      "amount": "1500"
    }
  ],
  "offer": {
    "hash": "off_123",
    "title": "Curso Completo",
    "price": 10000,
    "installments": 1
  },
  "product": {
    "hash": "prod_123",
    "title": "Curso de Marketing Digital",
    "cover": "https://example.com/cover.jpg",
    "status": "active"
  },
  "items": [
    {
      "hash": "item_123",
      "product_id": 1,
      "operation_type": 1
    }
  ],
  "balance": {
    "amount": 9500,
    "status": "available"
  },
  "postback_url": "https://webhook.example.com",
  "created_at": "2024",
  "updated_at": "2024"
}
```
```

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

### Transaction Example

Source: https://docs.pepper.com.br/webhooks/v2/webhooks

This section shows an example of a transaction payload, illustrating the structure and fields commonly found in transaction events.

```APIDOC
## Transaction Example

### Description
This is an example of a transaction payload, demonstrating the data structure for transaction events.

### Method
N/A (Webhook Payload Example)

### Endpoint
N/A

### Parameters
N/A

### Request Example
```json
{
  "token": "abc123def4",
  "event": "transaction",
  "created_at": "2024-01-15T14:30:00.000000Z",
  "platform": "Pepper",
  "status": "waiting_payment",
  "method": "pix",
  "customer": {
    "id": "cust123abc",
    "name": "João Silva",
    "email": "joao.silva@exemplo.com",
    "phone": "+5511987654321",
    "document": "12345678901",
    "zip_code": null,
    "street_name": null,
    "number": null,
    "complement": null,
    "neighborhood": null,
    "city": null,
    "state": null
  },
  "transaction": {
    "id": "txn456def789",
    "status": "waiting_payment",
    "method": "pix",
    "amount": "6400",
    "url": "https://checkout.exemplo.com/customer/txn456def789",
    "billet": {
      "url": null,
      "barcode": null,
      "expires_at": null
    },
    "pix": {
      "code": "00020101021226830014BR.GOV.BCB.PIX2561pix.exemplo.com.br/v2/abc123def456789012345678901234565204000053039865802BR5909EXEMPLO6008SAOPAULO62070503***6304A1B2",
      "url": "https://checkout.exemplo.com/customer/txn456def789",
      "expires_at": null
    },
    "split_recipients": [
      {
        "amount": "483",
        "recipient_type": "platform"
      },
      {
        "amount": "5917",
        "recipient_type": "producer"
      }
    ]
  },
  "offer": {
    "hash": "offer789",
    "title": "Curso Completo de Marketing",
    "price": "4700"
  },
  "items": [
    {
      "hash": "item123abc",
      "product_hash": "prod456def",
      "offer_hash": "offer789",
      "title": "Módulo 1 - Fundamentos",
      "price": "4700",
      "quantity": 1,
      "cover": "https://cdn.exemplo.com/produtos/curso-cinesioterapia.jpg",
      "operation_type": 1
    },
    {
      "hash": "item789xyz",
      "product_hash": "prod012ghi",
      "offer_hash": "bonus123",
      "title": "Bônus Especial",
      "price": "1700",
      "quantity": 1,
      "cover": "https://cdn.exemplo.com/produtos/ebook-orderbump.jpg",
      "operation_type": 2
    }
  ],
  "tracking": {
    "src": "null",
    "utm_source": "null",
    "utm_campaign": "null",
    "utm_medium": "null",
    "utm_term": "null",
    "utm_content": "null"
  },
  "ip": "192.168.1.100",
  "fbp": "fb.1.1234567890123.123456789012345678",
  "fbc": null
}
```

### Response
N/A
```

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

### API Authentication Header Example

Source: https://docs.pepper.com.br/api-reference/autenticacao

This example shows the required 'Authorization' header format for API requests using a Bearer Token. Ensure your token is correctly placed after 'Bearer '.

```bash
Authorization: Bearer {seu_token_aqui}
```

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

### GET /websites/pepper_/products

Source: https://docs.pepper.com.br/api-reference/listar-produtos

Retrieves a list of products associated with the Pepper Project. Includes pagination and detailed product information.

```APIDOC
## GET /websites/pepper_/products

### Description
Retrieves a list of products. This endpoint supports pagination and returns detailed information about each product, including its offers, pricing, and support details.

### Method
GET

### Endpoint
/websites/pepper_/products

### Query Parameters
- **page** (integer) - Optional - The page number for pagination.

### Response
#### Success Response (200)
- **data** (array) - An array of product objects.
  - **hash** (string) - Unique identifier for the product.
  - **title** (string) - The title of the product.
  - **description** (string) - A detailed description of the product.
  - **cover** (string) - URL of the product's cover image.
  - **id_category** (integer) - The category ID of the product.
  - **product_type** (string) - The type of the product (e.g., 'digital').
  - **guaranted_days** (string) - Number of guaranteed days for the product.
  - **sale_page** (string) - URL of the product's sales page.
  - **offers** (array) - An array of offer objects associated with the product.
    - **hash** (string) - Unique identifier for the offer.
    - **title** (string/null) - Title of the offer.
    - **price** (integer) - The price of the offer.
    - **url** (string) - URL for the offer.
    - **status** (integer) - Status of the offer.
    - **interval** (string/null) - The interval for the offer (e.g., 'monthly').
    - **created_at** (string) - Timestamp of when the offer was created.
    - **updated_at** (string) - Timestamp of when the offer was last updated.
  - **status** (integer) - Status of the product.
  - **support_name** (string) - Name of the support contact.
  - **support_email** (string) - Email of the support contact.
  - **support_whatsapp** (string/null) - WhatsApp number of the support contact.
- **links** (object) - Pagination links.
  - **first** (string) - URL for the first page.
  - **last** (string) - URL for the last page.
  - **prev** (string/null) - URL for the previous page.
  - **next** (string/null) - URL for the next page.
- **meta** (object) - Pagination metadata.
  - **current_page** (integer) - The current page number.
  - **from** (integer) - The starting item number for the current page.
  - **last_page** (integer) - The total number of pages available.
  - **links** (array) - Array of pagination link objects.
    - **url** (string/null) - The URL for the link.
    - **label** (string) - The label for the link (e.g., page number, 'previous').
    - **active** (boolean) - Indicates if the link is for the current page.
  - **path** (string) - The base path for API requests.
  - **per_page** (integer) - The number of items per page.
  - **to** (integer) - The ending item number for the current page.
  - **total** (integer) - The total number of items available.

#### Response Example
```json
{
  "data": [
    {
      "hash": "abc123def",
      "title": "Curso de Marketing Digital",
      "description": "Um curso completo sobre marketing digital",
      "cover": "https://example.com/products/marketing-digital.jpg",
      "id_category": 2,
      "product_type": "digital",
      "guaranted_days": "7",
      "sale_page": "https://exemplo.com.br",
      "offers": [
        {
          "hash": "off123",
          "title": null,
          "price": 9900,
          "url": "https://go.pepper.com.br/off123",
          "status": 1,
          "interval": "monthly",
          "created_at": "2024-08-22 10:45:27",
          "updated_at": "2024-08-22 10:45:27"
        }
      ],
      "status": 1,
      "support_name": "Suporte",
      "support_email": "suporte@exemplo.com",
      "support_whatsapp": null
    }
  ],
  "links": {
    "first": "https://api.cloud.pepperpay.com.br/public/v1/products?page=1",
    "last": "https://api.cloud.pepperpay.com.br/public/v1/products?page=1",
    "prev": null,
    "next": null
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 1,
    "links": [
      {
        "url": null,
        "label": "pagination.previous",
        "active": false
      },
      {
        "url": "https://api.cloud.pepperpay.com.br/public/v1/products?page=1",
        "label": "1",
        "active": true
      },
      {
        "url": null,
        "label": "pagination.next",
        "active": false
      }
    ],
    "path": "https://api.cloud.pepperpay.com.br/public/v1/products",
    "per_page": 15,
    "to": 1,
    "total": 1
  }
}
```
```

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

### Get LLM Navigation and Pages

Source: https://docs.pepper.com.br/api-reference/obter-produto-especifico

Fetches navigation and other pages from the LLM service.

```APIDOC
## GET /websites/pepper_br

### Description
Retrieves navigation and other pages from the LLM service for the specified project.

### Method
GET

### Endpoint
/websites/pepper_br

### Parameters
#### Query Parameters
- **llms.txt** (string) - Required - The path to the file containing LLM navigation and page information.

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **success** (boolean) - Indicates if the request was successful.
- **message** (string) - A message providing details about the response, often including the content of the requested file or a status message.

#### Response Example
```json
{
  "success": true,
  "message": "Navigation and page data retrieved successfully."
}
```
```

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

### GET /websites/pepper_project

Source: https://docs.pepper.com.br/api-reference/listar-transacoes

Retrieves a list of items and associated balance information for the pepper_project website.

```APIDOC
## GET /websites/pepper_project

### Description
Retrieves a paginated list of transaction items, including details about the transaction, customer, producer, affiliate, offer, product, and balance information. It also provides pagination metadata.

### Method
GET

### Endpoint
/websites/pepper_project

### Parameters
#### Query Parameters
- **page** (integer) - Optional - The page number to retrieve.
- **per_page** (integer) - Optional - The number of items per page.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **data** (array) - An array of transaction items.
  - **event** (string) - The type of event.
  - **hash** (string) - A unique identifier for the transaction.
  - **payment_method** (string) - The method used for payment.
  - **payment_status** (string) - The status of the payment.
  - **installments** (integer) - The number of installments.
  - **pix** (object) - Details about Pix payment (if applicable).
  - **billet** (object) - Details about Billet payment (if applicable).
  - **amount** (integer) - The total transaction amount.
  - **amount_liquid** (integer) - The net amount after deductions.
  - **transaction** (string) - The transaction ID.
  - **utm_source** (string) - UTM source parameter.
  - **utm_campaign** (string) - UTM campaign parameter.
  - **utm_content** (string) - UTM content parameter.
  - **utm_term** (string) - UTM term parameter.
  - **utm_medium** (string) - UTM medium parameter.
  - **customer** (object) - Customer details.
    - **hash** (string) - Customer hash.
    - **name** (string) - Customer name.
    - **email** (string) - Customer email.
    - **phone_number** (string) - Customer phone number.
    - **document** (string) - Customer document ID.
  - **producer** (object) - Producer details.
    - **hash** (string) - Producer hash.
    - **name** (string) - Producer name.
    - **email** (string) - Producer email.
  - **affiliate** (object) - Affiliate details.
    - **hash** (string) - Affiliate hash.
    - **name** (string) - Affiliate name.
    - **email** (string) - Affiliate email.
  - **offer** (object) - Offer details.
    - **hash** (string) - Offer hash.
    - **title** (string) - Offer title.
    - **price** (integer) - Offer price.
    - **installments** (integer) - Offer installments.
  - **product** (object) - Product details.
    - **hash** (string) - Product hash.
    - **title** (string) - Product title.
    - **cover** (string) - URL to the product cover image.
    - **status** (string) - Product status.
  - **items** (array) - Array of items within the transaction.
    - **hash** (string) - Item hash.
    - **product_id** (integer) - The ID of the product associated with the item.
    - **operation_type** (integer) - The type of operation for the item.
  - **balance** (object) - Balance information.
    - **amount** (integer) - The available balance amount.
    - **status** (string) - The status of the balance.
  - **postback_url** (string) - The URL for postback notifications.
  - **created_at** (string) - Timestamp of creation.
  - **updated_at** (string) - Timestamp of last update.
- **current_page** (integer) - The current page number of the results.
- **last_page** (integer) - The total number of pages.
- **per_page** (integer) - The number of items per page.
- **total** (integer) - The total number of items across all pages.

#### Response Example
```json
{
  "data": [
    {
      "event": "transaction",
      "hash": "abc123def456",
      "payment_method": "credit_card",
      "payment_status": "paid",
      "installments": 1,
      "pix": {},
      "billet": {},
      "amount": 10000,
      "amount_liquid": 9500,
      "transaction": "txn_123456",
      "utm_source": "google",
      "utm_campaign": "black_friday",
      "utm_content": "banner_1",
      "utm_term": "pagamento",
      "utm_medium": "cpc",
      "customer": {
        "hash": "cust_123",
        "name": "João Silva",
        "email": "joao@email.com",
        "phone_number": "11999999999",
        "document": "12345678901"
      },
      "producer": {
        "hash": "hashId",
        "name": "Produtor XYZ",
        "email": "produtor@email.com"
      },
      "affiliate": {
        "hash": "aff_123",
        "name": "Afiliado ABC",
        "email": "afiliado@email.com"
      },
      "offer": {
        "hash": "off_123",
        "title": "Curso Completo",
        "price": 10000,
        "installments": 1
      },
      "product": {
        "hash": "prod_123",
        "title": "Curso de Marketing Digital",
        "cover": "https://example.com/cover.jpg",
        "status": "active"
      },
      "items": [
        {
          "hash": "item_123",
          "product_id": 1,
          "operation_type": 1
        }
      ],
      "balance": {
        "amount": 9500,
        "status": "available"
      },
      "postback_url": "https://webhook.example.com",
      "created_at": "2024",
      "updated_at": "2024"
    }
  ],
  "current_page": 1,
  "last_page": 1,
  "per_page": 10,
  "total": 2
}
```
```

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

### Get Product by Hash

Source: https://docs.pepper.com.br/api-reference/atualizar-produto

Retrieves detailed information about a specific product using its unique hash ID. This endpoint returns comprehensive data including product attributes, category, sales page URL, and associated offers.

```APIDOC
## GET /websites/pepper_//products/{hash}

### Description
Retrieves detailed information about a specific product using its unique hash ID. This endpoint returns comprehensive data including product attributes, category, sales page URL, and associated offers.

### Method
GET

### Endpoint
/websites/pepper_//products/{hash}

### Parameters
#### Path Parameters
- **hash** (string) - Required - Unique hash ID of the product.

### Request Example
```json
{
  "example": ""
}
```

### Response
#### Success Response (200)
- **hash** (string) - Unique hash ID of the product.
- **title** (string) - Title of the product.
- **description** (string) - Description of the product.
- **cover** (string) - URL of the product cover image.
- **id_category** (integer) - ID of the product category.
- **product_type** (string) - Type of the product.
- **guaranted_days** (string) - Product warranty days.
- **sale_page** (string) - URL of the product sales page.
- **offers** (array) - List of offers associated with the product.
  - **hash** (string) - Hash ID of the offer.
  - **title** (string, nullable) - Title of the offer.
  - **price** (integer) - Offer price in cents.
  - **url** (string) - Checkout URL for this offer.
  - **status** (integer) - Offer status.
  - **interval** (string, nullable) - Offer recurrence interval.
  - **created_at** (string) - Date of offer creation.
  - **updated_at** (string) - Date of offer update.
- **status** (integer) - Product status.
- **support_name** (string) - Product support name.
- **support_email** (string) - Product support email.
- **support_whatsapp** (string, nullable) - Product support WhatsApp.

#### Response Example
```json
{
  "example": "{\n  \"hash\": \"ll8eicyvcw\",\n  \"title\": \"Curso de Programação Atualizado\",\n  \"description\": \"Descrição atualizada do curso\",\n  \"cover\": \"https://example.com/cover-updated.jpg\",\n  \"id_category\": 4,\n  \"product_type\": \"ebook\",\n  \"guaranted_days\": \"7\",\n  \"sale_page\": \"https://novosite.com\",\n  \"offers\": [\n    {\n      \"hash\": \"ylw8f\",\n      \"title\": null,\n      \"price\": 8888,\n      \"url\": \"https://go.pepper.com.br/ylw8f\",\n      \"status\": 1,\n      \"interval\": null,\n      \"created_at\": \"2025-09-01 11:12:26\",\n      \"updated_at\": \"2025-09-01 11:12:26\"\n    }\n  ],\n  \"status\": 1,\n  \"support_name\": \"Suporte Premium\",\n  \"support_email\": \"suporte@novodominio.com.br\",\n  \"support_whatsapp\": null\n}"
}
```

#### Error Response (400)
- **message** (string) - Error message.
- **errors** (array) - Array of specific errors.

#### Error Response (404)
- **success** (boolean) - Indicates if the request was successful.
- **message** (string) - Error message: Product not found.
```

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

### Get Websites

Source: https://docs.pepper.com.br/api-reference/listar-transacoes

Retrieves a list of websites, including details about digital marketing courses associated with them. Supports pagination and filtering.

```APIDOC
## GET /websites/pepper_br

### Description
Retrieves information about digital marketing courses within the specified project.

### Method
GET

### Endpoint
/websites/pepper_br

### Query Parameters
- **page** (integer) - Optional - The page number for pagination.
- **per_page** (integer) - Optional - The number of items to display per page.

### Response
#### Success Response (200)
- **title** (string) - The title of the digital marketing course.
- **cover** (string) - URL of the course cover image.
- **status** (string) - The current status of the course (e.g., 'active').
- **items** (array) - A list of items associated with the course.
  - **hash** (string) - Unique identifier for the item.
  - **product_id** (integer) - The ID of the associated product.
  - **operation_type** (integer) - The type of operation for the item.
- **balance** (object) - Information about the balance.
  - **amount** (number) - The balance amount.
  - **status** (string) - The status of the balance (e.g., 'available').
- **postback_url** (string) - The URL for receiving postback notifications.
- **created_at** (string) - The creation date of the course.
- **updated_at** (string) - The last update date of the course.
- **current_page** (integer) - The current page number in the response.
- **last_page** (integer) - The last available page number.
- **per_page** (integer) - The number of items per page.
- **total** (integer) - The total number of items available.

#### Response Example
```json
{
  "title": "Curso de Marketing Digital",
  "cover": "https://example.com/cover.jpg",
  "status": "active",
  "items": [
    {
      "hash": "item_123",
      "product_id": 1,
      "operation_type": 1
    }
  ],
  "balance": {
    "amount": 9500,
    "status": "available"
  },
  "postback_url": "https://webhook.example.com",
  "created_at": "2024",
  "updated_at": "2024",
  "current_page": 1,
  "last_page": 5,
  "per_page": 50,
  "total": 250
}
```
```

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

### GET /products/{hash}

Source: https://docs.pepper.com.br/api-reference/obter-produto-especifico

Retrieves detailed information about a specific product using its unique hash ID. This endpoint is part of the Pepper API v1.

```APIDOC
## GET /products/{hash}

### Description
Obtain detailed data for a specific product from your account.

### Method
GET

### Endpoint
`/products/{hash}`

### Parameters
#### Path Parameters
- **hash** (string) - Required - Hash ID único do produto

### Request Example
(No request body for GET requests)

### Response
#### Success Response (200)
- **hash** (string) - Hash ID único do produto
- **title** (string) - Título do produto
- **description** (string) - Descrição do produto
- **cover** (string) - URL da imagem de capa do produto
- **id_category** (integer) - ID da categoria do produto
- **product_type** (string) - Tipo do produto
- **guaranted_days** (string) - Dias de garantia do produto
- **sale_page** (string) - URL da página de vendas do produto
- **offers** (array) - Lista de ofertas associadas ao produto
  - **hash** (string) - Hash ID da oferta
  - **title** (string | null) - Título da oferta
  - **price** (integer) - Preço da oferta em centavos
  - **url** (string) - URL do checkout dessa oferta
  - **status** (integer) - Status da oferta
  - **interval** (string | null) - Intervalo de recorrência da oferta
  - **created_at** (string) - Data de criação da oferta
  - **updated_at** (string) - Data de atualização da oferta
- **status** (integer) - Status do produto
- **support_name** (string) - Nome do suporte do produto
- **support_email** (string) - Email do suporte do produto
- **support_whatsapp** (string | null) - WhatsApp do suporte do produto

#### Error Response (404)
- **(content details not provided in source)**

#### Response Example
```json
{
  "hash": "prod123abc",
  "title": "Curso de Programação Avançada",
  "description": "Curso completo de programação para desenvolvedores",
  "cover": "https://example.com/products/curso-programacao.jpg",
  "id_category": 2,
  "product_type": "digital",
  "guaranted_days": "7",
  "sale_page": "https://exemplo.com.br",
  "offers": [
    {
      "hash": "off456def",
      "title": null,
      "price": 9900,
      "url": "https://go.pepper.com.br/off456def",
      "status": 1,
      "interval": "monthly",
      "created_at": "2024-08-22 10:45:27",
      "updated_at": "2024-08-22 10:45:27"
    }
  ],
  "status": 1,
  "support_name": "Suporte Técnico",
  "support_email": "suporte@exemplo.com",
  "support_whatsapp": null
}
```
```

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

### Production Webhook Payload

Source: https://docs.pepper.com.br/webhooks/v2/webhooks

This section provides an example of a real production webhook payload for a transaction, as received by the system.

```APIDOC
## Production Webhook Payload

### Description
This is an example of a real production webhook payload for a transaction, demonstrating the data received.

### Method
N/A (Webhook Payload Example)

### Endpoint
N/A

### Parameters
N/A

### Request Example
```json
{
  "token": "aeq9nd8kct",
  "event": "transaction",
  "created_at": "2025-08-29T20:02:44.000000Z",
  "platform": "Pepper",
  "status": "waiting_payment",
  "method": "pix",
  "customer": {
    "id": "l6bf9mn7bb",
    "name": "Igor Teste",
    "email": "igorsjohn@gmail.com",
    "phone": "+5551991446118",
    "document": "29371821000",
    "zip_code": null,
    "street_name": null,
    "number": null,
    "complement": null,
    "neighborhood": null,
    "city": null,
    "state": null
  },
  "transaction": {
    "id": "xljhf6kdnb",
    "status": "waiting_payment",
    "method": "pix",
    "amount": "64.00",
    "url": "https://go.pepper.com.br/customer/xljhf6kdnb",
    "billet": {
      "url": null,
      "barcode": null,
      "expires_at": null
    },
    "pix": {
      "code": "00020101021226830014BR.GOV.BCB.PIX2561qrcodespix.sejaefi.com.br/v2/155b263c579c43b48bc3d9cb0b64429e5204000053039865802BR5905EFISA6008SAOPAULO62070503***6304F29D",
      "url": "https://go.pepper.com.br/customer/xljhf6kdnb",
      "expires_at": null
    },
    "split_recipients": [
      {
        "amount": "483",
        "recipient_type": "platform"
      },
      {
        "amount": "5917",
        "recipient_type": "producer"
      }
    ]
  },
  "offer": {
    "hash": "7l5hd",
    "title": "Oferta vitalicio",
    "price": "4700"
  },
  "items": [
    {
      "hash": "x16ppcuepp",
      "product_hash": "byljourbbi",
      "offer_hash": "7l5hd",
      "title": "PROGRAMA PDF",
      "price": "4700",
      "quantity": 1,
      "cover": "https://d1dtnm4cmgaw4x.cloudfront.net/176539924/products/zmcab1ir2blbtzfbw7dmmyxo4",
      "operation_type": 1
    },
    {
      "hash": "w7bffoxkjx",
      "product_hash": "ysve7d0g4d",
      "offer_hash": "rrskc",
      "title": "3 Técnicas Secretas",
      "price": "1700",
      "quantity": 1,
      "cover": "https://d1dtnm4cmgaw4x.cloudfront.net/176539924/products/yjgqviqqdr6rieebvfkropjzx",
      "operation_type": 2
    }
  ],
  "tracking": {
    "src": "null",
    "utm_source": "null",
    "utm_campaign": "null",
    "utm_medium": "null",
    "utm_term": "null",
    "utm_content": "null"
  },
  "ip": "2804:1b2:9441:edef:50f4:800e:ab5a:e509",
  "fbp": "fb.2.1730522083400.528479227536114549",
  "fbc": null
}
```

### Response
N/A
```

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

### POST /websites/pepper_br/products

Source: https://docs.pepper.com.br/api-reference/criar-produto

Creates a new product within the specified website project.

```APIDOC
## POST /websites/pepper_br/products

### Description
Creates a new product in your account.

### Method
POST

### Endpoint
/websites/pepper_br/products

### Headers
- **Authorization**: `Bearer {your_token_here}` (Required)
- **Content-Type**: `application/json` (Required)
- **Accept**: `application/json` (Required)

### Request Body
*(The request body schema is not provided in the input text, so it is omitted here.)*

### Request Example
*(No request body example provided in the input text.)*

### Response
#### Success Response (200 or 201)
*(The success response schema is not provided in the input text, so it is omitted here.)*

#### Response Example
*(No response example provided in the input text.)*
```

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

### Create Product using OpenAPI Specification

Source: https://docs.pepper.com.br/api-reference/criar-produto

This snippet defines the OpenAPI 3.1.0 specification for the POST /products endpoint. It details the request body, including required properties like title, description, product_type, cover, sale_page, and price, along with their types and descriptions. It also outlines the successful response structure (201) containing the product's hash and other details.

```yaml
openapi: 3.1.0
info:
  title: Pepper API v1
  description: Documentação da API pública da Pepper.
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.cloud.pepperpay.com.br/public/v1/
security:
  - bearerAuth: []
paths:
  /products:
    post:
      description: Criar um novo produto na sua conta
      requestBody:
        description: Dados para criação do produto
        content:
          application/json:
            schema:
              type: object
              required:
                - title
                - description
                - product_type
                - cover
                - sale_page
                - price
              properties:
                title:
                  type: string
                  description: Título do produto
                description:
                  type: string
                  description: Descrição do produto
                product_type:
                  type: string
                  description: Tipo do produto
                  enum:
                    - curso
                    - ebook
                    - recorrencia
                    - mentoria
                    - evento
                    - link_pagamento
                    - telegram
                    - fisico
                category:
                  type: string
                  description: Categoria do produto
                  enum:
                    - administracao_negocios
                    - pets
                    - arquitetura_engenharia
                    - artes_musica
                    - autoajuda_desenvolvimento_pessoal
                    - automoveis
                    - blogs_redes_sociais
                    - casa_jardinagem
                    - culinaria_gastronomia_receitas
                    - design_templates
                    - edicao_audio_video_imagem
                    - cursos_educacionais_tecnicos
                    - entretenimento_lazer
                    - esportes_fitness
                    - filmes_cinema
                    - geral
                    - quadrinhos
                    - idiomas
                    - computacao
                    - marketing_internet
                    - investimentos_financas
                    - jogos_cartas_poker_loterias
                    - jogos_computador_jogos_online
                    - juridico
                    - literatura_poesia
                    - marketing_rede
                    - marketing_comunicacao
                    - meio_ambiente
                    - moda_roupas
                    - bandas_musica_shows
                    - encontros_sedução_relacionamentos
                    - pessoas_deficiencia
                    - plugins_widgets_extensoes
                    - produtividade_organizacao_pessoal
                    - produtos_criancas
                    - relatorios_artigos_pesquisa
                    - religiao_crencas
                    - romances_dramas_historias
                    - rpg_jogos_tabuleiro
                    - saude_bem_estar_beleza
                    - scripts
                    - seguranca_trabalho
                    - sexologia_sexualidade
                    - trechos_video_clipes
                    - turismo
                cover:
                  type: string
                  description: URL da imagem de capa do produto
                sale_page:
                  type: string
                  description: URL da página de vendas do produto
                price:
                  type: integer
                  description: Preço do produto em centavos
            examples:
              create_product:
                summary: Exemplo de criação de produto
                value:
                  title: Novo Produto
                  description: Descrição do produto
                  product_type: curso
                  cover: https://example.com/cover.jpg
                  sale_page: https://qualquer.com
                  price: 8888
        required: true
      responses:
        '201':
          description: Produto criado com sucesso
          content:
            application/json:
              schema:
                type: object
                properties:
                  hash:
                    type: string
                    description: Hash ID único do produto criado
                  title:
                    type: string
                    description: Título do produto
                  description:
                    type: string
                    nullable: true
                    description: Descrição do produto
                  cover:
                    type: string
                    description: URL da imagem de capa do produto
                  id_category:
                    type: integer
                    nullable: true
                    description: ID da categoria do produto
                  product_type:

```

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

### Products and Offers Management

Source: https://docs.pepper.com.br/index

List, create, and update products and offers in your account.

```APIDOC
## API for Products and Offers

### Description
List, create, and update products and offers on your account.

### Method
GET, POST, PUT

### Endpoint
/api-reference/introduction (Note: This is a placeholder based on the text, actual endpoints might differ)

### Parameters
#### Query Parameters (for GET)
- **product_id** (string) - Optional - Filter by a specific product ID.

#### Request Body (for POST/PUT)
- **name** (string) - Required - The name of the product or offer.
- **description** (string) - Optional - A detailed description.
- **price** (number) - Required - The price of the product/offer.
- **type** (string) - Required - Type of item (e.g., "product", "offer").

### Request Example (POST)
```json
{
  "name": "Summer Discount",
  "description": "Get 20% off all summer items.",
  "price": 0.00,
  "type": "offer"
}
```

### Response
#### Success Response (200 for GET)
- **items** (array) - A list of product or offer objects.
  - **id** (string) - Item ID.
  - **name** (string) - Item name.
  - **price** (number) - Item price.
  - **type** (string) - Item type.

#### Success Response (201 for POST, 200 for PUT)
- **item** (object) - Details of the created or updated item.
  - **id** (string) - Item ID.
  - **message** (string) - Confirmation message.

#### Response Example (GET)
```json
{
  "items": [
    {
      "id": "prod_abc",
      "name": "T-Shirt",
      "price": 25.99,
      "type": "product"
    }
  ]
}
```

#### Response Example (POST)
```json
{
  "item": {
    "id": "offer_xyz",
    "message": "Offer created successfully."
  }
}
```
```

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

### Get Checkout Data

Source: https://docs.pepper.com.br/index

Retrieve data for a checkout created by you.

```APIDOC
## GET /api-reference/obter-checkout

### Description
Get data for a checkout created by you.

### Method
GET

### Endpoint
/api-reference/obter-checkout

### Parameters
#### Query Parameters
- **checkout_id** (string) - Required - The unique identifier of the checkout.

#### Request Body
None

### Response
#### Success Response (200)
- **checkout_data** (object) - Contains all relevant data for the specified checkout.

#### Response Example
```json
{
  "checkout_data": {
    "id": "chk_12345",
    "status": "paid",
    "amount": 100.50,
    "currency": "BRL"
  }
}
```
```
Tokens:
Raw