Introdução

Ame Digital

Bem-vindo à documentação de integração da AME Digital!

Por meio de nossas ferramentas, nossos parceiros podem aumentar a conversão de negócios, fluxo de usuários dentro dos seus sites e gerenciar os pagamentos de maneira simples.

Nosso objetivo é ser mais do que uma plataforma de pagamentos, queremos gerar uma experiência de venda que seja intuitiva e agregue valor aos sites parceiros.

Essa documentação foi desenvolvida com o objetivo de facilitar e agilizar o processo de integração dos parceiros às nossas APIs. Essa documentação é complementada pela nossa referência da API em que apresentamos as chamadas e os resultados esperados.

Processos de Integração

É possível realizar a integração do seu negócio com a nossa plataforma de duas maneiras distintas.

Plataformas já integradas

Se você utiliza uma das plataformas que já estão integradas é muito simples começar a aceitar pagamentos com AME, verifique a lista de plataformas que já estão integradas e siga o processo que está descrito para habilitar AME como meio de pagamento.

Novas plataformas e Plataformas de desenvolvimento próprio

Caso você não utilize as plataformas listadas acima, pode integrar sua plataforma de e-commerce ou seu e-commerce de desenvolvimento próprio na nossa API, essa documentação e nossa referência da API irão lhe auxiliar durante esse processo.

Lembre-se: se você ainda não entrou em contato com nosso time comercial, fale conosco pelos seguintes e-mails para que possamos lhe enviar a proposta comercial que mais se adequa ao seu negócio.

-Novas plataformas de e-commerce: parceria.digital@amedigital.com

-Plataformas de desenvolvimento próprio: querovender@amedigital.com

Modelo de Autenticação e Chaves

A autenticação das APIs de transações da AME Digital é realizada através da informação do par de token, disponível na lista de APPs para o desenvolvedor. O par de token (client_id, access_token) deverá ser enviado no header do protocolo HTTP em cada requisição feita à API.

Homologação

As chaves de acesso ao ambiente de homologação podem ser solicitadas através do comercial ao através do menu de suporte na área logada deste portal.

Produção

HUBs: neste modelo de autentificação, o client_id será fixo por HUB e a variação será o access_token(fixo), cada estabelecimento/CNPJ possuirá seu proprio access_token.


API de Transação

Collection

Disponibilizamos as Collections, com todas as operações da API através dos arquivos:

Clique aqui para fazer o download.

Overview sobre Ordens

Ordens são eventos que permitem a execução de diversas funcionalidades relacionadas às transações dentro da AME. A criação de um transação, por exemplo, é realizada através da criação de uma ordem compra.

As ações relacionadas às Ordens são:

  1. Criar Ordem de Compra
  2. Cancelar Autorização da Ordem
  3. Capturar Ordem
  4. Criar Ordem de Estorno
Fluxograma 3

Criando uma ordem de compra

A criação de uma ordem de compra dentro da AME depende da interação entre a plataforma de venda, a AME Digital e o cliente que irá realizar a compra através do aplicativo AME.

Essa criação passa, obrigatoriamente, por duas etapas:

  1. Criação da ordem com base nas informações passadas pelo Sistema Parceiro
  2. Pagamento da ordem de compra através da leitura do QR Code pelo cliente com o app AME Digital
Criação de Ordem 2

Caso o Sistema Parceiro realize a solicitação da criação da ordem e apresente o QR Code, mas o cliente não realize a leitura do QR Code e confirme o pagamento, a criação da ordem não se concretizará e não será possível consultá-la.

1 - Criação da Ordem de Compra

No fluxo de criação de ordem, a primeira etapa é de responsabilidade do Sistema Parceiro, ele precisa passar os parâmetros necessários para que a AME retorne a URL de renderização do QR Code.

Sugerimos que a plataforma renderize o QR Code na tela para o cliente seguindo os padrões e informações que disponibilizamos nessa página.

Para as compras realizadas via mobile, iremos retornar o deepLink para que o cliente seja direcionado automaticamente para o aplicativo AME Digital.

POST /ordens
Parâmetros Necessários:
Header:

client_id:

access_token:

Request:
{
   "title":"Minha Loja.com",
   "description":"Pedido X",
   "amount":3000,
   "type":"PAYMENT",
   "currency":"BRL",
   "attributes":{
      "transactionChangedCallbackUrl":"https://webhook.site/8c285cf1-504e-4a69-8018-9dca72dd1958",
      "items":[
         {
            "ean":"22475411",
            "sku":"None",
            "amount":1000,
            "quantity":1,
            "description":"CAFE 180ML"
         },
         {
            "ean":"22475400",
            "sku":"None",
            "amount":1000,
            "quantity":1,
            "description":"REFRIGERANTE 350ML"
         },
         {
            "ean":"22475450",
            "sku":"None",
            "amount":1000,
            "quantity":1,
            "description":"AGUA S/ GAS 500ML"
         }
      ],
      "customPayload":{
         "isFrom":"MINHALOJA"
      },
      "address":[
         {
            "postalCode":"86047610",
            "street":"Rua Sete de Setembro",
            "number":"3",
            "complement":"APTO 2",
            "neighborhood":"Centro",
            "city":"Londrina",
            "state":"PR",
            "country":"BRA",
            "type":"BILLING"
         },
         {
            "postalCode":"86047610",
            "street":"Rua Sete de Setembro",
            "number":"3",
            "complement":"APTO 2",
            "neighborhood":"Centro",
            "city":"Londrina",
            "state":"PR",
            "country":"BRA",
            "amountValue":0,
            "type":"DELIVERY"
         }
      ],
      "paymentOnce":true,
      "riskHubProvider":"SYNC",
      "origin":"ECOMMERCE"
   }
}
Response:
{
   "id":"a11927a7-9d6c-4b6e-bfb4-5c6c249ad8a8",
   "title":"Minha Loja.com",
   "description":"Pedido X",
   "amount":3000,
   "type":"PAYMENT",
   "attributes":{
      "cashbackAmountValue":370,
      "transactionChangedCallbackUrl":"https://webhook.site/8c285cf1-504e-4a69-8018-9dca72dd1958",
      "items":[
         {
            "description":"CAFE BR MANIA CAPPUCCINO 180ML",
            "amount":1000,
            "quantity":1,
            "sku":"None"
         },
         {
            "description":"REFRI COCA COLA LT 350ML",
            "amount":1000,
            "quantity":1,
            "sku":"None"
         },
         {
            "description":"Abastecimento - Gasolina Aditivada",
            "amount":1000,
            "quantity":1,
            "sku":"None"
         }
      ],
      "customPayload":{
         "isFrom":"MINHALOJA"
      },
      "address":[
         {
            "country":"BRA",
            "number":"3",
            "city":"Londrina",
            "street":"Rua Sete de Setembro",
            "postalCode":"86047610",
            "neighborhood":"Centro",
            "state":"PR",
            "complement":"APTO 2",
            "type":"BILLING"
         },
         {
            "country":"BRA",
            "number":"3",
            "city":"Londrina",
            "street":"Rua Sete de Setembro",
            "postalCode":"86047610",
            "neighborhood":"Centro",
            "state":"PR",
            "complement":"APTO 2",
            "type":"DELIVERY",
            "amountValue":0
         }
      ],
      "paymentOnce":true,
      "riskHubProvider":"SYNC",
      "origin":"ECOMMERCE"
   },
   "qrCodeLink":"https://api.hml.amedigital.com/api/qrcode?qrcode=eyJ0eXBlIjoiUEFZTUVOVCIsIm9yZGVyX2lkIjoiYTExOTI3YTctOWQ2Yy00YjZlLWJmYjQtNWM2YzI0OWFkOGE4In0=",
   "deepLink":"amedigital://payment?qrcode=eyJ0eXBlIjoiUEFZTUVOVCIsIm9yZGVyX2lkIjoiYTExOTI3YTctOWQ2Yy00YjZlLWJmYjQtNWM2YzI0OWFkOGE4In0="
}


