FAQ

O Client ID é uma sequência de números única que representa cada APP criada para consumir as APIs da Ame Digital.

O Token é uma chave que precisa ser associada a APP criada para consumir as APIs da Ame Digital. O Access Token é único de cada merchant, por exemplo eu tenho tenhos mais de uma loja e quero oferecer pagamento via Ame Digital. Então eu criarei minha APP (que terá seu Client ID único) e cada uma das minhas lojas terá o seu Access Token.

O Token funciona como uma “carteira de identidade”, sendo necessário para formar a chave de acesso para um parceiro se autenticar e acessar uma API.

Diretamente pelo Portal de Desenvolvedores, através do menu superior ‘Ferramentas’ > ‘Minhas APPs’ será possível visualizar seu client_id e client_secret. Ao clicar em ‘detalhes’ você obterá acesso ao access_token vinculado a este client_id.

Não encontra-se liberado a criação de chaves de acesso pelo Portal de Desenvolvedores. Com isso, para obter APPs de uso em Homologação e Produção, é necessário entrar em contato com o suporte [link de direcionamento para abertura de ticket] solicitando a criação e liberação de uso.
Após esta ação, o time de suporte retornará sua solicitação com os dados de credenciamento, guia de documentações e maiores informações de uso.

Para subir para produção é necessário passar por uma validação técnica. Uma vez que a validação técnica ocorreu sem nenhum problema, será validado com o time comercial da Ame se o contrato já foi assinado e tendo uma resposta positiva é enviado as novas credenciais de produção.

Não. Cada ambiente possui sua chave de acesso respectivamente, do qual Sandbox só podem chamar a URL de Sandbox e precisam ter suas chaves equivalentes, ou seja, APP e TOKEN liberados para o este ambiente, exclusivamente.

É necessário que você esteja cadastrado e logado no Portal de Desenvolvedores para realizar a abertura de um chamado. Logado em sua conta, no menu superior da página, clique em ‘Central de ajuda’ e escolha a opção ‘Suporte’.

É necessário que você esteja cadastrado e logado no Portal de Desenvolvedores para realizar a abertura de um chamado. Logado em sua conta, no menu superior da página, clique em ‘Central de ajuda’ e escolha a opção ‘Suporte’.

Infelizmente não conseguimos auxiliar nesses casos. Para isso recomendamos que entre em contato com o SAC pelo telefone 4003-2120.

Para inserir saldo em sua conta de testes você pode estar abrindo um chamado e solicitando a inserção. É preciso enviar nesse chamado o nome de quem usa o aplicativo, telefone cadastrado no APP de Homologação e CPF/CNPJ cadastrado no APP de Homologação.

Essa é a nomenclatura padrão para o Aplicativo de Homologação. Não se preocupe! Quando estiver em produção aparecerá o nome da sua APP.

O Webhook é uma aplicação utilizada para os testes. Com ela você consegue fazer testes do recebimento de callback e simular o fluxo completo de pagamentos.

Existe sim um endpoint ppara o cancelamento do QRCode, para isso é importante lembrar que essa opção não permite o cancelamento de uma ordem que já foi paga ou paga e capturada. Essa operação deve ser utilizada exclusivamente para ordens/qrcode que foram exibidos para o usuário, mas por algum motivo o mesmo desistiu da compra, escolheu outro meio de pagamento ou até mesmo o QRCode tenha expirado (a expiração do qrcode deve ser controlada por vocês, vocês podem inserir um contador em tela de 5 minutos e caso não receba no callback com a confirmação de pagamento, vocês efetuam a chamada desse endpoint solicitando o cancelamento do QRCode).

Ponto de atenção: antes de disparar o cancelamento de um qrcode, orientamos que seja feito uma consulta no callback de vocês para certificar-se de que vocês não receberam a confirmação de pagamento.

GET/ordens

Inicialmente é necessário efetuar o GET/ordens para obter o ownerId.

curl --location --request GET
'http://api-amedigital.sensedia.com/hml/transacoes/v1/ordens/fa633331-f550-4849-ab8b-31cbb13e1d1f' \
--header 'client_id: 90c114d5-***********18e62aed8654' \
--header 'access_token: ba0f2dc1-************-15b1da83f340' \

DELETE/ordens

Em seguida deve ser feita a operação de DELETE/ordens, no qual deverá ser informado o orderID no endpoint e no campo customerId deve ser informado o ownerId obtido no ponto anterior.

curl --location --request DELETE
'http://api-amedigital.sensedia.com/hml/transacoes/v1/ordens/fa633331-f550-4849-ab8b-31cbb13e1d1f' \
--header 'client_id: 90c114d5-cc98-3247-94d0-18e62aed8654' \
--header 'access_token: 90c114d5-***********18e62aed8654' \
--header 'customerId: ba0f2dc1-************-15b1da83f340' \

