API de Incentivos

O incentivo nada mais é que uma transferência entre duas carteiras Ame, mas o diferencial deste serviço é a possibilidade de a transferência ficar agendada para um CPF ou CNPJ mesmo quando ele não se encontra cadastrado na Ame.


Fluxo de Status


Pendente (PENDING):

Status inicial do incentivo.

Processado (PROCESSED):

Após a criação, o incentivo entra em uma fila para ser processado, caso tudo ocorra sem problemas seu status é alterado para PROCESSED.

Erro (Error):

Caso ocorra algum problema no processamento do incentivo seu status é alterado para ERROR.

Aguardando cadastro AME (AWAITING_AME_REGISTRATION):

Caso o CPF ou CNPJ informado no incentivo não esteja registrado na AME no momento de seu processamento, o status é alterado para AWAITING_AME_REGISTRATION.

Cancelado (CANCELED):

Existem dois cenários para que o status do incentivo seja alterado para CANCELED:

1 - Chamada do endpoint de cancelamento

2 - O CPF informado é o mesmo da origem do incentivo


Fluxograma 3

Collection

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

Clique aqui para fazer o download.


Ambientes

Sandbox

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/incentivos/v1/

Exemplo:

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

Observação: É importante ressaltar que Tokens de Sandbox só podem chamar a URL de Sandbox. O mesmo é válido para os Tokens de Produção, onde só podem chamar a URL de Produção. Essa regra existe para evitar que seja realizada uma chamada para o ambiente de Produção com um Token válido de Sandbox.

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.


Criando um Incentivo

Neste endpoint é possível criar incentivos unitários.

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

Authorization: encode64(client_id:client_secret)

Request:
{
   "description":"Pagamento Beneficio 1",
    "amount": 150000,
    "bonusScheduledDate": "2021-06-05",
    "customer":{
        "document":{
            "number":"02751900054"
        },
        "contact":{
            "email": "teste@teste.com",
            "telephone":"51978678998"
        }
    }
}
Response:
{
    "id": "343f6f99-1cf3-4c5b-a887-2375ca03871a",
    "description": "Pagamento Beneficio 1",
    "amount": 150000,
    "bonusScheduledDate": "2021-06-05",
    "createdAt": "2021-05-26T13:05:32.108178",
    "incentiveStatus": "PENDING",
    "customer": {
        "document": {
            "number": "02751900054"
        },
        "contact": {
            "email": "teste@teste.com",
            "telephone": "51978678998"
        }
    }
}


Criando Incentivos em Massa

Neste endpoint é possível criar incentivos em massa, dá uma olhada nesse template aqui:

Template - Incentivos

POST /incentivos/lista
Parâmetros Necessários:
Header:

Content-Type: multipart/form-data

Authorization: encode64(client_id:client_secret)

Request:
form-data
Response:
[
    {
        "description": "testepagamento",
        "amount": 1001,
        "customer": {
            "document": {
                "number": "65620670066"
            },
            "contact": {}
        }
    },
    {
        "description": "testepagamento",
        "amount": 1000,
        "customer": {
            "document": {
                "number": "82034790065"
            },
            "contact": {}
        }
    }
]


Cancelando um Incentivo

DELETE /incentivos/:id
Parâmetros Necessários:
Header:

Authorization: encode64(client_id:client_secret)

Response:
{
  "id": "39552d6c-5ef4-4075-adb8-4c6aef3309e8",
  "documentId": "19508320079",
  "description": "Gift from AME",
  "amount": 100,
  "incentiveStatus": "CANCELED",
  "email": "ame@SeuDominio.com.br",
  "telephone": "(16) 3333-2226",
  "bonusScheduledDate": "2021-01-08T20:02:08",
  "createdAt": "2021-01-08T20:02:08",
  "updatedAt": "2021-01-08T20:02:19"
}


Consulta de Incentivos

GET /incentivos
Parâmetros Necessários:
Header:

Authorization: encode64(client_id:client_secret)

Params:

initDate

endDate

initScheduledDate

endScheduledDate

incentiveId

incentiveStatus

documentId

Response:
[
    {
        "id": "84b54ac6-604d-4ce3-ad0e-ce962b192ede",
        "description": "incentive01",
        "amount": 101,
        "bonusScheduledDate": "2021-06-05",
        "createdAt": "2021-05-26T11:24:12",
        "incentiveStatus": "PENDING",
        "updatedAt": "2021-05-26T11:24:12",
        "customer": {
            "document": {
                "number": "69033445000"
            },
            "contact": {
                "email": "teste@teste.com",
                "telephone": "21985857474"
            }
        }
    }
]

Português, Brasil