Payload de Criação de Ordem por Segmento

Abaixo temos alguns exemplos de payload de criação de ordem por segmento e deve ser implementado de acordo com o que a sua aplicação e ramo de negócio do merchant.



{
	"title":"Minha Loja.com",
	"description":"Pedido X",
	"amount":300000,
	"type":"PAYMENT",
	"currency":"BRL",
	"attributes":{
		"transactionChangedCallbackUrl":"https://webhook.site/1b636146-7899-4e71-962c-3ef753f5ddfc",
		"items":[
			{
					"ean": "22475411",
					"sku": "None",
					"amount": 670,
					"quantity": 1,
					"description": "CAFE 180ML"
				},
				{
					"ean": "22475400",
					"sku": "None",
					"amount": 990,
					"quantity": 1,
					"description": "REFRI COCA COLA LT 350ML" 
				},
				{
					"ean": "22475450",
					"sku": "None",
					"amount": 13000,
					"quantity": 1,
					"description": "Abastecimento - Gasolina Aditivada" 
				}
		],
		"customPayload":{
			"isFrom":"MeuPDV"
		},
		"paymentOnce":true,
		"riskHubProvider":"SYNC",
		"origin":"PDV"
	}
}
Propriedade Descrição Tipo Obrigatório

title Título da ordem string Sim
description Descrição da ordem string Sim
amount Valor da ordem em centavos int32 Sim
type Tipo de ordem criada. Enviar apenas PAYMENT string Sim
currency Moeda de cobrança da ordem. Aceito apenas BRL. string Sim
transactionChangedCallbackUrl URL de callback, no qual será enviado a confirmação de pagamento. string Sim
ean EAN do produto, se possuir deve ser enviado, caso não, enviar null Sim
sku SKU do produto ou código interno na base do merchant string Sim
amount Valor do item em centavos int32 Sim
quantity Quantidade de itens comprados, em unidade, caso seja combustivel ou qualquer produto em granel, enviar 1 int32 Sim
description Descrição do item string Sim
isFrom Nome da software house que está gerando a transação. string Sim
paymentOnce Quantas vezes o QRCode pode ser pago. Enviar TRUE - não permite pagar mais de uma vez neste modelo de integração. string Sim
riskHubProvider Enviar SYNC. string Sim
origin Identifica o tipo e integração. Exemplo: PDV, POS, E-COMMERCE string Sim
{
   "title":"Minha Loja.com",
   "description":"Pedido X",
   "amount":300000,
   "type":"PAYMENT",
   "currency":"BRL",
   "attributes":{
      "transactionChangedCallbackUrl":"https://webhook.site/1b636146-7899-4e71-962c-3ef753f5ddfc",
      "items":[
         {
                "ean": "22475411",
                "sku": "None",
                "amount": 670,
                "quantity": 1,
                "description": "CAFE BR MANIA CAPPUCCINO 180ML"
            },
            {
                "ean": "22475400",
                "sku": "None",
                "amount": 990,
                "quantity": 1,
                "description": "REFRI COCA COLA LT 350ML" 
            },
            {
                "ean": "22475450",
                "sku": "None",
                "amount": 13000,
                "quantity": 1,
                "description": "Abastecimento - Gasolina Aditivada" 
            }
      ],
      "customPayload":{
         "isFrom":"MeuPOS"
      },
      "paymentOnce":true,
      "riskHubProvider":"SYNC",
      "origin":"POS"
   }
}
Propriedade Descrição Tipo Obrigatório

title Título da ordem string Sim
description Descrição da ordem string Sim
amount Valor da ordem em centavos int32 Sim
type Tipo de ordem criada. Enviar apenas PAYMENT string Sim
currency Moeda de cobrança da ordem. Aceito apenas BRL. string Sim
transactionChangedCallbackUrl URL de callback, no qual será enviado a confirmação de pagamento. string Sim
ean EAN do produto, se possuir deve ser enviado, caso não, enviar null Sim
sku SKU do produto ou código interno na base do merchant string Sim
amount Valor do item em centavos int32 Sim
quantity Quantidade de itens comprados, em unidade, caso seja combustível ou qualquer produto em granel, enviar 1 int32 Sim
description Descrição do item string Sim
isFrom Nome da software house que está gerando a transação. string Sim
paymentOnce Quantas vezes o QRCode pode ser pago. Enviar TRUE - não permite pagar mais de uma vez neste modelo de integração. string Sim
riskHubProvider Enviar SYNC. string Sim
origin Identifica o tipo e integração. Exemplo: PDV, POS, E-COMMERCE string Sim
{
   "title":"Minha Loja.com",
   "description":"Pedido X",
   "amount":300000,
   "type":"PAYMENT",
   "currency":"BRL",
   "attributes":{
      "transactionChangedCallbackUrl":"https://webhook.site/1b636146-7899-4e71-962c-3ef753f5ddfc",
      "items":[
         {
                "ean": "22475411",
                "sku": "None",
                "amount": 670,
                "quantity": 1,
                "description": "Pagamento de nota de fiscal - 51080701212344000127550010000000981364112281"
            },
            {
                "ean": "22475400",
                "sku": "None",
                "amount": 990,
                "quantity": 1,
                "description": "Pagamento de boleto X"
            },
            {
                "ean": "22475450",
                "sku": "None",
                "amount": 13000,
                "quantity": 1,
                "description": "Pagamento de conta X" 
            }
      ],
      "customPayload":{
         "isFrom":"MeuSite.com"
      },
      "paymentOnce":true,
      "riskHubProvider":"SYNC",
      "origin":"BILLS"
   }
}
Propriedade Descrição Tipo Obrigatório

