Campos do Request
| Campo | Tipo | Descrição |
|---|---|---|
| amount | decimal | Valor de captura do pagamento - Valor da Transação |
| accountType | string | * 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. |
| installment | object | Objeto que configura os valores de transações Parceladas. |
| * type | integer | Tipo do parcelamento: * Sem Parcelamento: 1 * Merchant: 2 - Parcelado lojista (Sem juros para o cliente) * Issuer: 3 - Parcelado emissor (Com juros para o cliente) |
| * number | integer | Nú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 |
| hasAlcoholicDrink | booleam | Tem 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..) |
| splits | array of objects | Lista de objetos que configuram os recebedores (Apenas para parceiros Pagar-me. Para saber mais, fale com seu Bizdev(Account Manager). |
| * amount | integer | Valor destinado ao recebedor. |
| * splitType | string | Tipo de divisão. Os valores possíveis são flat ou percentage. Flat é o valor inteiro.\ Flat ; Percentage; |
| * recipientIdentification | string | Código do recebedor. Formato: rp_XXXXXXXXXXXXXXXX. |
| * changeProcessingFee | booleam | Indica se o recebedor vinculado à regra será cobrado pelas taxas da transação |
| * chargeRemainderFee | booleam | Indica se o recebedor vinculado à regra irá receber o restante dos recebíveis após uma divisão. |
| * liable | booleam | Indica 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.
| Campo | Tipo | Observação |
|---|---|---|
| brandName | string | Marca retornada pelo emissor do cartão. exemplo: “MASTER CREDITO” |
| receipt | object | |
| * acquirerTransactionKey | string | Identificador único da transação ( Identificador gerado pelo autorizador, único para cada transação. Utiliza-se a mesma ATK entre os eventos; |
| * aid | string | Identificador 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 | decimal | Valor da transação; |
| * arqc | string | criptograma ARQC para efetuar a transação em modo online; |
| * availableBalance | decimal | Saldo disponível para transações de voucher; |
| * brandName | string | Marca e modalidade da bandeira,\ exemplo: “MASTER CREDITO” |
| * cardholderName | string | Nome do titular do cartão |
| * initiatorTransactionKey | string | ITK - ID único enviado pela SDK/Slim para o Autorizador Stone. |
| * installmentType | integer | Tipo de parcela: * Sem Parcelamento= 1; * Merchant = 2 (Parcelado por decisão do estabelecimento comercial); * Issuer = 3 (Parcelado com juros, decisão do emissor). |
| * totalNumberOfPayments | integer | Número de parcelas |
| * maskedPrimaryAccountNumber | string | Dados do Pan do cartão mascarado. |
| * systemSpecifications | string | especificação do sistema. |
| * transactionDateTime | string | Data e hora da transação. |
| * transactionType | integer | Indica o tipo da transação. * Debit = 1; * Credit= 2; * Voucher = 7. |
| * clientVia | string | Cupom do cliente já formatado para impressão |
| * merchantVia | string | Cupom do estabelecimento já formatado para impressão |
| * cardReadingType | integer | Modo 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 | boolean | Cartão precisa de senha ou não. * False (Não necessita de senha); * True (Necessita de senha). |
| * authorisationCode | string | Código de autorização retornado pelo emissor do cartão |
| * messageDisplay | string | Mensagem do retorno do autorizador. |
| * isVoucher | boolean | Indica se o cartão é Voucher (Sodexo, VR, Ticket ou Alelo). * False (Não é cartão voucher); * True (Cartão Voucher); |
| * merchantName | string | Nome do estabelecimento |
| * merchantDocument | string | Cnpj do estabelecimento |
| * merchantAddress | string | Endereço do estabelecimento |
| * merchantCity | string | Cidade do estabelecimento |
| * merchantZipCode | string | CEP do estabelecimento |
| * totalAmountReversal | string | Valor de reversão do valor da bandeira Ticket. |
| * cne | string | Cardholder Name Extended (Tag EMV 9F0B). Mandatório na via do estabelecimento em transação de autorização chip. |
| * retrievalReferenceNumber | string | RRN (RetrievalReferenceNumber): Retorna o conteúdo do campo. Mandatório em todas as vias, autorização/estorno, chip/tarja e cliente e EC. IssuerTransactionIdentification. |
| * productBrandCard | string | Produto da bandeira utilizada na transação. |
| * stoneCode | string | Código único de identificador do estabelecimento na Stone. |
| card | object | Objeto cartão do portador. |
| * brandId | integer | Id da marca na carga de tabela |
| * brandName | string | Marca e modalidade da bandeira,\ exemplo: “MASTER CREDITO” |
| * cardholderName | string | Nome do portador do cartão |
| * expirationDate | string | Data de expiração do cartão |
| * maskedPrimaryAccountNumber | string | PAN mascarado |
| * cardType | integer | Modo 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 | string | Pan mascarado para uso em caso de cancelamento do pagamento via PDV. |
Fique atendo a lei de LGPD.
Jornada: Cobrar com cartão e Pix
Etapa 2 de 10