Suggest Edits

Bem vindo ao Stone Online!

Nesta documentação você encontrará o passo-a-passo, além de dicas, para se integrar à nossa solução E-Commerce

 

O Stone Online é uma Application Program Interface (API) de autorização da Stone.
Ele possui a função de Autorizar, Capturar, Cancelar e Consultar transações, para utilização em plataformas de vendas on-line (E-Commerce)

O Stone Online é indicado para empresas que já possuem na sua estrutura serviços como: anti-fraude, tokenização, multi meios de pagamento, recorrência, etc., e necessitam apenas dos serviços transacionais base já mencionados.

Para parceiros que desejam, mas ainda não possuem estes serviços, as APIs mais indicadas são da MundiPagg e Pagar.me.

 
Suggest Edits

Overview da API

 

A API de Autorização Stone foi desenvolvida com os melhores padrões REST.

As operações são feitas por requisições aos endpoints, de acordo com os verbos HTTP, com corpos de mensagem em JSON. Independente do resultado da requisição, a resposta sempre possui HTTP status code 200 OK.

ATENÇÃO!

Não deve ser enviado no formato JSON, apenas XML.

Nossa API possui 4 operações disponíveis. São elas:

1 - Authorize
Operação responsável pela requisição de autorização e captura da transação. A captura pode ser executada de maneira automática junto a autorização, pode ser uma captura posteriormente.
2 - Cancellation
Operação responsável pelo cancelamento de transações.
3 - TransactionStatusReport
Operação responsável pela consulta do status das transações.
4 - CompletionAdvice
Operação responsável pela captura posterior de uma transação.

 
Suggest Edits

Fluxo Operacional

 

O fluxo para realizar transações na Stone é composto pelos processos transacionais que podem ser divididos nas etapas de Autorização e Captura.

Autorização

A autorização é o processo de troca de mensagens entre o estabelecimento e o adquirente para verificação do limite de saldo do portador para realização daquela transação.

Na autorização, ocorre o envio da transação para o banco para a análise de prevenção, análise do limite de crédito e da validação dos dados do cartão utilizado.

Quando a autorização é bem-sucedida, acontece a reserva do limite de crédito do portador do cartão junto ao banco emissor, mas nenhuma cobrança é feita.

Requisição de Autorização

A mensagem de AcceptorAuthorisationRequest é enviada pelo estabelecimento para o adquirente, para checar junto ao banco que a conta associada ao cartão possui recursos para financiar o pagamento. Este controle inclui a validação dos dados do cartão e todos os dados adicionais previstos.

Subadquirentes

Transações feitas por sub-adquirentes possuem campos adicionais nas mensagens de autorização e clearing que permitam a identificação do sub-merchant pela bandeira.

São eles:

  • Cidade do submerchant
  • CEP do submerchant
  • Tipo de Identidade do submerchant
  • CNPJ/CPF do submerchant
  • Identificador do submerchant

Resposta de Autorização

A mensagem AcceptorAuthorisationResponse é enviada pelo adquirente, para retornar o resultado da validação realizada pelo emissor sobre a operação de pagamento.

ESTRUTURA DA MENSAGEM

Clique aqui para ver a descrição das tags e exemplos das mensagens de autorização

Prazo da Captura

Caso a autorização não seja capturada no prazo máximo de 7 dias, ela é automaticamente cancelada pela Stone.

Captura

A captura de uma transação é o reconhecimento da autorização da transação pelo sistema de captura do lojista (E-commerce, POS, Pindpad). Feito isso, a mensagem de captura é enviada para a adquirente (Stone) que, por sua vez, liquida o saldo do cliente.

A captura representa a cobrança de fato do valor já reservado junto ao banco emissor. Nesse momento sua transação passará para o status pago e você possui a garantia de que receberá o valor daquela transação. Por padrão a autorização e a captura são feitas de forma automática, assim logo após criar uma transação você já recebe a resposta da captura, com a transação paga ou recusada.

Há dois tipos de captura:

Captura Automática

É a captura que é configurada para ocorrer automaticamente pelo sistema do cliente assim que a resposta de autorização é recebida.

Captura Posterior

Ocorre quando a mensagem de captura não é configurada pelo sistema do cliente para ser enviada imediatamente após o recebimento da resposta de autorização. Também é conhecida como captura "manual".

Autorização com captura imediata (Automática)

No cenário mais comum, a autorização com captura já acontecem quase que simultaneamente e de forma automática.

Em uma situação de compra via uma plataforma digital, o cliente seleciona os seus produtos ao carrinho e, ao finalizar o pedido, faz o pagamento inserindo os dados para autenticação da compra.

Nesse momento, é realizada uma comunicação com a adquirente solicitando a autorização e a captura daquele valor. Dessa forma, logo após criar uma transação já se recebe uma resposta de captura com a transação paga ou recusada.

Esse é o processo utilizado na maioria dos e-commerce.

  1. O estabelecimento envia uma mensagem AcceptorAuthorisationRequest para o adquirente solicitando autorização, informando que deseja realizar a captura financeira atribuindo o valor da tag <TxCaptr> como true.

  2. AcceptorAuthorisationResponse é devolvido pelo adquirente, informando ao estabelecimento sobre o êxito do pedido, uma vez que o adquirente tenha autorizado a transação sem a necessidade de envio de captura.

Quando enviar?

Essa operação é utilizada quando o cliente realiza uma compra com o cartão.

ESTRUTURA DA MENSAGEM

Para que a captura seja realizada automaticamente, basta atribuir o valor true para a tag <TxCaptr>, na mensagem de autorização.

Clique aqui para ver a descrição das tags e exemplos das mensagens de autorização, onde você encontrará o item "Autorização com captura imediata (Automática)" com mais detalhes!

Autorização com captura posterior

Ocorre quando o estabelecimento decide autorizar a transação e capturá-la de forma manual posteriormente. Um exemplo recorrente de captura posterior ocorre no caso de reservas em hotéis, em que o cliente acessa o site, escolhe o hotel, quarto, total de diárias e faz a reserva. O site do hotel, ao receber a solicitação de reserva, solicita à Stone que autorize o valor da reserva, mas não faz a captura até que o cliente faça o check-in no hotel.

Uma mensagem específica para a captura deve ser enviada no momento oportuno!

  1. O estabelecimento envia uma AcceptorAuthorisationRequest ao adquirente solicitando a autorização da transação. informando que deseja realizar a captura posteriormente, atribuindo o valor da tag <TxCaptr> como false.

  2. Uma AcceptorAuthorisationResponse é devolvida pelo adquirente, informando ao estabelecimento sobre o êxito da autorização.

  3. Se a transação tiver sido concluída com êxito no lado do estabelecimento, o estabelecimento envia uma AcceptorCompletionAdvice para capturar a transação.

  4. O adquirente retorna uma AcceptorCompletionAdviceResponse, reconhecendo o resultado e captura financeira da transação.

Quando enviar?

A captura posterior deve ser efetuada quando o cliente realiza uma compra com o cartão (mesmo caso da autorização), porém o lojista deseja que a captura não ocorra automaticamente, e prefere efetuar a captura manualmente em alguma data futura (como é o caso de reservas em hotéis, explicitado acima).

PRAZO PARA A CAPTURA POSTERIOR

O prazo para realizar a captura posterior é de até 5 DIAS após o recebimento da mensagem de autorização

RECAP

As transações são divididas de forma com que você possa optar em realizar a captura de forma automática ou posterior .

Na autorização com captura automática, o valor da transação é confirmado de maneira instantânea no momento da requisição de autorização, sem a necessidade de enviar a requisição de captura. Essa é a modalidade mais utilizada.

Já na autorização com captura posterior, a transação é autorizada junto ao emissor do cartão (neste momento o valor ainda não é cobrado na fatura do portador) e posteriormente é necessário realizar a captura total ou parcial desta transação.

Cancelamento e Estorno

O desfazimento normalmente é feito a pedido do portador do cartão, na loja em que a compra foi realizada.
A solicitação poderá ser realizada a qualquer momento, mesmo que em dia diferente ao que ocorreu a transação.

O período permitido para a realização de um desfazimento depende do EMISSOR.

O prazo para que o desfazimento seja realizado é de 180 dias após a data na qual a transação foi realizada.

O cancelamento pode pode ser realizado apenas no estabelecimento onde foi realizada a transação original, pois o SAK será utilizado para localizar a transação na Stone.

O cancelamento só pode ser efetuado caso o cliente possua saldo positivo no valor igual ou maior ao valor da venda a ser cancelada/estornada.

Como o cancelamento e o estorno são dois tipos similares de desfazimento de transações, vamos utilizar o termo "Cancelamento" para nos referir à ambos os desfazimentos neste documento. Entretanto, é importante destacar a diferença entre o cancelamento do estorno:

Estorno

É o pedido de desfazimento de uma transação que ocorre quando o valor da transação já foi liquidado pela Stone para o lojista. Nesse caso o valor é recebido pelo portador do cartão na próxima fatura.

  • Estornos : Vendas desfeitas após a liquidação;

  • Estorno Parcial : Vendas parcialmente desfeitas após a liquidação;

Cancelamento

É o pedido de desfazimento de uma transação que ocorre quando o valor da transação ainda não foi liquidado pela Stone para o lojista. Nesse caso o valor é recebido pelo portador do cartão em até 5 dias.

  • Cancelamento : Vendas desfeitas antes da liquidação;

  • Cancelamento Parcial : Vendas parcialmente desfeitas antes da liquidação;

Tipos de transações que podem ser canceladas:

• Crédito (online e off-line)
o À vista, parcelado com juros e parcelado sem juros.
• Débito
• Voucher

Dados da transação original que podem ser pedidos para serem digitados na solução de captura:

• Stone ID;
• Data da transação;
• Valor a ser cancelado;

QUANDO ENVIAR UM CANCELAMENTO?

Quando um cliente desiste de uma reserva (no caso de hoteís e serviços correlatos) ou desiste de um produto comprado (e-commerces em geral) o cliente pode entrar em contato direto com o lojista e solicitar o cancelamento/estorno da reserva/compra ou pode falar diretamente com o banco emissor de seu cartão e solicitar um chargeback (ou contestação) por diversos motivos.

Não há relação entre o modo de entrada da transação original e do cancelamento. Por exemplo: se a transação for realizada com chip, o desfazimento pode ser feito tanto com chip, como com tarja magnética ou digitado.

REQUISIÇÃO DE CANCELAMENTO

A mensagem AcceptorCancellationRequest é utilizada para realizar um pedido de cancelamento de uma transação autorizada

RESPOSTA DE CANCELAMENTO

A mensagem AcceptorCancellationResponse é respondida pelo adquirente com as informações sobre a requisição de cancelamento AcceptorCancellationRequest.

RECIBO DE CANCELAMENTO

Os dados do recibo de cancelamento são enviados somente nesta mensagem.

  1. O estabelecimento envia uma AcceptorAuthorisationRequest para o adquirente para realizar um pedido de autorização;

  2. Uma AcceptorAuthorisationResponse é enviada pelo adquirente confirmando e aprovando o pedido de autorização;

  3. Uma AcceptorCompletionAdvice é utilizada para informar ao adquirente sobre a captura da transação;

  4. O adquirente envia uma AcceptorCompletionAdviceResponse reconhecendo o pedido de cancelamento por parte do estabelecimento;

Nesta transação o estabelecimento não necessita de nenhum pedido de cancelamento prévio pois supomos que ele já possui as informações de que o cancelamento pode realmente ser realizado.

Clique aqui para ver a descrição das tags e exemplos das mensagens de cancelamento

Consulta de Transações

A consulta de transação é uma mensagem enviada pelo sistema do cliente (lojista) para a adquirente com informações de uma transação para que ela envie ao cliente os dados acerca da transação em questão de a garantir acesso à informações mais detalhadas sobre a sua transação.

QUANDO ENVIAR

  • Quando deseja-se confirmar se o valor correto de uma transação foi capturado e/ou autorizado

  • Quando deseja-se confirmar se uma transação foi cancelada ou não

  • Quando deseja-se confirmar algum tipo de erro nas requisições anteriores: Autorização, Captura ou Cancelamento

REQUISIÇÃO DE CONSULTA DE TRANSAÇÃO

A mensagem AcceptorTransactionStatusReportRequest é utilizada para realizar um pedido de consulta de uma transação

RESPOSTA DE CONSULTA DE TRANSAÇÃO

A mensagem AcceptorTransactionStatusReportResponse é respondida pelo adquirente com as informações sobre a requisição de consulta AcceptorTransactionStatusReportRequest.

ESTRUTURA DA MENSAGEM

Clique aqui para ver a descrição das tags e exemplos das mensagens de consulta de transação

Liquidação

É o processo de pagamento ao cliente.
De acordo com as suas vendas, o cliente gera um saldo, ou uma agenda de recebíveis. A adquirente é responsável por efetivar o pagamento deste saldo para o lojista. Esse momento do pagamento é chamado de liquidação.

Ex: "Liquidar o saldo acumulado do cliente" significa "Depositar na conta do cliente o saldo acumulado dele"

EXEMPLOS

Nos exemplos abaixo o MDR e os juros serão desconsiderados para facilitar o entendimento.

Para esclarecer a liquidação vejamos dois exemplos:

  1. Cliente com saldo positivo :

Caso o cliente (lojista) possua saldo maior ou igual a R$0,00 e realize uma transação de R$30,00 ele receberá na data devida de liquidação, caso continue com o saldo de R$0,00 ou maior quando a liquidação ocorrer, o valor de R$30,00.

  1. Cliente com saldo negativo mesmo após realizar transações :

Vamos supor um cenário no qual um cliente (lojista) possui negociado um aluguel de R$120,00 da maquininha Stone e naquele mês transacionou apenas R$50,00. Nesse caso, quando a cobrança referente ao POS for realizada nos recebíveis do cliente, não haverá saldo suficiente, de modo que o mesmo ficará com um saldo negativo de R$70,00.

