API de Conciliação


Collection

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

Clique aqui para fazer o download.


Ambiente

Sandbox

Os retornos desse ambiente são estáticos, ou seja, os retornos são fixos e padronizados. As credenciais de homologação operam de forma idêntica ao ambiente produtivo. É importante que a aplicação deve apontar a URL para o ambiente de homologação ao invés de produção.

URL de Sandbox

http://api-amedigital.sensedia.com/hml/conciliacoes/v1/

Exemplo:

http://api-amedigital.sensedia.com/hml/conciliacoes/v1/vendas?data=2020-09-27

Produção

As credenciais de acesso a esse ambiente e a URL são fornecidas apenas após a validação técnica ser concluída.

Observação: para as conciliadoras as credenciais são liberadas por lojista, ou seja, é necessário realizar um request para cada lojista com as suas devidas credenciais.


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"
}


Se liga:

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



Se liga:

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"
}


Se liga:

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 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"
}


Se liga:

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