Introdução

Objetivo

• Realizar Transações de Pagamento: Com o APP iFood Pago, você poderá efetuar pagamentos usando diversos métodos de pagamento (Débito, Crédito, Pix, Voucher).
• Processar Estornos: Realizar estornos em transações quando necessário.
• Acompanhar as transações: Receber informações sobre o status das transações conforme eles ocorrem em seu aplicativo.

Como funciona

1. Iniciar uma transação a. Você deverá criar um deeplink com informações codificadas em Base64, como método de pagamento, valor da transação, ID e demais informações.b. A transação será capturada e processada pelo APP iFood Pago, que redirecionará para uma URL que você nos informará.
2. Processar um estorno a. Para realizar um estorno, você precisa gerar um link semelhante com o ID da transação a ser estornada e demais informações.b. O App do iFood Pago redirecionará para a URL que você fornecer, com o status da transação após completar o estorno.

Lista com Permissões Compatíveis com o Terminal

• Aplicativos que funcionam como "launchers" não são permitidos.
• Não é permitido usar a flag testOnly no arquivo AndroidManifest.xml.
• Não é permitido criar serviços de acessibilidade.
• O modo de depuração (debug) não está disponível nos terminais.
• Não há navegadores instalados nos terminais.
• Os terminais não têm Google Play Services instalados.
• Não é possível reverter para versões anteriores de um aplicativo; você pode apenas atualizá-lo ou desinstalá-lo.
• Prefira soluções que não usem WebView, mas o terminal é compatível com a versão 123.0.6312.0.

Compatibilidade do Aplicativo

Realizar venda

Chamada para o APP da Maquinona

https://portal.ifood.com.br/make-payment?content={conteudo_base64}

{
  "paymentMethod": "DEBIT", //STRING – DEBIT OR CREDIT OR PIX OR VOUCHER
  "value": 2000, //INTEIRO – VALOR EM CENTAVOS
  "transactionId": "", //STRING ID DA TRANSAÇÃO (PARA FINS DE CONTROLE)
  "tableId": "", //STRING NÚMERO DE MESA QUE ESTÁ TRANSACIONANDO
  "printReceipt": true, //BOOLEAN QUE DEFINE A IMPRESSÃO OU NÃO DO COMPROVANTE
  "urlToReturn": "", //NULLABLE
  "sendResultInSameIntent": false //BOOLEAN QUE DEFINE SE O RETONRO PARA O APP SERÁ VIA UMA NOVA INTENT OU VIA INTENT RESULT
}

Descrição dos Parâmetros

• paymentMethod: Método de pagamento que será processado. Valores possíveis: DEBIT, CREDIT, PIX, VOUCHER.
• value: Valor da transação em centavos. Exemplo: Para R$ 20,00, envie 2000.
• transactionId: ID da transação do seu sistema interno, retornado após a finalização do pagamento.
• tableId: Número da mesa que está realizando o pagamento. Este valor é opcional e retornado após a transação.
• printReceipt: Define se o comprovante será impresso pelo POS.
• urlToReturn: URL para onde o APP da Maquinona irá redirecionar após a transação, enviando as informações do resultado. Ex:
  • https://anota.ai/payment-result?result= ➔ Aqui é definido o deeplink que o APP da Maquinona irá chamar quando finalizar a transação. No exemplo acima, o dentro do result será enviado um JSON em Base64 com as informações definidas via contrato.
• sendResultInSameIntent: Define se o retorno para o APP que está chamando será via Intent Result.

Exemplo de Chamada

https://portal.ifood.com.br/make-payment?content=eyAicGF5bWVudE1ldGhvZCI6ICJERUJJVCIsICJ2YWx1ZSI6IDIwMDAwLCAidHJhbnNhY3Rpb25JZCI6ICJ0cmFuc2FjdGlvbklkUmV0b3JuYWRvIiwgInRhYmxlSWQiOiAidGFibGVJZCIsICJwcmludFJlY2VpcHQiOiB0cnVlLCAidXJsVG9SZXR1cm4iOiAiaHR0cHM6Ly9hbm90YS5haS5jb20uYnIvcGF5bWVudC1yZXN1bHQ/cmVzdWx0PSIsICJzZW5kUmVzdWx0SW5TYW1lSW50ZW50IjogZmFsc2V9