Porque seu saldo se tornará :

SALDO = SALDO ANTERIOR + VALOR DA TRANSAÇÃO = R$ - 120,00 + 50,00 = R$ -70,00.

Então, como apenas liquidamos saldo, não iremos retirar esse R$ -70,00 da conta do cliente. Esse valor é "cobrado" quando a liquidação ocorre, e é deduzido do valor positivo que entra na conta do cliente conforme ocorreu nesse exemplo.

Liquidação de transações tipo Débito

Em geral, a liquidação para transações de débito ocorre em D+1, ou seja, um dia depois da captura da transação.

Transações de Débito não são válidas para o ambiente eletrônico (eCommerce).

Liquidação de transações tipo Crédito

Crédito à vista: Em geral a liquidação de transações de crédito à vista ocorre em D+30, ou seja, trinta dias depois da captura da transação (dias úteis).

Crédito parcelado: Em uma transação parcelada, por exemplo, em 2 parcelas, a primeira liquidação acontece geralmente em D+30 e a segunda em D+60, ambas a partir da data da captura.

EXEMPLO

O cliente realiza uma transação de crédito no valor de R$ 300,00 em 3 vezes. Assumindo que o cliente possui saldo positivo com a adquirente (Stone) em todo o período até receber a última parcela, o cliente recebe o valor associado à primeira parcela 30 dias depois da captura da transação, recebe a segunda parcela 60 (2 x 30) dias depois da captura da transação e recebe a última parcela 90 (3 x 30 ) depois da captura da transação.

Chargeback

O conceito de chargeback (ou contestação) é bem simples. Quando o portador do cartão entra em contato com o banco (emissor) e solicita o cancelamento da transação.

O chargeback pode acontecer por algum dos diversos motivos:

  • Fraude : O portador do cartão (cliente consumidor final) entra em contato com o banco informando que não reconhece a compra apesar de ter recebido a mercadoria corretamente e não ter sido cobrado de maneira indevida.

  • Desacordo comercial : O portador alega haver algum desacordo comercial em relação à sua compra. Por exemplo em um caso onde tenha recebido um produto diferente do que aquele que solicitou.

  • Erros no processamento : Quando ocorre algum tipo de falha técnica que impede a captura correta da transação, nesses caso o banco pode solicitar chargeback.

Reapresentação

A reapresentação é a contestação de um chargeback.

Infelizmente, o consumidor pode solicitar um chargeback de má fé. Por exemplo, ele faz a compra e, mesmo ao receber a mercadoria corretamente, ele entra em contato com o banco emissor e solicita o chargeback.

Nesses casos, a reapresentação pode ser realizada com a ajuda da Stone. Para isso você deve enviar documentos que comprovem a efetividade da compra como:

  • Cópia legível do comprovante de venda.

  • Documentação de suporte de venda.

  • Alguma documentação comprobatória como: nota fiscal, algumas informações que o consumidor recebeu as mercadorias/serviços na data combinada,de maneira correta e sem defeitos.

  • Qualquer outra documentação que comprove que a venda é legítima.

Entre em contato com o relacionamento com o cliente Stone no telefone 3004-9680 ou no email meajuda@stone.com.br para receber um atendimento pessoal e cheio de disposição da nossa equipe e enviá-los os documentos necessários.

 
Suggest Edits

Credenciais de Acesso

 

Em ambos os casos será necessário ter em mãos credenciais de acesso para enviar requisições para nossos endpoints.

As chaves vinculadas ao produto Stone Online são:

SAK (SaleAffiliationKey)
StoneCode

A obtenção das credenciais para cada ambiente é descrita logo abaixo.

Homologação

Para obter sua chave de homologação em nosso ambiente de teste (sandbox), solicite suas credenciais de acesso ao nosso time de integrações pelo e-mail:

integracoes@stone.com.br

Lembrando que o StoneCode também deve ser de conhecimento do desenvolvedor/estabelecimento.

Produção

Uma vez que a etapa de homologação for concluída você precisará de uma credencial de PRODUÇÃO que será encaminhada após o seu cadastro com a Stone.
Para solicitar, encaminhe um e-mail para:

meajuda@stone.com.br

 
Suggest Edits

Comunicação

 

O protocolo de comunicação utilizado para se conectar a Stone é o HTTPS. O HTTPS verb a ser utilizado deve ser POST.
Para o ambiente de transações (Autorização/Cancelamento/Diagnóstico), as mensagens são baseadas na versão 2.0 do protocolo EPAS/ISO 20022 CAPE (Card Payment Exchanges).

O protocolo de comunicação para requisições HTTP ao Host da Stone, será o TLS v1.2, de acordo com o PCI DSS 3.1.

 
Suggest Edits

Ambientes

 

Para que você possa conhecer melhor nossa solução, antes de fazer transações reais, dividimos o processo de integração em duas partes:

Homologação

É a etapa em que o cliente utilizará nossa API ligada a um simulador para realizar transações de TESTE para se adequar e familiarizar com a nossa lógica de funcionamento.

Nessa fase ainda não é necessário ser cliente cadastrado para enviar requisições.

Todas as mensagens serão enviadas através do protocolo HTTP, utilizando o método POST para o seguinte endpoint:

Endpoint para Homologação

https://sandbox-auth-integration.stone.com.br

Códigos de Retorno no Ambiente de Integração

Nosso Sandbox foi preparado para lhe ajudar a validar as principais respostas das bandeiras. As transações recebem respostas correspondentes ao valor dos centavos instanciados.

Exemplo: Transações de R$1,00 tem código de resposta 0000. Transações de R$1,01 tem código de resposta 1007.

Todos os possíveis códigos de retorno deste ambiente e seus significados encontram-se na seção Códigos de Retorno do Sandbox.

Produção

É a etapa seguinte à homologação. O cliente precisará ser cadastrado e poderá efetuar transações REAIS, utilizando nosso serviço de adquirência online.

Todas as mensagens serão enviadas através do protocolo HTTP utilizando o método POST para o seguinte endpoint:

Endpoint para Produção

https://e-commerce.stone.com.br

 
Suggest Edits

Preparando sua Aplicação

 

Para iniciar a integração são necessárias duas chaves para dar acesso ao ambiente de testes do Stone Online. São elas:

  • SAK (SaleAffiliationKey)

Ambas devem ser solicitadas no canal:

integracoes@stone.com.br

Com Sale Affiliation Key (SAK) em mãos, você já pode testar a comunicação no nosso endpoint de homologação.

Endpoint de Homologação

https://sandbox-auth-integration.stone.com.br/

Temos as seguintes operações disponíveis para o Stone Online:

Funcionalidade Path
Autorização AUTHORIZE
Captura posterior COMPLETIONADVICE
Cancelamento CANCELLATION
Consulta de Transações TRANSACTIONSTATUSREPORT

A requisições xml que devem ser populadas e enviadas para esse ambiente devem respeitar os layouts de operação e regras listados abaixo.

 
Suggest Edits

Tipos e tamanhos

 

Este documento menciona diversos dados em comandos e tabelas, sendo que estes dados, por suas características, devem respeitar diferentes regras de codificação.

Para multiplicidades, utilizaremos a notação “[N1.N2]” onde os valores possíveis de N1 são: 0, 1 ou (muitos) e para N2 são: 1 e (muitos). Para o valor de N1 = 1, informa que o campo é obrigatório e quando o valor de N1 = 0, informa que o campo é opcional.

Os tipos de dados são:

Tipo Descrição
ans Alfanumérico e caracteres especiais
an Caracteres alfanuméricos
n Dígitos numéricos

O número após o tipo indica o tamanho do campo, seguindo o padrão:

Tamanho fixo
n 32 - campo numérico de 32 dígitos
an 6 - campo alfanumérico de 6 dígitos

Tamanho variável
ans ...22 - campo alfanumérico e caracteres especiaisde de até 22 dígitos
n ...3 - campo numérico de até 3 dígitos

 
Suggest Edits

Authorize

Neste item exemplificamos o modelo esperado pela nossa API para as requisições de autorização e o mapeamento das tags para a mensagem de resposta para a mesma operação (autorização). Deve-se adicionar o endpoint /Authorize ao endereço de conexão.

 
posthttps://sandbox-auth-integration.stone.com.br/Authorize

SUBADQUIRENTES

Para enviar os dados adicionais obrigatórios vamos usar a TAG SponsoredMerchant, disponível na ISO 20022, com algumas adições para suportar todos os dados necessários.

O conteúdo será inserido na hierarquia <AuthstnReq> → <Cntxt> → <SaleContext> → <SpnsrdMrchnt>

<Cntxt>
	<SaleCntxt>
		<SpnsrdMrchnt>
			<City>{Cidade do Submerchant}</City>
			<PstlAdr>{CEP do Submerchant}</PstlAdr>
			<TaxIdTp>{Tipo de Entidade do Submerchant}</TaxIdTp>
			<TaxIdNb>{CPF/CNPJ Submerchant}</TaxIdNb>
			<RegdIdr>{Identificador do Submerchant}</RegdIdr>
		</SpnsrdMrchnt>
	</SaleCntxt>
</Cntxt>

Observações

O campo Nome do Facilitador é recuperado do cadastro do subadquirente. O campo Nome do Submerchant já é enviado no campo <AuthstnReq> → <Envt> → <Mrchnt> → <Id> → <ShrtNm>
*O campo MCC Submerchant já é enviado no campo <AuthstnReq> → <Tx> → <MrchntCtgyCd>

Configuração dos Campos

Campo
Ocorrência
Tipo
Tamanho
Descrição

City

[1..1]

Text

ans ...35

Cidade do sub-merchant

PstlAdr

[1..1]

Text

n ...16

CEP do sub-merchant

RegdIdr

[0..1]

Text

an ...35

Identificador do sub-merchant

SaleCntxt

[0..1]

Container

-

Container de dados da venda

SpnsrdMrchnt

[0..1]

Container

-

Container de dados do sub-merchant

TaxIdNb

[0..1]

Text

n ...35

CNPJ do sub-merchant (Apenas números)

TaxIdTp

[0..1]

Code Set

an 4

Legal Personality -

JRDC (Pessoa Juridica)

PRSN (Pessoa Fisica)

JRDC (Pessoa Juridica)

PRSN (Pessoa Fisica)

TaxIdNb [0..1] Text n ...35 CNPJ do sub-merchant (Apenas números)
RegdIdr [0..1] Text an ...35 identificador do sub-merchant

MENSAGEM DE REQUISIÇÃO

Abaixo estão descritas as tags para a mensagem de requisição de autorização:

Campo
Ocorrência
Tipo
Tamanho
Descrição

Header<Hdr>

[1..1]

Container

-

Cabeçalho da mensagem.

MessageFunction<MsgFctn>

[1..1]

CodeSet

an 4

Identifica o tipo de processo em que a mensagem se propõe. AUTQ= AuthorisationRequest.

ProtocolVersion<PrtcolVrsn>

[1..1]

Text

ans ...6

Versão do protocolo utilizado na mensagem.

AuthorisationRequest<AuthstnReq>

[1..1]

Container

-

Dados da requisição de autorização.

Environment<Envt>

[1..1]

Container

-

Ambiente da transação.

Merchant <Mrchnt>

[1..1]

Container

-

Dados do estabelecimento.

Identification<ID>

[1..1]

Container

-

Identificação do estabelecimento comercial.

Identification<ID>

[1..1]

Text

an 32

Identificação do estabelecimento comercial no adquirente. Também conhecido internamente como “SaleAffiliationKey”.

ShortName<ShrtNm>

[0..1]

Text

an ...25

O nome que aparecerá na fatura. Se a transação for mastercard, o limite é 22 caracteres; Se a transação for visa, o limite é 25 caracteres; Se for parcelado, a visa usa os 8 primeiros caracteres do nome do lojista pra passar a informação de parcelamento, sobrando 17 caracteres.

Poi<POI>

[1..1]

Container

-

Dados do ponto de interação

Identification<ID>

[1..1]

Container

-

Identificação do ponto de interação

Identification<ID>

[1..1]

Text

ans 8

Código de identificação do ponto de interação atribuído pelo estabelecimento.

Card<Card>

[1..1]

Container

-

Dados do cartão utilizado na transação.

PlainCardData<PlainCardData>

[0..1]

Container

-

Dados não criptografados do cartão utilizado na transação.

PAN<PAN>

[1..1]

Text

n ...19

Número do cartão. (Primary Account Number)

ExpiryDate<XpryDt>

[1..1]

Text

ans 7

Data de validade do cartão no formato “yyyy-MM”.

CardSctyCd<CardSctyCd>

[1..1]

Container

-

Código de segurança do cartão

CSCVal<CSCVal>

[0..1]

Text

n ...4

CVV estampado no verso do cartão.

No caso de recorrência, CVV é obrigatório somente na primeira compra, nas demais não.

Context<Cntxt>

[1..1]

Container

-

Informações da transação a ser realizada.

PaymentContext<PmtCntxt>

[1..1]

Container

-

Informações sobre o pagamento.

CardDataEntryMode<CardDataNtryMd>

[1..1]

CodeSet

an 4

Modo da entrada dos dados do cartão: PHYS = Ecommerce ou Digitada.

TransactionChannel<TxChanl>

[1..1]

CodeSet

an 4

Tipo do canal de comunicação utilizado na transação ECOM = Ecommerce ou Digitada.

SalesContext <SaleCntxt>

[0..1]

-

Container

Dados da venda

SponsoredMerchant <SpnsrdMrchnt>

[1..1]

-

Container

Dados do sub-merchant

City <City>

[1..1]

ans …35

Text

Cidade do sub-merchant

PostalAddress <PstlAdr>

[1..1]

n …16

Text

CEP do sub-merchant

TaxIdentificationType <TaxIdTp>

[1..1]

an …4

Text

Legal Personality. “JRDC” = Pessoa Juridica “PRSN” = Pessoa Fisica

