get https://partnerhub-sdx-external-api.stone.com.br/pricing/offers
Lista as ofertas disponíveis para o lojista
Estrutura Principal do Response
Campo | Tipo | Descrição Detalhada |
---|---|---|
success | boolean | Indica se a requisição geral foi bem-sucedida. |
data | object | Objeto que encapsula o conteúdo principal da resposta, neste caso, a lista de ofertas. |
Detalhamento da Oferta Comercial (Objeto em offers
)
offers
)A resposta contém uma lista de objetos, onde cada um representa uma única oferta comercial com todas as suas regras, taxas e produtos associados.
Campo | Tipo | Descrição Detalhada |
---|---|---|
id | string | O identificador único (UUID) desta oferta específica. |
name | string | O nome comercial da oferta (ex: "Receba Todo Dia Útil"). |
conditions | object | Um objeto que contém um conjunto de regras e sinalizadores (flags ) que definem o comportamento e os pré-requisitos da oferta. |
promotion_details | object | Um objeto que conteria detalhes específicos caso a oferta fosse parte de uma promoção. |
prepayments_fees | object | Agrupa todas as taxas percentuais relacionadas à antecipação de recebíveis. |
volume_exemption_condition | string ou null | Descreve a condição para obter isenção de taxas por volume de vendas, se houver. |
mdr | object | Um objeto que detalha as taxas de MDR (Merchant Discount Rate) para cada bandeira e modalidade de transação. |
total_effective_cost | number ou null | O Custo Efetivo Total (CET) da oferta, se aplicável e calculado. |
mdr_for_daily_payment | object ou null | Taxas MDR específicas aplicáveis apenas se o pagamento diário estiver ativo. |
terminals | array | Uma lista de objetos, onde cada um representa um equipamento (maquininha) disponível nesta oferta. |
pix | object | Contém as configurações e taxas específicas para transações via Pix. |
CET
O Custo Efetivo Total da oferta é será passado no campo
total_effective_cost
Condições da Oferta (conditions
)
conditions
)Este objeto funciona como um painel de controle, ativando ou desativando características da oferta.
Campo | Tipo | Descrição Detalhada |
---|---|---|
promotion | boolean | true se a oferta é uma promoção padrão. |
campaign | boolean | true se a oferta faz parte de uma campanha específica com tempo limitado. |
prepayment_d0 | boolean | true se a antecipação no mesmo dia da venda (D+0) está habilitada. |
stone_account | boolean | true se a posse de uma Conta Stone é um pré-requisito ou benefício. |
prepayment_automatic | boolean | true se a antecipação automática de recebíveis é a padrão para esta oferta. |
volume_exemption | boolean | true se existem regras de isenção de taxas por volume de faturamento. |
prepayment_d1 | boolean | true se a antecipação no dia útil seguinte (D+1) está habilitada. |
promotion_free_trial | boolean | true se a oferta inclui um período de teste gratuito ("free trial"). |
daily_payment_type | number ou null | Código que identifica o tipo de pagamento diário, se aplicável. |
daily_payment | boolean | true se o modelo de pagamento diário está ativo. |
Taxas de Antecipação (prepayments_fees
)
prepayments_fees
)Campo | Tipo | Descrição Detalhada |
---|---|---|
automatic | number | Taxa percentual aplicada na antecipação automática diária. |
spot | number | Taxa percentual aplicada na antecipação pontual (spot), solicitada manualmente pelo cliente. |
d0 | number | Taxa adicional (ou total) para receber o valor das vendas no mesmo dia (D+0). |
d1 | number | Taxa adicional (ou total) para receber o valor das vendas no dia útil seguinte (D+1). |
Taxas MDR por Bandeira (mdr
)
mdr
)Define as taxas percentuais de MDR para cada bandeira. A estrutura interna é a mesma para visa
, master
, elo
, etc.
Sub-campo | Tipo | Descrição Detalhada |
---|---|---|
credit | number | Taxa para transações de crédito à vista. |
credit2to6 | number | Taxa para transações de crédito parcelado de 2 a 6 vezes. |
credit7to12 | number | Taxa para transações de crédito parcelado de 7 a 12 vezes. |
debit | number ou null | Taxa para transações de débito. Pode ser null se a bandeira não operar no débito. |
Terminais Disponíveis (terminals
)
terminals
)Campo | Tipo | Descrição Detalhada |
---|---|---|
type | string | O tipo do terminal (ex: "pos"). |
value | number | O valor de venda ou aluguel recorrente do equipamento. |
firstValue | number | O valor da primeira parcela ou adesão, que pode ser diferente do valor recorrente. |
technology | string | A tecnologia do sistema operacional do terminal (ex: "Android", "Mamba"). |
exemption | object | Detalhes sobre a isenção de aluguel. |
exemption.periodType | string | A unidade de tempo para a isenção (ex: "days", "months"). |
exemption.value | number | O valor numérico do período de isenção (ex: 30 dias, 3 meses). |
exemption.period | string | A descrição textual do período (ex: "Dias"). |
quantity | object | Limites de quantidade para aquisição do terminal. |
quantity.min | number | Quantidade mínima de terminais que podem ser adquiridos. |
quantity.max | number | Quantidade máxima de terminais que podem ser adquiridos. |
Configuração do Pix (pix
)
pix
)Campo | Tipo | Descrição Detalhada |
---|---|---|
fee | number | O valor da taxa a ser cobrada por transação Pix. |
type | string | O tipo da taxa (ex: "percentual", "fixo"). |
allow_change_fee | boolean | true se o parceiro ou vendedor tem permissão para alterar a taxa do Pix durante a negociação. |