{
  "paymentMethod": "DEBIT",
  "value": 20000,
  "transactionId": "transactionIdRetornado",
  "tableId": "tableId",
  "printReceipt": true,
  "urlToReturn": "https://anota.ai.com.br/payment-result?result=",
  "sendResultInSameIntent": false
}

Retorno do APP da Maquinona

{
  "transactionIdAnotaAi": "", //STRING ID DA TRANSAÇÃO DO ANOTA AI
  "tableIdAnotaAi": "", //STRING NÚMERO DE MESA QUE ESTÁ TRANSACIONANDO
  "transactionIdAdyen": "", //nullable
  "status": "", //STRING - SUCCESS OR ERROR
  "deviceSerialNumber": "000158224211090",
  "cardBrand": "", //STRING - BANDEIRA DO CARTÃO UTILIZADO PARA REALIZAR O PAGAMENTO
  "errorReason": "" //STRING - RAZÃO DO POSSÍVEL ERRO DA TRANSAÇÃO
}

Descrição dos Parâmetros de Retorno

• transactionIdAnotaAi: ID da transação retornado do parâmetro transactionId.
• tableIdAnotaAi: Número da mesa retornado do parâmetro tableId.
• transactionIdAdyen: ID da transação processada na Adyen (opcional).
• status: Status da transação, podendo ser SUCCESS ou ERROR.
• deviceSerialNumber: Número de série do POS que realizou a transação.
• cardBrand: Bandeira do cartão utilizado na transação.
• errorReason: Razão do possível erro na transação.

Exemplo de Chamada

https://anota.ai/payment-result?result=eyJ0cmFuc2FjdGlvbklkQW5vdGFBaSI6InRyYW5zYWN0aW9uSWRBbm90YUFpIiwidGFibGVJZEFub3RhQWkiOiJ0YWJsZUlkQW5vdGFBaSIsInRyYW5zYWN0aW9uSWRBZHllbiI6IjFjNzRmMGU1LTNmNTctNGI4Ni05MGMxLTlkZjZmZmM4YmE3ZiIsInN0YXR1cyI6IlNVQ0NFU1MiLCAiZGV2aWNlU2VyaWFsTnVtYmVyIjogIjAwMDE1ODIyNDIxMTA5MCIsICJjYXJkQnJhbmQiOiAiTUMiLCAiZXJyb3JSZWFzb24iOiBudWxsfQ==

{
  "transactionIdAnotaAi": "transactionIdAnotaAi",
  "tableIdAnotaAi": "tableIdAnotaAi",
  "transactionIdAdyen": "1c74f0e5-3f57-4b86-90c1-2f6ffc8ba7f",
  "status": "SUCCESS",
  "deviceSerialNumber": "000158224211090",
  "cardBrand": "MC",
  "errorReason": null
}

Fluxo na Maquinona

1. O aplicativo do terceiro chama o deeplink do APP da Maquinona.
2. O APP da Maquinona processa a transação.
3. Após a transação, o APP da Maquinona redireciona para a URL especificada com o resultado da transação.

Realizar estorno

Chamada para o APP da Maquinona

https://portal.ifood.com.br/make-refund?content={conteudo_base64}

{
  "transactionIdAdyen": "125a0b07-160c-4365-b687-e3b8136851fd", //STRING
  "printReceipt": true, //BOOLEAN QUE DEFINE A IMPRESSÃO OU NÃO DO COMPROVANTE
  "urlToReturn": "https://anota.ai/refund-result?result=", //STRING
  "sendResultInSameIntent": false //BOOLEAN QUE DEFINE SE O RETONRO PARA O APP SERÁ VIA UMA NOVA INTENT OU VIA INTENT RESULT
}

Descrição dos Parâmetros

• transactionIdAdyen: ID da transação processada pela Maquinona e retornada para o seu sistema ao final da ação de pagamentotransação de pagamento.
• printReceipt: Define se o comprovante será impresso pelo POS.
• urlToReturn: URL para onde o APP da Maquinona irá redirecionar após a transação, enviando as informações do resultado. Ex:
  • https://anota.ai/refund-result?result= → Aqui é definido o deeplink que o APP da Maquinona irá chamar quando finalizar o estorno. No exemplo acima, o dentro do result será enviado um JSON em Base64 com as informações definidas via contrato.
• sendResultInSameIntent: Define se o retorno para o APP que está chamando será via Intent Result.

Exemplo de Chamada