TaxIdentificationNumber <TaxIdNb>

[1..1]

n …35

Text

CNPJ do sub-merchant (apenas números)

RegisteredIdentifier <RegdIdr>

[1..1]

an …35

Text

Identificador do sub-merchant

Transaction<Tx>

[1..1]

Container

-

Informações da transação.

AdditionalService<AddtlSvc>

[0..1]

CodeSet

an 4

Informações da transação de recorrência.

Valor "FIXO" = RECP (Recurring Payment)

ServiceAttribute<SvcAttr>

[0..1]

CodeSet

an 4

Informações da transação de recorrência. Essa tag é obrigatória apenas para esse tipo de transação.

Valores:
FREC (First Recurring) para a PRIMEIRA TRANSAÇÃO

RREC (Following Recurring) para as TRANSAÇÕES POSTERIORES

InitiatorTransactionIdentification<InitrTxId>

[0..1]

Text

an ...32

Identificação da transação definida pelo sistema que se comunica com o Host Stone. Essa tag é obrigatória apenas para transação de recorrência.

Este campo é conhecido internamente na Stone como ITK

MerchantCategoryCode <MrchntCtgyCd>

[0..1]

Text

n 4

Valor do MCC dinâmico, para clientes que precisam sinalizar esta informação na autorização. Deve haver a possibilidade de configuração desta informação para envio no client e-commerce.

TransactionCapture<TxCaptr>

[1..1]

Boolean

an 4

Indica se os dados da transação devem ser capturados - true - ou não false - imediatamente.

TransactionIdentification<TxId>

[1..1]

Container

-

Dados de identificação da transação atribuída pelo POI (Ponto de interação).

TransactionDateTime<TxDtTm>

[1..1]

DateTime

ans 19

Data local e hora da transação atribuídas pelo POI (ponto de interação), no formato:
yyyy-mm-ddTHH:mm:SS

TransactionReference<TxRef>

[1..1]

Text

an ...32

Valor que pode ser atribuído pelo cliente para identificar a transação.
Este valor não é armazenado pela Stone ou demonstrado em nenhum relatório.
O formato é livre.

TransactionDetails<TxDtls>

[1..1]

Container

-

Detalhes da transação.

Currency<Ccy>

[1..1]

CodeSet

n 3

Moeda utilizada na transação em conformidade com a ISO 4217 - 986 = Real Brasileiro.

TotalAmount<TtlAmt>

[1..1]

Amount

n ...23

Valor total da transação em centavos.

AccountType<AcctTp>

[0..1]

Text

an 4

Modalidade do cartão utilizado na transação.
Fixo: CRDT = Crédito.

RecurringTransaction<RcrngTx>

[0..1]

Container

-

Os dados relativos à(s) parcela(s) ou a uma transação recorrente.

InstalmentType<InstlmtTp>

[1..1]

Text

an 4

Tipo de parcelamento.
NONE = A vista
MCHT = Lojista (sem juros)
ISSR = Emissor (com Juros)

TotalNumberOfPayments <TtlNbOfPmts>

[1..1]

Number

n ...2

Número do total de parcelas.
Para transação a vista deve ser enviado o valor “0".

MENSAGEM DE RESPOSTA

Abaixo estão descritas as tags para a mensagem de resposta de autorização:

Campo
Ocorrência
Tipo
Tamanho
Descrição

Header<Hdr>

[1..1]

Container

Cabeçalho da mensagem

MessageFunction<MsgFctn>

[1..1]

CodeSet

n 4

Identifica o tipo de processo em que a mensagem se propõe. Fixo: AUTP = AuthorisationResponse.

ProtocolVersion<PrtcolVrsn>

[1..1]

Text

ans ...6

Versão do protocolo utilizado na mensagem.

CreationDateTime<CreDtTm>

[1..1]

Text

ans 19

Data de criação da mensagem no formato:
yyyy-mm-ddTHH:mm:SS

AuthorisationResponse<AuthstnRspn>

[1..1]

Container

Informações relacionadas à resposta da autorização.

Environment<Envt>

[1..1]

Container

Ambiente da transação.

Merchant Identification<MrchntId>

[1..1]

Container

Dados do estabelecimento.

Identification<Id>

[1..1]

Text

an 32

Identificação do estabelecimento comercial no adquirente. Também conhecido internamente como “SaleAffiliationKey”.

POIId<POIId>

[0..1]

Container

Dados do ponto de interação.

Identification<Id>

[1..1]

Text

an 32

Identificação do POI.

Transaction<Tx>

[1..1]

Container

Informações da transação.

TransactionIdentification<TxId>

[1..1]

Container

Dados de identificação da transação atribuída pelo POI (Ponto de interação).

TransactionDateTime<TxDtTm>

[1..1]

DateTime

ans 19

Data local e hora da transação atribuído pelo POI (ponto de interação). Este campo será ecoado pelo adquirente.

TransactionReference<TxRef>

[1..1]

Text

an …32

Identificação da transação atribuída pelo POI (Ponto de interação). Este campo será ecoado pelo adquirente.

RecipientTransactionIdentification<RcptTxId>

[1..1]

Text

an ...35

Identificação da transação definida pela Stone.

Este campo é conhecido internamente na Stone como ATK

TransactionDetails<TxDtls>

[1..1]

Container

Detalhes da transação.

Currency<Ccy>

[1..1]

CodeSet

n 3

Moeda utilizada na transação em conformidade com a ISO 4217 - 986 = Real Brasileiro.

TotalAmount<TtlAmt>

[1..1]

Amount

n ...23

Valor total autorizado em centavos.

AccountType<AcctTp>

[0..1]

CodeSet

an 4

Modalidade do cartão utilizado na transação. CRDT = Crédito.

TransactionResponse<TxRspn>

[1..1]

Container

Dados de resposta da transação.

AuthorisationResult<AuthstnRslt>

[1..1]

Container

Resultado da autorização.

ResponseToAuthorisation<RspnToAuthstn>

[1..1]

Container

Dados da resposta da autorização.

Response<Rspn>

[1..1]

CodeSet

an 4

Resposta da transação: DECL: Declined, APPR: Aproved, PART: PartialApproved e TECH: TechinicalError.

ResponseReason<RspnRsn>

[1..1]

Text

n 4

Código de resposta da autorização (equivalente ao campo 39 da ISO 8583 de 2003).

AuthorisationCode<AuthstnCd>

[0..1]

Text

n 6

Código de autorização retornado pelo emissor.

CompletionRequired<CmpltnReqrd>

[0..1]

Boolean

an 4

Indica se a mensagem precisa ser capturada posteriormente.

Action<Actn>

[0..*]

Container

Mensagem a ser demonstrada no display

ActionType<ActnTp>

[1..1]

CodeSet

n 4

Fixo: DISP

MessageToPresent<MsgToPres>

[1..1]

Container

Mensagem a ser demonstrada no display

MessageDestination<MsgDstn>

[1..1]

CodeSet

n 4

A quem se destina a mensagem no contexto:

“MDSP” = Mensagem para ser apresentada no display

“CDSP“ – Mensagem para ser exibida no display do cliente

MessageContent <MsgCntt>

[1..1]

Text

ans 20000

Texto para ser exibido em display

RECORRÊNCIA

Ao encaminhar uma transação recorrente, deve-se adicionar as seguintes TAGs nas informações da transação (<tx>):

  • <AddtlSvc> - AdditionalService
  • <SvcAttr> - ServiceAttribute
<!-- Para primeira transação da recorrência: -->
<tx>
...
<AddtlSvc>RECP</AddtlSvc>
<SvcAttr>FREC</SvcAttr>
...
</tx>


<!-- Para as transações posteriores da recorrência: -->
<tx>
...
<AddtlSvc>RECP</AddtlSvc>
<SvcAttr>RREC</SvcAttr>
...
</tx>

CVV

No caso de recorrência, o CVV é obrigatório somente na primeira transação da recorrência, nas demais não!

Autorização com captura imediata (Automática)

A tag TxCaptr deve ser enviada com valor TRUE

<!-- Para Autorização com Captura AUTOMÁTICA -->
<TxCaptr>true</TxCaptr>

<!-- Para Autorização com Captura POSTERIOR -->
<TxCaptr>false</TxCaptr>

Autorização com captura AUTOMÁTICA x Autorização com captura POSTERIOR

A diferença entre a mensagem de autorização para captura automática e captura posterior, está no valor do elemento TxCaptr.

Para ver como realizar a captura posterior, clique aqui.

<Document xmlns="urn:AcceptorAuthorisationRequestV02.1">
    <AccptrAuthstnReq>
        <Hdr>
            <MsgFctn>AUTQ</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
        </Hdr>
        <AuthstnReq>
            <Envt>
                <Mrchnt>
                    <Id>
                        <Id>EF1CC1A4FECE40EB8B29CA7328955C77</Id>
                        <ShrtNm>Nome da fatura</ShrtNm>
                    </Id>
                </Mrchnt>               
                <POI>
                    <Id>
                        <Id>2FB4C89A</Id>
                    </Id>
                </POI>
              <Card>
                    <PlainCardData>
                        <PAN>4066559930861909</PAN>
                        <XpryDt>2017-10</XpryDt>
                        <CardSctyCd>
                            <CSCVal>123</CSCVal>
                        </CardSctyCd>
                    </PlainCardData>
                </Card>
            </Envt>
            <Cntxt>
                <PmtCntxt>
                    <CardDataNtryMd>PHYS</CardDataNtryMd>
                    <TxChanl>ECOM</TxChanl>
                </PmtCntxt>
            </Cntxt>
          <Cntxt>
           <SaleCntxt>
              <SpnsrdMrchnt>
                <City>São Paulo</City>
                <PstlAdr>12375098</PstlAdr>
                <TaxIdTp>JRCD</TaxIdTp>
                <TaxIdNb>123456789000012</TaxIdNb>
                <RegdIdr>Submerchant</RegdIdr>
              </SpnsrdMrchnt>
           </SaleCntxt>
          </Cntxt>
            <Tx>
                <AddtlSvc>RECP</AddtlSvc>
                <SvcAttr>FREC</SvcAttr>
                <InitrTxId>123123123</InitrTxId>
                <TxCaptr>false</TxCaptr>
                <TxId>
                    <TxDtTm>2014-03-12T15:11:06</TxDtTm>
                    <TxRef>06064f516a50483da7f189243c95ccca</TxRef>
                </TxId>
                <TxDtls>
                    <Ccy>986</Ccy>
                    <TtlAmt>100</TtlAmt>
                    <AcctTp>CRDT</AcctTp>
                    <RcrngTx>
                        <InstlmtTp>NONE</InstlmtTp>
                        <TtlNbOfPmts>0</TtlNbOfPmts>
                    </RcrngTx>
                </TxDtls>
            </Tx>
        </AuthstnReq>
    </AccptrAuthstnReq>
</Document>
A binary file was returned

You couldn't be authenticated

<Document xmlns="urn:AcceptorAuthorisationResponseV02.1">
    <AccptrAuthstnRspn>
        <Hdr>
            <MsgFctn>AUTP</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
            <CreDtTm>2014-03-12T18:10:58</CreDtTm>
        </Hdr>
        <AuthstnRspn>
            <Envt>
                <MrchntId>
                    <Id>EF1CC1A4FECE40EB8B29CA7328955C77</Id>
                  <ShrtNm>Nome da fatura</ShrtNm>
                </MrchntId>
            </Envt>
            <Tx>
                <TxId>
                    <TxDtTm>2014-03-12T15:11:06</TxDtTm>
                    <TxRef>06064f516a50483da7f189243c95ccca</TxRef>
                </TxId>
                <RcptTxId>00000034071000000215353</RcptTxId>
                <TxDtls>
                    <Ccy>986</Ccy>
                    <TtlAmt>100</TtlAmt>
                    <AcctTp>CRDT</AcctTp>
                </TxDtls>
            </Tx>
            <TxRspn>
                <AuthstnRslt>
                    <RspnToAuthstn>
                        <Rspn>APPR</Rspn>
                        <RspnRsn>0000</RspnRsn>
                    </RspnToAuthstn>
                    <AuthstnCd>007091</AuthstnCd>
                    <CmpltnReqrd>true</CmpltnReqrd>
                </AuthstnRslt>
                <Actn>
                    <ActnTp>DISP</ActnTp>
                    <MsgToPres>
                        <MsgDstn>MDSP</MsgDstn>
                        <MsgCntt>Aprovado</MsgCntt>
                    </MsgToPres>
                </Actn>
            </TxRspn>
        </AuthstnRspn>
    </AccptrAuthstnRspn>
</Document>
 
Suggest Edits

CompletionAdvice

Neste item exemplificamos o modelo esperado pela nossa API para as requisições de captura posterior s e o mapeamento das tags para a mensagem de resposta para a mesma operação (captura posterior). Deve-se adicionar o endpoint /CompletionAdvice ao endereço de conexão.

 
post/CompletionAdvice

MENSAGEM DE REQUISIÇÃO

Abaixo estão descritas as tags para a mensagem de requisição de captura posterior:

Campo
Ocorrência
Tipo
Tamanho
Descrição

Header<Hdr>

[1..1]

Container

Cabeçalho da mensagem.

MessageFunction<MsgFctn>

[1..1]

CodeSet

n 4

Identifica o tipo de processo em que a mensagem se propõe. CMPV = Completion Advice ou RVRA = ReversalAdvice.

ProtocolVersion<PrtcolVrsn>

[1..1]

Text

ans ...6

Versão do protocolo utilizado na mensagem.

CompletionAdvice<CmpltnAdvc>

[1..1]

Container

Informações relacionadas ao processo de captura ou desfazimento de uma autorização.

Environment<Envt>

[1..1]

Container

Ambiente da transação.

Merchant<Mrchnt>

[1..1]

Container

Dados do estabelecimento.

Identification<Id>

[1..1]

Text

an 32

Identificação do estabelecimento comercial no adquirente. Também conhecido internamente como SAK.

