Consulta de Precificação

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

Como funciona

Primeiros passos

  1. Leia Introdução ao GraphQL, com exemplos reais da nossa API.
  2. Crie um usuário no portal do desenvolvedor.
  3. Cadastre sua primeira aplicação.
  4. Utilize o dashboard para acessar suas configurações de acesso.
  5. Para explorar rapidamente as APIs aqui na página de documentação, use o console de GraphQL, na seção de referências. Nele, você pode ver as consultas de exemplo, executá-las e alterá-las.

Primeiros passos na plataforma de Desenvolvedores Elo

Jaydson GomesDesenvolvedor Evangelista

Os dados de precificação podem ser gerados para um determinado estabelecimento comercial ou para um determinado segmento comercial, 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.

As consultas que retornam a precificação são:

  • merchant(...): Busca a precificação aplicada para um determinado estabelecimento comercial;
  • merchantCategory(...): Busca a precificação aplicada para um determinado segmento comercial.

Listagem por CNPJ Lista a precificação de acordo com o CNPJ informado:

pública

query {
  merchant(legalIds: {
    cnpj:"1"
  })
  {
    transactionFees {
    lastModified,
    expiry, marketingFee,
    marketingFeeCeilValue,
    acquiringServiceFee,
    acquiringServiceFeeCeilValue,
    processingCost,
    additionalInstallmentCost,  
    cardUsage{id, name},
    installmentsRange{min,max},
    processingCost
    }
  }
}

Listagem por MCC Lista a precificação de acordo com o MCC informado:

pública

query {
  merchantCategory(iso: 1) {
    transactionFees {
      lastModified,
      expiry, marketingFee,
      marketingFeeCeilValue,
      acquiringServiceFee,
      acquiringServiceFeeCeilValue,
      processingCost,
      additionalInstallmentCost,  
      cardUsage{id, name},
      installmentsRange{min,max},
      processingCost
    }
  }
}



Argumentos:

first: Int

after: String

last: Int

before: String



Argumentos:

legalIds: CompanyLegalIdsInput obrigatório



Argumentos:

iso: Int obrigatório






Campos:

cnpj

:

String


Campos:

min

:

Int

max

:

Int


Campos:

nameContains

:

String

legalIds

:

lista de CompanyLegalIdsInput obrigatório

includeCategories

:

lista de MerchantCategoryRangeInput obrigatório

excludeCategories

:

lista de MerchantCategoryRangeInput obrigatório


Campos:

startTimestamp

:

DateTime

endTimestamp

:

DateTime

includeMerchantCategories

:

lista de MerchantCategoryRangeInput obrigatório

excludeMerchantCategories

:

lista de MerchantCategoryRangeInput obrigatório

captureId

:

ID

usageId

:

ID


Campos:

filter

:

String


Campos:

maxUsage

:

Int

expiry

:

DateTime

allowedTxAmounts

:

lista de CardCurrencyRangeInput obrigatório

allowedIdCodes

:

lista de ID obrigatório

allowedMerchantCategories

:

lista de MerchantCategoryRangeInput obrigatório

deniedMerchantCategories

:

lista de MerchantCategoryRangeInput obrigatório


Campos:

status

:

CardStatus

usageConstraints

:

CardUsageConstraintsInput

cardHolderServiceId

:

ID

funding

:

CardFunding

cardProductId

:

ID

cardBrandId

:

ID

cardCaptureId

:

ID

cardUsageId

:

ID

cardNetworkId

:

ID

cardIssuerId

:

ID





Campos:

hasPreviousPage

:

Boolean obrigatório

hasNextPage

:

Boolean obrigatório

startCursor

:

String

endCursor

:

String


Campos:

url

:

String obrigatório

width

:

Int obrigatório

height

:

Int obrigatório

mimeType

:

String obrigatório


Campos:

number

:

String obrigatório


Campos:

cnpj

:

CNPJ


Campos:

type

:

CompanyContactType obrigatório

context

:

String

value

:

String obrigatório


Campos:

context

:

String

country

:

String obrigatório

city

:

