Consulta de Fee

A interface de programação referente a Consulta de Precificação é primariamente composta por consultas que retornam o Fee a partir da consulta dos estabelecimentos comerciais ou segmentos comerciais

Feito para:  Estabelecimentos ComerciaisFacilitadoresAdquirentesOutros DesenvolvedoresCarteiras Digitais

Introdução

Os dados de precificação podem ser consultados para um determinado estabelecimento comercial ou para um determinado segmento comercial (MCC), baseado no tipo de uso (i.e: Crédito à vista, Crédito parcelado pela loja...) e uma taxa, à cada parcela, que o comerciante terá que pagar à bandeira e ao credenciador. Esta interface de programação não suporta alteração dos dados de precificação. A alteração dos dados é feita exclusivamente pela Elo.

Consulta dos dados de precificação (Fee Padrão e Fee Especial) Para que as informações sejam retornadas, é necessário que o client_id tenha permissão de acesso aos dados de Merchants, e é preciso que a requisição tenha um access_token válido, ou seja, o usuário tenha feito o fluxo de login (Ver seção de Login).

Exemplos de consulta

As consultas podem ser feitas passando um único CNPJ, uma lista de CNPJs ou o número relativo ao MCC

query {
  priceMerchants(cnpjs: ["0228701"]) {
    cnpj
    price {
      cardUsage {
        cardUsageId
        name
        code
      }
      installmentsRange {
        min
        max
      }
      lastModified
      presentCard {
        physicalPerson {
          recurringCharge {
            marketingFee
            marketingFeeCeilValue
            marketingFeeInstalmentAdditional
            acquiringServiceFee
            acquiringServiceFeeCeilValue
            acquiringServiceFeeInstalmentAdditional
            processingCost
            processingCostCeilValue
            processingCostInstalmentAdditional
          }
          notRecurringCharge {
            marketingFee
            marketingFeeCeilValue
            marketingFeeInstalmentAdditional
            acquiringServiceFee
            acquiringServiceFeeCeilValue
            acquiringServiceFeeInstalmentAdditional
            processingCost
            processingCostCeilValue
            processingCostInstalmentAdditional
          }
        }
        legalPerson {
          recurringCharge {
            marketingFee
            marketingFeeCeilValue
            marketingFeeInstalmentAdditional
            acquiringServiceFee
            acquiringServiceFeeCeilValue
            acquiringServiceFeeInstalmentAdditional
            processingCost
            processingCostCeilValue
            processingCostInstalmentAdditional
          }
          notRecurringCharge {
            marketingFee
            marketingFeeCeilValue
            marketingFeeInstalmentAdditional
            acquiringServiceFee
            acquiringServiceFeeCeilValue
            acquiringServiceFeeInstalmentAdditional
            processingCost
            processingCostCeilValue
            processingCostInstalmentAdditional
          }
        }
      }
      notPresentCard {
        physicalPerson {
          recurringCharge {
            marketingFee
            marketingFeeCeilValue
            marketingFeeInstalmentAdditional
            acquiringServiceFee
            acquiringServiceFeeCeilValue
            acquiringServiceFeeInstalmentAdditional
            processingCost
            processingCostCeilValue
            processingCostInstalmentAdditional
          }
          notRecurringCharge {
            marketingFee
            marketingFeeCeilValue
            marketingFeeInstalmentAdditional
            acquiringServiceFee
            acquiringServiceFeeCeilValue
            acquiringServiceFeeInstalmentAdditional
            processingCost
            processingCostCeilValue
            processingCostInstalmentAdditional
          }
        }
        legalPerson {
          recurringCharge {
            marketingFee
            marketingFeeCeilValue
            marketingFeeInstalmentAdditional
            acquiringServiceFee
            acquiringServiceFeeCeilValue
            acquiringServiceFeeInstalmentAdditional
            processingCost
            processingCostCeilValue
            processingCostInstalmentAdditional
          }
          notRecurringCharge {
            marketingFee
            marketingFeeCeilValue
            marketingFeeInstalmentAdditional
            acquiringServiceFee
            acquiringServiceFeeCeilValue
            acquiringServiceFeeInstalmentAdditional
            processingCost
            processingCostCeilValue
            processingCostInstalmentAdditional
          }
        }
      }
    }
  }
}

Listagem por vários CNPJs

É possível listar a precificação de vários estabelecimentos, enviando uma lista de CNPJs na requisição. Nessa consulta pode ser informado até 500 CNPJs por vez. Também é possível enviar somente os 8 primeiros dígitos de um CNPJ para obter a precificação de todos os CNPJs que começam com esse prefixo.