TransactionIdentification<TxId>

[1..1]

Container

Dados de identificação da transação atribuída pelo POI.

TransactionDateTime<TxDtTm>

[1..1]

DateTime

ans 19

Data local e hora da transação atribuído pelo POI, no formato:
yyyy-mm-ddTHH:mm:SS. Este campo será ecoado pelo adquirente.

TransactionReference<TxRef>

[1..1]

Text

an ...32

Identificação da transação atribuída pelo POI. Este campo será ecoado pelo adquirente.

OriginalTransaction<OrgnlTx>

[1..1]

Container

Identificação da transação original

RecipientTransactionIdentification<RcptTxId>

[1..1]

Text

an ...35

Identificação da transação definida pelo adquirente.

TransactionDetails<TxDtls>

[1..1]

Container

Detalhes da transação.

Currency<Ccy>

[1..1]

CodeSet

n 3

Moeda utilizada na transação em conformidade com a ISO 4217.

TotalAmount<TtlAmt>

[1..1]

Amount

n ...23

Valor total da transação em centavos.

MENSAGEM DE RESPOSTA

Abaixo estão descritas as tags para a mensagem de resposta de captura posterior:

Campo
Ocorrência
Tipo
Tamanho
Descrição

Header<Hdr>

[1..1]

Container

Cabeçalho da mensagem.

MessageFunction<MsgFctn>

[1..1]

CodeSet

n 4

Identifica o tipo de processo em que a mensagem se propõe. “CMPK” = CompletionAdviceResponse ou “RVRR” = ReversalAdviceResponse.

CreationDateTime<CreDtTm>

[0..1]

Text

ans 19

Data de criação da mensagem

ProtocolVersion<PrtcolVrsn>

[1..1]

Text

ans ...6

Versão do protocolo utilizado na mensagem.

CompletionAdviceResponse<CmpltnAdvcRspn>

[1..1]

Container

Informações sobre a resposta da captura ou desfazimento de uma autorização.

Environment<Envt>

[1..1]

Container

Ambiente da transação.

Merchant Identification<MrchntId>

[1..1]

Container

Dados do estabelecimento.

Identification<Id>

[1..1]

Text

an 32

Identificação do estabelecimento comercial no adquirente. Também conhecido como SAK.

POIId<POIId>

[0..1]

Container

Dados do ponto de interação.

Transaction<Tx>

[1..1]

Container

Dados da transação.

TransactionIdentification<TxId>

[1..1]

Container

Dados da identificação da transação definida pelo POI.

TransactionDateTime<TxDtTm>

[1..1]

DateTime

ans 19

Data e hora da transação

TransactionReference<TxRef>

[1..1]

Text

an ...32

Identificação da transação definida pelo ponto de interação. Este campo será ecoado pelo adquirente.

Response<Rspn>

[1..1]

CodeSet

n 4

Resultado da transação. DECL = Declined, APPR = Approved, PART = Partial Approved, TECH = Technical Error.

<Document xmlns="urn:AcceptorCompletionAdviceV02.1">
    <AccptrCmpltnAdvc>
        <Hdr>
            <MsgFctn>CMPV</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
        </Hdr>
        <CmpltnAdvc>
            <Envt>
                <Mrchnt>
                    <Id>
                        <Id>EF1CC1A4FECE40EB8B29CA7328955C77</Id>
                    </Id>
                </Mrchnt>
            </Envt>
            <Tx>
                <TxId>
                    <TxDtTm>2014-06-11T17:15:44</TxDtTm>
                    <TxRef>1111</TxRef>
                </TxId>
                <OrgnlTx>
                    <RcptTxId>9CDF257AQKR</RcptTxId>
                </OrgnlTx>
                <TxDtls>
                    <Ccy>986</Ccy>
                    <TtlAmt>100</TtlAmt>
                </TxDtls>
            </Tx>
        </CmpltnAdvc>
    </AccptrCmpltnAdvc>
</Document>
A binary file was returned

You couldn't be authenticated

<Document xmlns="urn:AcceptorCompletionAdviceResponseV02.1">
    <AccptrCmpltnAdvcRspn>
        <Hdr>
            <MsgFctn>CMPK</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
        </Hdr>
        <CmpltnAdvcRspn>
            <Envt>
                <Mrchnt>
                    <Id>EF1CC1A4FECE40EB8B29CA7328955C77</Id>
                </Mrchnt>
            </Envt>
            <Tx>
                <TxId>
                    <TxDtTm>2014-03-12T15:17:59</TxDtTm>
                    <TxRef>7ca686eb242b4c0482c58961f5d3aac7</TxRef>
                </TxId>
                <Rspn>APPR</Rspn>
            </Tx>
        </CmpltnAdvcRspn>
    </AccptrCmpltnAdvcRspn>
</Document>
 
Suggest Edits

Cancellation

Neste item exemplificamos o modelo esperado pela nossa API para as requisições de cancelamentos e o mapeamento das tags para a mensagem de resposta para a mesma operação (cancelamento). Deve-se adicionar o endpoint /Cancellation ao endereço de conexão.

 
post/Cancellation

MENSAGEM DE REQUISIÇÃO

Abaixo estão descritas as tags para a mensagem de requisição de cancelamento:

Campo
Ocorrência
Tipo
Tamanho
Descrição

Header<Hdr>

[1..1]

Container

Cabeçalho da mensagem

MessageFunction<MsgFctn>

[1..1]

CodeSet

n 4

Identifica o tipo de processo em que a mensagem se propõe. Fixo: “CCAQ” = Cancellation Request.

ProtocolVersion<PrtcolVrsn>

[1..1]

Text

ans …6

Versão do protocolo utilizado na mensagem.

CancellationRequest<CxlReq>

[1..1]

Container

Informações relacionadas à requisição de cancelamento.

Environment<Envt>

[1..1]

Container

Ambiente da transação.

Merchant<Mrchnt>

[1..1]

Container

Dados do estabelecimento.

Identification<Id>

[1..1]

Container

Identificação do estabelecimento comercial.

Identification<Id>

[1..1]

Text

an 32

Identificação do estabelecimento comercial no adquirente. Também conhecido como SAK

LocationAndContact <LctnAndCtct>

[0..1]

Container

Dados de PSP

PostalAddress <PstlAdr>

[0..1]

Container

Dados de PSP

PostCode <PstCd>

[0..1]

Text

n.. 16

CEP do submerchant

TownName <TwnNm>

[0..1]

Text

ans ...35

Cidade do submerchant

CountrySubDivision <CtrySubDvsn>

[0..1]

Text

ans ...35

Estado do submerchant

Country<Ctry>

[0..1]

Text

an ...2

País do submerchant

Poi<POI>

[1..1]

Container

Dados do Ponto de Interação

Identification<Id>

[1..1]

Container

Identificação do ponto de interação

Identification<Id>

[1..1]

Text

ans 8

Código de identificação do ponto de interação atribuído pelo estabelecimento.

Capabilities

[0..1]

Container

Capacidades do Ponto de interação.

Transaction<Tx>

[1..1]

Container

Dados da transação.

TransactionCapture<TxCaptr>

[1..1]

Boolean

an 4

Fixo true para requisições de cancelamento.

TransactionIdentification<TxId>

[1..1]

Container

Identificação da transação atribuída pelo POI (Ponto de interação).

TransactionDateTime<TxDtTm>

[1..1]

DateTime

ans 19

Data e hora local da transação definidas pelo ponto de interação, no formato:
yyyy-mm-ddTHH:mm:SS

TransactionReference<TxRef>

[1..1]

Text

an …32

Identificação da transação definida pelo ponto de interação. O formato é livre.

TransactionDetails<TxDtls>

[1..1]

Container

Detalhes da transação

Currency<Ccy>

[1..1]

CodeSet

n 3

Moeda utilizada na transação em conformidade com a ISO 4217.

TotalAmount<TtlAmt>

[1..1]

Amount

n ...23

Valor total da transação em centavos

OriginalTransaction<OrgnlTx>

[1..1]

Container

Dados da transação original

InitiatorTransactionIdentification<InitrTxId>

[1..1]

Text

an ...32

Identificação da transação definida pelo sistema que se comunica com o Host Stone.

RecipientTransactionIdentification<RcptTxId>

[1..1]

Text

an ...35

Identificação da transação definida pelo adquirente. Deve ser o valor da transação original.

MENSAGEM DE RESPOSTA

Abaixo estão descritas as tags para a mensagem de resposta de cancelamento:

Campo
Ocorrência
Tipo
Tamanho
Descrição

Header<Hdr>

[1..1]

Container

Cabeçalho da mensagem

MessageFunction<MsgFctn>

[1..1]

CodeSet

n 4

Identifica o tipo de processo em que a mensagem se propõe. Fixo: “CCAP” = Cancellation Response.

ProtocolVersion<PrtcolVrsn>

[1..1]

Text

ans …6

Versão do protocolo utilizado na mensagem.

CreationDateTime<CreDtTm>

[0..1]

Text

ans 19

Data de criação da mensagem

CancellationResponse<CxlRspn>

[1..1]

Container

Informações relacionadas à resposta de cancelamento.

Environment<Envt>

[1..1]

Container

Ambiente da transação.

Merchant Identification<MrchntId>

[0..1]

Container

Dados do estabelecimento.

Identification<Id>

[1..1]

Text

an 32

Identificação do estabelecimento comercial no adquirente. Também conhecido internamente como SAK

POIId<POIId>

[0..1]

Container

Dados do ponto de interação

Identification<Id>

[1..1]

Text

ans 8

Código de identificação do ponto de interação atribuído pelo estabelecimento (Campo ecoado).

Transaction<Tx>

[1..1]

Container

Dados da transação.

TransactionCapture<TxCaptr>

[1..1]

Boolean

an 4

Indica se os dados da transação devem ser capturados true ou não false imediatamente.

TransactionIdentification<TxId>

[1..1]

Container

Identificação da transação atribuída pelo POI.

TransactionDateTime<TxDtTm>

[1..1]

DateTime

ans 19

Data e hora local da transação definidas pelo ponto de interação.

TransactionReference<TxRef>

[1..1]

Text

an ...32

Identificação da transação definida pelo ponto de interação. Este campo será ecoado pelo adquirente.

TransactionDetails<TxDtls>

[1..1]

Container

Detalhes da transação

Currency<Ccy>

[1..1]

CodeSet

n 3

Moeda utilizada na transação em conformidade com a ISO 4217.

TotalAmount<TtlAmt>

[1..1]

Amount

n ...23

Valor total da transação em centavos.

TransactionResponse<TxRspn>

[1..1]

Container

Dados de resposta da transação.

AuthorisationResult<AuthstnRslt>

[1..1]

Container

Informações sobre o resultado da autorização a ser cancelada.

ResponseToAuthorisation<RspnToAuthstn>

[1..1]

Container

Dados de resposta da autorização a ser cancelada.

Response<Rspn>

[1..1]

CodeSet

n 4

Resposta da transação. DECL: Declined; APPR: Aproved; PART: PartialApproved; TECH: TechinicalError;

ResponseReason<RspnRsn>

[0..1]

Text

n 4

Código de resposta da autorização.

CompletionRequired<CmpltnReqrd>

[0..1]

Boolean

n 4

Indica se a mensagem precisa ser capturada posteriormente.

<Document xmlns="urn:AcceptorCancellationRequestV02.1">
    <AccptrCxlReq>
        <Hdr>
            <MsgFctn>CCAQ</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
        </Hdr>
        <CxlReq>
            <Envt>
                <Mrchnt>
                    <Id>
                        <Id>EF1CC1A4FECE40EB8B29CA7328955C88</Id>
                    </Id>
                </Mrchnt>
                <LctnAndCtct>
                    <PstlAdr>
                        <PstCd>123456789</PstCd>
                        <TwnNm>São Paulo</TwnNm>
                        <CtrySubDvsn>SP</CtrySubDvsn>
                        <Ctry>BR</Ctry>                               
                    </PstlAdr>
                </LctnAndCtct>
                <POI>
                    <Id>
                        <Id>2FB4C89A</Id>
                    </Id>
                </POI>
            </Envt>
            <Tx>
                <TxCaptr>true</TxCaptr>
                <TxId>
                    <TxDtTm>2014-03-12T15:09:00</TxDtTm>
                    <TxRef>12345ABC</TxRef>
                </TxId>
                <TxDtls>
                    <Ccy>986</Ccy>
                    <TtlAmt>100</TtlAmt>
                </TxDtls>
                <OrgnlTx>
                    <InitrTxId>123123123</InitrTxId>
                    <RcptTxId>00000034071000000215346</RcptTxId>
                </OrgnlTx>
            </Tx>
        </CxlReq>
    </AccptrCxlReq>
</Document>
A binary file was returned

You couldn't be authenticated

<Document xmlns="urn:AcceptorCancellationResponseV02.1">
    <AccptrCxlRspn>
        <Hdr>
            <MsgFctn>CCAP</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
        </Hdr>
        <CxlRspn>
            <Envt>
                <MrchntId>
                    <Id>EF1CC1A4FECE40EB8B29CA7328955C77</Id>
                </MrchntId>
            </Envt>
            <Tx>
                <TxCaptr>true</TxCaptr>
                <TxId>
                    <TxDtTm>2014-03-12T15:09:00</TxDtTm>
                    <TxRef>123456798</TxRef>
                </TxId>
                <TxDtls>
                    <Ccy>986</Ccy>
                    <TtlAmt>100</TtlAmt>
                </TxDtls>
            </Tx>
            <TxRspn>
                <AuthstnRslt>
                    <RspnToAuthstn>
                        <Rspn>APPR</Rspn>
                        <RspnRsn>0000</RspnRsn>
                    </RspnToAuthstn>
                </AuthstnRslt>
            </TxRspn>
        </CxlRspn>
    </AccptrCxlRspn>
</Document>
 
Suggest Edits

TransactionStatusReport