https://portal.ifood.com.br/make-refund?content=eyJ0cmFuc2FjdGlvbklkQWR5ZW4iOiIxMjVhMGIwNy0xNjBjLTQzNjUtYjY4Ny1lM2I4MTM2ODUxZmQiLCJwcmludFJlY2VpcHQiOnRydWUsInVybFRvUmV0dXJuIjoiaHR0cHM6Ly9hbm90YS5haS9yZWZ1bmQtcmVzdWx0P3Jlc3VsdD0iLCAic2VuZFJlc3VsdEluU2FtZUludGVudCI6IGZhbHNlfQ==

{
  "transactionIdAdyen": "125a0b07-160c-4365-b687-e3b8136851fd",
  "printReceipt": true,
  "urlToReturn": "https://anota.ai/refund-result?result=",
  "sendResultInSameIntent": false
}

Retorno do APP da Maquinona

{
  "status": "", //STRING - SUCCESS OR ERROR
  "deviceSerialNumber": "000158224211090"
}

Descrição dos Parâmetros de Retorno

• status: Status da transação, podendo ser SUCCESS ou ERROR.
• deviceSerialNumber: Número de série do POS que realizou a transação.

Exemplo de Retorno

https://anota.ai/refund-result?result=eyJzdGF0dXMiOiAiU1VDQ0VTUyIsICJkZXZpY2VTZXJpYWxOdW1iZXIiOiAiMDAwMTU4MjI0MjExMDkwIn0=

{
  "status": "SUCCESS",
  "deviceSerialNumber": "000158224211090"
}

Impressão de arquivos

1. Na primeira etapa haverá uma requisição para obter um token de autorização para que as impressões possam ser realizadas.
2. Na segunda etapa, deverá ser realizada uma chamada para nossa API onde deverá ser enviado o token de autorização junto com a imagem em base64 que poderá ser impressa.

Chamada para o APP da Maquinona - Obter Autorização

https://portal.ifood.com.br/print-file?content={conteudo_base64}

{
  "integrationApp": "integrationApp", //STRING
  "urlToReturn": "https://anota.ai/print-result?result=", //STRING
  "sendResultInSameIntent": false //BOOLEAN QUE DEFINE SE O RETONRO PARA O APP SERÁ VIA UMA NOVA INTENT OU VIA INTENT RESULT
}

Descrição dos Parâmetros

• integrationApp: ID da transação processada pela Maquinona e retornada para o seu sistema ao final da ação de pagame.
• urlToReturn: URL para onde o APP da Maquinona irá redirecionar após a transação, enviando as informações do resultado. Ex:
  • https://anota.ai/print-result?result= → Aqui é definido o deeplink que o APP da Maquinona irá chamar quando finalizar o estorno. No exemplo acima, o dentro do result será enviado um JSON em Base64 com as informações definidas via contrato.
• sendResultInSameIntent: Define se o retorno para o APP que está chamando será via Intent Result.

Exemplo de Chamada

https://portal.ifood.com.br/print-file?content=eyJpbnRlZ3JhdGlvbkFwcCI6IkFub3RhQWkiLCJ1cmxUb1JldHVybiI6Imh0dHBzOi8vYW5vdGEuYWkvcHJpbnQtYXV0aG9yaXphdGlvbj9yZXN1bHQ9IiwgInNlbmRSZXN1bHRJblNhbWVJbnRlbnQiOiBmYWxzZX0=

{
  "integrationApp": "AnotaAi",
  "urlToReturn": "https://anota.ai/refund-result?result=",
  "sendResultInSameIntent": false
}

Retorno do APP da Maquinona

{
  "status": "", //STRING - SUCCESS OR ERROR
  "hash": "token",
  "createAt": "2025-03-23 18:13:51.070184",
  "deviceSerialNumber": "000158224211090"
}

Descrição dos Parâmetros de Retorno

• status: Status da transação, podendo ser SUCCESS ou ERROR.
• hash: Token que será utilizado para realizar a impressão do arquivo na segunda etapa;
• createAt: Hora de criação do token em nossos servidores (Vale lembrar que temos um fuso +3h, em relação ao horário de Brasília);
• deviceSerialNumber: Número de série do POS que realizou a transação.

Exemplo de Retorno

