> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.shimi.cash/api-reference/shimi-api/airtime-data-bills-vtu/purchase-airtime/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.shimi.cash/_mcp/server.

# Purchase Airtime

POST https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime
Content-Type: application/json

Buys airtime for a phone number.

**Body (JSON):**

| Field               | Type    | Rules                                                     |
| ------------------- | ------- | --------------------------------------------------------- |
| `idempotencyKey`    | string  | required, 4–250 chars, unique per purchase                |
| `serviceCategoryId` | string  | required, 4–250; an active **Airtime** category (network) |
| `phoneNumber`       | string  | required, exactly 11 digits (e.g. `08031234567`)          |
| `amount`            | number  | required, ₦100–₦50,000                                    |
| `settlementId`      | integer | required; one of your active settlement accounts          |

**Purchase outcomes** (shared flow):

* **200** `data.status: "SUCCESS"` — delivered.
* **200** `data.status: "PENDING"` with message `... purchase is being confirmed. Do not retry; check the transaction status.` — provider outcome unknown; you have been debited and **not** refunded. Poll **Fetch Single VTU Transaction**; do not resend.
* **400** `... purchase failed. Your balance has been refunded.` — provider definitively rejected; safe to retry with a **new** `idempotencyKey`.
* **409** `Duplicate request in flight` — another request with the same `idempotencyKey` is being processed.
* **200** `Duplicate request — returning existing transaction` — the `idempotencyKey` was already used; the original transaction is returned and nothing is charged.

Your settlement balance must be **strictly greater** than the amount (`balance <= amount` is rejected as insufficient).

**Error format:** body validation failures (Joi) return `{ "status": "error", "message": "Validation error", "details": [ ... ] }`; all other errors return `{ "success": false, "message": "..." }`. Money fields (`amount`, `fee`) are Prisma Decimals and are serialized as **strings** (e.g. `"1000"`).

Reference: https://docs.shimi.cash/api-reference/shimi-api/airtime-data-bills-vtu/purchase-airtime

## Authentication

- `Authorization` header (bearer token, required) — Access token from Generate Access Token (valid 15 minutes).

## Request

### Body (application/json)

This endpoint expects an object.

- `idempotencyKey` (string, optional)
- `serviceCategoryId` (string, optional)
- `phoneNumber` (string, optional)
- `amount` (integer, optional)
- `settlementId` (integer, optional)

## Response

### 200

Success / Pending (being confirmed) / Duplicate (existing transaction)

- `success` (boolean, optional)
- `data` (VtuPurchaseAirtimePostResponsesContentApplicationJsonSchemaData, optional)
- `message` (string, optional)

## Errors

### 400 Bad Request Error

Failed (refunded) / Insufficient balance / Validation error / Invalid category / Settlement not activated

- `success` (boolean, optional)
- `message` (string, optional)
- `status` (string, optional)
- `details` (list of string, optional)

### 401 Unauthorized Error

Unauthorized

- `message` (string, optional)

### 403 Forbidden Error

Invalid or expired access token / KYB not approved / Account deactivated

- `message` (string, optional)
- `code` (string, optional)
- `kybStatus` (string, optional)

### 409 Conflict Error

Conflict

- `success` (boolean, optional)
- `message` (string, optional)

### 500 Internal Server Error

Internal Server Error

- `success` (boolean, optional)
- `message` (string, optional)

## Types

### VtuPurchaseAirtimePostResponsesContentApplicationJsonSchemaData

- `transactionId` (string, optional)
- `status` (string, optional)
- `type` (string, optional)
- `amount` (string, optional)
- `createdAt` (string, optional)

## Examples

### 200 Success

**Response**

```json
{
  "success": true,
  "data": {
    "transactionId": "cm2z9h1j20011vtx3ab45cd6",
    "status": "SUCCESS",
    "type": "AIRTIME",
    "amount": "1000",
    "createdAt": "2026-10-04T10:22:31.418Z"
  }
}
```

**SDK Code**

```python 200 Success
import requests

url = "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript 200 Success
const url = 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go 200 Success
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby 200 Success
require 'uri'
require 'net/http'

url = URI("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java 200 Success
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php 200 Success
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp 200 Success
using RestSharp;

var client = new RestClient("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift 200 Success
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### 200 Pending (being confirmed)

**Response**

```json
{
  "success": true,
  "data": {
    "transactionId": "cm2z9h1j20011vtx3ab45cd6",
    "status": "PENDING",
    "type": "AIRTIME",
    "amount": "1000",
    "createdAt": "2026-10-04T10:22:31.418Z"
  },
  "message": "Airtime purchase is being confirmed. Do not retry; check the transaction status."
}
```

**SDK Code**

```python 200 Pending (being confirmed)
import requests