Neste item exemplificamos o modelo esperado pela nossa API para as requisições de consulta de transação e o mapeamento das tags para a mensagem de resposta para a mesma operação (consulta de transação). Deve-se adicionar o endpoint /TransactionStatusReport ao endereço de conexão.

 
posthttps://sandbox-auth-integration.stone.com.br/TransactionStatusReport

MENSAGEM DE REQUISIÇÃO

Abaixo estão descritas as tags para a mensagem de requisição de consulta de transação:

Campo
Ocorrência
Tipo
Tamanho
Descrição

AcceptorTransactionStatusReportRequest<AccptrTxStsRptRq>

[1..1]

Container

Raiz da requisição de consulta de transação

Header<Hdr>

[1..1]

Container

Cabeçalho da mensagem

MessageFunction<MsgFctn>

[1..1]

CodeSet

an 4

O valor deve ser TSRR para a mensagem de AcceptorTransactionStatusReportRequestV02.1

ProtocolVersion<PrtcolVrsn>

[1..1]

Text

ans …6

O valor deve ser 2.0 para a esta mensagem

InitialParty<InitgPty>

[1..1]

Container

Identificação unica da parte que iniciou a requisição (cliente)

Identification<Id>

[1..1]

Text

an 32

Id do terminal ou id do lojista, mais conhecido como SAK

TransactionStatusReport<TxStsRpt>

[1..1]

Container

Raiz das informações sobre a transação consultada

Transaction<Tx>

[1..*]

Container

Coleção de transações para pesquisa.

TransactionReport<TxRpt>

[1..*]

Container

Define o tipo de Resposta

OPRS = Retorna os dados de todas as operações da transação.

SUMM = Retorna um relatorio detalhado sobre a transação.

OriginalTransaction<OrgnlTx>

[1..1]

Container

Dados da transação original.

RecipientTransactionIdentification<RcptTxId>

[0..1]

Text

an ...35

Identificador da transação fornecido pelo adquirente na resposta da autorização. (ATK)

InitiatorTransactionIdentification<InitrTxId>

[0..1]

Text

an ...32

Identificação da transação definida pelo sistema que se comunica com o Host Stone.
(ITK)

MENSAGEM DE RESPOSTA

Abaixo estão descritas as tags para a mensagem de resposta de consulta de transação:

Campo
Ocorrência
Tipo
Tamanho
Descrição

TransactionStatusReportResponse<TxStsRptRspn>

[1..1]

Container

Conteúdo da resposta da pesquisa

Transaction<Tx>

[1..*]

Container

Coleção de resultados de transações

Summary<Summry>

[1..1]

Container

Parte detalhada de informações sobre a transação

RecipientTransactionIdentification<RcptTxId>

[1..1]

Text

an ...35

Identificador do adquirente para a transação. É o ATK da transação original.

InitiatorTransactionIdentification<InitrTxId>

[1..1]

Text

an ...32

Identificador único da transação para o cliente (lojista)

AcquirerDateTime<AcqrrDtTm>

[1..1]

DateTime

ans 19

Data da transação no adquirente.
Formato: yyyy-MM-ddTHH:mm:ss

LocalDateTime<LclDtTm>

[1..1]

DateTime

ans 19

Data do local da transação.
Formato: yyyy-MM-ddTHH:mm:ss.

FirstCaptureDateTime<FrstCaptrDtTm>

[1..1]

DateTime

ans 19

Data da primeira captura.
Formato: yyyy-MM-ddTHH:mm:ss

FirstCancellationDateTime<FrstCxlDtTm>

[1..1]

DateTime

ans 19

Data do primeiro cancelamento
Formato: yyyy-MM-ddTHH:mm:ss

TotalOriginalAmount<TtlOrgnlAmt>

[1..1]

Amount

n ...23

Valor original da transação
Fomato: {0.00}

TotalAuthorisedAmount<TtlAuthrsdAmt>

[1..1]

Amount

n ...23

Valor autorizado da transação
Fomato: {0.00}

TotalCapturedAmount<TtlCaptrdAmt>

[1..1]

Amount

n ...23

Valor capturado da transação
Fomato: {0.00}

TotalCancelledAmount<TtlCancAmt>

[1..1]

Amount

n ...23

Valor cancelado da transação
Fomato: {0.00}

AuthorisedStatus<AuthrsdSts>

[1..1]

CodeSet

n 4

Status da transação

FULL : Indica que o valor integral da transação foi autorizado.

PART : Indica que o valor original foi autorizado parcialmente

NONE : Indica que a transação não foi autorizada

CapturedStatus<CaptrdSts>

[1..1]

CodeSet

n 4

Status da captura

FULL : Indica que o valor total da transação foi capturado.

PART : Indica que somente parte do valor autorizado foi capturado.

NONE: Indica que a transação não foi capturada.

CanceledStatus<CancSts>

[1..1]

CodeSet

n 4

Status do cancelamento

FULL : Indica que o valor total da transação foi cancelado.

PART : Indica que somente parte do valor capturado foi cancelado.

NONE: Indica que a transação não foi cancelada.

Currency<Ccy>

[1..1]

CodeSet

n 3

Moeda utilizada na transação em conformidade com a ISO 4217 - 986 = Real Brasileiro.

AccountType<AcctTp>

[1..1]

CodeSet

n 4

Tipo de conta da transação original

CRDT : Crédito

CHCK : Debito

MerchantShortName<MrchntShrtNm>

[1..1]

Text

an ...25

Nome do lojista usado na transação
Será exibido o soft descriptor quando este for enviado, se não o nome padrão do lojista será retornado.

MerchantCategoryCode<MrchntCtgyCd>

[1..1]

Text

n 4

Sera retornado o Mcc usado na hora da transação, caso não tenha sido informado sera retornado o mcc padrão do lojista.

AdditionalService<AddtlSvc>

[1..1]

CodeSet

n 4

Serviços adicionais:

INSA:Indica que foi solicitado parcelamento tipo lojista “sem juros”.
INSI : Indica que foi solicitado parcelamento tipo emissor “com juros”

Installment<Instlmt>

[1..1]

Container

Informações da parcela

TotalNumberOfPayments<TtlNbOfPmts>

[1..1]

Quantity

n ..2

Número de parcelas da transação

Operations<Oprs>

[1..1]

Container

Operações da transação

Authorisation<Authstn>

[1..1]

Container

Informações sobre a autorização

ReceptorOperationIdentification<RcptOprId>

[1..1]

Text

an …32

Número da operação no adquirente.

AcquirerDateTime<AcqrrDtTm>

[1..1]

DateTime

ans 19

Data da transação no adquirente
Formato: yyyy-MM-ddTHH:mm:ss

LocalDateTime<LclDtTm>

[1..1]

DateTime

ans 19

Data do local da transação
Formato: yyyy-MM-ddTHH:mm:ss

OriginalAmount<OrgnlAmt>

[1..1]

Amount

n ...23

Valor original da transação
Formato: {0.00}

AuthorisedAmount<AuthrsdAmt>

[1..1]

Amount

n ...23

Valor autorizado da transação
Formato: {0.00}

Response<Rspn>

[1..1]

CodeSet

n 4

Resposta para a transação:

DECL : A operação não foi autorizada
APPR : A Operação foi autorizada
TECH : Ocorreu um erro na operação

ResponseReason<RspnRsn>

[1..1]

Text

n 4

Codigo de resposta para a transação

AuthorisationCode<AuthstnCd>

[1..1]

Text

n 6

Codigo de autorização fornecido pelo banco

Capture<Cptr>

[1..1]

Container

Informações sobre as capturas

Cancellation<Cxl>

[1..1]

Container

Informações sobre os cancelamentos

<Document xmlns="urn:AcceptorTransactionStatusReportRequestV02.1">
	<AccptrTxStsRptRq>
			<Hdr>
				<MsgFctn>TSRR</MsgFctn>
				<PrtcolVrsn>2.0</PrtcolVrsn>
				<InitgPty>
					<Id>EF1CC1A4FECE40EB8B29CA7328955C77</Id>
				</InitgPty>
		</Hdr>
		<TxStsRpt>
			<Tx>
				<TxRpt>OPRS</TxRpt>
				<TxRpt>SUMM</TxRpt>
			<OrgnlTx>
				<InitrTxId>2a42327648f644f4</InitrTxId>
				<RcptTxId>11350002663228</RcptTxId>
			</OrgnlTx>
		</Tx>
		</TxStsRpt>
	</AccptrTxStsRptRq>
</Document>
A binary file was returned

You couldn't be authenticated

<Document xmlns="urn:AcceptorTransactionStatusReporResponseV02.1" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<AccptrTxStsRptRspn>
		<Hdr>
			<MsgFctn>TSRP</MsgFctn>
			<PrtcolVrsn>2.0</PrtcolVrsn>
			<CreDtTm>2015-01-19T14:17:02</CreDtTm>
			<InitgPty>
				<Id>EF1CC1A4FECE40EB8B29CA7328955C77</Id>
			</InitgPty>
		</Hdr>
		<TxStsRptRspn>
			<Tx>
				<Summry>
					<RcptTxId>11350002663228</RcptTxId>
					<InitrTxId>2a42327648f644f4</InitrTxId>
					<AcqrrDtTm>2015-01-13T18:17:26</AcqrrDtTm>
					<LclDtTm>2015-01-13T18:17:25</LclDtTm>
					<FrstCaptrDtTm>2015-01-13T18:17:28</FrstCaptrDtTm>
					<TtlOrgnlAmt>622.00</TtlOrgnlAmt>
					<TtlAuthrsdAmt>622.00</TtlAuthrsdAmt>
					<TtlCaptrdAmt>622.00</TtlCaptrdAmt>
					<AuthrsdSts>FULL</AuthrsdSts>
					<CaptrdSts>FULL</CaptrdSts>
					<CancSts>NONE</CancSts>
					<Ccy>986</Ccy>
					<AcctTp>CRDT</AcctTp>
					<MrchntShrtNm>STONE TEST</MrchntShrtNm>
					<MrchntCtgyCd>5311</MrchntCtgyCd>
					<AddtlSvc>INSA</AddtlSvc>
					<Instlmt>
						<TtlNbOfPmts>8</TtlNbOfPmts>
					</Instlmt>
				</Summry>
				<Oprs>
					<Authstn>
						<RcptOprId>1135000002663228</RcptOprId>
						<AcqrrDtTm>2015-01-13T18:17:26</AcqrrDtTm>
						<LclDtTm>2015-01-13T18:17:25</LclDtTm>
						<OrgnlAmt>622.00</OrgnlAmt>
						<AuthrsdAmt>622.00</AuthrsdAmt>
						<Rspn>APPR</Rspn>
						<RspnRsn>0000</RspnRsn>
						<AuthstnCd>172675</AuthstnCd>
					</Authstn>
					<Captr>
						<RcptOprId>1135000002663232</RcptOprId>
						<AcqrrDtTm>2015-01-13T18:17:28</AcqrrDtTm>
						<LclDtTm>2015-01-13T18:17:28</LclDtTm>
						<Amt>622.00</Amt>
						<Rspn>APPR</Rspn>
						<RspnRsn>0000</RspnRsn>
					</Captr>
					<Cxl>
						<RcptOprId>1135000002663232</RcptOprId>
						<AcqrrDtTm>2015-01-13T18:17:28</AcqrrDtTm>
						<LclDtTm>2015-01-13T18:17:28</LclDtTm>
						<Amt>622.00</Amt>
						<Rspn>DECL</Rspn>
						<RspnRsn>1000</RspnRsn>
					</Cxl>
				</Oprs>
			</Tx>
		</TxStsRptRspn>
	</AccptrTxStsRptRspn>
</Document>
 
Suggest Edits

Exemplos de Mensageria - Requisição e Resposta

Inclusive com cenários de erro.

 

1. Autorização com captura posterior

<Document xmlns="urn:AcceptorAuthorisationRequestV02.1">
    <AccptrAuthstnReq>
        <Hdr>
            <MsgFctn>AUTQ</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
        </Hdr>
        <AuthstnReq>
            <Envt>
                <Mrchnt>
                    <Id>
                        <Id>BFDB58AB9A8A48828C2647E18B7F1114</Id>
                        <ShrtNm>Nome da fatura</ShrtNm>
                    </Id>
                </Mrchnt>
                <POI>
                    <Id>
                        <Id>2FB4C89A</Id>
                    </Id>
                </POI>
                <Card>
                    <PlainCardData>
                        <PAN>4066559930861909</PAN>
                        <XpryDt>2017-10</XpryDt>
                        <CardSctyCd>
                            <CSCVal>123</CSCVal>
                        </CardSctyCd>
                    </PlainCardData>
                </Card>
            </Envt>
            <Cntxt>
                <PmtCntxt>
                    <CardDataNtryMd>PHYS</CardDataNtryMd>
                    <TxChanl>ECOM</TxChanl>
                </PmtCntxt>
            </Cntxt>
            <Tx>
                <AddtlSvc>RECP</AddtlSvc>
                <SvcAttr>FREC</SvcAttr> 
                <InitrTxId>123123123</InitrTxId>
                <TxCaptr>false</TxCaptr>
                <TxId>
                    <TxDtTm>2017-06-01T15:11:06</TxDtTm>
                    <TxRef>06064f516a50483da7f189243c95ccca</TxRef>
                </TxId>
                <TxDtls>
                    <Ccy>986</Ccy>
                    <TtlAmt>100</TtlAmt>
                    <AcctTp>CRDT</AcctTp>
                    <RcrngTx>
                        <InstlmtTp>NONE</InstlmtTp>
                        <TtlNbOfPmts>0</TtlNbOfPmts>
                    </RcrngTx>
                </TxDtls>
            </Tx>
        </AuthstnReq>
    </AccptrAuthstnReq>
</Document>

Response