title Título da ordem string Sim
description Descrição da ordem string Sim
amount Valor da ordem em centavos int32 Sim
type Tipo de ordem criada. Enviar apenas PAYMENT string Sim
currency Moeda de cobrança da ordem. Aceito apenas BRL. string Sim
transactionChangedCallbackUrl URL de callback, no qual será enviado a confirmação de pagamento. string Sim
ean EAN do produto, se possuir deve ser enviado, caso não, enviar null Sim
sku SKU do produto ou código interno na base do merchant string Sim
amount Valor do item em centavos int32 Sim
quantity Quantidade de itens comprados, em unidade, caso seja combustível ou qualquer produto em granel, enviar 1 int32 Sim
description Descrição do item string Sim
isFrom Nome da software house que está gerando a transação. string Sim
paymentOnce Quantas vezes o QRCode pode ser pago. Enviar TRUE - não permite pagar mais de uma vez neste modelo de integração. string Sim
riskHubProvider Enviar SYNC. string Sim
origin Identifica o tipo e integração. Exemplo: PDV, POS, E-COMMERCE, BILLS string Sim
{
  "title": "Minha Loja.com",
  "description": "Evento: X",
  "amount": 3000,
  "type": "PAYMENT",
  "attributes": {
    "transactionChangedCallbackUrl": "https://webhook.site/1b636146-7899-4e71-962c-3ef753f5ddfc",
    "externalTransactionIdentifier": 1786158,
    "items": [
            {
                "ean": "22475411",
                "sku": "None",
                "amount": 1000,
                "quantity": 1,
                "description": "Rock Festival"
            },
            {
                "ean": "22475400",
                "sku": "None",
                "amount": 1000,
                "quantity": 1,
                "description": "Meet and Greet" 
            }
    ],
    "riskHubProvider": "SYNC",
    "paymentOnce": true,
    "ticket": {
      "eventName": "Rock Festival",
      "eventVenueLocation": "Rua Grecia - 500, 04308-970, Jabaquara, Sao Paulo, SP",
      "eventDate": 1613221200,
      "eventCategory": "ADULT"
    },
    "customPayload": {
      "isFrom": "MEUTICKETONLINE.COM"
    },
    "origin": "TICKET"
  }
}
Propriedade Descrição Tipo Obrigatório

title Título da ordem string Sim
description Descrição da ordem string Sim
amount Valor da ordem em centavos int32 Sim
type Tipo de ordem criada. Enviar apenas PAYMENT string Sim
currency Moeda de cobrança da ordem. Aceito apenas BRL. string Sim
transactionChangedCallbackUrl URL de callback, no qual será enviado a confirmação de pagamento. string Sim
ean EAN do produto, se possuir deve ser enviado, caso não, enviar null Sim
sku SKU do produto ou código interno na base do merchant string Sim
amount Valor do item em centavos int32 Sim
quantity Quantidade de itens comprados, em unidade, caso seja combustivel ou qualquer produto em granel, enviar 1 int32 Sim
description Descrição do item string Sim
isFrom Nome do emissor de ticket online. string Sim
paymentOnce Quantas vezes o QRCode pode ser pago. Enviar TRUE - não permite pagar mais de uma vez neste modelo de integração. string Sim
riskHubProvider Enviar SYNC. string Sim
origin Identifica o tipo e integração. Exemplo: TICKET, PDV, POS, E-COMMERCE, BILLS string Sim
eventName Nome do evento string Sim
eventVenueLocation Endereço do evento, conforme exemplo acima, string Sim
eventDate Data do evento, caso tenha mais de um dia, você poderá enviar a data iniciar. Unix Sim
eventCategory Categoria do evento. Exemplo: ADULT string Sim
{
  "title": "Minha Loja.com",
  "description": "Pedido X",
  "amount": 14990,
  "type": "PAYMENT",
  "currency": "BRL",
  "attributes": {
    "transactionChangedCallbackUrl": "https://webhook.site/1b636146-7899-4e71-962c-3ef753f5ddfc",
    "items": [
      {
                "ean": "22475411",
                "sku": "None",
                "amount": 670,
                "quantity": 1,
                "description": "CAFE BR MANIA CAPPUCCINO 180ML"
            },
            {
                "ean": "22475400",
                "sku": "None",
                "amount": 990,
                "quantity": 1,
                "description": "REFRI COCA COLA LT 350ML" 
            },
            {
                "ean": "22475450",
                "sku": "None",
                "amount": 13000,
                "quantity": 1,
                "description": "Abastecimento - Gasolina Aditivada" 
            }
    ],
    "customPayload": {
      "isFrom": "MinhaPlataforma"
    },
    "address": [
      {
        "postalCode": "86047610",
        "street": "Rua Sete de Setembro",
        "number": "3",
        "complement": "APTO 2",
        "neighborhood": "Centro",
        "city": "Londrina",
        "state": "PR",
        "country": "BRA",
        "type": "BILLING"
      },
      {
        "postalCode": "86047610",
        "street": "Rua Sete de Setembro",
        "number": "3",
        "complement": "APTO 2",
        "neighborhood": "Centro",
        "city": "Londrina",
        "state": "PR",
        "country": "BRA",
        "amountValue": 0,
        "type": "DELIVERY"
      }
    ],
    "paymentOnce": true,
    "riskHubProvider": "SYNC",
    "origin": "ECOMMERCE"
  }
}

Pagamento da Ordem de Compra


O pagamento da ordem de compra deve ser feito exclusivamente através do aplicativo de homologação que disponibilizamos durante a fase de integração. Clique aqui para maiores informações sobre como obter o aplicativo de homologação.

Após a criação da ordem, ela poderá assumir os seguintes status:

