Active Documentation for /v1
Our active docs provide the ability to test out your account and to see the responses to your queries. The services are RESTful, and are accessed using…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Our active docs provide the ability to test out your account and to see the responses to your queries. The services are RESTful, and are accessed using standard HTTP methods over a secure HTTPS channel. Requests and responses are currently sent in JSON format, and have a base URL of /v1.
Endpoints 15
account
- GETAccount balance
/iatu/balanceReturns a JSON of the account balance.
charges
- GETList of account charges in JSON
/iatu/charges/reports/all?date_from=2016-01-28&date_to=2016-01-28Returns charges by date range. - GETList of account charges in CSV
/iatu/charges/reports/all.csv?date_from=2016-01-28&date_to=2016-01-28Returns charges by date range in CSV.
utilities
- GETMobile number validation
/iatu/number-validator?country_code=BR&mobile_number=5521983115555Checks to verify if the phone number is valid for the country supplied. - GETCurrent promotions
/iatu/products/promotionsReturns a JSON of the current promotions. - GETStatus check
/statusReturns a JSON of the API status.
products
- GETGet a list of products in JSON format
/iatu/products/reports/allReturns a JSON list of products, ranges, and their commissions percentages. - GETGet a list of products in CSV format
/iatu/products/reports/all.csvReturns a CSV of products, ranges, and their commissions percentages. - GETGet the estimated Local Value of a product
/iatu/products/reports/local-value?country_code=GT&carrier_code=Claro&amount=500¤cy_code=USDReturns a CSV of products, ranges, and their commissions percentages.
topups
- POSTTopup a mobile phone
/iatu/topupsSubmits an IATU transaction request. - POSTSearch topups transactions
/iatu/topups/reportsSearch topups transactions, by date, with client_transaction_id or to_service_number. Use 'client_transaction_id' to search by transaction number, or… - GETList of account topups in JSON
/iatu/topups/reports/all?date_from=2016-01-28&date_to=2016-01-28Returns topups by date range. - GETList of account topups in CSV
/iatu/topups/reports/all.csv?date_from=2016-01-28&date_to=2016-01-28Returns topups by date range in CSV. - GETSummary of account topups in JSON
/iatu/topups/reports/totals?date_from=2016-01-28&date_to=2016-01-28Returns topups totals by date range. - POSTReversal of a Topup
/iatu/topups/reverseOccasionally, a carrier will not be able to successfully complete a topup request. In this case, we will attempt to automatically reverse the transaction for…
API details
- Base URL
https://api.idtbeyond.com/v1- Authentication
- None declared in the description
- Operations
- 15 operations on 15 pathsGET 12POST 3
- Main resources
- topups 6products 3utilities 3charges 2account 1
- Response formats
application/json- Description format
- Swagger 2.0, API version
1.1.7 - Links
- OpenAPI document · Terms of service
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the Active Documentation for /v1 in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Active Documentation for /v1 collection, without the publisher's secrets.
- Add your credentialsOpen the collection's variables or an environment and enter your API key or token, if the API needs one.
- Send a requestPick an endpoint, for example “Account balance” (GET /iatu/balance), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Active Documentation for /v1?
Our active docs provide the ability to test out your account and to see the responses to your queries. The services are RESTful, and are accessed using… It is listed under Communication and has 15 endpoints.
Who publishes the Active Documentation for /v1?
It is listed from Idtbeyond's public API description (an OpenAPI document), not published by Idtbeyond on Swastik Codes. Anyone who controls idtbeyond.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Active Documentation for /v1?
Requests go to https://api.idtbeyond.com/v1. Endpoint paths are added to this base URL.
How do I authenticate with the Active Documentation for /v1?
Its OpenAPI description does not declare an authentication scheme. Some endpoints may be open; check the provider's documentation before relying on that.
How many endpoints does the Active Documentation for /v1 have?
15 operations on 15 paths (12 GET, 3 POST). The largest groups are topups, products, utilities, charges.
Is forking the Active Documentation for /v1 free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.