Introdução

Você está acessando o site de documentação e sandbox para integrar / consumir os serviços Stelo, uma provedora de meios de pagamento online que pertence à Elo Participações Holding (Banco do Brasil e Bradesco) e Cielo

A solução de integração disponível é o Checkout Transparente, que permite que o pagamento seja realizado no ambiente do seu site, ou seja, o comprador não é redirecionado para outro site, informando os dados de pagamento no ambiente do seu e-commerce.

checkout

Exemplo de loja virtual com checkout transparente

Público alvo

Este guia descreve como integrar-se e consumir os serviços transacionais expostos pela API Stelo.
É destinado a desenvolvedores familiarizados com integração HTTPS, RESTFul e JSON.

Estrutura

Nossos serviços de API usam a estrutura de endpoint RESTFul suportada pelo Stelo Application Gateway, plataforma segura para processamento online de transações de pagamento e valor agregado.

Todas as mensagens trocadas (request e response) seguem o formato JSON encoded em UTF-8 .

Canais suportados

E-Commerce - Sites de comércio eletrônico, onde o pagamento de produtos ou serviços é realizado no site, diretamente pelo comprador.

Recorrente - Quando o comprador autoriza o vendedor a processar um pagamento regularmente, estabelecendo as regras de valor e periodicidade. Para evitar estornos, o comerciante necessita obter uma formalização do comprador referente aos termos acordados sobre a recorrência (Exemplo: serviços de subscrição no valor X por um período Y).

Outros canais - Telemarketing, Automação..., onde o vendedor coleta as informações para pagamento e submete diretamente através de um canal encriptado TLS. (Modo de processamento síncrono).

Meios de pagamento suportados

Com a Stelo você disponibiliza para seus clientes as principais bandeiras, boleto e carteira digital Stelo.

cartoes

Entendendo o fluxo de uma transação

O fluxo de uma operação financeira de pagamento com cartão de crédito em uma loja online parece ser complicado, mas é muito mais simples do que se imagina.

sequenceDiagram Loja->>Stelo: Envia Json (Pagamento) Stelo->>Emissor: Solicita Autorização Emissor->>Stelo: Resposta da Autorização Stelo->>Loja: Recebe Json (Retorno do Pagamento)

Autorização

É a reserva do valor da cobrança pelo emissor do cartão (ainda não ocorreu a liquidação/captura, mas o linmite do cartão já foi sensibilizado). Esta reserva pode ser mantida por no máximo 5 dias. Caso não seja realizada a captura do valor reservado dentro deste período, a Stelo procede com o cancelamento desta reserva de valor automaticamente.

Captura

É o momento em que ocorre a confirmação do pagamento, isto é, onde o valor é liquidado. Esta ação de captura deve ser realizada dentro dos 5 dias limite, caso não seja executada, a transação é cancelada automaticamente e o valor autorizado é liberado. Nota: o valor capturado deve ser menor ou igual ao valor autorizado.

Cancelamento

Quando o vendedor deseja desfazer ou reembolsar determinado valor da transação. Ela pode ser de 3 tipos:

Desfazimento/Void: Ação iniciada pelo comerciante para cancelamento de uma transação com o status de autorizada. Neste caso, é possível desfazer a autorização e o portador do cartão não será debitado no fechamento da fatura.

Reversão/Reversal: Ação iniciada sistêmicamente pela Stelo para reversão de uma transação que sofreu timed out, por exemplo.

Reembolso/Refund: Cancelamento de uma transação já capturada. Neste caso, o portador do cartão sofrerá um débito na fatura e um crédito posterior. Geralmente, quando o cancelamento é realizado no mesmo dia da captura, é possível desfazer a solicitação de captura e proceder com um desfazimento da autorização, evitando o reembolso.

Feedback

Sua sugestão é muito importante para nós. Ajude a Stelo a melhorar a documentação e sandbox enviando seus comentários para integracao@stelo.com.br.

Boas Práticas

A Stelo recomenda fortemente que você siga as 8 práticas abaixo para obter uma melhor taxa de conversão e oferecer a melhor experiência de checkout ao seu cliente.

✔ Exibir a página de checkout através de um canal seguro TLS (versão 1.2 ou superior).

✔ Somente enviar transações no modo Server to Server (o navegador do usuário não deve ser usado para transmitir dados sensíveis, como por exemplo, informações do cartão).

✔ Somente enviar meios de pagamento suportados pela Stelo.

✔ Programe seu botão de pagamento para processar o evento UMA ÚNICA VEZ. (Múltiplos "clicks" podem resultar em transações duplicadas).

Validar o valor de cada campo informado pelo cliente em relação aos tipos de dados aceitos pela Stelo antes de iniciar o processamento.
Exemplo: Como o código de segurança do cartão (CVV2) aceita apenas dígitos e comprimento de 3 a 4 caracteres, garanta que a entrada do dado permita apenas dígitos e o comprimento suportado.

Se o campo não estiver devidamente formatado, não deixe a página de checkout. Realce e explique qual a inconsistência para que o cliente reentre a informação.

validacao

Alert Logo Deixar a página de checkout para iniciar o processamento do pagamento sem a certeza da integridade dos dados está no topo das razões de baixa conversão.

✔ Exibir uma caixa de mensagem ao cliente para que saiba que a transação foi iniciada e esta em processamento.

pagamento_loading

✔ Testar sua interface de checkout e rotinas de validação nos principais navegadores da web para garantir que funcionem corretamente e de forma responsiva. (desktop, mobile, tablet...)

navegadores

✔ Uma vez finalizada a transação, exibir uma mensagem de confirmação e enviar um e-mail ao comprador informando os dados do pedido, entrega e status do pagamento.

Arquitetura

A plataforma transacional da Stelo possibilita a captura de transações de pagamento e valor agregado de forma simples, segura e interoperável.

• A estrutura do serviço segue o padrão RESTFul através de mensagens JSON.

• O encode utilizado deve ser UTF-8.

• Toda comunicação deve ser estabelecida no modo Server to Server, via canal criptografado TLS (1.2 ou acima) , isto é, o navegador do cliente não deve participar do processamento da transação de pagamento.

• Elementos JSON que não possuem valor ou vazios não devem fazer parte da mensagem.

Chave Primária

A chave primária da transação é utilizada para garantir a unicidade das transações apresentadas neste documento.

É composta por: TerminalID + TransactionID.

O TransactionID segue o padrão case insensitive (caracteres minúsculos=maiúsculos) e deve ser um valor único, gerado por você, que não duplique para o mesmo TerminalID. Este ID será o identificador para execução de qualquer transação subsequente.

Exemplo: Ano(2)+Data Juliana(3)+MilisegundosDoDia(8)+ outro identificador (até 7) => 1700112345678ABCDEFG

Contextos

As transações disponíveis pela API Stelo estão agrupadas em 3 contextos.

Payments

Expõe transações relacionadas ao pagamento

Vault

Expõe transações relacionados à segurança

Services

Expõe outros tipos de transações de valor agregado

Todo o consumo das transações expostas pela Stelo resulta em um Abstract Response, que pode ser do tipo transação ou do tipo erro. Exemplo: Payment retorna um PaymentResponse ou Payment retorna um ErrorResponse

Erros

A API utiliza os próprios Códigos de Status HTTP para indicar sucesso ou falha da chamada. Em geral, os códigos iniciados com 2 indicam sucesso, os iniciados com 4 indicam erro (Ex: Falta de parâmetro obrigatório) e iniciados com 5 indicam erro interno nos servidores da Stelo.

Parâmetros de entrada inválidos (HTTP Status 400 Bad Request)


{
"Status": "FAILURE",
"ErrorData": {
"ResponseCode": "INCORRECT_DATA",
"DisplayResponseMessage":"Problema no processamento da transação. Por favor, aplique as devidas correções e tente novamente. Se persistir, contate a central de atendimento do estabelecimento",
"ErrorMessage":"TransactionID is required",
"HostDateTime":"2017-05-20T14:35:39-03:00"
            }
}

Exemplos de Erros

Caso sua aplicação informe algum dado incorreto ou fora do padrão esperado pela aplicação, será retornado uma mensagem informando o problema. Confira abaixo alguns erros que podem ser retornados:

HTTP 400 – Bad Request: Ocorre quando um ou mais dados foram encaminhados de forma incorreta ou fora do padrão.

HTTP 504 – Gateway timeout: Ocorre quando o serviço demora mais que o normal para responder.

HTTP 403 – Forbidden: Ocorre quando sua aplicação encaminhou uma credencial inválida ou inexistente.

Autorização

A API de pagamento possibilita desde a criação de um simples pagamento por cartão de crédito à implementação de esquemas de pagamento por 1-click, reembolso e pré-autorização (autorização com captura posterior).

