API de Recorrência



Collection

Aqui, na Ame disponibilizamos as Collections através do arquivo:

Clique aqui para fazer o download.



Ambientes

Temos dois ambientes: o primeiro é o de homologação, que torna possível rodar todos os testes que você precisar. O segundo, é o ambiente produtivo.
Ah, vale lembrar que os dois ambientes seguem o mesmo fluxo e mesmos retornos, beleza?

Ambiente Base URI
Homologação http://api-amedigital.sensedia.com/hml/recorrencia/v1
Produção http://api-amedigital.sensedia.com/recorrencia/v1


Overview cobrança recorrente

Com a cobrança recorrente Ame, nossos parceiros podem fazer cobranças em ciclos nas carteiras de clientes de maneira simples. Assim, não é preciso que o usuário faça uma ação como leitura de QRCode, confirmação de pagamento no checkout e etc. sempre que o pagamento precisar ser efetuado.

Com esse serviço, a Ame pode ser utilizada como meio de pagamento de serviços por assinatura de planos, cobranças recorrentes e muitos outros.

Dá uma olhada em quais são os passos necessários para utilizar a cobrança recorrente:

1. Criação de Ordem de Compra

Olha só, para garantir que exista um primeiro contato entre as carteiras, se mantem o fluxo padrão da criação de ordem de compra onde, após a confirmação de pagamento pelo cliente, é disparado internamente a criação de um vínculo entra as carteiras. Ah, este vínculo precisa ser caracterizado como Recurrence.

subType
RECURRENCE

Recurrence
Enabled : True

Payload de criação de ordem com os atributos:

{
   "title":"Teste em massa - Sensedia - v2",
   "description":"Teste em massa - Sensedia - v2",
   "amount":100,
   "type":"PAYMENT",
   "subType":"RECURRENCE",
   "attributes":{
      "transactionChangedCallbackUrl":"https://webhook.site/",
      "recurrence":{
         "enabled":true
      },
      "items":[
         {
            "ean":null,
            "sku":"1234322",
            "description":"Itens do Pedido",
            "amount":1000,
            "quantity":1
         }
      ],
      "customPayload":{
         "isFrom":"Plataforma"
      },
      "paymentOnce":true,
      "riskHubProvider":"SYNC",
      "origin":"ECOMMERCE"
   }
}

2. Criação das Cobranças Recorrentes

Aí, através do ID deste vínculo é possível fazer as execuções das cobranças recorrentes. Dá uma olhadinha aqui pra saber mais.

3. Cancelamento do Vínculo entre as Wallets

Se o cliente deixa de autorizar as cobranças recorrentes, o cancelamento acontece e o vínculo entre as carteiras acaba. Uma nova autorização depende de um novo ciclo. Dá uma olhada a aqui pra saber mais.



Criando Cobranças Recorrentes

Para chamar a API de criação de cobrança recorrente, o vendedor deve passar os valores a serem cobrados, o Token de vínculo e as demais informações necessárias, ok?

Dá uma olhada em API REFERENCES – Cobrança Recorrentes

Fluxo :

Criando_Cobrança_Recorrentes

Esta API que faz a ponte entre o vendedor e a criação da ordem de compra na carteira do cliente através do Token de vínculo que foi criado. Ah, você que é nosso parceiro, não esquece de armazenar o Token, ok?

Com a criação da ordem de compra, é possível realizar operações como estorno, cancelamento, captura dentre outras. Dá uma olhada aqui para ver mais.

Nesta modalidade, o vínculo vai ser renovado a cada cobrança, mas seu ID continua o mesmo e o vendedor pode utilizar quando precisar. Ah, o ID pode ser utilizado até uma solicitação de cancelamento.

Vale lembrar que a Ame se responsabiliza apenas pela execução da cobrança, dados como data de vencimento, cancelamento e valor são de responsabilidade do vendedor, ok?


POST /recorrencias/cobrar
Parâmetros Necessários:
Header:

Authorization + Base64(client_id:client_secret)

Request:
{
   "subscriptionUuid":"d9199df1-05c9-4d5c-982d-ff78fdf30388",
   "amountInCents":400,
   "title":"Meu título",
   "description":"Minha descrição detalhada",
   "softDescription":"Minha descrição resumida",
   "attributes":{
      "items":[
         {
            "sku":"sku_1",
            "amount":400,
            "description":"Descrição",
            "quantity":1
         }
      ],
      "customPayload":{
         "meuId":"abcd"
      }
   }
}
Response:
{
   "orderUuid":"a4353845-90b6-4882-996e-f3a2c2dc1727",
   "status":"AUTHORIZED",
   "amount":3000,
   "subscription":{
      "uuid":"0e72ed81-56ce-456d-996e-f3a2c2dc1727",
      "partnerName":"Seller Debit",
      "partnerWalletUuid":"a4353845-90b6-4882-86f0-07e86fa36666",
      "customerWalletUuid":"ce8df216-bc7e-40b6-ad6a-98e66b19b777",
      "paymentMethod":"CREDIT_CARD",
      "enabled":true
   }
}


Cancelamento de Assinatura

Vale lembrar, nossos parceiros que devem cancelar o vínculo entre as carteiras, ok? Isso pode ser feito em casos de uma operação que implique no não pagamento da recorrência ou na necessidade de criar um novo vínculo entre carteiras.

Dá uma olhada nos tipos de operação que podem implicar na necessidade de cancelamento de vínculo:

Cancelamento de plano pelo cliente;

Troca do meio de pagamento Ame para algum outro.

Fluxo :

Cancelamento_Assinatura
DELETE /recorrencias/{id}
Parâmetros Necessários:
Header:

Authorization + Base64(client_id:client_secret)

Response:
{
    "uuid": "b63c9708-ae61-4e24-8286-865dbd223cd7",
    "partnerName": "Seller Debit",
    "partnerWalletUuid": "a4353845-90b6-4882-86f0-07e86fa364f6",
    "customerWalletUuid": "72ce5ac8-1b72-4312-8be2-fb71bb37e72c",
    "status": "DISABLED",
    "createdAt": "2021-08-09T15:07:59"
}



Português, Brasil