Skip to main content
POST
Criar oferta para produto

Authorizations

X-Api-Client-Token
string
header
required

Token de autenticação do cliente obtido via endpoint /auth

Path Parameters

product_hash
string
required

Hash do produto

Body

application/json
name
string
required

Nome da oferta.

Maximum string length: 191
Example:

"Oferta Premium"

price
integer
required

Preço da oferta em centavos.

Required range: 0 <= x <= 99999999
type_of_charge
enum<string>
required

Tipo de cobrança.

Available options:
one-time,
recurring
allow_pix
boolean
required

Se aceita pagamento via PIX avulso.

allow_bank_slip
boolean
required

Se aceita boleto bancário.

allow_credit_card
boolean
required

Se aceita pagamento via cartão de crédito.

quantity_items
integer

Quantidade de itens disponíveis em estoque.

  • Obrigatório apenas para produtos do tipo 'physical'
  • Limite: 1 a 100 unidades
  • Opcional para produtos digitais (course, ebook)
Required range: 1 <= x <= 100
allow_pix_recurring
boolean

Se aceita PIX Automático (débito recorrente). Necessário para vender a oferta com payment_method=pix_recurring no checkout. Só vale para ofertas recorrentes (type_of_charge=recurring). Quando true, pix_recurring_frequency e pix_recurring_authorization_type passam a ser obrigatórios.

Pré-requisito: PIX Automático liberado para o produtor. A liberação é feita pela Ticto na conta do produtor dono do produto e não pode ser feita pela API. Solicite ao seu contato na Ticto (inclusive para o ambiente de sandbox). Enquanto o produtor não estiver liberado, a oferta é salva com allow_pix_recurring = false mesmo que a requisição envie true: o POST/PUT responde com sucesso e o valor enviado é ignorado, sem erro. O checkout com payment_method=pix_recurring para essa oferta é recusado. Se a liberação do produtor for revogada, o PIX Automático é desligado em todas as ofertas dele. Os campos de PIX Automático não são devolvidos na resposta da oferta (ResponseOffer); depois de liberar o produtor, reenvie a configuração da oferta e valide com um checkout pix_recurring.

pix_recurring_frequency
enum<string> | null

Frequência de cobrança do PIX Automático. Obrigatório quando allow_pix_recurring = true.

Available options:
weekly,
biweekly,
monthly,
quarterly,
biannual,
annual
Example:

"monthly"

pix_recurring_authorization_type
enum<string> | null

Tipo de autorização do PIX Automático. Obrigatório quando allow_pix_recurring = true. Só a autorização mensal com retentativa mensal é aceita.

Available options:
monthly_auth_monthly_retry
Example:

"monthly_auth_monthly_retry"

allow_bank_slip_installments
boolean

Se permite parcelamento no boleto (somente ofertas não recorrentes).

bank_slip_days_due
integer

Número de dias para vencimento do boleto.

Required range: 1 <= x <= 7
bank_slip_installments_limit
integer

Limite máximo de parcelas no boleto.

Required range: 1 <= x <= 12
credit_card_installments_options
integer[]

Opções de parcelamento para cartão de crédito.

Required range: 1 <= x <= 36
allow_affiliates
boolean

Se permite afiliação para esta oferta.

custom_commission
boolean | null

Se a oferta utiliza comissão personalizada (diferente do padrão do produto).

commission_only_first_installment
boolean | null

Se a comissão do afiliado é calculada apenas sobre a primeira parcela. Aplicável apenas para ofertas recorrentes (type_of_charge=recurring).

affiliates_subscription_percentage
number | null

Percentual de comissão do afiliado para cobranças recorrentes (renovações). Aplicável apenas para ofertas recorrentes (type_of_charge=recurring).

Required range: 1 <= x <= 80
transfer_fixed_fee_to_buyer
boolean

Repassa a taxa fixa da transação (R$2,49) ao comprador.

  • true — o comprador paga a taxa fixa (valor adicionado ao total no checkout)
  • false — o produtor absorve a taxa fixa
  • Quando não informado na criação, o padrão é true
allow_smart_installment
boolean

Habilita parcelamento inteligente no cartão de crédito. Quando true, ao recusar o cartão por saldo insuficiente, a Ticto cria automaticamente um parcelamento. Sem juros, valor dividido igualmente, máximo 12 parcelas, mínimo R$5 por parcela.

producer_pays_interest
boolean | null

Se o produtor absorve os juros do parcelamento no cartão de crédito.

subscription
object

Configurações de assinatura (usar quando type_of_charge=recurring).

freight
object

Parâmetros de frete (obrigatório para produtos físicos).

Response

Oferta criada com sucesso

Objeto de retorno com os dados da oferta.

code
string
required

Código único da oferta.

name
string
required

Nome da oferta.

type_of_charge
enum<string>
required

Tipo de cobrança.

Available options:
one-time,
recurring
price
integer
required

Preço da oferta em centavos.

allow_credit_card
boolean
required

Indica se aceita cartão de crédito.

credit_card_installments_options
integer[]
required

Opções de parcelamento no cartão de crédito.

Required range: 1 <= x <= 36
allow_pix
boolean
required

Indica se aceita PIX.

allow_bank_slip
boolean
required

Indica se aceita boleto bancário.

created_at
string
required

Data de criação (formato YYYY-MM-DD HH:mm:ss)

Example:

"2026-01-15 14:30:00"

updated_at
string
required

Data de atualização (formato YYYY-MM-DD HH:mm:ss)

Example:

"2026-01-15 14:30:00"

fake_initial_price
integer | null

Preço "de" para exibição de desconto (em centavos).

quantity_items
integer

Quantidade de itens em estoque (para produtos físicos).

Required range: 1 <= x <= 100
allow_bank_slip_installments
boolean

Se permite parcelamento no boleto.

bank_slip_days_due
integer

Número de dias para vencimento do boleto.

Required range: 1 <= x <= 7
bank_slip_installments_limit
integer

Limite máximo de parcelas no boleto.

Required range: 1 <= x <= 12
allow_affiliates
boolean

Se permite afiliação para esta oferta.

affiliates_percentage
number | null

Percentual de comissão do afiliado.

Required range: 1 <= x <= 80
affiliates_subscription_percentage
number | null

Percentual de comissão do afiliado para cobranças recorrentes.

Required range: 1 <= x <= 80
commission_only_first_installment
boolean | null

Se a comissão é calculada apenas sobre a primeira parcela.

producer_pays_interest
boolean | null

Se o produtor paga os juros do parcelamento.

is_free
boolean | null

Se a oferta é gratuita (price = 0).

transfer_fixed_fee_to_buyer
boolean

Indica se a taxa fixa da transação (R$2,49) é repassada ao comprador.

  • true — comprador paga a taxa fixa
  • false — produtor absorve a taxa fixa
subscription
object

Configurações de assinatura (quando type_of_charge = recurring).

freight
object

Informações de frete retornadas para produtos físicos.