lighthouse.dock.tech

Dock Lighthouse

Welcome to Dock Lighthouse! You'll find comprehensive guides and documentation to help you start working with our products as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started

Recharges API is a product that allows to perform mobile phone recharges. The recharge is allowed for the four main dealer codes in Brazil:

  • Vivo;
  • Claro;
  • Oi;
  • TIM.

📘

Credit SLA

Mobile phone recharges can take up to 72 hours to be credited to your phone number.

🚧

Recharge Cancellation

It is not possible to cancel the confirmed phone recharges.
We highly suggest confirming the phone number before confirming the recharge.

Step-by-Step


To recharge a mobile phone you must follow the step-by-step below:

1) List all dealers available.

GET api.caradhras.io/recharges/dealers

2) Request a recharge for a specific phone number associated to a specific dealer (listed in the first step). The API will return an identification code for the recharge order (orderId) and the recharge amounts available for the chosen dealer.

POST api.caradhras.io/recharges

3) Place a request according to the orderId and choose the recharge amount based on the available options, both returned in the step 2.

POST api.caradhras.io/recharges/{orderId}

4) Confirm the request placed in the step 3 to finish the process.

POST api.caradhras.io/recharges/{orderId}/confirm

5) It is also possible to list all mobile phone recharges done by an account and search a specific mobile phone recharge performed.

GET api.caradhras.io/recharges/account/{idAccount}
GET api.caradhras.io/recharges/adjustment/{idAdjustment}

Technical Documentation


To see the technical resources about this product, you can access our technical documentation by clicking here.

📘

Webhooks

The registration of the postbacks must be requested through Zendesk informing what is the URL to receive the JSON messages. To see the available webhooks for Recharges click here.

Updated 5 months ago


Overview


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.