Recarga telefônica

1. Objetivo

Realizar uma recarga telefônica.

2. Quem pode usar

Todos os clientes de plataforma que utilizam nossa API.

3. Descrição geral

Para realizar uma recarga telefônica é necessário informar o telefone, o tipo do produto, valor da recarga e a operadora do telefone.

4. Etapas

1. Realizar a busca das operadoras disponíveis através da rota GET /v1/mobile/providers

2. Realizar a busca dos produtos da operadora pelo DDD do telefone através da rota GET /v1/mobile/providers/{provider}/products

3. Realizar a recarga telefônica atravé da rota POST /v1/mobile/recharge

5. Exemplos

Busca das operadoras

{
  "providers": [
    { 
      "name": "TIM"
    },
    {
      "name": "VIVO"
    },
    {
      "name": "CLARO"
    }
  ]
}

Busca dos produtos da operadora pelo DDD

{
  "provider": "VIVO",
  "products": [
    {
      "name": "VIVO",
      "value": 1000,
      "areaCode": 11,
      "type": "ONLINE_PIN"
    }
  ]
}

Recarga telefônica

{
  "id": "ede7a89d-608a-4eaf-8290-78478fe1d877",
  "transactionId": "d5c3758f-61f9-4174-a973-d5c38b96f9df",
  "status": "COMPLETED",
  "product": "VIVO",
  "provider": "VIVO",
  "type": "MOBILE_RECHARGE",
  "amount": "1000",
  "transactionDate": "2025-02-27T21:07:59.000Z",
  "createdAt": "2025-03-05T12:08:23.000Z",
  "updatedAt": "2025-03-05T15:15:31.000Z"
}

Referências