Status Descrição
AUTHORIZED Ordem foi criada com sucesso e o valor do pagamento está provisionado na carteira do cliente
Ordem aguarda captura ou cancelamento
DENIED Não foi possível realizar a criação da ordem. Esse status é apresentado quando o pagamento foi recusado por falta de saldo, quando o cartão está bloqueado, entre outros motivos.
CANCELED A transação foi autorizada e cancelada em seguida.
Esse status é apresentado quando o risco identifica um problema após a autorização ou quando ocorre um problema na URL de Callback.
CAPTURED Ordem foi criada e capturada com sucesso. A captura automática ocorreu pois não foi fornecida nenhuma URL de Callback pelo Sistema Parceiro.

Callback - Aviso de pagamento

Após a ordem ser paga pelo usuário, é enviado um aviso de confirmação de pagamento para a URL de callback informada no campo "transactionChangedCallbackUrl" na criação da ordem de compra.

Exemplo da chamada de callback:

{
   "id":"ab48af16-e2c4-40ca-8254-07609b27a183",
   "date":[
      2021,
      2,
      10,
      17,
      20,
      14,
      801275000
   ],
   "operationType":"DEBIT",
   "name":"Compra on-line",
   "title":"Minha Loja.com",
   "description":"Pedido X",
   "status":"AUTHORIZED",
   "type":"PAYMENT",
   "currency":"BRL",
   "cashType":"CASH",
   "amount":3000,
   "amountRefunded":0,
   "splits":[
      {
         "id":"c299a433-c4a6-431d-ac9d-fcb6e57455c0",
         "date":[
            2021,
            2,
            10,
            17,
            20,
            14,
            801288000
         ],
         "status":"AUTHORIZED",
         "cashType":"CASH",
         "amount":3000,
         "installments":null,
         "cardMasked":null,
         "cardBrand":null
      }
   ],
   "attributes":{
      "cashbackAmountValue":300,
      "transactionChangedCallbackUrl":"https://webhook.site/8c285cf1-504e-4a69-8018-9dca72dd1958",
      "items":[
         {
            "description":"CAFE 180ML",
            "amount":1000,
            "quantity":1,
            "ean":null,
            "sku":"1234322"
         },
         {
            "description":"REFRIGERANTE 350ML",
            "amount":1000,
            "quantity":1,
            "ean":"1234567890128",
            "sku":null
         },
         {
            "description":"AGUA S/ GAS 500ML",
            "amount":1000,
            "quantity":1,
            "ean":null,
            "sku":"128982"
         }
      ],
      "customPayload":{
         "isFrom":"MINHALOJA"
      },
      "address":[
         {
            "country":"BRA",
            "number":"3",
            "city":"Londrina",
            "street":"Rua Sete de Setembro",
            "postalCode":"86047610",
            "neighborhood":"Centro",
            "state":"PR",
            "complement":"APTO 2",
            "type":"BILLING"
         },
         {
            "country":"BRA",
            "number":"3",
            "city":"Londrina",
            "street":"Rua Sete de Setembro",
            "postalCode":"86047610",
            "neighborhood":"Centro",
            "state":"PR",
            "complement":"APTO 2",
            "type":"DELIVERY",
            "amountValue":0
         }
      ],
      "paymentOnce":true,
      "riskHubProvider":"SYNC",
      "origin":"ECOMMERCE",
      "orderId":"83dc8e33-d368-4566-a541-0ec72f6b7805"
   },
   "operationReference":null,
   "peer":null,
   "nsu":"662414801293",
   "debitWalletId":"7f522584-d6dd-419e-ba06-6fa658ed1278"
}

Cancelando uma ordem

A chamada de Cancelamento de Ordem, permite que o Sistema Parceiro cancele uma ordem que já foi autorizada mas ainda não foi capturada. Após o cancelamento, o saldo da compra que havia sido provisionado na carteira do cliente após a criação da ordem será automáticamente liberado.

Lembre-se de sempre cancelar uma ordem que não será capturada, caso contrário, o saldo ficará provisionado na carteira do cliente.

Abaixo, explicamos os parâmetros dispoíveis na chamada de cancelamento de ordem, maiores detalhes técnicos e de obrigatoriedade dos campos podem ser consultados aqui.

Parâmetro Descrição
id (PATH PARAM) ID de pagamento da ordem, que foi recebido na URL de Callback após o pagamento ter sido efetuado Atenção: aqui não deve ser utilizado o ID de criação da ordem

Após o cancelamento da ordem, ela poderá assumir o seguinte status:

Status Descrição
CANCELLED Ordem foi cancelada com sucesso

Lembre-se

Uma ordem só pode ser cancelada caso seu status seja AUTHORIZED. Para reverter ordens já capturadas cujo status é SUCCESS, verifique a página de estorno de ordem

Request:
DELETE /pagamentos/:idPagamento
Parâmetros Necessários:
Header:

client_id:

access_token:

Response:
 {
    "id": "4e0aff26-0cbc-41ae-8417-dfb404d86c02",
    "date": "2020-06-29T15:39:15.515929",
    "operationType": "DEBIT",
    "name": "Compra on-line",
    "title": "titulo da ordem de teste",
    "description": "descrição da ordem",
    "status": "CANCELED",
    "type": "PAYMENT",
    "currency": "BRL",
    "cashType": "CASH",
    "amount": 600,
    "amountRefunded": 0,
    "splits": [
        {
            "id": "f05f7856-5d66-4339-a767-016d34cb3bda",
            "date": "2020-06-29T15:39:15.516183",
            "status": "CANCELED",
            "cashType": "CASH",
            "amount": 600
        }
    ],
    "attributes": {
        "orderId": "e9e65d7f-0a10-4d13-be7d-7aca5a4a4467",
        "paymentOnce": false,
        "riskHubProvider": "SYNC",
        "customPayload": {
            "isFrom": "MAGENTO",
            "billingAddress": {
                "billingAddress": {
                    "country": "BRA",
                    "number": "123",
                    "city": "São Paulo",
                    "street": "lorem ipsum",
                    "postalCode": "01229010",
                    "neighborhood": "bairro do limoeiro",
                    "state": "SP",
                    "complement": "cs 1"
                }
            }
        },
        "items": [
            {
                "amount": 100,
                "quantity": 6,
                "description": "item de teste - sku do produto OU item"
            }
        ],
        "transactionChangedCallbackUrl": "https://iapi.hml.amedigital.com/sua/url/de/callback"
    },
    "peer": {
        "id": "d480e038-054c-4171-a406-b96805c96866",
        "name": "nome do merchant de teste,
        "type": "MERCHANT"
    },
    "nsu": 56355516192
}