query {
  priceMerchants(cnpjs: ["0228701","37117908"]) {
    cnpj
    price {
      cardUsage {
        cardUsageId
        name
        code
      }
      installmentsRange {
        min
        max
      }
      lastModified
        presentCard {
          physicalPerson {
            recurringCharge {
              marketingFee
              marketingFeeCeilValue
              marketingFeeInstalmentAdditional
              acquiringServiceFee
              acquiringServiceFeeCeilValue
              acquiringServiceFeeInstalmentAdditional
              processingCost
              processingCostCeilValue
              processingCostInstalmentAdditional
            }
            notRecurringCharge {
              marketingFee
              marketingFeeCeilValue
              marketingFeeInstalmentAdditional
              acquiringServiceFee
              acquiringServiceFeeCeilValue
              acquiringServiceFeeInstalmentAdditional
              processingCost
              processingCostCeilValue
              processingCostInstalmentAdditional
            }
          }
          legalPerson {
            recurringCharge {
              marketingFee
              marketingFeeCeilValue
              marketingFeeInstalmentAdditional
              acquiringServiceFee
              acquiringServiceFeeCeilValue
              acquiringServiceFeeInstalmentAdditional
              processingCost
              processingCostCeilValue
              processingCostInstalmentAdditional
            }
            notRecurringCharge {
              marketingFee
              marketingFeeCeilValue
              marketingFeeInstalmentAdditional
              acquiringServiceFee
              acquiringServiceFeeCeilValue
              acquiringServiceFeeInstalmentAdditional
              processingCost
              processingCostCeilValue
              processingCostInstalmentAdditional
            }
          }
        }
        notPresentCard {
          physicalPerson {
            recurringCharge {
              marketingFee
              marketingFeeCeilValue
              marketingFeeInstalmentAdditional
              acquiringServiceFee
              acquiringServiceFeeCeilValue
              acquiringServiceFeeInstalmentAdditional
              processingCost
              processingCostCeilValue
              processingCostInstalmentAdditional
            }
            notRecurringCharge {
              marketingFee
              marketingFeeCeilValue
              marketingFeeInstalmentAdditional
              acquiringServiceFee
              acquiringServiceFeeCeilValue
              acquiringServiceFeeInstalmentAdditional
              processingCost
              processingCostCeilValue
              processingCostInstalmentAdditional
            }
          }
          legalPerson {
            recurringCharge {
              marketingFee
              marketingFeeCeilValue
              marketingFeeInstalmentAdditional
              acquiringServiceFee
              acquiringServiceFeeCeilValue
              acquiringServiceFeeInstalmentAdditional
              processingCost
              processingCostCeilValue
              processingCostInstalmentAdditional
            }
            notRecurringCharge {
              marketingFee
              marketingFeeCeilValue
              marketingFeeInstalmentAdditional
              acquiringServiceFee
              acquiringServiceFeeCeilValue
              acquiringServiceFeeInstalmentAdditional
              processingCost
              processingCostCeilValue
              processingCostInstalmentAdditional
            }
          }
        }
      }
    }
  }
}

Listagem por MCC

Também é possível realizar a consulta a partir do MCC, ou seja, do Merchant Category Code, um número de quatro dígitos registrado para serviços financeiros de varejo. O MCC é usado para classificar um estabelecimento quanto ao tipo de serviço ou benefícios fornecidos.

Um MCC é atribuído a um comerciante pelo Emissor. O código reflete a categoria principal em que o comerciante faz negócios e pode ser usado.

A consulta a seguir lista a precificação de acordo com o número de MCC informado:

query {
  priceMerchantCategories(mcc: "3389") {
    mcc
    price {
      cardUsage {
        cardUsageId
        name
        code
      }
      installmentsRange {
        min
        max
      }
      lastModified
      presentCard {
        physicalPerson {
          recurringCharge {
            marketingFee
            marketingFeeCeilValue
            marketingFeeInstalmentAdditional
            acquiringServiceFee
            acquiringServiceFeeCeilValue
            acquiringServiceFeeInstalmentAdditional
            processingCost
            processingCostCeilValue
            processingCostInstalmentAdditional
          }
          notRecurringCharge {
            marketingFee
            marketingFeeCeilValue
            marketingFeeInstalmentAdditional
            acquiringServiceFee
            acquiringServiceFeeCeilValue
            acquiringServiceFeeInstalmentAdditional
            processingCost
            processingCostCeilValue
            processingCostInstalmentAdditional
          }
        }
        legalPerson {
          recurringCharge {
            marketingFee
            marketingFeeCeilValue
            marketingFeeInstalmentAdditional
            acquiringServiceFee
            acquiringServiceFeeCeilValue
            acquiringServiceFeeInstalmentAdditional
            processingCost
            processingCostCeilValue
            processingCostInstalmentAdditional
          }
          notRecurringCharge {
            marketingFee
            marketingFeeCeilValue
            marketingFeeInstalmentAdditional
            acquiringServiceFee
            acquiringServiceFeeCeilValue
            acquiringServiceFeeInstalmentAdditional
            processingCost
            processingCostCeilValue
            processingCostInstalmentAdditional
          }
        }
      }
      notPresentCard {
        physicalPerson {
          recurringCharge {
            marketingFee
            marketingFeeCeilValue
            marketingFeeInstalmentAdditional
            acquiringServiceFee
            acquiringServiceFeeCeilValue
            acquiringServiceFeeInstalmentAdditional
            processingCost
            processingCostCeilValue
            processingCostInstalmentAdditional
          }
          notRecurringCharge {
            marketingFee
            marketingFeeCeilValue
            marketingFeeInstalmentAdditional
            acquiringServiceFee
            acquiringServiceFeeCeilValue
            acquiringServiceFeeInstalmentAdditional
            processingCost
            processingCostCeilValue
            processingCostInstalmentAdditional
          }
        }
        legalPerson {
          recurringCharge {
            marketingFee
            marketingFeeCeilValue
            marketingFeeInstalmentAdditional
            acquiringServiceFee
            acquiringServiceFeeCeilValue
            acquiringServiceFeeInstalmentAdditional
            processingCost
            processingCostCeilValue
            processingCostInstalmentAdditional
          }
          notRecurringCharge {
            marketingFee
            marketingFeeCeilValue
            marketingFeeInstalmentAdditional
            acquiringServiceFee
            acquiringServiceFeeCeilValue
            acquiringServiceFeeInstalmentAdditional
            processingCost
            processingCostCeilValue
            processingCostInstalmentAdditional
          }
        }
      }
    }
  }
}



