API de Cobrança Confiável

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?

Overview cobrança confiável

Com a cobrança confiável Ame é possível que uma carteira possa efetuar cobranças em outra carteira sem que esta precise executar alguma ação (leitura de QRCode, confirmação de pagamento no checkout etc.).

Para utilizar a cobrança confiável é só seguir estes passos:

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. Esta é a principal estrutura para a execução da cobrança confiável.

É só clicar aqui para ver mais.

2. Criação da Cobrança Confiável

Com Token do vínculo é possível a execução de cobranças confiáveis sem a necessidade da interação do usuário. Dá uma olhada aqui para saber mais.

Criando vínculo entre as carteiras

Para criar o vínculo entre carteiras, o parceiro precisa enviar na chamada da API transacional de criação de ordem, esses dois atributos aqui:

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":"TRUST_WALLET",
   "attributes":{
      "transactionChangedCallbackUrl":"https://webhook.site/",
      "TrustWallet":{
         "enabled":true
      },
      "items":[
         {
            "ean":null,
            "sku":"1234322",
            "description":"Itens do Pedido",
            "amount":1000,
            "quantity":1
         }
      ],
      "customPayload":{
         "isFrom":"Plataforma"
      },
      "paymentOnce":true,
      "riskHubProvider":"SYNC",
      "origin":"ECOMMERCE"
   }
}

Com isso, garante que no momento da primeira autorização de pagamento efetuada pelo cliente, o fluxo de criação do vínculo será disparado automaticamente e o Token será enviado no callback da ordem para que o parceiro utilize.

Fluxo :

Token do Vinculo

O vínculo entre duas carteiras tem um Token único, isso garante que quando o vendedor fizer cobranças futuras, o valor será retirado da carteira certa. Temos novas validações que podem influenciar ou não a autorização da ordem, dá uma olhada:

Criando cobrança confiável

O vendedor deve solicitar a API de criação de cobrança confiável e passar os parâmetros necessários para a execução da cobrança.

Dá uma olhada nos atributos em API REFERENCES - Cobrança Confiável

Fluxo :

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.

Clique aqui para ver mais.

O vínculo é desfeito assim que a ordem tiver autorização de pagamento, o que faz com que o parceiro sempre tenha que criar uma nova quando necessário.

Parâmetros Necessários:

Header:

Authorization + Base64(client_id:client_secret)

Request:

{
    "linkUuid": "61ec7c4c-033c-497f-97ab-18b2a9fda873",
    "amountInCents": 110,
    "title": "Teste",
    "description": "Teste",
    "attributes": {
        "transactionChangedCallbackUrl": "https://webhook.site/fd360b53-573c-4b0d-8fe6-9e0020612baf",
        "items": [
            {
                "amount": 110,
                "description": "Coca Cola Zero 350ml",
                "sku": null,
                "quantity": 1
            }
        ]
    }
}

Response:

{
  "uuid": "string",
  "status": "string",
  "amountInCents": 0,
  "linkUuid": "string"
}