Capturando uma ordem

A captura pode ser realizada para as ordens que possuem o status AUTHORIZED. Quando a captura da ordem é bem sucedida, o valor do pagamento que estava provisionado na carteira do cliente é processado e o valor a ser recebido é lançado na agenda do vendedor.

Nós aconselhamos que a captura seja feita automaticamente após a autorização da ordem, para isso, configure o seu sistema para que solicite a captura da ordem assim que a AME retornar o status AUTHORIZED.

Abaixo, explicamos os parâmetros dispoíveis na chamada de captura de ordem, maiores detalhes técnicos e de obrigatoriedade dos campos podem ser consultados aqui.

Parâmetro Descrição
id (PATH PARAM) ID de pagamento da ordem, que foi recebido na URL de Callback
Atenção: aqui não deve ser utilizado o ID de criação da ordem

Importante

Caso a URL de Callback não seja fornecida no momento de criação da ordem, a ordem será capturada automaticamente, ou seja, não haverá necessidade de chamar o endpoint de captura de ordem.

Após a captura da ordem, ela poderá assumir os seguintes status:

Status Descrição
Success Ordem capturada com sucesso.
O valor a ser recebido é lançado na agenda do vendedor.
Esse pode ser o último status da ordem, caso seja necessário, ela poderá ser estornada.
Request:
POST /pagamentos
Parâmetros Necessários:
Header:

client_id:

access_token:

{
    "idPagamento":  "98f0fda5-a95c-4d9c-ae82-e369ad0e8ab1"
}
Response:
{
    "id": "98f0fda5-a95c-4d9c-ae82-e369ad0e8ab1",
    "date": "2020-06-29T18:21:06.642483",
    "operationType": "CREDIT",
    "name": "Compra on-line",
    "title": "titulo da ordem de teste",
    "description": "descrição da ordem",
    "status": "SUCCESS",
    "type": "PAYMENT",
    "currency": "BRL",
    "cashType": "MULTIPLE",
    "amount": 500,
    "amountRefunded": 0,
    "splits": [
        {
            "id": "25461617-6bb8-4b4e-9ceb-0130e3872602",
            "date": "2020-06-29T18:21:06.642907",
            "status": "SUCCESS",
            "cashType": "CASH",
            "amount": 275
        },
        {
            "id": "dfa899c7-749d-43b1-91f0-1bfa937635a0",
            "date": "2020-06-29T18:21:06.643098",
            "status": "SUCCESS",
            "cashType": "CARD",
            "amount": 225,
            "installments": 1,
            "cardMasked": "449872######7549",
            "cardBrand": "VISA"
        }
    ],
    "attributes": {
        "orderId": "32059d60-46ab-4257-82f7-c85561dd2baa",
        "paymentOnce": false,
        "riskHubProvider": "SYNC",
        "customPayload": {
            "isFrom": "MAGENTO",
            "billingAddress": {
                "billingAddress": {
                    "country": "BRA",
                    "number": "123",
                    "city": "São Paulo",
                    "street": "lorem ipsum",
                    "postalCode": "01229010",
                    "neighborhood": "bairro do limoeiro",
                    "state": "SP",
                    "complement": "cs 1"
                }
            }
        },
        "items": [
            {
                "amount": 100,
                "quantity": 1,
                "description": "item de teste - sku do produto OU item"
            },
            {
                "amount": 200,
                "quantity": 2,
                "description": "item de teste - sku do produto OU item"
            }
        ],
        "transactionChangedCallbackUrl": "https://iapi.hml.amedigital.com/sua/url/de/callback"
    },
    "peer": {
        "id": "e7d3e610-7323-4ee7-bf3a-9154666191e2",
        "name": "Usuario de Testes",
        "type": "MERCHANT"
    },
    "nsu": 666066647128
}

Estornando uma ordem

O estorno da ordem pode ser realizado quando ela já foi capturada e seu status é SUCCESS. Para cancelar uma ordem que ainda não tenham sido capturada e que tenha o status AUTHORIZED é necessário realizar o cancelamento da ordem.

Um estorno pode ser feita de maneira integral, quando todo o valor da venda é estornado ou parcialmente.

É possível realizar vários estornos referentes a uma mesma ordem, entretanto a somatória dos valores estornados nunca poderá ser maior do que o valor total da venda.

Abaixo, explicamos os parâmetros dispoíveis na chamada de estorno de ordem, maiores detalhes técnicos e de obrigatoriedade dos campos podem ser consultados aqui.

Parâmetro Descrição
id (PATH PARAM) ID de pagamento da ordem, que foi recebido na URL de Callback após o pagamento ter sido efetuado
Atenção: aqui não deve ser utilizado o ID recebido na criação da Ordem
refundId (PATH PARAM) Id que deve ser gerado pelo sistema parceiro para identificar a transação de estorno, deve ser criado seguindo a lógica de UUID.
Esse ID deve ser único para cada requisição de estorno criada.
Sugerimos que a criação do UUID siga o padrão: silgadoecommerce-uuid
amount ID de pagamento da ordem, que foi recebido na URL de Callback após o pagamento ter sido efetuado
Atenção: aqui não deve ser utilizado o ID recebido na criação da Ordem

RefundId único

É possível gerar vários estornos parciais em uma mesma ordem, entretanto, é necessário que cada um desses estornos seja gerado com um refundId único. Caso o refundId já tenha sido utilizado, não será possível realizar o estorno.

Após o estorno da ordem, ela poderá assumir os seguintes status:

Status Descrição
SUCCESS Ordem foi estornada com sucesso, mas ainda existem valores que não foram estornados. Esse é o status de uma ordem que foi estornada parcialmente.
REFUNDED Ordem foi estornada com sucesso e não existem mais valores a serem estornados. Esse é o status de uma ordem que foi estornada integralmente.

Status REFUNDED

A ordem só terá seu status atualizado para REFUNDED caso o valor da ordem tenha sido estornado integralmente

Request:
PUT /pagamentos/:pagamentoId
Parâmetros Necessários:
Header:

client_id:

access_token:

