Obter Ofertas

Lista as ofertas disponíveis para o lojista

Estrutura Principal do Response

CampoTipoDescrição Detalhada
successbooleanIndica se a requisição geral foi bem-sucedida.
dataobjectObjeto que encapsula o conteúdo principal da resposta, neste caso, a lista de ofertas.

Detalhamento da Oferta Comercial (Objeto em 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.

CampoTipoDescrição Detalhada
idstringO identificador único (UUID) desta oferta específica.
namestringO nome comercial da oferta (ex: "Receba Todo Dia Útil").
conditionsobjectUm objeto que contém um conjunto de regras e sinalizadores (flags) que definem o comportamento e os pré-requisitos da oferta.
promotion_detailsobjectUm objeto que conteria detalhes específicos caso a oferta fosse parte de uma promoção.
prepayments_feesobjectAgrupa todas as taxas percentuais relacionadas à antecipação de recebíveis.
volume_exemption_conditionstring ou nullDescreve a condição para obter isenção de taxas por volume de vendas, se houver.
mdrobjectUm objeto que detalha as taxas de MDR (Merchant Discount Rate) para cada bandeira e modalidade de transação.
total_effective_costnumber ou nullO Custo Efetivo Total (CET) da oferta, se aplicável e calculado.
mdr_for_daily_paymentobject ou nullTaxas MDR específicas aplicáveis apenas se o pagamento diário estiver ativo.
terminalsarrayUma lista de objetos, onde cada um representa um equipamento (maquininha) disponível nesta oferta.
pixobjectConté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)

Este objeto funciona como um painel de controle, ativando ou desativando características da oferta.

CampoTipoDescrição Detalhada
promotionbooleantrue se a oferta é uma promoção padrão.
campaignbooleantrue se a oferta faz parte de uma campanha específica com tempo limitado.
prepayment_d0booleantrue se a antecipação no mesmo dia da venda (D+0) está habilitada.
stone_accountbooleantrue se a posse de uma Conta Stone é um pré-requisito ou benefício.
prepayment_automaticbooleantrue se a antecipação automática de recebíveis é a padrão para esta oferta.
volume_exemptionbooleantrue se existem regras de isenção de taxas por volume de faturamento.
prepayment_d1booleantrue se a antecipação no dia útil seguinte (D+1) está habilitada.
promotion_free_trialbooleantrue se a oferta inclui um período de teste gratuito ("free trial").
daily_payment_typenumber ou nullCódigo que identifica o tipo de pagamento diário, se aplicável.
daily_paymentbooleantrue se o modelo de pagamento diário está ativo.

Taxas de Antecipação (prepayments_fees)

CampoTipoDescrição Detalhada
automaticnumberTaxa percentual aplicada na antecipação automática diária.
spotnumberTaxa percentual aplicada na antecipação pontual (spot), solicitada manualmente pelo cliente.
d0numberTaxa adicional (ou total) para receber o valor das vendas no mesmo dia (D+0).
d1numberTaxa adicional (ou total) para receber o valor das vendas no dia útil seguinte (D+1).

Taxas MDR por Bandeira (mdr)

Define as taxas percentuais de MDR para cada bandeira. A estrutura interna é a mesma para visa, master, elo, etc.

Sub-campoTipoDescrição Detalhada
creditnumberTaxa para transações de crédito à vista.
credit2to6numberTaxa para transações de crédito parcelado de 2 a 6 vezes.
credit7to12numberTaxa para transações de crédito parcelado de 7 a 12 vezes.
debitnumber ou nullTaxa para transações de débito. Pode ser null se a bandeira não operar no débito.

Terminais Disponíveis (terminals)

CampoTipoDescrição Detalhada
typestringO tipo do terminal (ex: "pos").
valuenumberO valor de venda ou aluguel recorrente do equipamento.
firstValuenumberO valor da primeira parcela ou adesão, que pode ser diferente do valor recorrente.
technologystringA tecnologia do sistema operacional do terminal (ex: "Android", "Mamba").
exemptionobjectDetalhes sobre a isenção de aluguel.
exemption.periodTypestringA unidade de tempo para a isenção (ex: "days", "months").
exemption.valuenumberO valor numérico do período de isenção (ex: 30 dias, 3 meses).
exemption.periodstringA descrição textual do período (ex: "Dias").
quantityobjectLimites de quantidade para aquisição do terminal.
quantity.minnumberQuantidade mínima de terminais que podem ser adquiridos.
quantity.maxnumberQuantidade máxima de terminais que podem ser adquiridos.

Configuração do Pix (pix)

CampoTipoDescrição Detalhada
feenumberO valor da taxa a ser cobrada por transação Pix.
typestringO tipo da taxa (ex: "percentual", "fixo").
allow_change_feebooleantrue se o parceiro ou vendedor tem permissão para alterar a taxa do Pix durante a negociação.
Language
Credentials
Header
Click Try It! to start a request and see the response here!