Request

                        
{  
    "Language": "PT-BR",
    "TransactionID": "1234567890",
    "ReferenceTransactionID": "1234567890",
    "Action": "AUTHORIZATION",
    "Free": "Campo Livre para preencimento",
    "FraudAnalysisType": "FULL",
    "CustomerData":{  
    "DeviceFingerPrint": "FFFFFFFFFFFFFFFF",
    "Email": "email@lojamodelo.com.br",
    "BirthDate": "1991-01-20",
    "IP": "192.168.0.1",
    "TaxID":{  
    "FullName": "Nome Comprador",
    "Country": "BRA",
    "Type": "CNPJ",
    "ID": "12345678901230",
    "CollaboratorData":{  
    "FullName": "Nome Colaborador",
    "Country": "BRA",
    "Type": "CPF",
    "ID": "12345678909"
                 }
             },
    "PhoneList":[  
              {  
    "Type": "LANDLINE",
    "CountryCode": "55",
    "AreaCode": "11",
    "Number": "12345678"
              },
              {  
    "Type": "MOBILE",
    "CountryCode": "55",
    "AreaCode": "11",
    "Number": "912345678"
              }
          ],
    "BillingAddress":{  
    "Street": "Rua Exemplo",
    "Number": "100",
    "Complement": "Apartamento 123",
    "Neighborhood": "Centro",
    "ZipCode": "99999999",
    "City": "Cidade Exemplo",
    "State": "SP",
    "Country": "BRA"
          }
      },
    "PurchaseData" :{  
    "DateTime": "2016-10-16T10: 37: 44-03: 00",
    "OrderID": "IDdoPedido",
    "OrderDescription": "Descricao do pedido",
    "ItemList":[  
              {  
    "ID": "1234567",
    "Name": "Produto 1",
    "Quantity": "1",
    "Currency": "986",
    "Price": "1000"
              },
              {  
    "ID": "7654321",
    "Name": "Produto 2",
    "Quantity": "1",
    "Currency": "986",
    "Price": "1000"
              }
          ],
    "TotalAmount":{  
    "Currency": "986",
    "Total": "235000",
    "Details":{  
    "SubTotal": "200000",
    "Shipping": "50000",
    "Discount": "15000"
              }
          },
    "ShippingData":{  
    "ShippingBehavior": "DELIVERY",
    "ShippingBehaviorPriority": "FAST",
    "ShippingAddress":{  
    "Alias": "Minha Casa",
    "Street": "Rua Exemplo",
    "Number": "100",
    "Complement": "Apartamento 123",
    "Neighborhood": "Centro",
    "ZipCode": "99999999",
    "City": "Cidade Exemplo",
    "State": "SP",
    "Country": "BRA"
              }
          }
      },
    "NotificationData":{  
    "NotificationURL":{  
    "Callback": "https: //lojamodelo.com.br/notifica.html/ID123/"
    "PostOnStatus" :[  
    "CAPTURED",
    "CANCELED"
              ]
          },
    "BuyerNotificationEmail":{  
    "Email": "email@lojamodelo.com.br",
    "PostOnStatus":[  
    "CAPTURED",
    "CANCELED"
              ]
          }
      },
  "PaymentRequestData":{  
  "Card":{  
  "Product": "CREDIT",
  "CardData": "4444111122223333=1230",
  "CVV2Indicator": "1",
  "CVV2": "123",
  "InstallmentType": "MERCHANT",
  "Installments": "6",
  "Currency": "986",
  "Amount": "25000",
  "NameOnCard": "Nome no Cartão",
  "SoftDescriptor": "Loja Teste",
  "TerminalEntryCapability": "01",
  "CardEntryMode": "01",
  "ECI": "7",
  "TokenSettingData":{  
  "AccountID": "email@lojamodelo.com.br",
  "Exchange": "0",
  "ExpirationDateTime": "2030-11-19T09: 13: 41-02: 00",
  "Salt": "NomeDoDispositivo"
              }
          }
      }
  }

Campo Obrigatoriedade Formato Tamanho
Language

Campo que define o idioma no qual será retornada a resposta da transação.

Opcional LanguageType
TransactionID

Identificador da transação, único por estabelecimento.

Obrigatório ^([0-9A-Za-z-._]{1,20})$ 1..20
ReferenceTransactionID

Identificador da transação que está sendo referenciada.

Opcional ^([0-9A-Za-z-._]{1,20})$ 1..20
Action

Ação a ser realizada na transação e definida pelo estabelecimento.

Obrigatório ActionType
Free

Campo livre para preenchimento, disponível ao estabelecimento.