url = "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript 200 Pending (being confirmed)
const url = 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go 200 Pending (being confirmed)
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby 200 Pending (being confirmed)
require 'uri'
require 'net/http'

url = URI("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java 200 Pending (being confirmed)
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php 200 Pending (being confirmed)
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp 200 Pending (being confirmed)
using RestSharp;

var client = new RestClient("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift 200 Pending (being confirmed)
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### 200 Duplicate (existing transaction)

**Response**

```json
{
  "success": true,
  "data": {
    "transactionId": "cm2z9h1j20011vtx3ab45cd6",
    "status": "SUCCESS",
    "type": "AIRTIME",
    "amount": "1000",
    "createdAt": "2026-10-04T10:22:31.418Z"
  },
  "message": "Duplicate request — returning existing transaction"
}
```

**SDK Code**

```python 200 Duplicate (existing transaction)
import requests

url = "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.json())
```

```javascript 200 Duplicate (existing transaction)
const url = 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime';
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go 200 Duplicate (existing transaction)
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby 200 Duplicate (existing transaction)
require 'uri'
require 'net/http'

url = URI("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

```java 200 Duplicate (existing transaction)
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php 200 Duplicate (existing transaction)
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp 200 Duplicate (existing transaction)
using RestSharp;

var client = new RestClient("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift 200 Duplicate (existing transaction)
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Airtime, Data & Bills (VTU)_purchaseAirtime_example

**Request**

```json
{
  "idempotencyKey": "{{$guid}}",
  "serviceCategoryId": "{{service_category_id}}",
  "phoneNumber": "08012345678",
  "amount": 1000,
  "settlementId": 1
}
```

**Response**

```json
{
  "success": true,
  "data": {
    "transactionId": "cm2z9h1j20011vtx3ab45cd6",
    "status": "SUCCESS",
    "type": "AIRTIME",
    "amount": "1000",
    "createdAt": "2026-10-04T10:22:31.418Z"
  }
}
```

**SDK Code**

```python Airtime, Data & Bills (VTU)_purchaseAirtime_example
import requests

url = "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime"

payload = {
    "idempotencyKey": "{{$guid}}",
    "serviceCategoryId": "{{service_category_id}}",
    "phoneNumber": "08012345678",
    "amount": 1000,
    "settlementId": 1
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Airtime, Data & Bills (VTU)_purchaseAirtime_example
const url = 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"idempotencyKey":"{{$guid}}","serviceCategoryId":"{{service_category_id}}","phoneNumber":"08012345678","amount":1000,"settlementId":1}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Airtime, Data & Bills (VTU)_purchaseAirtime_example
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"{{$guid}}\",\n  \"serviceCategoryId\": \"{{service_category_id}}\",\n  \"phoneNumber\": \"08012345678\",\n  \"amount\": 1000,\n  \"settlementId\": 1\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Airtime, Data & Bills (VTU)_purchaseAirtime_example
require 'uri'
require 'net/http'

url = URI("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"idempotencyKey\": \"{{$guid}}\",\n  \"serviceCategoryId\": \"{{service_category_id}}\",\n  \"phoneNumber\": \"08012345678\",\n  \"amount\": 1000,\n  \"settlementId\": 1\n}"

response = http.request(request)
puts response.read_body
```

```java Airtime, Data & Bills (VTU)_purchaseAirtime_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotencyKey\": \"{{$guid}}\",\n  \"serviceCategoryId\": \"{{service_category_id}}\",\n  \"phoneNumber\": \"08012345678\",\n  \"amount\": 1000,\n  \"settlementId\": 1\n}")
  .asString();
```

```php Airtime, Data & Bills (VTU)_purchaseAirtime_example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime', [
  'body' => '{
  "idempotencyKey": "{{$guid}}",
  "serviceCategoryId": "{{service_category_id}}",
  "phoneNumber": "08012345678",
  "amount": 1000,
  "settlementId": 1
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Airtime, Data & Bills (VTU)_purchaseAirtime_example
using RestSharp;

var client = new RestClient("https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"idempotencyKey\": \"{{$guid}}\",\n  \"serviceCategoryId\": \"{{service_category_id}}\",\n  \"phoneNumber\": \"08012345678\",\n  \"amount\": 1000,\n  \"settlementId\": 1\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Airtime, Data & Bills (VTU)_purchaseAirtime_example
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "idempotencyKey": "{{$guid}}",
  "serviceCategoryId": "{{service_category_id}}",
  "phoneNumber": "08012345678",
  "amount": 1000,
  "settlementId": 1
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://shimi-waas-api-9493532b9281.herokuapp.com/api/v1/vtu/purchase-airtime")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```