<?xml version="1.0" encoding="utf-8"?>
<Document xmlns="urn:AcceptorAuthorisationResponseV02.1" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <AccptrAuthstnRspn>
        <Hdr>
            <MsgFctn>AUTP</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
            <CreDtTm>2017-06-16T11:42:43</CreDtTm>
        </Hdr>
        <AuthstnRspn>
            <Envt>
                <MrchntId>
                    <Id>BFDB58AB9A8A48828C2647E18B7F1114</Id>
                    <ShrtNm>Nome da fatura</ShrtNm>
                </MrchntId>
            </Envt>
            <Tx>
                <TxId>
                    <TxDtTm>2017-06-01T15:11:06</TxDtTm>
                    <TxRef>06064f516a50483da7f189243c95ccca</TxRef>
                </TxId>
                <RcptTxId>26770052347033</RcptTxId>
                <TxDtls>
                    <Ccy>986</Ccy>
                    <TtlAmt>100</TtlAmt>
                    <AcctTp>CRDT</AcctTp>
                </TxDtls>
            </Tx>
            <TxRspn>
                <AuthstnRslt>
                    <RspnToAuthstn>
                        <Rspn>APPR</Rspn>
                        <RspnRsn>0000</RspnRsn>
                    </RspnToAuthstn>
                    <AuthstnCd>347033</AuthstnCd>
                    <CmpltnReqrd>true</CmpltnReqrd>
                </AuthstnRslt>
                <Actn>
                    <ActnTp>DISP</ActnTp>
                    <MsgToPres>
                        <MsgDstn>MDSP</MsgDstn>
                        <MsgCntt>Aprovado</MsgCntt>
                    </MsgToPres>
                </Actn>
            </TxRspn>
        </AuthstnRspn>
    </AccptrAuthstnRspn>
</Document>

2. Autorização com captura imediata

<Document xmlns="urn:AcceptorAuthorisationRequestV02.1">
    <AccptrAuthstnReq>
        <Hdr>
            <MsgFctn>AUTQ</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
        </Hdr>
        <AuthstnReq>
            <Envt>
                <Mrchnt>
                    <Id>
                        <Id>BFDB58AB9A8A48828C2647E18B7F1114</Id>
                        <ShrtNm>Nome da fatura</ShrtNm>
                    </Id>
                </Mrchnt>
                <POI>
                    <Id>
                        <Id>2FB4C89A</Id>
                    </Id>
                </POI>
                <Card>
                    <PlainCardData>
                        <PAN>4066559930861909</PAN>
                        <XpryDt>2017-10</XpryDt>
                        <CardSctyCd>
                            <CSCVal>123</CSCVal>
                        </CardSctyCd>
                    </PlainCardData>
                </Card>
            </Envt>
            <Cntxt>
                <PmtCntxt>
                    <CardDataNtryMd>PHYS</CardDataNtryMd>
                    <TxChanl>ECOM</TxChanl>
                </PmtCntxt>
            </Cntxt>
            <Tx> 
                <AddtlSvc>RECP</AddtlSvc>
                <SvcAttr>FREC</SvcAttr> 
                <InitrTxId>123123123</InitrTxId>
                <TxCaptr>true</TxCaptr>
                <TxId>
                    <TxDtTm>2017-06-01T15:11:06</TxDtTm>
                    <TxRef>06064f516a50483da7f189243c95ccca</TxRef>
                </TxId>
                <TxDtls>
                    <Ccy>986</Ccy>
                    <TtlAmt>100</TtlAmt>
                    <AcctTp>CRDT</AcctTp>
                    <RcrngTx>
                        <InstlmtTp>NONE</InstlmtTp>
                        <TtlNbOfPmts>0</TtlNbOfPmts>
                    </RcrngTx>
                </TxDtls>
            </Tx>
        </AuthstnReq>
    </AccptrAuthstnReq>
</Document>

Resposta

<?xml version="1.0" encoding="utf-8"?>
<Document xmlns="urn:AcceptorAuthorisationResponseV02.1" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <AccptrAuthstnRspn>
        <Hdr>
            <MsgFctn>AUTP</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
            <CreDtTm>2017-06-16T11:46:35</CreDtTm>
        </Hdr>
        <AuthstnRspn>
            <Envt>
                <MrchntId>
                    <Id>BFDB58AB9A8A48828C2647E18B7F1114</Id>
                    <ShrtNm>Nome da fatura</ShrtNm>
                </MrchntId>
            </Envt>
            <Tx>
                <TxId>
                    <TxDtTm>2017-06-01T15:11:06</TxDtTm>
                    <TxRef>06064f516a50483da7f189243c95ccca</TxRef>
                </TxId>
                <RcptTxId>26770052347037</RcptTxId>
                <TxDtls>
                    <Ccy>986</Ccy>
                    <TtlAmt>100</TtlAmt>
                    <AcctTp>CRDT</AcctTp>
                </TxDtls>
            </Tx>
            <TxRspn>
                <AuthstnRslt>
                    <RspnToAuthstn>
                        <Rspn>APPR</Rspn>
                        <RspnRsn>0000</RspnRsn>
                    </RspnToAuthstn>
                    <AuthstnCd>347037</AuthstnCd>
                    <CmpltnReqrd>false</CmpltnReqrd>
                </AuthstnRslt>
                <Actn>
                    <ActnTp>DISP</ActnTp>
                    <MsgToPres>
                        <MsgDstn>MDSP</MsgDstn>
                        <MsgCntt>Aprovado</MsgCntt>
                    </MsgToPres>
                </Actn>
            </TxRspn>
        </AuthstnRspn>
    </AccptrAuthstnRspn>
</Document>

3. Cancelamento/Estorno (Desfazimento)

<Document xmlns="urn:AcceptorCancellationRequestV02.1">
    <AccptrCxlReq>
        <Hdr>
            <MsgFctn>CCAQ</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
        </Hdr>
        <CxlReq>
            <Envt>
                <Mrchnt>
                    <Id>
                        <Id>EF1CC1A4FECE40EB8B29CA7328955C88</Id>
                    </Id>
                </Mrchnt>
                <POI>
                    <Id>
                        <Id>2FB4C89A</Id>
                    </Id>
                </POI>
            </Envt>
            <Tx>
                <TxCaptr>true</TxCaptr>
                <TxId>
                    <TxDtTm>2014-03-12T15:09:00</TxDtTm>
                    <TxRef>12345ABC</TxRef>
                </TxId>
                <TxDtls>
                    <Ccy>986</Ccy>
                    <TtlAmt>100</TtlAmt>
                </TxDtls>
                <OrgnlTx>
                    <InitrTxId>123123123</InitrTxId>
                    <RcptTxId>00000034071000000215346</RcptTxId>
                </OrgnlTx>
            </Tx>
        </CxlReq>
    </AccptrCxlReq>
</Document>

Resposta

<?xml version="1.0" encoding="utf-8"?>
<Document xmlns="urn:AcceptorCancellationResponseV02.1" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <AccptrCxlRspn>
        <Hdr>
            <MsgFctn>CCAP</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
            <CreDtTm>2017-06-16T11:48:32</CreDtTm>
        </Hdr>
        <CxlRspn>
            <Envt>
                <MrchntId>
                    <Id>EF1CC1A4FECE40EB8B29CA7328955C88</Id>
                </MrchntId>
            </Envt>
            <TxRspn>
                <AuthstnRslt>
                    <RspnToAuthstn>
                        <Rspn>DECL</Rspn>
                        <RspnRsn>9114</RspnRsn>
                    </RspnToAuthstn>
                    <CmpltnReqrd>false</CmpltnReqrd>
                </AuthstnRslt>
            </TxRspn>
            <Tx>
                <TxId>
                    <TxDtTm>2014-03-12T15:09:00</TxDtTm>
                    <TxRef>12345ABC</TxRef>
                </TxId>
                <RcptTxId>00000034071000000215346</RcptTxId>
                <TxDtls>
                    <Ccy>986</Ccy>
                    <TtlAmt>100</TtlAmt>
                </TxDtls>
            </Tx>
        </CxlRspn>
    </AccptrCxlRspn>
</Document>
<?xml version="1.0" encoding="utf-8"?>
<Document xmlns="urn:AcceptorCancellationResponseV02.1" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <AccptrCxlRspn>
        <Hdr>
            <MsgFctn>CCAP</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
            <CreDtTm>2017-10-04T15:57:40</CreDtTm>
        </Hdr>
        <CxlRspn>
            <Envt>
                <MrchntId>
                    <Id>XPTO</Id>
                </MrchntId>
            </Envt>
            <TxRspn>
                <AuthstnRslt>
                    <RspnToAuthstn>
                        <Rspn>DECL</Rspn>
                        <RspnRsn>9114</RspnRsn>
                    </RspnToAuthstn>
                    <CmpltnReqrd>false</CmpltnReqrd>
                </AuthstnRslt>
            </TxRspn>
            <Tx>
                <TxId>
                    <TxDtTm>2014-03-12T15:09:00</TxDtTm>
                    <TxRef>XPTO</TxRef>
                </TxId>
                <RcptTxId>XPTO</RcptTxId>
                <TxDtls>
                    <Ccy>986</Ccy>
                    <TtlAmt>100</TtlAmt>
                </TxDtls>
            </Tx>
        </CxlRspn>
    </AccptrCxlRspn>
</Document>

4. Consulta

<Document xmlns="urn:AcceptorTransactionStatusReportRequestV02.1">
  <AccptrTxStsRptRq>
      <Hdr>
        <MsgFctn>TSRR</MsgFctn>
        <PrtcolVrsn>2.0</PrtcolVrsn>
        <InitgPty>
          <Id>EF1CC1A4FECE40EB8B29CA7328955C88</Id>
        </InitgPty>
    </Hdr>
    <TxStsRpt>
      <Tx>
        <TxRpt>OPRS</TxRpt>
        <TxRpt>SUMM</TxRpt>
      <OrgnlTx>
        <InitrTxId>2a42327648f644f4</InitrTxId>
        <RcptTxId>11350002663228</RcptTxId>
      </OrgnlTx>
    </Tx>
    </TxStsRpt>
  </AccptrTxStsRptRq>
</Document>

Resposta

<?xml version="1.0" encoding="utf-8"?>
<Document xmlns="urn:AcceptorTransactionStatusReportResponseV02.1" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <AccptrTxStsRptRspn>
        <Hdr>
            <MsgFctn>TSRP</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
            <CreDtTm>2017-06-16T11:51:22</CreDtTm>
            <InitgPty>
                <Id>EF1CC1A4FECE40EB8B29CA7328955C88</Id>
            </InitgPty>
        </Hdr>
        <TxStsRptRspn/>
    </AccptrTxStsRptRspn>
</Document>

SAK não identificado pelo autorizador Stone

Requisição

<Document xmlns="urn:AcceptorAuthorisationRequestV02.1">
    <AccptrAuthstnReq>
        <Hdr>
            <MsgFctn>AUTQ</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
        </Hdr>
        <AuthstnReq>
            <Envt>
                <Mrchnt>
                    <Id>
                        <Id>XTPO</Id>
                        <ShrtNm>Nome da fatura</ShrtNm>
                    </Id>
                </Mrchnt>
                <POI>
                    <Id>
                        <Id>2FB4C89A</Id>
                    </Id>
                </POI>
                <Card>
                    <PlainCardData>
                        <PAN>XTPO</PAN>
                        <XpryDt>2017-10</XpryDt>
                        <CardSctyCd>
                            <CSCVal>123</CSCVal>
                        </CardSctyCd>
                    </PlainCardData>
                </Card>
            </Envt>
            <Cntxt>
                <PmtCntxt>
                    <CardDataNtryMd>PHYS</CardDataNtryMd>
                    <TxChanl>ECOM</TxChanl>
                </PmtCntxt>
            </Cntxt>
            <Tx> 
                <AddtlSvc>RECP</AddtlSvc>
                <SvcAttr>FREC</SvcAttr> 
                <InitrTxId>123123123</InitrTxId>
                <TxCaptr>false</TxCaptr>
                <TxId>
                    <TxDtTm>2017-06-01T15:11:06</TxDtTm>
                    <TxRef>06064f516a50483da7f189243c95ccca</TxRef>
                </TxId>
                <TxDtls>
                    <Ccy>986</Ccy>
                    <TtlAmt>100</TtlAmt>
                    <AcctTp>CRDT</AcctTp>
                    <RcrngTx>
                        <InstlmtTp>NONE</InstlmtTp>
                        <TtlNbOfPmts>0</TtlNbOfPmts>
                    </RcrngTx>
                </TxDtls>
            </Tx>
        </AuthstnReq>
    </AccptrAuthstnReq>
</Document>

Resposta

<?xml version="1.0" encoding="utf-8"?>
<Document xmlns="urn:AcceptorRejectionV02.1" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <AccptrRjctn>
        <Hdr>
            <MsgFctn>RJCT</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
            <CreDtTm>2017-10-04T15:08:21</CreDtTm>
        </Hdr>
        <Rjct>
            <RjctRsn>INTP</RjctRsn>
            <AddtlInf>Invalid identification data for the sender.</AddtlInf>
            <MsgInErr/>
        </Rjct>
    </AccptrRjctn>
</Document>

Número de Parcelas maior que 1, porém com TAG InstlmtTp igual a NONE