String obrigatório

state

(


abbrev:

Boolean

)

:

String

zip

:

String

district

:

String

kind

:

String

number

:

Int

place

:

String obrigatório

complement

:

String

reference

:

String

instructions

:

String

lon

:

Float

lat

:

Float


Campos:

id

:

ID obrigatório

name

:

String obrigatório

code

:

Int obrigatório


Campos:

min

:

Int obrigatório

max

:

Int obrigatório


Campos:

cardUsage

:

CardUsage obrigatório

expiry

:

DateTime

installments

:

Int obrigatório

totalCost

:

Float obrigatório

processingCost

:

Float obrigatório

installmentsCost

:

Float obrigatório

marketingCost

:

Float obrigatório

acquiringServiceCost

:

Float obrigatório


Campos:

cardUsage

:

CardUsage obrigatório

installmentsRange

:

IntRange

lastModified

:

DateTime obrigatório

expiry

:

DateTime

marketingFee

:

Float obrigatório

marketingFeeCeilValue

:

Float

acquiringServiceFee

:

Float obrigatório

acquiringServiceFeeCeilValue

:

Float

processingCost

:

Float obrigatório

additionalInstallmentCost

:

Float

calc

(


transactionValue:

Float obrigatório

installments:

Int

)

:

MerchantTransactionFeesCalc obrigatório


Campos:

pageInfo

:

PageInfo obrigatório

edges

:

lista de MerchantsEdge

totalCount

:

Int


Campos:

id

:

ID obrigatório

iso

:

Int obrigatório

name

(


language:

String

)

:

String obrigatório

image

(


width:

Int

height:

Int

mimeType:

String

)

:

ImageUrl

transactionFees

:

lista de MerchantTransactionFees obrigatório

merchants

(


first:

Int

after:

String

last:

Int

before:

String

)

:

MerchantsConnection


Campos:

cursor

:

String obrigatório


Campos:

pageInfo

:

PageInfo obrigatório

edges

:


totalCount

:

Int


Campos:

id

:

ID obrigatório

name

:

String obrigatório

legalName

:

String obrigatório

description

:

String

image

(


width:

Int

height:

Int

mimeType:

String

)

:

ImageUrl

legalIds

:

CompanyLegalIds obrigatório

contacts

:

lista obrigatória de CompanyContact obrigatório

addresses

:

lista obrigatória de Address obrigatório

url

:

String

categories

:

lista obrigatória de MerchantCategory obrigatório

transactionFees

:

lista de MerchantTransactionFees obrigatório

cardTransactions

(


first:

Int

after:

String

last:

Int

before:

String

)

:

CardTransactionsConnection


Campos:

cursor

:

String obrigatório

node

:

Merchant


Campos:

id

:

ID obrigatório

name

:

String obrigatório

code

:

Int obrigatório


Campos:

id

:

ID obrigatório

code

:

CodeProduct obrigatório

name

:

String obrigatório

image

(


width:

Int

height:

Int

mimeType:

String

)

:

ImageUrl

url

:

String


Campos:

id

:

ID obrigatório

name

:

String obrigatório

image

(


width:

Int

height:

Int

mimeType:

String

)

:

ImageUrl

url

:

String


Campos:

id

:

ID obrigatório

name

:

String obrigatório

image

(


width:

Int

height:

Int

mimeType:

String

)

:

ImageUrl

url

:

String


Campos:

pageInfo

:

PageInfo obrigatório

edges

:

lista de CardsEdge

totalCount

:

Int


Campos:

id

:

ID obrigatório

name

:

String obrigatório

legalName

:

String obrigatório

description

:

String

image

(


width:

Int

height:

Int

mimeType:

String

)

:

ImageUrl

legalIds

:

CompanyLegalIds obrigatório

contacts

:

lista obrigatória de CompanyContact obrigatório

addresses

:

lista obrigatória de Address obrigatório

url

:

String

cards

(


first:

Int

after:

String

last:

Int

before:

String

)

:

CardsConnection


Campos:

image

(


width:

Int

height:

Int

mimeType:

String

)

