Definição dos campos

Tabelas com as definições de cada campo no request e response

Campos do Request

CampoTipoDescrição
amountdecimalValor de captura do pagamento - Valor da Transação
accountTypestring
  • Undefined: - deixa a definição de tipo de transação para o usuário escolher no pinpad;
  • Debit: define a transação para Débito;
  • Credit: define a transação para Crédito;
  • Voucher: define a transação para Voucher.
installmentobjectObjeto que configura os valores de transações Parceladas.
  • type
integerTipo do parcelamento:
  • Sem Parcelamento: 1
  • Merchant: 2 - Parcelado lojista (Sem juros para o cliente)
  • Issuer: 3 - Parcelado emissor (Com juros para o cliente)
  • number
integerNúmero de parcelas da transação para os casos de Merchant e Issuer.
Credito é possível parcelas de 2 a 18 vezes.
Debito = 0
Credito á vista = 1
OBS: Parcelado de 13 a 18x, tem valor mínimo por parcela de 10 reais
hasAlcoholicDrinkbooleamTem como padrão o valor false. Informe true em caso de bloqueio de produtos Alcoólicos ou Cigarros.Segundo o normativo PAT (Programa de Alimentação do Trabalhador) é vetado a venda de produtos alcoólicos ou cigarros com cartões Voucher (refeição, alimentação, cultura e etc..)
splitsarray of objectsLista de objetos que configuram os recebedores (Apenas para parceiros Pagar-me. Para saber mais, fale com seu Bizdev(Account Manager).
  • amount
integerValor destinado ao recebedor.
  • splitType
stringTipo de divisão. Os valores possíveis são flat ou percentage. Flat é o valor inteiro.
Flat ;
Percentage;
  • recipientIdentification
stringCódigo do recebedor. Formato: rp_XXXXXXXXXXXXXXXX.
  • changeProcessingFee
booleamIndica se o recebedor vinculado à regra será cobrado pelas taxas da transação
  • chargeRemainderFee
booleamIndica se o recebedor vinculado à regra irá receber o restante dos recebíveis após uma divisão.
  • liable
booleamIndica se o recebedor é responsável pela transação em caso de chargeback.

Campos do Response

Os campos do retorno da API, são necessários para montagem do cupom e para uso na rota de cancelamento quando for o caso.


CampoTipoObservação
brandNamestringMarca retornada pelo emissor do cartão.
exemplo: “MASTER CREDITO”
receiptobject
  • acquirerTransactionKey
stringIdentificador único da transação ( Identificador gerado pelo autorizador, único para cada transação. Utiliza-se a mesma ATK entre os eventos;
  • aid
stringIdentificador da aplicação. Apenas para transações com chip/NFC/EMV; ( Código único gerado pelo AutoTEF para identificar e determinar a inicialização da transação. Deve ser formatado seguindo a seguinte regra: nnnnnnddmmyyyyHHMMSS sendo que nnnnnn=número sequencial gerado pelo AutoTEF.)
  • amount
decimalValor da transação;
  • arqc
stringcriptograma ARQC para efetuar a transação em modo online;
  • availableBalance
decimalSaldo disponível para transações de voucher;
  • brandName
stringMarca e modalidade da bandeira,
exemplo: “MASTER CREDITO”
  • cardholderName
stringNome do titular do cartão
  • initiatorTransactionKey
stringITK - ID único enviado pela SDK/Slim para o Autorizador Stone.
  • installmentType
integerTipo de parcela:
  • Sem Parcelamento= 1;
  • Merchant = 2 (Parcelado por decisão do estabelecimento comercial);
  • Issuer = 3 (Parcelado com juros, decisão do emissor).
  • totalNumberOfPayments
integerNúmero de parcelas
  • maskedPrimaryAccountNumber
stringDados do Pan do cartão mascarado.
  • systemSpecifications
stringespecificação do sistema.
  • transactionDateTime
stringData e hora da transação.
  • transactionType
integerIndica o tipo da transação.
  • Debit = 1;
  • Credit= 2;
  • Voucher = 7.
  • clientVia
stringCupom do cliente já formatado para impressão
  • merchantVia
stringCupom do estabelecimento já formatado para impressão
  • cardReadingType
integerModo de entrada da transação/cartão;
Segue modelos de entrada transação possíveis:
  • Undefined = 0;
  • MagneticStrip = 4 (Tarja magnética);
  • Chip = 5 (ICC);
  • Contactless = 7 (NFC simula tarja);
  • EMVProximityReader = 8 (NFC simula chip)
  • cardNeedsPassword
booleanCartão precisa de senha ou não.
  • False (Não necessita de senha);
  • True (Necessita de senha).
  • authorisationCode
stringCódigo de autorização retornado pelo emissor do cartão
  • messageDisplay
stringMensagem do retorno do autorizador.
  • isVoucher
booleanIndica se o cartão é Voucher (Sodexo, VR, Ticket ou Alelo).
  • False (Não é cartão voucher);
  • True (Cartão Voucher);
  • merchantName
stringNome do estabelecimento
  • merchantDocument
stringCnpj do estabelecimento
  • merchantAddress
stringEndereço do estabelecimento
  • merchantCity
stringCidade do estabelecimento
  • merchantZipCode
stringCEP do estabelecimento
  • totalAmountReversal
stringValor de reversão do valor da bandeira Ticket.
  • cne
stringCardholder Name Extended (Tag EMV 9F0B). Mandatório na via do estabelecimento em transação de autorização chip.
  • retrievalReferenceNumber
stringRRN (RetrievalReferenceNumber): Retorna o conteúdo do campo. Mandatório em todas as vias, autorização/estorno, chip/tarja e cliente e EC. IssuerTransactionIdentification.
  • productBrandCard
stringProduto da bandeira utilizada na transação.
  • stoneCode
stringCódigo único de identificador do estabelecimento na Stone.
cardobjectObjeto cartão do portador.
  • brandId
integerId da marca na carga de tabela
  • brandName
stringMarca e modalidade da bandeira,
exemplo: “MASTER CREDITO”
  • cardholderName
stringNome do portador do cartão
  • expirationDate
stringData de expiração do cartão
  • maskedPrimaryAccountNumber
stringPAN mascarado
  • cardType
integerModo de entrada do cartão;
  • Undefined = 0;
  • Emv = 1 (ICC ou NFC simula Chip);
  • MagneticStrip = 2 (Tarja magnética);
  • Contactless = 3 (NFC simula tarja);
  • applicationId
string
  • applicationCryptogram
string
  • needsPassword
boolean
  • maskedPan
stringPan mascarado para uso em caso de cancelamento do pagamento via PDV.
🚧

Alguns campos aparecem repetidos, porém podem conter dados diferentes. Estamos trabalhando para melhorar e universalizar esse retorno.

❗️

Fique atendo a lei de LGPD.

Em sua maioria os dados aqui retornados, devem ser usados apenas para compor o cupom da transação. Salvo apenas os campos necessários para executar a rota de cancelamento em um PDV. Que exige validação com a apresentação do cartão utilizado na transação.