> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://apidocs.sare.africa/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://apidocs.sare.africa/_mcp/server.

# Add Bill Account To Favourites

POST http://localhost:8080/api/v3/bill-accounts/favourites
Content-Type: application/json

Reference: https://apidocs.sare.africa/sare-core-api/wallet/add-bill-account-to-favourites

## Request

### Headers

- `Authorization` (string, optional)
- `X-Device-Id` (string, optional) — Required on non-GET requests to non-public paths (DeviceSignatureFilter), skipped for GET/whitelisted/multipart requests and in the local profile.
- `X-Signature` (string, optional) — Base64 ECDSA signature over sha256(body) + timestamp + requestId, signed with the device's registered private key.
- `X-Timestamp` (string, optional) — Unix epoch seconds; must be within 5 minutes of server time.
- `X-Request-Id` (string, optional) — Unique per request - reused values are rejected as replays.

### Body (application/json)

This endpoint expects an object.

- `billProvider` (string, optional)
- `businessNumber` (string, optional)
- `accountNumber` (string, optional)
- `nickname` (string, optional)
- `defaultAmount` (integer, optional)
- `isFavorite` (boolean, optional)
- `isActive` (boolean, optional)
- `paymentMethod` (string, optional)

## Response

### 201

201 Created

- `code` (integer, optional)
- `message` (string, optional)
- `data` (string, optional)

## Examples

**Request**

```json
{
  "billProvider": "5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f",
  "businessNumber": "88880",
  "accountNumber": "12345678",
  "nickname": "Electricity",
  "defaultAmount": 500,
  "isFavorite": true,
  "isActive": true,
  "paymentMethod": "MPESA_PAYBILL"
}
```

**Response**

```json
{
  "code": 201,
  "message": "Bill account added to favourites successfully",
  "data": "OK"
}
```

**SDK Code**

```python Wallet_addBillAccountToFavourites_example
import requests

url = "http://localhost:8080/api/v3/bill-accounts/favourites"

payload = {
    "billProvider": "5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f",
    "businessNumber": "88880",
    "accountNumber": "12345678",
    "nickname": "Electricity",
    "defaultAmount": 500,
    "isFavorite": True,
    "isActive": True,
    "paymentMethod": "MPESA_PAYBILL"
}
headers = {
    "Authorization": "Bearer {{accessToken}}",
    "X-Device-Id": "{{deviceId}}",
    "X-Request-Id": "{{requestId}}",
    "X-Signature": "{{signature}}",
    "X-Timestamp": "{{timestamp}}",
    "Content-Type": "application/json"
}

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

print(response.json())
```

```javascript Wallet_addBillAccountToFavourites_example
const url = 'http://localhost:8080/api/v3/bill-accounts/favourites';
const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer {{accessToken}}',
    'X-Device-Id': '{{deviceId}}',
    'X-Request-Id': '{{requestId}}',
    'X-Signature': '{{signature}}',
    'X-Timestamp': '{{timestamp}}',
    'Content-Type': 'application/json'
  },
  body: '{"billProvider":"5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f","businessNumber":"88880","accountNumber":"12345678","nickname":"Electricity","defaultAmount":500,"isFavorite":true,"isActive":true,"paymentMethod":"MPESA_PAYBILL"}'
};

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

```go Wallet_addBillAccountToFavourites_example
package main

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