https://anota.ai/print-authorization?result=eyJzdGF0dXMiOiJTVUNDRVNTIiwiaGFzaCI6IjBmMDA2ZmIzNjRlMDY1NmExMDE4ZDMyZmRhZjQwYmMxOWMzOTZlYjE3YTE5ODc2NTAxZDcyNzExYzdlNGQxZjMiLCJjcmVhdGVBdCI6ICIyMDI1LTAzLTIzIDE4OjEzOjUxLjA3MDE4NCIsICJkZXZpY2VTZXJpYWxOdW1iZXIiOiIwMDAxNTgyMjQyMTEwOTAifQ==

{
  "status": "SUCCESS",
  "hash": "0f006fb364e0656a1018d32fdaf40bc19c396eb17a19876501d72711c7e4d1f3",
  "createAt": "2025-03-23 18:13:51.070184",
  "deviceSerialNumber": "000158224211090"
}

Chamada para API de Impressão

Request

POST:
https://movilepay-api.ifood.com.br/ifoodpay/mobile/api/print/file

{
  "authorizationHash": "TOKEN", //STRING
  "contentBase64": "IMAGEM EM BASE 64" //STRING
}

Descrição dos Parâmetros

• authorizationHash: Deverá ser utilizado o token obtido no passo anterior, onde o APP da Maquinona retornou;
• contentBase64: Imagem que deseja imprimir em Base64.
  • Vale ressaltar que a imagem deverá atender alguns requisitos da Adyen, quando a resolução como o padrão da imagem: Documentação sobre padrão de impressão da Adyen → Padrão de impressão da Adyen

Emulador para testes

1. Introdução

• O que é o Emulador "Small Phone API 30":
  • O emulador "Small Phone API 30" é uma ferramenta que simula um dispositivo móvel com Android 11, usada para testar a aplicação em um ambiente próximo ao de produção. Ele permite que os desenvolvedores validem a funcionalidade e a compatibilidade do aplicativo antes de implantá-lo nos dispositivos físicos.

2. Por que Usar o Emulador

• Benefícios para o Parceiro:
  • Testar a aplicação em um ambiente seguro e controlado.
  • Simular o comportamento do aplicativo como se estivesse rodando no dispositivo físico (smartPOS).
  • Detectar e corrigir problemas de compatibilidade e funcionalidade antecipadamente.

3. Download e Instalação do Android Studio

• Passo a Passo para Baixar o Android Studio:
  • Acesse o site oficial do Android Studio: Download Android Studio & App Tools - Android Developer
  • Faça o download da versão mais recente do Android Studio para o seu sistema operacional (Windows, macOS ou Linux).
  • Siga as instruções de instalação fornecidas no site para configurar o ambiente de desenvolvimento.

4. Configuração do Emulador "Small Phone API 30"

• Criando o Dispositivo Virtual (AVD):
  • Abra o Android Studio e navegue até o "AVD Manager" (Ferramentas > Gerenciador de Dispositivos Virtuais).
  • Clique em "Create Virtual Device" e selecione um dispositivo com tela pequena, por exemplo, "Small Phone".
  • Configure o sistema operacional Android para API 30 (Android 11).
  • Ajuste as configurações, como a orientação (portrait) e resolução de tela, conforme as especificações recomendadas.
  • Clique em "Finish" para concluir a configuração do emulador.

5. Testando a Aplicação no Emulador

• Passos para Instalar o APK no Emulador:
  • Inicie o emulador "Small Phone API 30" no Android Studio.
  • Arraste e solte o arquivo APK no emulador ou use a linha de comando para instalar o aplicativo.
  • Execute os testes e verifique o funcionamento conforme as diretrizes.

6. Orientações Adicionais

• Boas Práticas para o Uso do Emulador:
  • Testar diferentes cenários de uso e comportamentos do aplicativo.
  • Manter o emulador atualizado com as últimas configurações e imagens de sistema.
• Links Úteis:
  • Documentação oficial do Android Studio:Develop for Android | Android Developers
  • Guia sobre como usar o AVD Manager:Create and manage virtual devices | Android Studio | Android Developers .

7. Suporte

• Contato para Suporte Técnico:
  • Caso o parceiro encontre dificuldades para configurar ou usar o emulador, entre em contato com o time de suporte técnico através do e-mail integracaoifoodpago@ifood.com.br ou acesse o portal de ajuda.

• Contato para Suporte Técnico:
  • Caso o parceiro encontre dificuldades para configurar ou usar o emulador, entre em contato com o time de suporte técnico através do e-mail integracaoifoodpago@ifood.com.br ou acesse o portal de ajuda.

FAQ