O Callback deve ser definido junto ao seu analista comercial, ele irá te auxiliar nesse processo

Após a geração da ordem você pode estar utilizando o APP de Homologação da Ame para simular o pagamento, e com isso será disparado um callback com o qual você poderá realizar a captura do pagamento, efetivando ele no ambiente de testes.

Você pode solicitar a validação técnica abrindo um chamado, que nossa equipe irá te responder com sugestões de dias e horários.

A Conciliação Ame é uma API que disponibiliza as informações necessárias para que você possa consultar suas transações e realizar seu processo de conciliação. Os dados são disponibilizados diariamente, permitindo que através da integração com nossa API, mantenha uma visão clara sobre o ciclo de vida de suas transações.

As solicitações, dúvidas, problemas e reclamações podem ser direcionadas através da nossa plataforma de suporte na área logada aqui do nosso portal de desenvolvedores.

O horário de atendimento é de segunda a sexta das 8h às 17h, exceto em feriados.

O prazo para o primeiro atendimento é de até 2h.

Os dados disponibilizados contém todo o fluxo de uma transação, apresentando uma visão sobre as vendas realizadas e capturadas, a visão de liquidação destas vendas e os possíveis estornos que possam ter ocorrido. Esta visão é apresentada através da disponibilização de 4 arquivos diários: Sales, Financial, Refund e Cashout.

A API de Conciliação utiliza formato JSON e disponibiliza os dados em uma visão D-1, ou seja, disponibiliza diariamente as informações referentes às transações ocorridas no dia anterior.

Atualmente, a API disponibiliza todos os dados desde a sua data de cadastro na Ame.

No momento, nossa API entrega os dados somente em formato JSON.

Confira abaixo a relação das Conciliadoras que já possuem integração conosco em ambiente produtivo:

• AdaptiveSoft
• All Data
• Atos Capital
• BoaVista Tecnologia
• Concil
• Equals
• F360
• Redesoft
• SCOPE Con – NCR
• Sitef Conciliação
• Smart Concilia
• Tecnuv
• TrackCash
• Zaal

Após a solicitação recebida, é gerada uma chave de conciliação para o cliente e os dados devem ser liberados em até 2 dias úteis.

Apenas o access_token, que está vinculado a um CNPJ específico e o client_id da APP (aplicação).

O tempo para disponibilização é de D-1, ou seja, as transações efetuadas na data do dia 21/07 serão liberadas no dia 22/07. Lembrando que, a data parâmetro informada na consulta será do dia 21/07.

Conciliação sempre funciona com D+1, então dentro desse período você pode realizar a consulta.

A diferença está basicamente nas versões, sendo a V1 mais antiga e a Transaction mais nova.
Entre as 3 APIs o que mais muda é o modo de autenticação e endpoints, os requests permanecem quase os mesmos.

Abaixo está um exemplo de Payload da API de Transações:

curl --location --request POST
'http://api-amedigital.sensedia.com/hml/transacoes/v1/ordens' \
--header 'client_id: b468a965-6475-3845-aa46-9453b11eeaee' \
--header 'access_token: 7d6b5741-056c-3477-809c-bef50e9b63d8' \
--header 'Content-Type: application/json' \
--data-raw '{
	"title":"Pedido - Loja X",
	"description":"Pedido X",
	"amount":1000,
	"type":"PAYMENT",
	"attributes":{
		"transactionChangedCallbackUrl":"https://webhook.site/",
		"items":[
			{
				"ean":null,
				"sku":"1234322",
				"description":"Itens do Pedido",
				"amount":1000,
				"quantity":1
			}
		],
		"customPayload":{
			"isFrom":"LOJASEMANUELLE"
		},
		"address":[
			{
				"country":"BRA",
				"street":"Avenida Presidente Vargas",
				"number":"338",
				"complement":null,
				"neighborhood":"Jardim Califórnia",
				"postalCode":"14801000",
				"city":"Campinas",
				"state":"SP",
				"type":"BILLING"
			},
			{
				"country":"BRA",
				"street":"Avenida Presidente Vargas",
				"number":"338",
				"complement":null,
				"neighborhood":"Jardim Califórnia",
				"postalCode":"14801000",
				"city":"Campinas",
				"state":"SP",
				"amountValue":5,
				"type":"DELIVERY"
			}
		],
		"paymentOnce":true,
		"riskHubProvider":"SYNC",
		"origin":"ECOMMERCE"
	}
}'

O payload é modificado de acordo com o segmento da loja. Nesse explo é utilizado um de e-commerce, todos os campos descritos nele são campos obrigatórios.

O campo amount é definido em centavos. É muito importante se atentar a isso na hora de fazer a definição dele.