{
    "amount": 100,
    "refundId": "e53799a2-aee2-43c0-bcc8-ee61e904e887"
}
Response:
{{
    "refundId": "ddef064b-5755-44c5-8637-36fa8ce2d6c3",
    "operationId": "d44b1e58-dde8-4b87-a90d-65d494ef66b7",
    "amount": 500,
    "status": "REFUNDED",
    "createdAt": "2020-06-30T17:01:09.553505",
    "refundedAt": "2020-06-30T17:01:09.617693"
}

API de Conciliação

Collection

Disponibilizamos as Collections, com todas as operações da API através dos arquivos:

Clique aqui para fazer o download.

Consulta arquivo Vendas

Nesse endpoint é possível consultar as vendas de um dia específico.

GET /vendas?data=AAAA-MM-DD

data* - Data de referência do arquivo.

Parâmetros Necessários:
Header:

client_id:

access_token:

Response:
{
  "data": { //Estrutura de dados
    "cnpjManager": "32778350000170", //CNPJ Ame Digital
    "nameManager": "AME DIGITAL BRASIL LTDA", //Razão Social Ame Digital
    "cnpjCustomer": "02314250000121", //CNPJ Vendedor
    "nameCustomer": "Empresa de teste", //Razão Social Vendedor
    "orders": [ //Estrutura do pedido     
      {
        "orderUuid": "265573ab-19b8-4570-a180-c9c5b47e8555", //ID do pedido
        "externalTransactionIdentifier": null, //ID do pedido na plataforma do vendedor
        "typeFile": "PURCHASE", //Tipo do arquivo ("PURCHASE")
        "createdAt": "2020-07-02T18:34:46-03:00", //Data de criação do pedido
        "totalAmountInCents": 16998, //Valor total do pedido
        "transactions": [ //Estrutura dos meios de pagamentos/parcelas
          {
            "transactionUuid": "017009ca-1cda-4f64-a7d7-9d527de9946d", //ID da transação
            "paymentUuid": "d274b55d-1aa7-40b9-b866-43453f98829f", //ID do pagamento
            "status": "CAPTURED", //Status da transação ("CAPTURED")
            "updatedAt": "2020-07-02T18:35:02-03:00", //Data de atualização
            "paymentMethod": "CASH", //Método de pagamento ("CREDIT_CARD"/"CASH")
            "operationType": "CREDIT", //Tipo de operação ("CREDIT")
            "grossAmountInCents": 5904, //Valor bruto
            "takeRateunit": "PERCENT", //Unidade de taxa de MDR ("PERCENT"/"CURRENCY")
            "takeRate": 184, //Taxa de MDR
            "takeRateAmountInCents": 108, //Taxa de MDR em centavos
            "takeRateUnitGateway": "CURRENCY", //Unidade de taxa de Gateway ("PERCENT"/"CURRENCY")
            "takeRateGateway": 0, //Taxa de Gateway
            "takeRateAmountInCentsGateway": 0, //Taxa de Gateway em centavos
            "netAmountInCents": 5796, //Valor liquido
            "releaseInstallment": 1,  //Número da parcela
            "numberOfInstallments": 1, //Quantidade de parcelas
            "releaseTime": 30, //Prazo de liquidação
            "scheduledFor": "2020-08-01T18:35:02-03:00" //Data de agendamento do release
          },
          {
            "transactionUuid": "b8814a6a-c284-4f2e-b569-5e0884fe7941", //ID da transação
            "paymentUuid": "2d41a40f-d98b-44a3-b947-4014bfa943a8", //ID do pagamento
            "status": "CAPTURED", //Status da transação ("CAPTURED")
            "updatedAt": "2020-07-02T18:35:02-03:00", //Data de atualização
            "paymentMethod": "CREDIT_CARD", //Método de pagamento ("CREDIT_CARD"/"CASH")
            "operationType": "CREDIT", //Tipo de operação ("CREDIT")
            "grossAmountInCents": 5547, //Valor bruto
            "takeRateunit": "PERCENT", //Unidade de taxa de MDR ("PERCENT"/"CURRENCY")
            "takeRate": 219, //Taxa de MDR
            "takeRateAmountInCents": 121, //Taxa de MDR em centavos
            "takeRateUnitGateway": "CURRENCY", //Unidade de taxa de Gateway ("PERCENT"/"CURRENCY")
            "takeRateGateway": 0, //Taxa de Gateway
            "takeRateAmountInCentsGateway": 0, //Taxa de Gateway em centavos
            "netAmountInCents": 5426, //Valor liquido
            "releaseInstallment": 1,  //Número da parcela
            "numberOfInstallments": 2, //Quantidade de parcelas
            "releaseTime": 30, //Prazo de liquidação
            "scheduledFor": "2020-08-01T18:35:02-03:00" //Data de agendamento do release
          },
          {
            "transactionUuid": "7899f2dc-83bf-4f8f-af4f-771888ea1fe4", //ID da transação
            "paymentUuid": "2d41a40f-d98b-44a3-b947-4014bfa943a8", //ID do pagamento
            "status": "CAPTURED", //Status da transação ("CAPTURED")
            "updatedAt": "2020-07-02T18:35:02-03:00", //Data de atualização
            "paymentMethod": "CREDIT_CARD", //Método de pagamento ("CREDIT_CARD"/"CASH")
            "operationType": "CREDIT", //Tipo de operação ("CREDIT")
            "grossAmountInCents": 5547, //Valor bruto
            "takeRateunit": "PERCENT", //Unidade de taxa de MDR ("PERCENT"/"CURRENCY")
            "takeRate": 219, //Taxa de MDR
            "takeRateAmountInCents": 121, //Taxa de MDR em centavos
            "takeRateUnitGateway": "CURRENCY", //Unidade de taxa de Gateway ("PERCENT"/"CURRENCY")
            "takeRateGateway": 0, //Taxa de Gateway
            "takeRateAmountInCentsGateway": 0, //Taxa de Gateway em centavos
            "netAmountInCents": 5426, //Valor liquido
            "releaseInstallment": 2,  //Número da parcela
            "numberOfInstallments": 2, //Quantidade de parcelas
            "releaseTime": 30, //Prazo de liquidação
            "scheduledFor": "2020-08-31T18:35:02-03:00" //Data de agendamento do release
          }
        ]
      }
    ]
  },
  "pageable": { //Estrutura de paginação
    "number": 0, //Pagina atual
    "hasNext": false //Indicador de existência de próxima pagina ("true"/"false")
  },
  "success": true,
  "msg": "Processed"
}


Observação:

Em ambiente de homologação os registros estão disponíveis entre 01/01/2020 até 15/10/2020. Caso você efetue um get fora deste período irá obter o retorno 202.

Em ambiente produtivo, caso você obtenha o retorno 202, é necessário aguardar uma hora para o processamento do arquivo, em seguida, você poderá efetuar um novo GET para obter os retornos.

Consulta arquivo de Estornos

Nesse endpoint é possível consultar os estornos de um dia específico..

GET /estornos?data=AAAA-MM-DD

data* - Data de referência do arquivo.

Parâmetros Necessários:
Header:

client_id:

access_token:

Response:
{
  "data": { //Estrutura de dados
    "cnpjManager": "32778350000170", //CNPJ Ame Digital
    "nameManager": "AME DIGITAL BRASIL LTDA", //Razão Social Ame Digital
    "cnpjCustomer": "02314250000121", //CNPJ Vendedor
    "nameCustomer": "Empresa de teste", //Razão Social Vendedor
    "orders": [ //Estrutura do pedido
      {
        "orderUuid": "e720c80b-cf46-4782-ad9b-2979add13221", //ID do estorno
        "referenceOrderUuid": "8d4caca7-d265-4a3c-b5b5-b521ad8c10de", //ID do pedido
        "externalTransactionIdentifier": null, //ID do pedido na plataforma do vendedor
        "typeFile": "REFUND", //Tipo do arquivo ("REFUND")
        "createdAt": "2020-06-14T14:36:03-03:00", //Data de criação do pedido
        "totalAmountInCents": 2997, //Valor total do pedido
        "transactions": [  //Estrutura dos meios de pagamentos/parcelas
          {
            "transactionUuid": "0e5a77ec-0ac8-482e-943c-42de7d479e73", //ID da transação de estorno
            "paymentUuid": "a5770485-a2cf-41eb-aa5c-ae3b1383aef6", //ID do pagamento
            "status": "REFUNDED", //Status da transação ("REFUNDED")
            "updatedAt": "2020-06-14T14:36:04-03:00", //Data de atualização
            "paymentMethod": "CASH", //Método de pagamento ("CREDIT_CARD"/"CASH")
            "operationType": "DEBIT", //Tipo de operação ("DEBIT")
            "netAmountInCents": 1717 //Valor do estornado do vendedor
          },
          {
            "transactionUuid": "5b641993-9377-4600-b0a9-71d664e9c085", //ID da transação de estorno
            "paymentUuid": "8c34a868-8964-466b-b2f5-f7a78206fdca", //ID do pagamento
            "status": "REFUNDED", //Status da transação ("REFUNDED")
            "updatedAt": "2020-06-14T14:36:04-03:00", //Data de atualização
            "paymentMethod": "CREDIT_CARD", //Método de pagamento ("CREDIT_CARD"/"CASH")
            "operationType": "DEBIT", //Tipo de operação ("DEBIT")
            "netAmountInCents": 1255 //Valor do estornado do vendedor
          }
        ]
      }
    ]
  },
  "pageable": { //Estrutura de paginação
    "number": 0, //Pagina atual
    "hasNext": false //Indicador de existência de próxima pagina ("true"/"false")
  },
  "success": true,
  "msg": "Processed"
}


Regra de priorização de estorno

Nossos estornos segue a prioridade abaixo:

  1. CASH
  2. CREDIT_CARD
Exemplo:

Venda no valor de R$ 1.000,00 nas seguintes formas de pagamento:

R$ 200,00 em CASH

R$ 800,00 em CREDIT_CARD

Cenário 1 - Estorno de R$ 150,00

Será feito um estorno de R$ 150,00 em CASH

Cenário 2 - Estorno de R$ 300,00

Será feito um estorno de R$ 200,00 em CASH e R$ 100,00 em CREDIT_CARD

Cenário 3 - Estorno de R$ 1000,00

Será feito um estorno de R$ 200,00 em CASH e R$ 800,00 em CREDIT_CARD

Regra de estorno para parcelas não liquidadas

Em caso estorno de vendas não liquidadas fazemos a aceleração de parcelas futuras, ou seja, antecipamos as parcelas futuras sem cobrar taxa de antecipação.

Exemplo:

Venda no dia 01/01/2020 no valor de R$ 300,00 com MDR de 3% em 3 parcelas:

Agenda futura

Parcela 1 agendada para 31/01/2020 no valor de R$ 97,00

Parcela 2 agendada para 01/03/2020 no valor de R$ 97,00

Parcela 3 agendada para 31/03/2020 no valor de R$ 97,00

Cenário 1 - Estorno de R$ 300,00 no dia 15/01/2020

Parcela 1 agendamento atualizado para 15/01/2020 no valor de R$ 97,00

Parcela 2 agendamento atualizado para 15/01/2020 no valor de R$ 97,00

Parcela 3 agendamento atualizado para 15/01/2020 no valor de R$ 97,00



Observação:

Em ambiente de homologação os registros estão disponíveis entre 01/01/2020 até 15/10/2020. Caso você efetue um get fora deste período irá obter o retorno 202.

Em ambiente produtivo, caso você obtenha o retorno 202, é necessário aguardar uma hora para o processamento do arquivo, em seguida, você poderá efetuar um novo GET para obter os retornos.

Consulta arquivo de Retiradas

Nesse endpoint é possível consultar as retiradas de um dia específico.

GET //retiradas?data=AAAA-MM-DD

data* - Data de referência do arquivo.

Parâmetros Necessários:
Header:

client_id:

access_token:

Response:
{
  "data": { //Estrutura de dados
    "cnpjManager": "32778350000170", //CNPJ Ame Digital
    "nameManager": "AME DIGITAL BRASIL LTDA", //Razão Social Ame Digital
    "cnpjCustomer": "02314250000121", //CNPJ Vendedor
    "nameCustomer": "Empresa de teste", //Razão Social Vendedor
    "orders": [ //Estrutura do pedido
      {
        "orderUuid": "001d25a2-1a58-4a31-a2a8-32a77785c993", //ID da retirada
        "typeFile": "CASH_OUT", //Tipo do arquivo ("CASH_OUT")
        "createdAt": "2020-07-07 12:25:45.13702", //Data de criação do retirada
        "totalAmountInCents": 63476, //Valor total da retirada
        "transactions": [ //Estrutura dos meios de pagamentos/parcelas
          {
            "transactionUuid": "df2090e4-99a7-45e0-984b-e58550dc1b2b", //ID da transação de retirada
            "status": "CAPTURED", //Status da transação ("CAPTURED")
            "updatedAt": "2020-07-08 11:13:23.623186", //Data de atualização do pagamento/parcela
            "paymentMethod": "BANK_TRANSFER", //Método de pagamento ("BANK_TRANSFER")
            "operationType": "DEBIT", //Tipo de operação ("DEBIT")
            "grossAmountInCents": 63476, // Valor bruto
            "takeRateunit": "CURRENCY", //Unidade de taxa de retirada ("PERCENT"/"CURRENCY")
            "takeRate": 0, //Taxa de retirada
            "takeRateAmountInCents": 0, //Taxa de retirada em centavos
            "netAmountInCents": 63476, //Valor liquido
            "bank": "1", //Banco de destino
            "agency": "3399", //Agencia de destino
            "accountNumber": "56316" //Conta de destino
          }
        ]
      }
    ]
  },
  "pageable": { //Estrutura de paginação
    "number": 0, //Pagina atual
    "hasNext": false //Indicador de existência de próxima pagina ("true"/"false")
  },
  "success": true,
  "msg": "Processed"
}


Observação:

Para esse método em especifico os dados estão disponíveis para o dia 01/09/2020. Caso você efetue um get fora deste período irá obter o retorno 202.

Em ambiente produtivo, caso você obtenha o retorno 202, é necessário aguardar uma hora para o processamento do arquivo, em seguida, você poderá efetuar um novo GET para obter os retornos.

Consulta Arquivo Financeiro

Nesse endpoint é possível consultar a movimentação financeira de um dia específico.

GET /financeiros?data=AAAA-MM-DD

data* - Data de referência do arquivo.

Parâmetros Necessários:
Header:

client_id:

access_token:

Response:
{
  "data": { //Estrutura de dados
    "cnpjManager": "32778350000170", //CNPJ Ame Digital
    "nameManager": "AME DIGITAL BRASIL LTDA", //Razão Social Ame Digital
    "cnpjCustomer": "02314250000121", //CNPJ Vendedor
    "nameCustomer": "Empresa de teste", //Razão Social Vendedor
    "orders": [ //Estrutura do pedido
      {
        "orderUuid": "3dd7da22-ead2-4b73-9c1f-0502d6df3edf", //ID do release
        "referenceOrderUuid": "89aeead9-d1f9-4ca9-801a-b614c4b2e2b2", //ID do pedido
        "externalTransactionIdentifier": "2B147262771149F7A01F477BC7F5A81E",  //ID do pedido na plataforma do vendedor
        "typeFile": "RELEASE", //Tipo do arquivo ("RELEASE"/"ANTICIPATION")
        "createdAt": "2020-05-31T19:51:22-03:00", //Data de criação do pedido
        "totalAmountInCents": 16099, //Valor total do pedido
        "transactions": [ //Estrutura dos meios de pagamentos/parcelas
          {
            "transactionUuid": "637850c1-4f72-4874-b664-3813ca6121f0", //ID da parcela
            "paymentUuid": "baef4919-83f5-4ee1-9104-35f2361701ae", //ID do pagamento
            "status": "RELEASED", //Status da transação ("RELEASED")
            "updatedAt": "2020-06-30T19:51:32-03:00", //Data de atualização
            "paymentMethod": "CASH", //Método de pagamento ("CREDIT_CARD"/"CASH")
            "operationType": "CREDIT", //Tipo de operação ("CREDIT")
            "grossAmountInCents": 1040, //Valor bruto
            "takeRateunit": "PERCENT", //Unidade de taxa de MDR ("PERCENT"/"CURRENCY")
            "takeRate": 184, //Taxa de MDR
            "takeRateAmountInCents": 19, //Taxa de MDR em centavos
            "takeRateUnitGateway": "CURRENCY", //Unidade de taxa de Gateway ("PERCENT"/"CURRENCY")
            "takeRateGateway": 0, //Taxa de Gateway
            "takeRateAmountInCentsGateway": 0, //Taxa de Gateway em centavos 
            "netAmountInCents": 1021, //Valor liquido após MDR e Gateway
            "takeRateUnitAnticipation": null, //Unidade de taxa de antecipação ("PERCENT"/"CURRENCY")
            "takeRateAnticipation": null, //Taxa de antecipação
            "takeRateAnticipationAmountInCents": null, //Taxa de antecipação em centavos
            "netAnticipationAmountInCents": null, //Valor liquido após a antecipação
            "releaseInstallment": 1, //Número da parcela
            "numberOfInstallments": 1, //Quantidade de parcelas
            "releaseTime": 30, //Prazo de liquidação
            "scheduledFor": "2020-06-30T19:51:32-03:00" //Data de agendamento do release
          },
          {
            "transactionUuid": "aa53412d-3690-4aaa-bbe6-70a8ff7dd4cc",
            "paymentUuid": "ad0c846b-78c3-4c0f-8967-ac58f2687915",
            "status": "RELEASED",
            "updatedAt": "2020-06-30T19:51:32-03:00",
            "paymentMethod": "CREDIT_CARD",
            "operationType": "CREDIT",
            "grossAmountInCents": 15059,
            "takeRateunit": "PERCENT",
            "takeRate": 184,
            "takeRateAmountInCents": 277,
            "takeRateUnitGateway": "CURRENCY",
            "takeRateGateway": 0,
            "takeRateAmountInCentsGateway": 0,
            "netAmountInCents": 14782,
            "takeRateUnitAnticipation": null,
            "takeRateAnticipation": null,
            "takeRateAnticipationAmountInCents": null,
            "netAnticipationAmountInCents": null,
            "releaseInstallment": 1,
            "numberOfInstallments": 1,
            "releaseTime": 30,
            "scheduledFor": "2020-06-30T19:51:32-03:00"
          }
        ]
      }
    ]
  },
  "pageable": { //Estrutura de paginação
    "number": 0, //Pagina atual
    "hasNext": false //Indicador de existência de próxima pagina ("true"/"false")
  },
  "success": true,
  "msg": "Processed"
}


Observação:

Em ambiente de homologação os registros estão disponíveis entre 01/01/2020 até 15/10/2020. Caso você efetue um get fora deste período irá obter o retorno 202.

Em ambiente produtivo, caso você obtenha o retorno 202, é necessário aguardar uma hora para o processamento do arquivo, em seguida, você poderá efetuar um novo GET para obter os retornos.

Português, Brasil