Opcional ^([0-9A-Za-zÀ-ú-_+=*.,;:/'´!|?@#$%&()º°ª®©äëïöüÄËÏÖÜ ]{1,128})$ 1..128
FraudAnalysisType

Campo que identifica o tipo de antifraude da transação. Nota: Este campo deverá ser enviado caso o estabelecimento deseje que a transação passe pela análise de fraude.

Opcional FraudAnalysisTypeType
CustomerData

Bloco de dados do comprador. Nota: Este bloco é obrigatório somente para transações com antifraude ou transações de boleto.

Condicional CustomerDataType
PurchaseData

Bloco que identifica os dados da compra.

Obrigatório PurchaseDataType
NotificationData

Bloco que indica o tipo de notificação pelo qual o estabelecimento optou. Nota: Caso este bloco seja enviado, ao menos um dos tipos de notificação (NotificationURL ou BuyerNotificationEmail) deve ser enviado.

Opcional NotificationDataType
ContainerSettingData

Bloco que identifica as configurações de um container de pagamento. Nota: Este bloco é relacionado ao Action CONTAINER.

Condicional ContainerSettingDataType
PaymentRequestData

Bloco que identifica os dados para pagamento. Nota: Este bloco é obrigatório para transações que gerem um pagamento. (Não deve ser enviado para transações CONTAINER).

Condicional PaymentRequestDataType

Response

                            
{  
    "Status": "AUTHORIZED",
    "PaymentResponseData":{  
    "Card":{  
    "AuthorizationData":{  
    "ResponseCode": "APPROVED",
    "DisplayResponseMessage": "Transação Aprovada",
    "NSU": "071675",
    "ApprovalCode": "123456",
    "IssuerResponseCode": "00",
    "Association": "VISA",
    "CardData": "************3333=1230",
    "Token": "60B649DD49AB50D7AE78B3205A5491EF3333",
    "Currency": "986",
    "Amount": "25000",
    "HostDateTime": "2017-04-12T19:45:05-03:00",
    "CaptureExpirationDateTime": "2017-04-17T19:45:05-03:00",
    "CancelExpirationDateTime": "2017-04-17T19:45:05-03:00"
                    }
                }
            }
}

Campo Obrigatoriedade Formato Tamanho
Status

Campo que indica o status da transação.

Obrigatório StatusType 1..50
PaymentResponseData

Bloco de dados referente à resposta da transação. Nota: Este bloco será retornado somente para transações de pagamento.

Condicional PaymentResponseDataType
AuthorizationData

Bloco de dados referente à resposta da autorização de uma transação de “Cartão”. Nota: Este bloco será retornado para toda transação de pagamento com cartão.

Condicional CardAuthorizationDataType

Verificação de Cartão

BETA

Também conhecida como transação “zero reais”, esta funcionalidade tem por objetivo verificar se um cartão está ativo, sem que qualquer valor seja autorizado.

                        
    "Action": "CARD_VERIFICATION",

Campo Obrigatoriedade Formato Tamanho
Action

Identificador da ação a ser realizada na transação, definida pelo estabelecimento.

Obrigatório ActionType

ActionType

Valor Descrição
AUTHORIZATION Somente autorização
SALE Captura automática
CARD_VERIFICATION Verificação dos dados do cartão
CONTAINER Criação de container de dados

Transação Garantida

A Transação Garantida oferece cobertura contra fraudes em pagamentos não autorizados pelo titular do cartão de crédito. Isto quer dizer que se a sua transação for elegível ao programa, as contestações geradas por motivo de fraude não serão debitadas da sua conta. Você passa a contar com uma tranquilidade adicional para realizar as suas vendas.

Para que sua transação se enquadre na Transação Garantida solicitamos a inclusão de um bloco HTML na tela de checkout e que alguns campos sejam enviados obrigatoriamente no request da criação do pedido.

Clique aqui e baixe o arquivo com as instruções.

O campo IDUNICO deve ser substituído sempre por um valor único nas ultimas 24 horas. Este IDUNICO deve ser enviado no campo DeviceFingerPrint do REQUEST para criar a transação.

                        
    "FraudAnalysisType": "FULL",

Campo Obrigatoriedade Formato Tamanho
FraudAnalysisType

Campo que identifica o tipo de antifraude da transação.
Nota: Este campo deverá ser enviado caso o estabelecimento deseje que a transação passe pela análise de fraude.

Opcional FraudAnalysisType

Caso os requisitos dispostos neste manual não sejam implementados a loja virtual passa automaticamente a não ter qualquer garantia em suas transações sendo estas integralmente repassada para a loja.

Captura

Captura é o momento em que ocorre a confirmação do pagamento, isto é, onde o valor é liquidado. Esta ação de captura deve ser realizada dentro dos 5 dias de limite, caso não seja executada, a transação é desfeita automaticamente e o valor "autorizado" é liberado. Nota: o valor liquidado deve ser menor ou igual ao valor autorizado.

Request

                        
{  
    "Language":"PT-BR",
    "Amount":"10000"
}

Campo Obrigatoriedade Formato Tamanho
Language

Campo que define o idioma no qual será retornada a resposta da transação.

Opcional LanguageType
Amount

Campo que identifica o valor da captura referente à transação.
Nota: O valor da captura deve ser menor ou igual ao valor da autorização.
Caso este campo não seja enviado, a captura será realizada no valor total da autorização (captura full).

Obrigatório Numérico (Int32) 1..9

Response

                        
{  
    "Status":"CAPTURED",
    "PaymentResponseData":{  
    "Card":{  
    "AuthorizationData":{  
    "ResponseCode":"APPROVED",
    "DisplayResponseMessage":"Transação Aprovada",
    "NSU":"071675",
    "ApprovalCode":"123456",
    "IssuerResponseCode":"00",
    "Association":"VISA",
    "CardData":"************3333=1230",
    "Token":"60B649DD49AB50D7AE78B3205A5491EF3333",
    "Currency":"986",
    "Amount":"50000",
    "HostDateTime":"2017-04-12T19:45:05-03:00",
    "CaptureExpirationDateTime":"2017-04-17T19:45:05-03:00",
    "CancelExpirationDateTime":"2017-04-17T19:45:05-03:00"
            },
    "CaptureData":{  
    "ResponseCode":"APPROVED",
    "DisplayResponseMessage":"Aprovada",
    "Currency":"986",
    "Amount":"10000",
    "HostDateTime":"2016-10-11T10:30:51-03:00",
    "CancelExpirationDateTime":"2016-10-16T10:30:51-03:00"
            }
        }
    }
}

Campo Obrigatoriedade Formato Tamanho
ResponseCode

Campo que indica o código de resposta referente à captura da transação.

Obrigatório ResponseCodeType
DisplayResponseMessage

Campo contendo mensagem amigável com instruções destinadas ao comprador referente à captura da transação (maior conversão).

Obrigatório ^([0-9A-Za-zÀ-ú./()" ]{1,128})$ 1..255
Currency

Campo que identifica a moeda utilizada na transação.

Condicional ISO 4217 – Numerico
(Apenas 986)
Amount

Campo que identifica o valor da captura da transação.

Condicional Numérico (Int32)
HostDateTime

Campo que indica a data e hora em que foi realizada a requisição de captura da transação.

Obrigatório Date time
(yyyy-MM-ddTHH:mm:sszzz)
CancelExpirationDateTime *Cartão

Campo que indica o prazo máximo para o envio da solicitação de cancelamento referente à transação.

Condicional Date time
(yyyy-MM-ddTHH:mm:sszzz)
URL *BOLETO

Campo contendo a URL com o boleto que foi gerado.

Condicional URL

Pagamento Recorrente

Esta funcionalidade oferece a possibilidade de indicar que determinada transação é fruto de uma recorrência. Este indicador é trafegado até o emissor, que tende a aumentar a taxa de aprovação para esta transação.

                        
    "RecurringType" : "MERCHANT",

Campo Obrigatoriedade Formato Tamanho
RecurringType

Campo que indica qual o tipo de recorrência da transação, caso a transação seja recorrente. Nota: Este campo não deve ser enviado caso a transação seja parcelada.

Opcional RecurringTypeType

Container

Esta funcionalidade possibilita o agrupamento de compras e pagamentos. Uma das aplicações é viabilizar o pagamento com mais de 1 cartão, referente à um mesmo pedido.

Request

                        
        {
    "Language": "PT-BR",
    "TransactionID": "1234567890",
    "Action": "CONTAINER",
    "Free": "Campo Livre para preencimento",
    "PurchaseData":{  
    "DateTime": "2017-04-18T19:45:05-03:00",
    "OrderID": "1234567890abcde",
    "OrderDescription": "Exemplo teste de Container",
    "ItemList":[  
                    {  
    "ID": "1234567",
    "Name": "Produto Stelo I ",
    "Quantity": "1",
    "Currency": "986",
    "Price": "1000"
                    },
                    {  
    "ID": "7654321",
    "Name": "Produto Stelo II",
    "Quantity": "1",
    "Currency": "986",
    "Price": "1000"
                    }
                ],
    "TotalAmount":{  
    "Currency": "986",
    "Total": "2115",
    "Details":{  
    "SubTotal": "2000",
    "Shipping": "500",
    "Discount" :"150"
                    }
                },
    "ShippingData":{  
    "ShippingBehavior": "DELIVERY",
    "ShippingBehaviorPriority": "FAST",
    "ShippingAddress":{  
    "Alias": "Minha Casa",
    "Street": "Rua Exemplo",
    "Number": "100",
    "Complement": "Apartamento 123",
    "Neighborhood": "Centro",
    "ZipCode": "99999999",
    "City": "Cidade Exemplo",
    "State": "SP",
    "Country": "BR"
                    }
                }
            },
    "NotificationData":{  
    "NotificationURL":{  
    "Callback": "https://lojamodelo.com.br/notifica.html/ID123/",
    "PostOnStatus":[  
    "CREATED",
    "OPENED",
    "CLOSED"
                    ]
                }
            },
 "ContainerSettingData":{  
 "ExpirationDateTime": "2017-04-20T19:45:05-03:00",
 "SearchIndex1": "Container exemplo",
 "SearchIndex2": "Container exemplo novo"
            }
        }
    
Campo Obrigatoriedade Formato Tamanho
Language

Campo que define o idioma no qual será retornada a resposta da transação.

Opcional LanguageType
TransactionID

Identificador da transação, único por estabelecimento.

Obrigatório ANS 1..20
Action

Identificador da ação a ser realizada na transação, definida pelo estabelecimento.

Obrigatório ActionType
PurchaseData

Bloco que identifica os dados da compra. Nota: Este bloco é obrigatório somente para transações com antifraude.

Obrigatório PurchaseDataType
NotificationData

Bloco que indica o tipo de notificação pelo qual o estabelecimento optou. Nota: Caso este bloco seja enviado, ao menos um dos tipos de notificação (NotificationURL ou BuyerNotificationEmail) deve ser enviado.

Opcional NotificationDataType
ContainerSettingData

Bloco que contém os dados de configuração do container. Nota: Este bloco é obrigatório somente para transações “Container”.

Obrigatório ContainerSettingDataType

Response

                            
{  
    "Status":"CREATED",
    "HostDateTime":"2017-04-20T19:45:05-03:00"
}
    
Campo Obrigatoriedade Formato Tamanho
Status

Campo onde é indicado o Status da transação.

Obrigatório StatusCode
HostDateTime

Campo que indica a data e hora em que foi realizada a requisição de autorização da transação.

Obrigatório Date time

(yyyy-MM-ddTHH:mm:sszzz)

Cancelamento

O Cancelamento é realizado quando deseja-se desfazer ou reembolsar determinado valor da transação. O Cancelamento pode gerar:

Desfazimento: ocorre quando cancelamos uma autorização, ou seja, é realizada a devolução do valor reservado na autorização.

Reembolso: ocorre quando cancelamos uma transação liquidada, ou seja, é realizada a devolução do valor já capturado (confirmado) de uma autorização.

Request

                        
{  
"Language":"PT-BR",
"Amount":"5000",
"Note": "Cancelamento do pedido"
}
            
            
Campo Obrigatoriedade Formato Tamanho
Language

Campo que define o idioma no qual será retornada a resposta da transação.

Opcional LanguageType -
Amount

Campo que identifica o valor do cancelamento referente à transação. Nota:
* O valor do cancelamento deve ser menor ou igual ao valor autorizado/capturado.
* Para autorização, somente é permitido o cancelamento no valor total.
* Caso este campo não seja enviado, o cancelamento será realizado no valor total da autorização/captura (cancelamento full).

Opcional Numérico 1..9
Note

Campo livre para que o estabelecimento possa adicionar algum dado adicional à solicitação de cancelamento.

Opcional ANS 1..128

Response

                            
{  
    "Status":"CANCELED",
    "PaymentResponseData":{  
    "Card":{  
    "AuthorizationData":{  
    "ResponseCode":"APPROVED",
    "DisplayResponseMessage":"Transação Aprovada",
    "NSU":"071675",
    "ApprovalCode":"123456",
    "IssuerResponseCode":"00",
    "Association":"VISA",
    "CardData":"************3333=1230",
    "Token":"60B649DD49AB50D7AE78B3205A5491EF3333",
    "Currency":"986",
    "Amount":"25000",
    "HostDateTime":"2017-04-12T19:45:05-03:00",
    "CaptureExpirationDateTime":"2017-04-17T19:45:05-03:00",
    "CancelExpirationDateTime":"2017-04-17T19:45:05-03:00"
},
    CaptureData":{  
    "ResponseCode":"APPROVED",
    "DisplayResponseMessage":"Aprovada",
    "Currency":"986",
    "Amount":"10000",
    "HostDateTime":"2017-04-18T19:45:05-03:00",
        "CancelExpirationDateTime":"2017-04-28T19:45:05-03:00"
         },
            "CancelData":[  
             {  
               "ResponseCode":"APPROVED",
               "DisplayResponseMessage":"Aprovada",
               "Currency":"986",
               "Amount":"5000",
               "Action":"REFUND",
               "HostDateTime":"2017-04-19T19:45:05-03:00",
               "Note":"Cancelamento do pedido"
             },
        {  
                "ResponseCode":"APPROVED",
                "DisplayResponseMessage":"Aprovada",
                "Currency":"986",
                "Amount":"5000",
                "Action":"REFUND",
                "HostDateTime":"2017-04-20T19:45:05-03:00",
                "Note":"Cancelamento do pedido"
                }
            ]
        }
    }
}
                
                

CardCancelDataType

Campo Obrigatoriedade Formato Tamanho
ResponseCode

Campo que define o idioma no qual será retornada a resposta da transação.

Obrigatório ResponseCodeType
DisplayResponseMessage

Campo contendo mensagem amigável com instruções destinadas ao comprador referente ao cancelamento da transação (maior conversão).

Obrigatório ANS
Currency

Campo que identifica a moeda utilizada na transação.

Condicional ISO 4217 – Numerico

(Apenas 986)

Amount

Campo que identifica o valor do cancelamento da transação.

Condicional N
Action

Campo que identifica a ação tomada referente à solicitação de cancelamento.

Condicional CancelActionType
HostDateTime

Campo que indica a data e hora em que foi realizada a requisição de cancelamento da transação.

Obrigatório Date time

(yyyy-MM-ddTHH:mm:sszzz)

Note

Campo que reflete a nota que pode ser enviada na requisição do cancelamento da transação.

Condicional ANS

Consultas Sistêmicas

Esta funcionalidade possibilita a consulta das transações enviadas pela Nova API Stelo, sendo que esta consulta poderá ser parametrizada de acordo com os filtros: Consulta ReferenceTransactionID, Free, Action, Status, SearchIndex1, SearchIndex2, startDateTime ou endDateTime.

Request

                        
curl "/api/Payments/{{TransactionID}}" -X GET \
-H "AccessKey: FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF" \
-H "TerminalID: 001234567890123000001" \
-H "PartnerID: 1234567890" \
-H "Accept: application/json; version=3.0.0"
    
Campo Obrigatoriedade Formato Tamanho
TransactionID

Identificador da transação, único por estabelecimento.

Obrigatório ANS 1..20
Consulta por filtros:
                            
curl "/Payments?ReferenceTransactionID=1287128713819&Free=Eu+sou+um+campo+Livre&Status=APPROVED&StartDateTime=120315&EndDateTime=130315&SearchIndex1=teste&SearchIndex2=teste&Action=SALE" -X GET \
-H "AccessKey: FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF" \
-H "TerminalID: 001234567890123000001" \
-H "PartnerID: 1234567890" \
-H "Accept: application/json; version=3.0.0"
    
Campo Obrigatoriedade Formato Tamanho
ReferenceTransactionID

Identificador da transação que está sendo referenciada.

Opcional ANS 1..20
Free

Campo livre para preenchimento disponível para o estabelecimento.

Opcional ANS 1..128
Action

Identificador da ação a ser realizada na transação, definida pelo estabelecimento.

Opcional ActionType
Status

Campo que indica o Status da transação.

Opcional StatusCode
SearchIndex1

Identificador do Container definido pelo estabelecimento. Nota: Este campo é opcional, mas poderá ser utilizado somente para transações de “Container”.

Opcional ANS 1..128
SearchIndex2

Identificador do Container definido pelo estabelecimento. Nota: Este campo é opcional, mas poderá ser utilizado somente para transações de “Container”.

Opcional ANS 1..128
StartDateTime

Especifica a data inicial do intervalo de pesquisa. Somente transações criadas a partir desta data serão retornadas.

Opcional Date time

(yyyy-MM-ddTHH:mm:sszzz)

EndDateTime

Especifica a data final do intervalo de pesquisa.

Opcional Date time

(yyyy-MM-ddTHH:mm:sszzz)

Tokenização

Esta funcionalidade é restrita e permite a substituição dos dados do cartão por um token, permitindo que o estabelecimento ofereça serviços atrelados ao armazenamento do cartão do portador, sem a necessidade de possuir certificação PCI. O token pode ainda ser diferente por cada canal em que ele será utilizado (aplicativo, site, entre outros).

Há ainda a possibilidade de se definir a data de validade para este token e a possibilidade de trocar determinado token que já tenha sido gerado.

                            
"TokenSettingData" : {
"AccountID": "email@lojamodelo.com.br",
"Exchange": "0"
"ExpirationDateTime": "2017-05-20T15:54:38-03:00"
"Salt": "DeviceName"
            }
    
Campo Obrigatoriedade Formato Tamanho
AccountID

Campo que indica o identificador do token.

Obrigatório ANS 1..60
Exchange

Campo que indica a solicitação de troca de um determinado token. Nota:
Se este campo não for enviado, a solicitação será considerada como a criação de um token para o cartão utilizado na transação.

Opcional Booleano
ExpirationDateTime

Campo que identifica a data e hora da expiração do token.

Opcional Date time

(yyyy-MM-ddTHH:mm:sszzz)

Salt

Campo que identifica a modalidade do token a ser gerado para o cartão utilizado na transação.

Opcional ANS 1..64

Consulta BIN

BETA

Esta funcionalidade restrita oferece a possibilidade do estabelecimento identificar a bandeira, tipo de produto (crédito ou débito) e banco emissor do cartão, permitindo que se otimize a aceitação e identificação do cartão no checkout da loja.

Request

                        
curl "/api/service/cardBin/{{BIN}}" -X GET \
-H "AccessKey: FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFF" \
-H "TerminalID:001234567890123000001" \
-H "PartnerID: 1234567890" \
-H "Accept: application/json; version=3.0.0"

Response

                            
{
"StatusCode": "AUTHORIZED",
"Association": "VISA",
"Product": "CREDIT",
"Domestic": "True",
"HostDateTime": "2016-10-11T10:35:51-03:00"
}

Campo Obrigatoriedade Formato Tamanho
Status

Campo onde é indicado o Status da transação.

Obrigatório StatusCode
Association

Campo que indica qual a bandeira referente ao BIN consultado.

Condicional AssociationType
Product

Campo que indica qual o produto referente ao BIN consultado.

Condicional ANS
Domestic

Campo que indica se o BIN consultado é doméstico.

Condicional Booleano
HostDateTime

Campo que indica a data e hora em que foi realizada a requisição de troca de chave transacional.

Obrigatório Date time

(yyyy-MM-ddTHH:mm:sszzz)

Descrição Dinâmina na Fatura

Esta funcionalidade é restrita e oferece a possibilidade de definir a descrição que aparece na fatura do portador por transação, visando permitir a identificação personalizada do estabelecimento ou vendedor a cada compra e também diminuir o índice de “não reconhecimento da compra” pelo portador

                        
"SoftDescriptor": "Loja Modelo",
    
Campo Obrigatoriedade Formato Tamanho
SoftDescriptor

Campo que identifica a descrição a ser apresentada na fatura do portador para a referida transação.

Opcional AN e espaço 1..13

Multi-Idiomas

Consiste em um campo retornado na resposta da transação, campo este que o estabelecimento poderá apresentar para o comprador buscando orientá-lo de forma mais assertiva quanto a ação em caso de uma negativa.

                        
"Language": "PT-BR",
    
Campo Obrigatoriedade Formato Tamanho
Language

Campo que define o idioma no qual será retornada a resposta da transação.

Opcional LanguageType -

IP White List

Esta funcionalidade permite adicionar um fator extra de segurança, possibilitando atrelar IPs do servidor do estabelecimento ao seu TerminalID. Uma vez feito isso, o envio de transações de qualquer IP que não esteja pré-definido será negado.

Caso necessite de mais informações, por favor entre em contato Através do e-mail integracao@stelo.com.br.

Troca de Chaves

Esta funcionalidade permite a criação de múltiplas chaves e permissões, de acordo com a necessidade do estabelecimento, suportando também sua troca online, visando atender as diferentes políticas e necessidades do negócio do estabelecimento.

Request

                        
{
KeyExchangeType: "MERCHANT"
}
                
            
Campo Obrigatoriedade Formato Tamanho
KeyExchangeType

Campo que indica qual o tipo de troca de chaves.

Obrigatório KeyExchangeTypeType -

KeyExchangeTypeType

Valor Descrição
MERCHANT Troca de chave do tipo “MERCHANT”

Response

                            
{
"Status": "AUTHORIZED",
"Merchant": {
            "AccessKeyOnHold": "03C53856998C04CAD02890A1230C1466B5E1D96D74F5027811FA565A32ED0AC2",
             }
"HostDateTime": "2016-10-11T10:30:51-03:00"
}
            
            
Campo Obrigatoriedade Formato Tamanho
Status

Campo onde é indicado o Status da transação.

Obrigatório StatusType
Merchant

Bloco de dados de resposta à solicitação de troca de chave.

Condicional AccessKeyOnHold
HostDateTime

Campo que indica a data e hora em que foi realizada
a requisição de troca de chave transacional.

Obrigatório Date time

(yyyy-MM-ddTHH:mm:sszzz)

AccessKeyOnHold

Campo Obrigatoriedade Formato Tamanho
AccessKeyOnHold

Campo que indica a nova chave transacional gerada e que está
aguardando utilização para efetivação da substituição da chave atual.

Obrigatório Hexadecimal 64

Notificação

Notificações são avisos que a Stelo envia para seu sistema ou para o comprador indicando que algum evento ocorreu e que sua atenção é necessária.

A Stelo oferece notificações de transações para permitir que você ou o comprador seja avisado automaticamente sempre que ocorrer uma mudança de status na transação. Integrando seu sistema com a funcionalidade de notificação, você terá ainda mais eficiência nas suas vendas.

A Stelo oferece duas alternativas para o recebimento de notificações:

1. Notificações por e-mail

O estabelecimento poderá solicitar que o comprador seja notificado via e-mail quando houver alteração no status da compra. Os status para notificação e o e-mail ao qual deverá ser enviada a notificação são parametrizáveis pelo estabelecimento no momento do envio da transação.

Exemplo:


"NotificationData": {
"BuyerNotificationEmail": {
"Email": "email@lojamodelo.com.br",
"PostOnStatus": ["CAPTURED", "CANCELED"]
                }
            }

Campo Obrigatoriedade Formato Tamanho
Email

Campo que indica o email do comprador a ser notificado.

Sim ANS 5..60
PostOnStatus

Campo que indica lista de status a serem notificados para o email do comprador.
Nota: Estes status são parametrizados pelo estabelecimento.

Sim PostOnStatusEmailType -
sequenceDiagram Stelo->>Sua caixa de emails: Envia um e-mail a cada alteração de status das transações

Você será informado por e-mail sempre que um pagamento for efetuado, ou o status da transação for alterado.

2. API de Notificação

O estabelecimento poderá definir uma URL de callback, no qual a Stelo realizará a notificação de acordo com a alteração de status da venda. Os status para notificação e a URL de callback são parametrizáveis pelo estabelecimento no momento do envio da transação.

Exemplo:

    
"NotificationData": {
"NotificationURL": {
"CallBack": "https://lojamodelo.com.br/notifica.html/ID123/",
"PostOnStatus": ["CAPTURED", "CANCELED"]
    	        }
            }

Campo Obrigatoriedade Formato Tamanho
Callback

Campo que indica a URL do estabelecimento a ser notificada.

Sim ANS 5..255
PostOnStatus

Campo que indica lista de status a serem notificados para o email do comprador.
Nota: Estes status são parametrizados pelo estabelecimento.

Sim PostOnStatusType
sequenceDiagram Stelo->>Sua Loja: POST/GET para URL informada Sua Loja->>Stelo: Realiza a consulta da transação Stelo->>Sua Loja: Retorna os dados da transação

Teste / Certificação

Para usar as APIs de Pagamentos em ambiente produtivo é necessário submeter-se ao processo de homologação Stelo.

Este processo tem como objetivo garantir que sua integração com a Stelo está performando corretamente, evitando assim transtornos no processo de pagamento.


Criar sua chave para teste e/ou certificação.


Suas Chaves Transacionais

Informações para Teste e Certificação

URL de Teste
Url API Teste/Certificação https://m1sandbox.stelo.com.br/api
Cartões de Teste
Associação Crédito Débito
Visa 4444 1111 2222 3333 N/A
MasterCard 5431 1111 1111 1111 N/A
Diners 3011 112222 3331 N/A
Elo 6363 6860 8297 0603 N/A
Amex 3764 111122 2233 N/A
Defaults do Ambiente de Teste
Parâmetro Crédito Débito
Timed out 45 segundos. N/A
Dias para Captura ou Cancelamento (Void) 1 dia a contar da data autorização. N/A
Dias para Estorno (Refund) 1 dia a contar da data captura. N/A
Notificação 60 segundos após o evento. N/A
Valor minimo de parcela 5.00(BRL) N/A

Simulação para Teste e Certificação

AUTORIZAÇÃO
Teste Como simular
Aprovar Preencher os últimos 2 dígitos do valor da autorização com 00.
Negar Preencher os últimos 2 dígitos do valor da autorização com um valor diferente de 00 e 11.
Timed out Preencher o valor da autorização com 999999.
Falhar Qualquer tag, conteúdo inválido ou transação fora da regra de negócio resultará em falha.
Transação Zero Reais
Teste Como Simular
Aprovar Qualquer número de cartão de teste
Negar 4444 3333 2222 1111
Transação Garantida (Prevenção e Risco)
Teste Como Simular
Aprovar Qualquer número de cartão de teste
Negar 4444 3333 2222 1111
CAPTURA
Teste Como simular
Aprovar

Captura Full

Capturar uma transação com o status AUTHORIZED.
Aprovar

Captura Parcial

Capturar uma transação com o status AUTHORIZED com valor menor que o autorizado.
Falhar Capturar uma transação com o status CAPTURED (já capturada). Qualquer tag, conteúdo inválido ou transação fora da regra de negócio resultará em falha.
CANCELAMENTO
Teste Como simular
Aprovar

Desfazimento de Autorização

Cancelar uma transação com status AUTHORIZED.
Aprovar

Estorno Full da Captura

Cancelar uma transação com o status CAPTURED, após 2 minutos da sua captura .
Aprovar

Estorno Parcial da Captura

Cancelar parcialmente uma transação com o status CAPTURED, após 2 minutos da sua captura.
Falhar Qualquer tag ou conteúdo inválido, transação fora da regra de negócio (transação já cancelada, etc) resultará em falha.

Use as informações acima para realizar todos os testes necessários antes de solicitar uma certificação.

Lista de requisitos

Ter uma conta sandbox com a ferramenta API habilitada.

Melhores práticas aplicada no checkout?

A integração foi realizada em ambiente de teste (sandbox) contemplando todos os cenários que serão usados em produção.

As informações solicitadas ao pagador atendem as informações obrigatórias para se processar um pagamento.

O pagador é informado com clareza sobre o valor total a ser pago, incluindo descontos e acréscimos.

O cliente é comunicado na interface, de forma discreta, que o pagamento será processado pelo Stelo. Clique aqui para baixar as imagens.

Já tenho uma conta Stelo em ambiente de produção. (Caso não possua, clique aqui e cadastre-se gratuitamente)

Legal já preenchi todos os requisitos e agora?

Clique aqui e preencha os dados da planilha e envie um e-mail para integracao@stelo.com.br solicitando a homologação.

Informações de Produção

URL
Url API Produção https://m1.stelo.com.br/api
Chaves de Produção
item E-Commerce
TerminalID Fornecido após a afiliação do comerciante por seu representante de vendas.
AccessKey Fornecido após a afiliação do comerciante por seu representante de vendas.
PartnerID * Requerido para plataformas/gateways Fornecido após o processo de certificação.

Segurança

A Stelo recomenda que qualquer lojista que armazene, processe ou trafegue dados de cartão de crédito em sua aplicação siga as normas do PCI Compliance e envie a Stelo seu certificado de conformidade PCI DSS.

Encriptação TLS End to End

O Todas as transações devem ser enviadas através de um canal criptografado TLS 1.2 (ou superior).

O Todas as mensagens JSON devem ser transmitidas pensamento um Server-To-Server Direct Post modo, ou seja, o navegador do usuário não deve ser usado para essa finalidade.

Dados sensíveis

O número do cartão é devolvido mascarado.

CVV2, PINBlock, KSN e outros dados sensíveis de acordo com PCI DSS nunca são devolvidos.

Qualquer outro dado sensível nunca é retornado pela Stelo.

Autenticação de transações

O AccessKey é fornecido pela Stelo e é exclusivo para cada TerminalID. Ele é usado para autenticar cada solicitação de transação e deve ser armazenado de forma SEGURA.

IPv4 Whitelist

Uma lista de IPv4 é uma lista de IPs de servidor autorizados a enviar transações de seu TerminalID.

Exemplo:

200.100.100.1;200.100.100.2 (apenas estes IPs são permitidos)

200.100.100.1-200.100.100.9 (todos os IPs nesta faixa são permitidos)

Tokenização

Como uma alternativa segura para armazenar o número do cartão no ponto de venda, a Stelo oferece um mecanismo de tokenização. O token pode ser armazenamento para utilização em compras subsequentes ou recorrentes, atendendo as melhores práticas e diretrizes de tokenização PCI DSS.

O token nunca é derivado dos dados do cartão, não seguem qualquer seqüencial e nunca podem ser revertidos, resultando em proteção para você e seus clientes.

Auditoria

A Stelo monitora e armazena todas as requisições e dumps transacionais, visando auditoria e ação proativa em qualquer tentativa de violação de regras e segurança.

Apêndice

Header

Campo Obrigatoriedade Formato Tamanho
AccessKey

Chave transacional única por TerminalID,
que tem a função de autenticar o estabelecimento no momento do envio da transação.

Obrigatório Hexadecimal 64
TerminalID

Identificador único do estabelecimento, que juntamente com a AccessKey
tem a função de autenticar o estabelecimento no momento do envio da transação.

Obrigatório Numérico 1..20
PartnerID

Identificador único por plataforma certificada e homologada tecnicamente pela Stelo.
Este campo é obrigatório para gateways e plataformas.

Condicional Numérico 10
ContentType

Identifica o tipo de conteúdo do corpo da requisição.

Obrigatório ContentTypeType -

ContentType

Valor Descrição
Application/JSON Tipo de conteúdo da requisição e da resposta (RFC 4627)
Version Versão da aplicação

LanguageType

Valor Descrição
PT-BR Português - BR
ES Espanhol
EN Inglês

ActionType

Valor Descrição
AUTHORIZATION Somente autorização
SALE Captura automática
CARD_VERIFICATION Verificação dos dados do cartão
CONTAINER Criação de container de dados

FraudAnalysisType

Valor Descrição
FULL Antifraude completo Stelo

CustomerDataType

Campo Obrigatoriedade Formato Tamanho
DeviceFingerPrint

Campo a ser preenchido com o código gerado pelo checkout do estabelecimento via javascript de risco. Nota: Este campo é obrigatório para transações com antifraude.

Condicional ANS 1..128
Email

Campo que identifica o e-mail do comprador.

Obrigatório ANS 5..60
BirthDate

Campo que identifica a data de nascimento do consumidor.

Opcional Date (ISO 8601)

yyyy-MM-dd

-
IP

Campo que identifica o IP pelo qual o comprador está realizando a compra.

Obrigatório IPv4 -
TaxID

Bloco de dados referente ao documento de identificação do comprador.

Obrigatório TaxIDType -
PhoneList

Bloco de dados de telefone do comprador. Nota: Este bloco é obrigatório para transações com antifraude ou transações de boleto (ao menos 1 telefone é requerido).

Condicional PhoneListType -
BillingAddress

Bloco de dados que identifica o endereço de cobrança do comprador. Nota: Este bloco é obrigatório para transações com antifraude ou transações de boleto.

Condicional BillingAddressType -

CardAuthorizationDataType

Campo Obrigatoriedade Formato Tamanho
ResponseCode

Campo que indica o código de resposta referente à operação.

Obrigatório ResponseCodeType 1..50
DisplayResponseMessage

Campo contendo mensagem amigável com orientação destinada ao comprador no caso de uma negativa (maior conversão).

Obrigatório ANS 1..255
NSU

Campo que indica o número sequencial único referente à transação.

Condicional Numérico 1..20
ApprovalCode

Campo que indica o código de aprovação referente à transação. Nota: Presente nas transações aprovadas com cartão.

Condicional Alfanumérico 6
IssuerResponseCode

Campo que indica o código de resposta do emissor referente à transação.

Condicional IssuerResponseCodeType 2
Association

Campo que indica a bandeira referente ao cartão utilizado na transação.

Condicional AssociationType 1..50
CardData

Campo que indica o cartão utilizado na transação (número do cartão será devolvido mascarado).

Condicional ANS 1..79
Token

Campo onde será retornado o token que tenha sido solicitado na requisição da transação.

Condicional Alfanumérico 1..68
Currency

Campo que identifica a moeda utilizada na transação.

Condicional ISO 4217 – Numerico

(Apenas 986)

-
Amount

Campo que identifica o valor da autorização da transação.

Condicional Numérico 1..9
HostDateTime

Campo que indica a data e hora em que foi realizada a requisição de autorização da transação.

Obrigatório Date time

(yyyy-MM-ddTHH:mm:sszzz)

-
CaptureExpirationDateTime

Campo que indica o prazo máximo para o envio da solicitação de captura referente à transação.

Condicional Date time

(yyyy-MM-ddTHH:mm:sszzz)

-
CancelExpirationDateTime

Campo que indica o prazo máximo para o envio da solicitação de cancelamento referente à transação.

Condicional Date time

(yyyy-MM-ddTHH:mm:sszzz)

-

ContainerSettingDataType

Campo Obrigatoriedade Formato Tamanho
ExpirationDateTime

Campo que identifica a data de expiração do container, parametrizado pelo estabelecimento.

Obrigatório Date time

(yyyy-MM-ddTHH:mm:sszzz)

-
SearchIndex1

Identificador do Container definido pelo estabelecimento. Nota: Este campo é opcional, mas poderá ser utilizado somente para transações de “Container”.

Opcional ANS 1..128
SearchIndex2

Identificador do Container definido pelo estabelecimento. Nota: Este campo é opcional, mas poderá ser utilizado somente para transações “Container”.

Opcional ANS 1..128

TaxIDType

Campo Obrigatoriedade Formato Tamanho
FullName

Campo que identifica o nome completo do comprador.

Obrigatório ANS 3..50
Country

Campo que identifica o país referente ao documento do comprador.

Obrigatório CountryType -
Type

Campo que identifica o tipo de documento do comprador.

Obrigatório TaxIDTypeType -
ID

Campo que identifica o número do documento do comprador.

Obrigatório Numérico 11 ou 14 (De acordo com o tipo de documento informado)
CollaboratorData

Caso o comprador seja uma pessoa jurídica, o tipo do documento é um CNPJ, para este caso, neste bloco há a possibilidade de se identificar o documento do colaborador que está realizando a compra pela empresa.

Opcional CollaboratorDataType -

CountryType

Tipo Descrição
BRA Brasil

TaxIdTypeType

TaxIDCountry Tipo Descrição
BRA CPF Documento tipo CPF
CNPJ Documento tipo CNPJ

CollaboratorDataType

Campo Obrigatoriedade Formato Tamanho
FullName

Campo que identifica o nome completo do colaborador.

Obrigatório ANS 3..50
Country

Campo que identifica o país referente ao documento do colaborador.

Obrigatório CountryType -
Type

Campo que identifica o tipo de documento do colaborador.

Obrigatório CollaboratorDataTypeType -
ID

Campo que identifica o número do documento do colaborador.

Obrigatório Numérico 11

CollaboratorDataTypeType

TaxIDCountry Tipo Descrição
BRA CPF Documento tipo CPF

PhoneListType

Campo Obrigatoriedade Formato Tamanho
Type

Campo que identifica o tipo da linha de telefone do comprador.

Obrigatório PhoneListTypeType -
CountryCode

Campo que identifica o código do país de origem do telefone do comprador.

Obrigatório ISO 3166 - Numerico -
AreaCode

Campo que identifica o código de área do telefone do comprador.

Obrigatório Numérico 2
Number

Campo que identifica o número do telefone do comprador.

Obrigatório Numérico 5..9

PhoneListTypeType

Valor Descrição
LANDLINE Telefone fixo
MOBILE Telefone celular

BillingAddressType

Campo Obrigatoriedade Formato Tamanho
Street

Campo que identifica a rua referente ao endereço de cobrança do comprador.

Obrigatório ANS 1..50
Number

Campo que identifica o número referente ao endereço de cobrança do comprador.

Obrigatório ANS 1..9
Complement

Campo que identifica o complemento referente ao endereço de cobrança do comprador.

Opcional ANS 1..50
Neighborhood

Campo que identifica o bairro referente ao endereço de cobrança do comprador.

Obrigatório ANS 1..50
ZipCode

Campo que identifica o CEP referente ao endereço de cobrança do comprador.

Obrigatório Numérico 1..8
City

Campo que identifica a cidade referente ao endereço de cobrança do comprador.

Obrigatório ANS 1..50
State

Campo que identifica o estado referente ao endereço de cobrança do comprador.

Obrigatório String 2..3
Country

Campo que identifica o país referente ao endereço de cobrança do consumidor.

Obrigatório ISO 3166-1 Alpha-3 3

PurchaseDataType

Campo Obrigatoriedade Formato Tamanho
DateTime

Campo que identifica a data e hora da compra.

Obrigatório Date time

(yyyy-MM-ddTHH:mm:sszzz)

-
OrderID

Campo que identifica o número do pedido referente à compra.

Opcional ANS 1..20
OrderDescription

Campo que identifica a descrição do pedido.

Opcional ANS 1..1024
ItemList

Bloco que identifica a descrição dos itens da compra. Nota: Este bloco é obrigatório para transações com antifraude.

Condicional ItemListType -
TotalAmount

Bloco que identifica os valores referente à compra.

Obrigatório TotalAmountType -
ShippingData

Bloco de dados de entrega da compra. Nota: Este bloco é obrigatório para transações com antifraude.

Condicional ShippingDataType -

ItemListType

Campo Obrigatoriedade Formato Tamanho
ID

Campo que identifica o ID ou SKU referente ao item da compra.

Opcional ANS 1..20
Name

Campo que identifica o nome referente ao item da compra.

Obrigatório ANS 1..255
Quantity

Campo que identifica a quantidade referente ao item da compra.

Obrigatório Numérico 1..3
Currency

Campo que identifica a moeda referente ao item da compra.

Obrigatório ISO 4217 – Numerico

(Apenas 986)

-
Price

Campo que identifica o valor unitário referente ao item da compra.

Obrigatório Numérico 1..9

TotalAmountType

Campo Obrigatoriedade Formato Tamanho
Currency

Campo que identifica a moeda referente à compra.

Obrigatório ISO 4217 – Numerico

(Apenas 986)

-
Total

Campo que identifica o valor total referente à compra.

Obrigatório Numérico 1..9
Details

Bloco que detalha o valor referente à compra.

Opcional DetailsType -

DetailsType

Campo Obrigatoriedade Formato Tamanho
SubTotal

Campo que identifica o subtotal referente à compra.

Obrigatório Numérico 1..9
Shipping

Campo que identifica o valor do frete referente à compra.

Obrigatório Numérico 1..9
Discount

Campo que identifica o valor de desconto referente à compra.

Opcional Numérico 1..9

ShippingBehavior

Campo Obrigatoriedade Formato Tamanho
ShippingBehavior

Campo que identifica o comportamento da entrega referente à compra.

Obrigatório ShippingBehaviorType -
ShippingBehaviorPriority

Campo que identifica a prioridade da entrega referente à compra. Nota: Caso este campo não seja enviado, a prioridade "Default" será considerada para a transação.

Opcional ShippingBehaviorPriorityType -
ShippingAddress

Bloco de dados referente ao endereço de entrega da compra. Nota: Este bloco é obrigatório de acordo com o que foi definido no campo “ShippingBehavior”.

Condicional ShippingAddressType -

ShippingBehaviorType

Valor Descrição
DELIVERY Compra com entrega
STORE_PICKUP Retirada em loja
NOT_APPLICABLE Não se aplica (sem entrega)

ShippingBehaviorPriorityType

Valor Descrição
FAST Entrega rápida
EXPRESS Entrega expressa
PRIORITY_EXPRESS Entrega com prioridade

ShippingAddressType

Campo Obrigatoriedade Formato Tamanho
Alias

Campo que identifica o tipo do endereço referente à entrega da compra.

Opcional ANS 1..50
Street

Campo que identifica a rua referente ao endereço de entrega da compra.

Obrigatório ANS 1..50
Number

Campo que identifica o número referente ao endereço de entrega da compra.

Obrigatório ANS 1..9
Complement

Campo que identifica o complemento referente ao endereço de entrega da compra.

Opcional ANS 1..50
Neighborhood

Campo que identifica o bairro referente ao endereço de entrega da compra.

Obrigatório ANS 1..50
ZipCode

Campo que identifica o CEP referente ao endereço de entrega da compra.

Obrigatório Numérico 1..8
City

Campo que identifica a cidade referente ao endereço de entrega da compra.

Obrigatório ANS 1..50
State

Campo que identifica o estado referente ao endereço de entrega da compra.

Obrigatório String 2..3
Country

Campo que identifica o país referente ao endereço de entrega da compra.

Obrigatório ISO 3166-1 Alpha-3 3

NotificationDataType

Campo Obrigatoriedade Formato Tamanho
NotificationURL

Bloco que identifica os parâmetros para notificação ao estabelecimento via URL. Nota: Este bloco é obrigatório caso o bloco BuyerNotificationEmail não seja enviado.

Condicional NotificationURLType -
BuyerNotificationEmail

Bloco que identifica os parâmetros para envio de notificação ao comprador via e-mail. Nota: Este bloco é obrigatório caso o bloco NotificationURL não seja enviado.

Condicional BuyerNotificationEmailType -

PostOnStatusType

Valor Descrição
AUTHORIZED Transação autorizada
AWAITING_PAYMENT Transação aguardando pagamento (apenas para boleto)
CAPTURED Transação capturada
CANCELED Transação cancelada
PARTIAL_CANCELED Transação parcialmente cancelada
IN_ANALYSIS Transação em análise
DECLINED Transação negada
CREATED Transação criada (apenas para Container)
OPENED Transação inciada (apenas para Container)
CLOSED Transação finalizada (apenas para Container)
NOT_CAPTURED Transação com captura expirada

CancelActionType

Valor Descrição
VOID Transação desfeita
REFUND Transação reembolsada
REVERSAL Transação revertida (sistêmico)

PostOnStatusEmailType

Valor Descrição
AWAITING_PAYMENT Transação aguardando pagamento (apenas para boleto)
CAPTURED Transação capturada
CANCELED Transação cancelada
PARTIAL_CANCELED Transação parcialmente cancelada
DECLINED Transação negada

PaymentRequestDataType

Campo Obrigatoriedade Formato Tamanho
Card

Bloco de dados para pagamento com cartão. Nota: Este bloco é obrigatório na ausência dos blocos Cash ou BankSlip.

Condicional CardPaymentRequestDataType -
BankSlip

Bloco de dados para pagamento com boleto. Nota: Este bloco é obrigatório na ausência dos blocos Card ou Cash.

Condicional BankSlipPaymentRequestDataType -
Cash

Bloco de dados para pagamento em dinheiro. Nota: Este bloco é obrigatório na ausência dos blocos Card ou BankSlip.

Condicional CashPaymentRequestDataType -

CardPaymentRequestDataType

Campo Obrigatoriedade Formato Tamanho
Product

Campo que identifica o tipo do produto do cartão.

Obrigatório ProductType -
CardData

Campo que identifica o número do cartão ou o token do cartão referente à compra.

Obrigatório ANS 12..79
CVV2Indicator

Campo referente à condição do CVV2 do cartão para a referida transação. Nota: Este campo é obrigatório (CVV2Indicator = 1), caso o campo CVV2 seja enviado.

Condicional CVV2IndicatorType -
CVV2

Campo que identifica o CVV2 do cartão. Nota: Este campo é obrigatório caso CVV2Indicator = 1 (Presente). Este campo não deve ser enviado caso CVV2Indicator não seja enviado ou seja diferente de ‘1’.

Condicional Numérico 3..4
InstallmentType

Campo que indica o tipo de parcelamento da transação. Nota: Este campo é obrigatório para transações parceladas. Este campo não deve ser enviado se a transação for recorrente.

Condicional InstallmentTypeType -
Installments

Campo que indica o número de parcelas da transação. Nota: Este campo é obrigatório para transações parceladas. Este campo não deve ser enviado se a transação for recorrente.

Condicional Numérico 1..2
Currency

Campo que indica a moeda utilizada na transação para realização do pagamento.

Obrigatório ISO 4217 – Numerico

(Apenas 986)

-
Amount

Campo que identifica o valor da transação para realização do pagamento.

Obrigatório Numérico 1..9
RecurringType

Campo que indica qual o tipo de recorrência da transação, caso a transação seja recorrente. Nota: Este campo não deve ser enviado caso a transação seja parcelada.

Condicional RecurringTypeType -
NameOnCard

Campo que identifica o nome descrito no cartão.

Opcional ANS 2..26
SoftDescriptor

Campo que identifica a descrição a ser apresentada na fatura do portador para a referida transação.

Opcional Alfanumérico e espaço 1..13
TerminalEntryCapability

Campo que indica a capacidade de entrada do terminal.

Obrigatório TerminalEntryCapabilityType -
CardEntryMode

Campo que indica o modo de entrada do cartão.

Obrigatório CardEntryModeType -
ECI

Campo que indica que a transação é do tipo e-commerce. Nota: Este campo é obrigatório para todas as transações e-commerce. Para transação recorrente este campo não deve ser enviado.

Condicional ECIType -
TokenSettingData

Bloco que identifica os dados referente à solicitação de criação/troca de token para o cartão utilizado na transação.

Opcional TokenSettingDataType -

CashPaymentRequestDataType

Campo Obrigatoriedade Formato Tamanho
Currency

Campo que indica a moeda utilizada na transação para realização do pagamento.

Obrigatório ISO 4217 – Numerico

(Apenas 986)

-
Amount

Campo que identifica o valor da transação para realização do pagamento

Obrigatório Numérico 1..9

BankSlipPaymentRequestDataType

Campo Obrigatoriedade Formato Tamanho
Currency

Campo que indica a moeda utilizada na transação para realização do pagamento.

Obrigatório ISO 4217 – Numerico

(Apenas 986)

-
Amount

Campo que identifica o valor da transação para realização do pagamento

Obrigatório Numérico 1..9

ProductType

Campo Descrição
CREDIT Transação de crédito

CVV2IndicatorType

Campo Descrição
0 CVV2 não informado
1 CVV2 presente
2 CVV2 ilegível
9 CVV2 ausente

InstallmentTypeType

Campo Descrição
MERCHANT Parcelado loja

RecurringTypeType

Campo Descrição
MERCHANT Recorrência controlada pela loja

TerminalEntryCapabilityType

Campo Descrição
01 Entrada manual / E-Commerce
02 Tarja magnética
03 Leitor de proximidade
04 EMV Chip (Com contato)
05 EMV Chip (Interface dupla – com contato e sem contato)

CardEntryModeType

Campo Descrição
01 Digitada - Cartão não presente (01)

ECIType

Campo Descrição
7 Transação sem autenticação

ResponseCodeType

Valor Descrição
APPROVED Aprovada
DECLINED Negada
EXPIRED Expirada
TIMED_OUT Timeout
IN_ANALYSIS Em análise
AWAITING_PAYMENT Aguardando Pagamento
UNEXPECTED_ERROR Erro inexperado
INCORRECT_DATA Dado incorreto
INVALID_CREDENTIAL Credencial inválida
INVALID_MESSAGE Mensagem inválida
MERCHANT_DISABLED Estabelecimento desabilitado
MISSING_DATA Dado faltante
DUPLICATE_TRANSACTION Transação duplicada
OPERATION_NOT_ALLOWED Operação não permitida
TRANSACTION_NOT_FOUND Transação não encontrada
TRANSACTION_NOT_SUPPORTED Transação não suportada
RULE_MISMATCH Regra incompatível
SYSTEM_UNAVAILABLE Sistema indisponível

AssociationType

Valor Descrição
VISA Transação Visa
MASTERCARD Transação MasterCard
DINERS Transação Diners
ELO Transação Elo
DISCOVER Transação Discover
AMEX Transação Amex
UNKNOWN Desconhecido

Status

Valor Descrição
CREATED Transação criada
AUTHORIZED Transação autorizada
DECLINED Transação negada
CAPTURED Transação capturada
NOT_CAPTURED Transação não capturada
CANCELED Transação cancelada
PARTIAL_CANCELED Transação parcialmente cancelada
IN_ANALYSIS Transação em análise
FAILURE Transação com falha
AWAITING_PAYMENT Transação aguardando pagamento
OPENED Transação iniciada (Container)
CLOSED Transação finalizada (Container)

Códigos de Retorno do Emissor

Código Definição Significado
00 Approved Transação Aprovada
01 Refer to card issuer Transação declinada. Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
02 Refer to card issuer, special condition Transação declinada. Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
03 Invalid merchant or service provider Transação declinada. Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
04 Pickup card Transação declinada. Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
05 Do not honor Transação declinada. Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
06 Error Problema no processamento, tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
07 Pickup card, special condition (other than lost/stolen card) Transação declinada. Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
08 Invalid CVV2 Transação declinada. Por favor, confira se o código de verificação do cartão está correto e tente novamente. Se persistir, contate a central de atendimento do cartão.
10 Partial Approved Transação Aprovada.
11 VIP Approval Transação Aprovada.
12 Invalid Transaction Transação declinada. Por favor, confirme se o tipo de cartão é compatível com o pagamento e tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
13 Invalid amount (currency field overflow) or amount exceeds maximum for card program Transação declinada. Valor da transação não suportado. Por favor, reentre utilizando um meio de pagamento alternativo ou contate a central de atendimento do estabelecimento.
14 Invalid account number (no such number) Transação declinada. Por favor, confirme se o número do cartão esta correto e tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
15 No such issuer Transação declinada. Por favor, confirme se os dados do cartão estão corretos e tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
21 No action taken Transação declinada. Por favor, tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
25 Unable to locate record in file Transação declinada. Por favor, tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
28 File temporarily not available for update or inquiry Transação declinada. Por favor, tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
30 Format error Transação declinada. Por favor, tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
39 No credit account Transação declinada. Por favor, confirme se o tipo de cartão é compatível com o pagamento e tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
41 Lost card, pick up (fraud account) Transação declinada. Por favor, contate a central de atendimento do cartão para maiores informações.
43 Stolen card, pick up (fraud account) Transação declinada. Por favor, contate a central de atendimento do cartão para maiores informações.
51 Not sufficient funds Transação declinada. Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
52 No checking account Transação declinada. Por favor, confirme se o tipo de cartão é compatível com o pagamento e tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
53 No savings account Transação declinada. Por favor, confirme se o tipo de cartão é compatível com o pagamento e tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
54 Expired card or expiration date is missing Transação declinada. Por favor, confirme se a data de validade do cartão esta correta e tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
55 Incorrect PIN or PIN missing Transação declinada. Por favor, confirme se a senha do cartão (PIN) esta correta e tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
57 Transaction not permitted to cardholder Transação não permitida. Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
58 Transaction not permitted on acquirer/terminal Transação não permitida pelo terminal. Por favor, contate a central de atendimento do estabelecimento ou reentre utilizando um meio de pagamento alternativo.
59 Suspected fraud Transação declinada. Por favor, contate a central de atendimento do cartão para maiores informações.
60 Card restriction Transação declinada. Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
61 Exceeds approval amount limit Transação declinada. Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
62 Restricted card (card invalid in this region or country) Cartão restrito na região. Por favor, contate a central de atendimento do cartão ou reentre utilizando outro cartão ou meio de pagamento alternativo.
63 Security violation (source is not correct issuer) Transação declinada. Por favor, confirme se os dados do cartão estão corretos e tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
64 Transaction does not fulfill AML requirement Transação declinada. Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
65 Exceeds withdrawal frequency limit Frequência de saque excedida. Por favor, contate a central de atendimento do cartão para maiores informações.
70 Contact card issuer Transação declinada Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
71 PIN not changed Transação declinada. Troca de senha não realizada. Por favor, contate a central de atendimento do cartão para maiores informações.
75 Allowable number of PIN entry tries exceeded Limite de tentativas excedido. Por favor, contate a central de atendimento do cartão para maiores informações.
76 Unable to locate previous message (no match on Retrieval Reference number) Transação declinada. Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
77 Previous message located for a repeat or reversal, but repeat or reversal data are inconsistent with original message Transação declinada. Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
78 "Blocked, first used"—The transaction is from a new cardholder, and the card has not been properly unblocked. Cartão pendente de desbloqueio. Por favor, solicite seu desbloqueio junto a central de atendimento do cartão e tente novamente.
79 Already reversed (by Switch) Transação declinada. Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
80 Visa transactions: credit issuer unavailable. Private label and check acceptance: Invalid date Transação declinada. Emissor do cartão temporariamente indisponível. Por favor, tente novamente. Se persistir, reentre utilizando um cartão emitido por outro emissor ou escolha um meio de pagamento alternativo.
81 Cryptographic error found in PIN Transação declinada. Por favor, confirme se os dados do cartão, senha estão corretos e tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
82 Negative CAM, dCVV, iCVV or CVV results Transação declinada. Por favor, confirme se o código de verificação e validade do cartão estão corretos e tente novamente. Se persistir, contate a central de atendimento do cartão.
85 No reason to decline a request for address verification, CVV2 verification, or a credit voucher or merchandise return Verificação do Cartão Aprovada.
86 Cannot verify PIN; for example, no PVV Transação declinada. Por favor, confirme se a senha (PIN) esta correta e tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
89 Ineligible to receive financial position information (GIV) Transação declinada. Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
91 Issuer unavailable or switch inoperative (STIP not applicable or available for this transaction) Transação declinada. Emissor do cartão não pode ser contatado. Por favor, tente novamente. Se persistir, reentre utilizando um cartão emitido por outro emissor ou escolha um meio de pagamento alternativo.
92 Financial institution or intermediate network facility cannot be found for routing (receiving institution ID is invalid) Transação declinada. Emissor do cartão não pode ser contatado. Por favor, tente novamente. Se persistir, reentre utilizando um cartão emitido por outro emissor ou escolha um meio de pagamento alternativo.
93 Transaction cannot be completed – violation of law Transação não pode ser completada. Por favor, tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
94 Duplicate transaction detected Transação não pode ser completada. Por favor, tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
96 System error Transação não pode ser completada. Por favor, tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
B2 Surcharge amount not supported by debit network issuer Transação declinada. Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
N0 Force STIP Transação declinada. Por favor, tente novamente. Se persistir, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
N3 Cash service not available Serviço de saque indisponível. Por favor, tente novamente mais tarde ou contate a central de atendimento do cartão para maiores informações.
N4 Cash request exceeds issuer or approved limit Transação excede limite. Por favor, contate a central de atendimento do cartão para maiores informações.
N5 Ineligible for resubmission Transação ilegível para resubmissão. Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
N7 Decline for CVV2 failure Transação declinada. Por favor, confira se o código de verificação do cartão está correto e tente novamente. Se persistir, contate a central de atendimento do cartão.
N8 Transaction amount exceeds preauthorized approval amoun Transação declinada. Por favor, contate a central de atendimento do cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
Q1 Card Authentication failed Transação declinada. Por favor, contate a central de atendimehto do seu cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.
R0 Stop Payment Order Transação declinada. Por favor, contate a central de atendimehto do seu cartão ou reentre utilizando um cartão ou meio de pagamento alternativo.

Glossário

• TerminalID

Identificador único do estabelecimento que, juntamente com a AccessKey, tem a função de autenticar o estabelecimento no momento do envio da transação.

• AccessKey

Chave transacional única por TerminalID, que tem a função de autenticar o estabelecimento no momento do envio da transação.

• TransactionID

Identificador da transação, único por estabelecimento.

• Transação de autorização

Uma transação de autorização sensibiliza o valor da cobrança no cartão do cliente (ainda não ocorreu a cobrança, mas o valor já está sensibilizado). Esta reserva pode ser mantida por no máximo 5 dias, caso não seja realizada a liquidação do valor reservado, ocorre o desfazimento desta reserva.

• Transação de captura

Uma transação de captura realiza a confirmação do pagamento, isto é, o valor inicialmente sensibilizado na autorização é liquidado. Esta ação de captura deve ser realizada dentro dos 5 dias, caso não seja executada, a transação é desfeita automaticamente e o valor "autorizado" é liberado.

• Transação de captura automática

Uma transação de captura automática realiza a liquidação da autorização automaticamente, não exigindo nenhuma ação adicional do estabelecimento comercial para a conclusão do pagamento.

• Transação de cancelamento

Uma transação de cancelamento é realizado quando deseja-se desfazer ou reembolsar determinado valor de uma transação.

• Desfazimento

Ocorre quando cancelamos uma autorização, ou seja, é realizada a devolução do valor sensibilizado no cartão.

• Reembolso

Ocorre quando cancelamento um transação liquidada, ou seja, é realizada a devolução do valor já capturado de uma autorização.

• Transação de verificação de cartão

Transação que verifica se um número de cartão é válido e ativado no banco emissor do titular do cartão. Ela permite executar uma transação com o valor = 0 (zero), o que significa que não há impacto no limite do cartão do portador e não necessita de nenhuma outra ação do estabelecimento comercial.

• Transação de container

Esta transação possibilita o agrupamento de compras e pagamentos. Uma das aplicações é viabilizar a gestão de pagamentos com mais de 1 cartão, referente à um mesmo pedido.

• Transação de Consulta

Esta transação possibilita a consulta das transações enviadas para a API Stelo, sendo que esta consulta poderá ser parametrizada com filtros específicos.

• Transação de troca de chaves

Uma transação realiza a troca online das chaves transacionais, visando atender as diferentes políticas e necessidades do negócio do estabelecimento.

• Transação parcelada

Uma transação parcelada identifica que o valor da compra será dividido em duas ou mais vezes.

• Transação recorrente

São transações referentes à planos/assinaturas, de cobrança periódica, com um acordo pré-estabelecido entre o estabelecimento que realiza a cobrança e o portador. Esta transação possui um indicador que oferece a possibilidade de identificar que determinada transação é fruto de uma recorrência. Este indicador é trafegado até o emissor, que tende a aumentar a taxa de aprovação para esta transação.

• Tokenização

A tokenização permite a substituição dos dados do cartão por um token, permitindo que o estabelecimento ofereça serviços atrelados ao armazenamento do cartão do portador, sem a necessidade de possuir certificação PCI.

• EMV / CHIP

EMV (Europay MasterCard Visa), é um padrão técnico para cartões de pagamento inteligentes e para terminais de pagamento/caixas eletrônicos que podem aceitá-los. Os cartões EMV são cartões inteligentes (também chamados de cartões de chip) que armazenam seus dados em circuitos integrados em vez de tarjas magnéticas. Eles podem ser cartões de contato que devem ser inseridos fisicamente (ou "mergulhados") em um leitor ou cartões sem contato que podem ser lidos em uma curta distância usando tecnologia de identificação por radiofreqüência. Os cartões de pagamento que cumprem o padrão EMV geralmente são chamados de cartões de chip e PIN ou de chip e assinatura, dependendo dos métodos de autenticação necessários para usá-los.

• Tarja magnética

A tarja magnética é a faixa preta localizada na parte de trás do seu cartão. Ela permite que os dados da conta do cartão sejam lidos através de um leitor magnético.

• CVV2

O CVV2 é um valor de três a quatro dígitos que é impresso na parte de trás do cartão.

• Descrição dinâmica na fatura (Soft Descriptor)

Permite ao comerciante configurar dinamicamente o "nome do vendedor" mais apropriado que aparecerá no extrato bancário do cliente. Seu objetivo é fornecer ao cliente as informações mais claras de onde a compra foi realizada e minimizar rejeições por não reconhecimento da compra.

• IP (Protocolo de Internet)

O endereço de protocolo da Internet (endereço IP) é um identificador numérico atribuído a cada dispositivo. O campo suporta IPv4 (32bits).

• UTF-8

UTF-8 é uma codificação que traduz todos os caracteres possíveis, em Unicode.

• Unicode

O Unicode é um padrão da indústria de computação para codificação consistente, representação e manipulação de texto expresso na maioria dos sistemas de escrita do mundo.

• HTTPS

O HTTPS (também chamado de HTTP sobre TLS, HTTP sobre SSL e HTTP Secure) é um protocolo para comunicação segura através da Internet.

• SSL

Secure Sockets Layer (SSL) é a tecnologia de segurança padrão para estabelecer um link criptografado entre um servidor web e um navegador, por exemplo. Este link garante que todos os dados passados ​​entre dois pontos permaneçam privados e integrais. Devido a falha de segurança de SSL, o sucessor Transport Layer Security (TLS) é o novo padrão de canal seguro.

• TLS

Transport Layer Security (TLS) é um protocolo que garante a privacidade entre as aplicações de comunicação e seus usuários na Internet. Quando um servidor e cliente se comunicam, o TLS garante que nenhum terceiro pode espantar ou manipular qualquer mensagem. TLS é o sucessor do Secure Sockets Layer (SSL).

Versão API

3.0.0

Lançamento da Nova API (Agosto/2017)

ativo

FUNCIONALIDADES

Transação Garantida

ativo

FUNCIONALIDADES

Transação Recorrente

ativo

FUNCIONALIDADES

Transação de Verificação de Cartão

beta

FUNCIONALIDADES

Consulta BIN

beta

FUNCIONALIDADES

Descrição Dinâmica na Fatura

ativo

FUNCIONALIDADES

Orientação Multi-Idiomas ao Comprador

ativo

FUNCIONALIDADES

Tokenização

ativo

FUNCIONALIDADES

Chaves Transacionais

ativo

FUNCIONALIDADES

Container

ativo

FUNCIONALIDADES

Consultas Sistêmicas

ativo

FUNCIONALIDADES

Notificação

ativo

Testando isso aqui

SandBox

Visando uma melhor experiência, agilidade e simplicidade para o integrador, o Sandbox Stelo inova oferencendo criação de mensagens dinâmicas, documentação e execução do teste, totalmente embutido na ferramenta.

Abaixo você consegue simular todas as nossas chamadas:

POST

Request

Headers

AccessKey:
TerminalID:
PartnerID:
Content-Type:

Body

cURL


                    
                

Response

Chamar API

Body


                    
                
POST

Request

Headers

AccessKey:
TerminalID:
PartnerID:
Content-Type:

Body

Transaction:

cURL


                    
                

Response

Chamar API

Body


                    
                
POST

Request

Headers

AccessKey:
TerminalID:
PartnerID:
Content-Type:

Body

Transaction:

cURL


                    
                

Response

Chamar API

Body


                    
                
GET

Request

Headers

AccessKey:
TerminalID:
PartnerID:
Accept:

Parameters

Transaction ID:
Status:
Start Date Time:
End Date Time:
Reference TransactionID:
Free:
Container Search Index1:
Container Search Index2:
Action:

cURL


                
            

Response

Chamar API

Body


                
            
POST

Request

Headers

AccessKey:
TerminalID:
PartnerID:
Content-Type:

Body

cURL


                        
                    

Response

Chamar API

Body


                        
                    
GET

Request

Headers

AccessKey:
TerminalID:
PartnerID:
Accept:

Body

CardBin:

cURL


                        
                    

Response

Chamar API

Body


                        
                    

voltar ao topo Voltar ao Topo