func main() {

	url := "http://localhost:8080/api/v3/bill-accounts/favourites"

	payload := strings.NewReader("{\n  \"billProvider\": \"5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f\",\n  \"businessNumber\": \"88880\",\n  \"accountNumber\": \"12345678\",\n  \"nickname\": \"Electricity\",\n  \"defaultAmount\": 500,\n  \"isFavorite\": true,\n  \"isActive\": true,\n  \"paymentMethod\": \"MPESA_PAYBILL\"\n}")

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

	req.Header.Add("Authorization", "Bearer {{accessToken}}")
	req.Header.Add("X-Device-Id", "{{deviceId}}")
	req.Header.Add("X-Request-Id", "{{requestId}}")
	req.Header.Add("X-Signature", "{{signature}}")
	req.Header.Add("X-Timestamp", "{{timestamp}}")
	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 Wallet_addBillAccountToFavourites_example
require 'uri'
require 'net/http'

url = URI("http://localhost:8080/api/v3/bill-accounts/favourites")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer {{accessToken}}'
request["X-Device-Id"] = '{{deviceId}}'
request["X-Request-Id"] = '{{requestId}}'
request["X-Signature"] = '{{signature}}'
request["X-Timestamp"] = '{{timestamp}}'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"billProvider\": \"5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f\",\n  \"businessNumber\": \"88880\",\n  \"accountNumber\": \"12345678\",\n  \"nickname\": \"Electricity\",\n  \"defaultAmount\": 500,\n  \"isFavorite\": true,\n  \"isActive\": true,\n  \"paymentMethod\": \"MPESA_PAYBILL\"\n}"

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

```java Wallet_addBillAccountToFavourites_example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("http://localhost:8080/api/v3/bill-accounts/favourites")
  .header("Authorization", "Bearer {{accessToken}}")
  .header("X-Device-Id", "{{deviceId}}")
  .header("X-Request-Id", "{{requestId}}")
  .header("X-Signature", "{{signature}}")
  .header("X-Timestamp", "{{timestamp}}")
  .header("Content-Type", "application/json")
  .body("{\n  \"billProvider\": \"5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f\",\n  \"businessNumber\": \"88880\",\n  \"accountNumber\": \"12345678\",\n  \"nickname\": \"Electricity\",\n  \"defaultAmount\": 500,\n  \"isFavorite\": true,\n  \"isActive\": true,\n  \"paymentMethod\": \"MPESA_PAYBILL\"\n}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'http://localhost:8080/api/v3/bill-accounts/favourites', [
  'body' => '{
  "billProvider": "5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f",
  "businessNumber": "88880",
  "accountNumber": "12345678",
  "nickname": "Electricity",
  "defaultAmount": 500,
  "isFavorite": true,
  "isActive": true,
  "paymentMethod": "MPESA_PAYBILL"
}',
  'headers' => [
    'Authorization' => 'Bearer {{accessToken}}',
    'Content-Type' => 'application/json',
    'X-Device-Id' => '{{deviceId}}',
    'X-Request-Id' => '{{requestId}}',
    'X-Signature' => '{{signature}}',
    'X-Timestamp' => '{{timestamp}}',
  ],
]);

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

```csharp Wallet_addBillAccountToFavourites_example
using RestSharp;

var client = new RestClient("http://localhost:8080/api/v3/bill-accounts/favourites");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer {{accessToken}}");
request.AddHeader("X-Device-Id", "{{deviceId}}");
request.AddHeader("X-Request-Id", "{{requestId}}");
request.AddHeader("X-Signature", "{{signature}}");
request.AddHeader("X-Timestamp", "{{timestamp}}");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"billProvider\": \"5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f\",\n  \"businessNumber\": \"88880\",\n  \"accountNumber\": \"12345678\",\n  \"nickname\": \"Electricity\",\n  \"defaultAmount\": 500,\n  \"isFavorite\": true,\n  \"isActive\": true,\n  \"paymentMethod\": \"MPESA_PAYBILL\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Wallet_addBillAccountToFavourites_example
import Foundation

let headers = [
  "Authorization": "Bearer {{accessToken}}",
  "X-Device-Id": "{{deviceId}}",
  "X-Request-Id": "{{requestId}}",
  "X-Signature": "{{signature}}",
  "X-Timestamp": "{{timestamp}}",
  "Content-Type": "application/json"
]
let parameters = [
  "billProvider": "5c6d7e8f-9a0b-4c1d-8e2f-3a4b5c6d7e8f",
  "businessNumber": "88880",
  "accountNumber": "12345678",
  "nickname": "Electricity",
  "defaultAmount": 500,
  "isFavorite": true,
  "isActive": true,
  "paymentMethod": "MPESA_PAYBILL"
] as [String : Any]

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

let request = NSMutableURLRequest(url: NSURL(string: "http://localhost:8080/api/v3/bill-accounts/favourites")! 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()
```