<Document xmlns="urn:AcceptorAuthorisationRequestV02.1">
    <AccptrAuthstnReq>
        <Hdr>
            <MsgFctn>AUTQ</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
        </Hdr>
        <AuthstnReq>
            <Envt>
                <Mrchnt>
                    <Id>
                        <Id>XPTO</Id>
                        <ShrtNm>Nome da fatura</ShrtNm>
                    </Id>
                </Mrchnt>
                <POI>
                    <Id>
                        <Id>2FB4C89A</Id>
                    </Id>
                </POI>
                <Card>
                    <PlainCardData>
                          <PAN>XPTO</PAN>
                        <XpryDt>2017-10</XpryDt>
                        <CardSctyCd>
                            <CSCVal>XPTO</CSCVal>
                        </CardSctyCd>
                    </PlainCardData>
                </Card>
            </Envt>
            <Cntxt>
                <PmtCntxt>
                    <CardDataNtryMd>PHYS</CardDataNtryMd>
                    <TxChanl>ECOM</TxChanl>
                </PmtCntxt>
            </Cntxt>
            <Tx> 
                <AddtlSvc>RECP</AddtlSvc>
                <SvcAttr>FREC</SvcAttr>
                <InitrTxId>123123123</InitrTxId>
                <TxCaptr>false</TxCaptr>
                <TxId>
                    <TxDtTm>2017-06-01T15:11:06</TxDtTm>
                    <TxRef>06064f516a50483da7f189243c95ccca</TxRef>
                </TxId>
                <TxDtls>
                    <Ccy>986</Ccy>
                    <TtlAmt>100</TtlAmt>
                    <AcctTp>CRDT</AcctTp>
                    <RcrngTx>
                        <InstlmtTp>NONE</InstlmtTp>
                        <TtlNbOfPmts>2</TtlNbOfPmts>
                    </RcrngTx>
                </TxDtls>
            </Tx>
        </AuthstnReq>
    </AccptrAuthstnReq>
</Document>

Cartão Inválido

Requisição

<Document xmlns="urn:AcceptorAuthorisationRequestV02.1">
	<AccptrAuthstnReq>
		<Hdr>
			<MsgFctn>AUTQ</MsgFctn>
			<PrtcolVrsn>2.0</PrtcolVrsn>
		</Hdr>
		<AuthstnReq>
			<Envt>
				<Mrchnt>
					<Id>
						<Id>XPTO</Id>
					</Id>
				</Mrchnt>
				<POI>
					<Id>
						<Id>CHECKOUT1</Id>
					</Id>
					<SysNm>SOFTWAREHOUSE</SysNm>
					<Cmpnt>
						<Tp>TERM</Tp>
						<Id>
							<PrvdrId>FABRICANTE</PrvdrId>
							<Id>MODELO</Id>
							<SrlNb>XPTO</SrlNb>
						</Id>
						<Sts>
							<VrsnNb>XPTO</VrsnNb>
						</Sts>
					</Cmpnt>
					<Cpblties>
						<PrtLineWidth>39</PrtLineWidth>
					</Cpblties>
				</POI>
				<Card>
					<PlainCardData>
						<PAN>5612000269966</PAN>
						<XpryDt>2050-12</XpryDt>
						<CardSctyCd>
							<CSCVal>111</CSCVal>
						</CardSctyCd>
					</PlainCardData>
				</Card>
				<Crdhldr>
					<Nm>XPTO</Nm>
					<Authntcn>
						<AuthntcnMtd>PPSG</AuthntcnMtd>
					</Authntcn>
				</Crdhldr>
			</Envt>
			<Cntxt>
				<PmtCntxt>
					<CardDataNtryMd>PHYS</CardDataNtryMd>
					<FllbckInd>false</FllbckInd>
					<TxChanl>ECOM</TxChanl>
				</PmtCntxt>
			</Cntxt>
			<Tx>
				<InitrTxId>00000124112016103201</InitrTxId>
				<TxCaptr>true</TxCaptr>
				<TxId>
					<TxDtTm>2016-11-24T10:32:01</TxDtTm>
					<TxRef>0123456</TxRef>
				</TxId>
				<TxDtls>
					<Ccy>986</Ccy>
					<TtlAmt>100</TtlAmt>
					<AcctTp>CRDT</AcctTp>
					<RcrngTx>
						<InstlmtTp>ISSR</InstlmtTp>
						<TtlNbOfPmts>5</TtlNbOfPmts>
					</RcrngTx>
				</TxDtls>
			</Tx>
		</AuthstnReq>
	</AccptrAuthstnReq>
</Document>

Resposta

<Document xmlns="urn:AcceptorAuthorisationResponseV02.1" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <AccptrAuthstnRspn>
        <Hdr>
            <MsgFctn>AUTP</MsgFctn>
            <PrtcolVrsn>2.0</PrtcolVrsn>
            <CreDtTm>2017-10-04T15:31:58</CreDtTm>
        </Hdr>
        <AuthstnRspn>
            <Envt>
                <MrchntId>
                    <Id>XPTO</Id>
                </MrchntId>
            </Envt>
            <Tx>
                <TxId>
                    <TxDtTm>2016-11-24T10:32:01</TxDtTm>
                    <TxRef>0123456</TxRef>
                </TxId>
                <RcptTxId>XPTO</RcptTxId>
                <TxDtls>
                    <Ccy>986</Ccy>
                    <TtlAmt>0</TtlAmt>
                    <AcctTp>CRDT</AcctTp>
                </TxDtls>
            </Tx>
            <TxRspn>
                <AuthstnRslt>
                    <RspnToAuthstn>
                        <Rspn>DECL</Rspn>
                        <RspnRsn>1011</RspnRsn>
                    </RspnToAuthstn>
                    <AuthstnCd/>
                    <CmpltnReqrd>false</CmpltnReqrd>
                </AuthstnRslt>
                <Actn>
                    <ActnTp>DISP</ActnTp>
                    <MsgToPres>
                        <MsgDstn>MDSP</MsgDstn>
                        <MsgCntt>Cartão inválido</MsgCntt>
                    </MsgToPres>
                </Actn>
            </TxRspn>
        </AuthstnRspn>
    </AccptrAuthstnRspn>
</Document>

Resposta de Rejeição

Mensagem Invalida – A mensagem enviada possui um formato inválido.

<Document xmlns="urn:AcceptorRejectionV02.1" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
	<AccptrRjctn>
		<Hdr>
			<MsgFctn>RJCT</MsgFctn>
			<PrtcolVrsn>2.0</PrtcolVrsn>
			<CreDtTm>2016-11-28T10:11:23</CreDtTm>
		</Hdr>
		<Rjct>
			<RjctRsn>IMSG</RjctRsn>
			<AddtlInf> Identification - GenericIdentification Id can not be null</AddtlInf>
			<MsgInErr/>
		</Rjct>
	</AccptrRjctn>
</Document>
 
Suggest Edits

Transações

 
Transação Modalidades Formas de Pagamento
Crédito Captura Imediata (Automática) À Vista / Parcelado emissor / Parcelado lojista
Crédito Captura Posterior À Vista / Parcelado emissor / Parcelado lojista

Modalidades de Pagamento

À vista - Consiste no pagamento do valor total da compra

Parcelado - É o pagamento mensal do valor da compra, dividido pelo número escolhido de parcelas. O pagamento é realizado de acordo com a data de faturamento acordada entre o portador do cartão e o emissor, nos meses subsequentes a compra, até que o valor integral devido seja quitado. É o adquirente (Stone) quem controla o número máximo de parcelas desta transação. Existem dois tipos de parcelamentos e ambos possuem juros. A diferença é de quem os juros serão cobrados: a) do portador do cartão ou; b) do lojista.

Tipos de parcelamento

Durante o credenciamento com a STONE é possível optar pelas seguintes formas de parcelamento de transações:

Parcelado lojista (sem juros) – é o pagamento mensal do valor da compra, dividido pelo número escolhido de parcelas. O pagamento é realizado de acordo com a data de faturamento acordada entre o portador do cartão e o emissor, nos meses subsequentes a compra, até que valor integral devido seja quitado. É o adquirente quem controla as parcelas desta transação.

Parcelado emissor (com juros) – é similar ao parcelado sem juros, porém, no valor a ser pago, será acrescentado juros cobrados diretamente pelo emissor e devidamente aceitos pelo portador. Para o adquirente e o estabelecimento, a transação será liquidada como à vista. É o emissor quem controla as parcelas dessa transação.

 
Suggest Edits

Tipo das TAGs XML

 

Container

É uma tag que possui tags "filhas", ou seja, cujos elementos são uma ou mais tags

Exemplo: Suponha que temos a tag Cliente que é um Container e possui como elementos as tags NomeDaLoja, MCC e SAK então a representação dessa tag XML seria :

<Cliente>
<NomeDaLoja></NomeDaLoja>
<MCC>999</MCC>
<SAK>xxxxxxxxxxxxxxxxxxx</SAK>
</Cliente>

CodeSet

São tags cujos valores são Enums, ou seja, cujos elementos são represantações em letras de números.

Exemplo : Ao criar um uma tag do tipo CodeSet chamada Aviso seus podemos criar alias ( apelidos ) para os números de 1 ,2 ,3 e chamá-los de OK , ERRO e ADVERTÊNCIA, respectivamente de maneira a facilitar a distinção deles dos números 1, 2 e 3 apenas.

A representação dessa tag XML ocorreria da seguinte forma :

<Aviso>OK<./Aviso>

Text

São tags cujos valores são strings alfanuméricas.

Exemplo :

Suponha que exista um tag chamada Nome, logo sua representação será :

<Nome>Fulano<Nome>

DateTime

São tags que representam a data e hora.

Exemplo :

Suponha que exista uma tag chamada DataEHoraAtual, sua representação será:

<DataEHoraAtual>2014-03-12T15:09:00</DataEHoraAtual>

Amount

São tags cujos valores são números decimais podendo ou não conter virgula, geralmente utilizados para identifcar valores de transações.

Exemplo:

Suponha que tenhamos uma tag com o nome <ValorTotalTransacao> que indica o valor total da venda, caso o valor total da venda fosse R$ 500,00 sua representação seria :

<ValorTotalTransacao>500.00</ValorTotalTransacao>

Quantity

São tags cujos valores são números inteiros ( sem vírgula ) utilizados para contagem.

Exemplo :

Suponha que tenhamos um tag com o nome <NumeroParcelas> que indica o número de parcelas de uma transação de crédito. No caso de uma transação de crédito em 3 vezes a representação da tag seria :

<NumeroParcelas>3<NumeroParcelas>

 
Suggest Edits

Códigos de Retorno do Sandbox

 

Nosso Sandbox permite que os desenvolvedores possam testar o comportamento para os principais códigos de retorno (Action Codes) possíveis. Os códigos retornados nas transações em ambiente de integração tem correspondência com o número de centavos do valor da transação.

Códigos para qualquer bandeira

Centavos <RspnRsn> Response Reason Code <Rspn> (Response) <MsgCntt> (Message Content) <MsgCntt> (Message Content)
00 0000 APPR Aprovado Approved
01 1007 DECL Consultar o emissor Refer to card issuer
02 1008 DECL Consultar as condições especiais do emissor Refer to card issuer's special conditions
03 1009 DECL Estabelecimento inválido Invalid card acceptor
04 2000 DECL Não aprovado Do not honour
05 1000 DECL Não aprovado Do not honour
06 9999 DECL Erro não especificado Other errors
07 2007 DECL Condições especiais Special conditions
08 0001 APPR Aprovar após verificação de identidade Approve after identity verification
09 9123 DECL Requisição em progresso Request in progress
10 0002 PART Parcialmente aprovado Partially approved
11 0003 APPR Aprovado (VIP) Approved (VIP)
12 9102 DECL Transação inválida Invalid transaction
13 1010 DECL Valor inválido Invalid amount
14 1011 DECL Cartão inválido Invalid card number
15 9108 DECL Não foi possível enviar a transação para o destinatário Transaction destination cannot be found for routing
16 0004 APPR Aprovado, atualizar trilha 3 Approved, upgrade track 3
17 9999 DECL Erro não especificado Other errors
18 9999 DECL Erro não especificado Other errors
19 9103 DECL Re-enter transaction Re-enter transaction
20 9999 DECL Erro não especificado Other errors
21 9999 DECL Erro não especificado Other errors
22 9999 DECL Erro não especificado Other errors
23 1013 DECL Unacceptable fee Unacceptable fee
24 3001 DECL
25 3002 DECL
26 3003 DECL
27 3004 DECL
28 3005 DECL
29 3006 DECL
30 9100 DECL Erro no formato da mensagem One or more data element errors (see message error indicator)
31 9108 DECL Não foi possível enviar a transação para o destinatário Transaction destination cannot be found for routing
32 9999 DECL Erro não especificado Other errors
33 2001 DECL Cartão vencido Expired card
34 2002 DECL Suspeita de fraude Suspected fraud
35 2003 DECL Estabelecimento entrar em contato com emissor Card acceptor contact acquirer
36 2004 DECL Cartão com restrição Restricted card
37 2005 DECL Estabelecimento entrar em contato com departamento de segurança do adquirente Card acceptor call acquirer's security department
38 2006 DECL Tentativas de senha excedidas Allowable PIN tries exceeded
39 1014 DECL Nenhuma conta do tipo selecionado No account of type requested
40 1015 DECL Função selecionada não suportada Requested function not supported
41 2008 DECL Cartão perdido Lost card
42 1014 DECL Nenhuma conta do tipo selecionado No account of type requested
43 2009 DECL Cartão roubado Stolen card
44 1014 DECL Nenhuma conta do tipo selecionado No account of type requested
45 9999 DECL Erro não especificado Other errors
46 9999 DECL Erro não especificado Other errors
47 9999 DECL Erro não especificado Other errors
48 9999 DECL Erro não especificado Other errors
49 9999 DECL Erro não especificado Other errors
50 9999 DECL Erro não especificado Other errors
51 1016 DECL Saldo insuficiente Not sufficient funds
52 1014 DECL Nenhuma conta do tipo selecionado No account of type requested
53 1014 DECL Nenhuma conta do tipo selecionado No account of type requested
54 1001 DECL Cartão vencido Expired card
55 1017 DECL Senha inválida Incorrect PIN
56 1018 DECL No card record No card record
57 1019 DECL Transação não permitida para o portador Transaction not permitted to cardholder
58 1020 DECL Transação não permitida para o terminal Transaction not permitted to terminal
59 1002 DECL Suspeita de fraude Suspected fraud
60 1003 DECL Estabelecimento entrar em contato com adquirente Card acceptor contact acquirer
61 1021 DECL Limite de valor para saque excedido Exceeds withdrawal amount limit
62 1004 DECL Cartão com restrição Restricted card
63 1022 DECL Violação de segurança Security violation
64 1010 DECL Valor inválido Invalid amount
65 1023 DECL Limite de quantidade de saques excedido Exceeds withdrawal frequency limit
66 1005 DECL Estabelecimento entrar em contato com departamento de segurança do adquirente Card acceptor call acquirer's security department
67 2000 DECL Não aprovado Do not honour
68 9999 DECL Erro não especificado Other errors
72 9999 DECL Erro não especificado Other errors
73 9999 DECL Erro não especificado Other errors
74 9999 DECL Erro não especificado Other errors
75 1006 DECL Tentativas de senha excedidas Allowable PIN tries exceeded
82 9999 DECL Erro não especificado Other errors
83 9999 DECL Erro não especificado Other errors
90 9106 DECL Cutover in process Cutover in process
91 9107 DECL Emissor fora de operação Card issuer or switch inoperative
92 9108 DECL Não foi possível enviar a transação para o destinatário Transaction destination cannot be found for routing
93 1024 DECL Violação da lei Violation of law
94 9113 DECL Transmissão duplicada Duplicate transmission
95 9115 DECL Reconciliation cutover or checkpoint error Reconciliation cutover or checkpoint error
96 9109 DECL Erro no sistema System malfunction