:

ImageUrl

backgroundColor

:

String

foregroundColor

:

String

issuer

:

String

brand

:

String

product

:

String


Campos:

holderOrAdditional

:

Int

companion

:

Int


Campos:

id

:

ID obrigatório

name

:

String obrigatório

description

:

String

image

(


width:

Int

height:

Int

mimeType:

String

)

:

ImageUrl

url

:

String

discounts

:

Discounts


Campos:

number

:

String obrigatório

panSizeRange

:

IntRange obrigatório

funding

:

CardFunding obrigatório

product

:

CardProduct obrigatório

country

:

String obrigatório

isInternational

:

Boolean obrigatório

regexp

:

String obrigatório

isCompany

:

Boolean obrigatório

isToken

:

Boolean obrigatório

brand

:

CardBrand obrigatório

allowedCaptures

:

lista obrigatória de CardCapture obrigatório

usages

:

lista obrigatória de CardUsage obrigatório

network

:

CardNetwork obrigatório

issuer

:

CardIssuer obrigatório

metadata

:

CardMetadata obrigatório

services

:

lista obrigatória de CardHolderService obrigatório

creditSettlementBankNumber

:

Int

debitSettlementBankNumber

:

Int


Campos:

currency

:

String

balance

:

String


Campos:

id

:

ID obrigatório

capture

:

CardCapture obrigatório

usage

:

CardUsage

bin

:

BIN

merchant

:

Merchant

currency

:

String obrigatório

value

:

String obrigatório

installments

:

Int obrigatório

timestamp

:

DateTime obrigatório

approvalCode

:

String

prePaid

:

PrePaid


Campos:

id

:

ID obrigatório

sensitive

(


keyId:

String

)

:

String

last4

:

String

expiry

:

CardExpiry

holder

:

CardHolder

billingAddress

:

Address

status

:

CardStatusInterface obrigatório

usageConstraints

:

CardUsageConstraints

availableServices

:

lista de CardHolderService obrigatório

usedServices

:

lista de CardHolderService obrigatório

bin

:

BIN

funding

:

CardFunding

product

:

CardProduct

isInternational

:

Boolean

isCompany

:

Boolean

isToken

:

Boolean

cardTokens

:

CardTokensConnection

brand

:

CardBrand

allowedCaptures

:

lista de CardCapture obrigatório

usages

:

lista de CardUsage obrigatório

network

:

CardNetwork

issuer

:

CardIssuer

metadata

:

CardMetadata

trackings

:

lista de Track

transactions

(


first:

Int

after:

String

last:

Int

before:

String

)

:

CardTransactionsConnection

transactionsSummary

(


filter:

CardTransactionSummaryFilterInput

)

:

lista de CardTransactionCategorySummary obrigatório

fraudTransactions

(


first:

Int

after:

String

last:

Int

before:

String

filter:

CardFraudTransactionFilterInput

)

:

CardFraudTransactionsConnection

queueFraudTransactions

(


first:

Int

after:

String

last:

Int

before:

String

filter:

CardFraudTransactionFilterInput

)

:

CardFraudTransactionsConnection


Campos:

cursor

:

String obrigatório

node

:

Card





Valores possíveis:


PHONE


EMAIL


IM


OTHER





Valores possíveis:


CREDIT


DEBIT


MULTIPLE


MEAL


FOOD





Valores possíveis:


BASIC


BUSINESS


CORPORATE


ELO_PLUS


SHOPPING


GRAFITE


NANQUIM


AWARDS


CORPORATE_EXPENDITURE


TRAVEL


CORPORATE_NANQUIM


GRAFITE_BUSINESS


PAYMENT_OF_SUPPLIERS


GENERAL_USE


GIFT_CARD


PAYMENTS


ELO_PLUS_ENTERPRISE


PREPAID_ENTERPRISE


NANQUIM_CORPORATE_DINERS





Valores possíveis:


APPROVED


REJECTED


RETURNED


REFUNDED


CHARGEBACK





Valores possíveis:


INACTIVE


ACTIVE


SUSPENDED