Consulta o Custo de Transação por CNPJ.

Argumentos:

cnpjs:

lista obrigatória de String obrigatório



Consulta o Custo de Transação por MCC.

Argumentos:

mcc: String obrigatório






Campos:

transactionValue

:

Float

Valor da transação a calcular o custo final, em BRL (R$).


idAccreditant

:

String

idAccreditant


accreditantName

:

String

accreditantName


accreditantEmail

:

String

accreditantEmail


installments

:

Int

Número de parcelas da transação. Para pagamentos à vista (cardUsage 70 ou 71), será desconsiderado. Se omitido, será considerado 1 (pagamento à vista).


expand

:

String

Expansão de relacionamento no retorno. Atributos permitidos calc






Campos:

cardUsageId

:

String

Identificador Global Único para este objeto.


name

:

String

Nome do Uso


code

:

Int

Código Bancário da Captura. Nos sistemas tradicionais pode ser necessário transitar o código da captura, que é fornecido por este número.



Campos:

min

:

Int

Número mínimo (inicial), incluso na faixa.


max

:

Int

Número máximo (final), incluso na faixa.



Campos:

marketingFee

:

Float

Valor a ser pago para a tarifa de desenvolvimento da bandeira e marketing, em BRL (R$). Valor final já calculado à partir do transactionValue e marketingFee, considerando marketingFeeCeilValue.


marketingFeeCeilValue

:

Float

Valor máximo a ser pago para a tarifa de desenvolvimento da bandeira e marketing, em BRL (R$).


marketingFeeInstalmentAdditional

:

Float

Valor incremental a ser pago para a tarifa de desenvolvimento da bandeira e marketing, em BRL (R$) de acordo com o prazo.


acquiringServiceFee

:

Float

Valor a ser pago para desenvolvimento e suporte de produtos ao credenciador, em BRL (R$). Valor final já calculado à partir do transactionValue e acquiringServiceFee, considerando acquiringServiceFeeCeilValue.


acquiringServiceFeeCeilValue

:

Float

Valor máximo a ser pago para desenvolvimento e suporte de produtos ao credenciador, em BRL (R$).


acquiringServiceFeeInstalmentAdditional

:

Float

Valor incremental ser pago para desenvolvimento e suporte de produtos ao credenciador, em BRL (R$) de acordo com o prazo.


processingCost

:

Float

Valor a ser pago para desenvolvimento e suporte de produtos ao credenciador, em BRL (R$). Valor final já calculado à partir do transactionValue e acquiringServiceFee, considerando acquiringServiceFeeCeilValue.


processingCostCeilValue

:

Float

Valor máximo a ser pago para desenvolvimento e suporte de produtos ao credenciador, em BRL (R$).


processingCostInstalmentAdditional

:

Float

Valor incremental a ser pago para desenvolvimento e suporte de produtos ao credenciador, em BRL (R$) de acordo com o prazo.



Campos:

recurringCharge

:

Charge

notRecurringCharge

:

Charge


Campos:

legalPerson

:

PersonPrice

physicalPerson

:

PersonPrice


Campos:

cardUsage

:

CardUsagePrice

installmentsRange

:

IntRangePrice

lastModified

:

String

Data e horário da última modificação.


presentCard

:

CardPrice

notPresentCard

:

CardPrice


Custo de Transação por CNPJ.

Campos:

cnpj

:

String

Cnpj da empresa consultada


price

:

Price


Custo de Transação por MCC.

Campos:

mcc

:

String

MCC da empresa consultada


price

:

Price