Códigos exclusivos para BINs MasterCard

Centavos <RspnRsn> Código de Resposta <Rspn> (Response) <MsgCntt> (Conteúdo da Mensagem)
70 1007 DECL Consultar o emissor Refer to card issuer
71 1048 DECL Nova senha inválida New PIN invalid
76 1042 DECL Status ruim para conta de destino To account bad status
77 1041 DECL Status ruim para conta de origem From account bad status
78 1014 DECL Nenhuma conta do tipo selecionado No account of type requested
79 8002 DECL
80 9112 DECL Emissor indisponível Card issuer unavailable
81 9102 DECL Transação inválida Invalid transaction
84 1033 DECL Ciclo de vida inválido para a transação Invalid life cycle for the transaction
85 0000 APPR Aprovado Approved
86 1801 DECL Não é possivel Validar o PIN Can not Validate PIN
87 0862 APPR
88 1802 DECL Falha na Criptografia Encryption failed
89 1017 DECL Senha inválida Incorrect PIN

Códigos exclusivos para BINs Visa e ELO

Centavos <RspnRsn> Código de Resposta <Rspn> (Response) <MsgCntt> (Conteúdo da Mensagem)
70 9999 DECL Erro não especificado Other errors
71 9999 DECL Erro não especificado Other errors
76 9114 DECL Não foi possível encontrar a transação original Not able to trace back to original transaction
77 9999 DECL Erro não especificado Other errors
78 1025 DECL Cartão bloqueado Card not effective
79 9999 DECL Erro não especificado Other errors
80 9112 DECL Emissor indisponível Card issuer unavailable
81 1802 DECL Falha na Criptografia Encryption failed
84 9999 DECL Erro não especificado Other errors
85 0000 APPR Aprovado Approved
86 1801 DECL Não é possivel Validar o PIN Can not Validate PIN
87 9999 DECL Erro não especificado Other errors
88 9999 DECL Erro não especificado Other errors
89 9999 DECL Erro não especificado Other errors
 
Suggest Edits

Códigos de retorno Autorizador Stone

 
Código de retorno Descrição Mensagem
0000 Approved Aprovado
0001 Approve after identity verification Aprovar após verificação de identidade
0002 Partially approved Parcialmente aprovado
0003 Approved (VIP) Aprovado (VIP)
0004 Approved, upgrade track 3 Aprovado, atualizar trilha 3
0005 Approved, account type defined by the issuer Aprovado, tipo de conta definido pelo emissor
0006 Partially approved, account type defined by the issuer Parcialmente aprovado, tipo de conta definido pelo emissor
0008 Approved but fees disputed Approved but fees disputed
0009 Approved with overdraft Approved with overdraft
0010 Approved, customer reactivated Approved, customer reactivated
0011 Aprovado offline, não foi possível ir online Aprovado offline, não foi possível ir online
0012 Approved, transaction processed offline by terminal Approved, transaction processed offline by terminal
0013 Approved, transaction processed offline after referral Approved, transaction processed offline after referral
1000 Do not honour Não aprovado
1001 Expired card Cartão vencido
1002 Suspected fraud Suspeita de fraude
1003 Card acceptor contact acquirer Estabelecimento entrar em contato com o adquirente
1004 Restricted card Cartão com restrição
1005 Card acceptor call acquirer's security department Estabelecimento entrar em contato com departamento de segurança do adquirente
1006 Allowable PIN tries exceeded Tentativas de senha excedidas
1007 Refer to card issuer Consultar o emissor
1008 Refer to card issuer's special conditions Consultar as condições especiais do emissor
1009 Invalid card acceptor Estabelecimento inválido
1010 Invalid amount Valor inválido
1011 Invalid card number Cartão inválido
1012 PIN data required Senha necessária
1013 Unacceptable fee Unacceptable fee
1014 No account of type requested Nenhuma conta do tipo selecionado
1015 Requested function not supported Função selecionada não suportada
1016 Not sufficient funds Saldo insuficiente
1017 Incorrect PIN Senha inválida
1018 No card record No card record
1019 Transaction not permitted to cardholder Transação não permitida para o portador
1020 Transaction not permitted to terminal Transação não permitida para o terminal
1021 Exceeds withdrawal amount limit Limite de valor para saque excedido
1022 Security violation Violação de segurança
1023 Exceeds withdrawal frequency limit Limite de quantidade de saques excedido
1024 Violation of law Violação da lei
1025 Card not effective Cartão bloqueado
1026 Invalid PIN block Dados de senha inválidos
1027 PIN length error Erro no tamanho da senha
1028 PIN key sync error Erro de sincronia de chave de senha
1029 Suspected counterfeit card Suspeita de cartão falso
1030 Currency unacceptable to card issuer Moeda inaceitável para o emissor
1031 Not authorised and fees disputed Not authorised and fees disputed
1032 Lost/stolen card Cartão perdido ou roubado
1033 Invalid life cycle for the transaction Ciclo de vida inválido para a transação
1034 Authorization lifecycle has expired Authorization lifecycle has expired
1035 Closed account Conta encerrada
1036 Closed savings account, or restricted for closing Conta poupança encerrada ou bloqueada para encerramento
1037 Closed credit account or restricted for closing Conta de crédito encerrada ou bloqueada para encerramento
1038 Closed credit facility cheque account or restricted for closing Closed credit facility cheque account or restricted for closing
1039 Closed cheque account or restricted for closing Conta corrente encerrada ou bloquada para encerramento
1040 Bad debt Bad debt
1041 From account bad status Status ruim para conta de origem
1042 To account bad status Status ruim para conta de destino
1043 Cheque already posted Cheque already posted
1044 Information not on file Information not on file
1045 Card verification data failed Código de segurança inválido
1046 Amount not found Amount not found
1047 PIN change required Troca de senha necessária
1048 New PIN invalid Nova senha inválida
1049 Bank not found Bank not found
1050 Bank not effective Bank not effective
1051 Customer vendor not found Customer vendor not found
1052 Customer vendor not effective Customer vendor not effective
1053 Customer vendor account invalid Customer vendor account invalid
1054 Vendor not found Vendor not found
1055 Vendor not effective Vendor not effective
1056 Vendor data invalid Vendor data invalid
1057 Payment date invalid Data de pagamento inválida
1058 Personal identification not found Personal identification not found
1059 Scheduled transactions exist Scheduled transactions exist
1060 Transaction did not complete normally at terminal Transação não completou normalmente no terminal
1061 Transaction not supported by the card issuer Transação não suportada pelo emissor
1062 Cashback not allowed Troco fácil não disponível
1063 Cashback amount exceeded Limite de troco fácil excedido
1064 Declined, transaction processed offline by terminal Negado offline pelo terminal
1065 Declined, terminal unable to process offline Declined, terminal unable to process offline
1066 Declined, transaction processed offline after referral Declined, transaction processed offline after referral
1068 Identification number invalid Identification number invalid
1069 Driver number invalid Driver number invalid
1070 Vehicle number invalid Vehicle number invalid
1071 Digital certificate expired Digital certificate expired
1801 Can not Validate PIN Não é possivel Validar o PIN
1802 Encryption failed Falha na Criptografia
2000 Do not honour Não aprovado
2001 Expired card Cartão vencido
2002 Suspected fraud Suspeita de fraude
2003 Card acceptor contact acquirer Estabelecimento entrar em contato com o adquirente
2004 Restricted card Cartão com restrição
2005 Card acceptor call acquirer's security department Estabelecimento entrar em contato com departamento de segurança do adquirente
2006 Allowable PIN tries exceeded Tentativas de senha excedidas
2007 Special conditions Condições especiais
2008 Lost card Cartão perdido
2009 Stolen card Cartão roubado
2010 Suspected counterfeit card Suspeita de cartão falso
2011 Daily withdrawal uses exceeded Limite de quantidade de saques excedido
2012 Daily withdrawal amount exceeded Limite de valor para saque excedido
9100 One or more data element errors (see message error indicator) Erro no formato da mensagem
9102 Invalid transaction Transação inválida
9103 Re-enter transaction Re-enter transaction
9105 Acquirer not supported by switch Adquirente não suportado pelo switch
9106 Cutover in process Cutover in process
9107 Card issuer or switch inoperative Emissor fora de operação
9108 Transaction destination cannot be found for routing Não foi possível enviar a transação para o destinatário
9109 System malfunction Erro no sistema
9110 Card issuer signed off Emissor se desconectou
9111 Card issuer timed out Emissor não respondeu em tempo
9112 Card issuer unavailable Emissor indisponível
9113 Duplicate transmission Transmissão duplicada
9114 Not able to trace back to original transaction Não foi possível encontrar a transação original
9115 Reconciliation cutover or checkpoint error Reconciliation cutover or checkpoint error
9116 MAC incorrect MAC incorreto
9117 MAC key sync error Erro de sincronização de chave de MAC
9118 No communication keys available for use Nenhuma chave de comunicação disponível
9119 Encryption key sync error Erro de sincronização de chave de encriptação
9120 Security software/hardware error – try again Erro de segurança de software/hardware, tente novamente
9121 Security software/hardware error – no action Erro de segurança de software/hardware
9122 Message number out of sequence Número da mensagem fora de sequência
9123 Request in progress Requisição em progresso
9124 Invalid security code Código de segurança inválido
9125 Database error Erro no banco de dados
9128 Customer vendor format error Customer vendor format error
9132 Recurring data error Erro nos dados de recorrência
9133 Update not allowed Atualização não permitida
9350 Violation of business arrangement Violação de acordo comercial
9999 Other errors Erro não especificado
UNPR Rejection Não Foi possível processar – Não foi possível processar a mensagem. Tente novamente.
IMSG Rejection Mensagem Invalida – A mensagem enviada possui um formato inválido.
PARS Rejection Erro na leitura da mensagem – Algum campo obrigatório não esta sendo enviado
SECU Rejection Segurança – Algum erro no processo de segurança. A chave de criptografia pode não estar presente no terminal.
INTP Rejection SAK Invalido – O SAK enviado não foi reconhecido
RCPP Rejection Destinatario Invalido – O local para aonde a mensagem foi enviada esta invalida
DPMG Rejection Mensagem Duplicada – Esta mensagem já foi recebida pela Stone.
VERS Rejection Protocolo – A versão do protocolo enviada não é suportada.
MSGT Rejection Tipo da Mensagem – o Message Type enviado não é reconhecido.
 
Suggest Edits

Glossário

 
Termo Definição
ATK Acquirer Transaction Key. É o campo que identifica a transação dentro da Stone. Também conhecido como NSU da Adquirente.
ITK Initiator Transaction Key. É um campo de controle da aplicação.
SAK Sales Affiliation Key. É a chave utiliza para transacionar com a Stone, também conhecida como número lógico.
 
Suggest Edits

FAQ - Perguntas e respostas

 

O que é Stone Online?

O Stone Online é uma API de autorização da Stone.
Ele possui a função de Autorizar, Capturar, Cancelar e Consultar transações, para utilização em plataformas de vendas on-line (E-Commerce)

Para quem é indicado?

O Stone Online é indicado para empresas que já possuem na sua estrutura serviços como: anti-fraude, tokenização, multi meios de pagamento, recorrência, etc.

Para parceiros que desejam, mas ainda não possuem estes serviços, a API mais indicada é a e-Stone.

Como eu posso acessar o ambiente de homologação?

Para acessar o ambiente de homologação você deve enviar um e-mail para o integracoes@stone.com.br com as seguintes informações:

  • O nome da empresa parceira que realizará transações na Stone;
  • O CNPJ da empresa;
  • Uma descrição sucinta do negócio parceiro (em uma frase);
  • E-mail para o qual a credencial deve ser enviada.

Como utilizar o ambiente de produção?

Para utilizar o ambiente de produção, é preciso já estar credenciado como um cliente da Stone.
Para solicitar o seu cadastro, envie um e-mail para o nosso time comercial — em ecommerce@stone.com.br —, para que possamos lhe auxiliar no processo de credenciamento.

Quais são as URLs de Produção e de Homologação?

Captura posterior ou imediata?

O nosso cliente pode optar por fazer captura imediata ou posterior dos valores de uma transação:

  • A captura imediata, como o nome sugere, significa que a transação segue o fluxo completo de autorização e confirmação da captura dos valores junto ao banco.
  • Já na captura posterior, você tem até sete dias para efetuar a confirmação de captura da transação junto ao banco, depois que ela é autorizada.

Tags não obrigatórias

Quando uma tag é opcional, ela não deve ser enviada. Caso ela seja enviada com o valor em branco, pode ocorrer um erro de validação de mensagem.