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

# Partner Balance

GET https://sandbox-payments.nolimit.money/interac/partner/balance

Use this endpoint to check your current available balance with NoLimit Payments.

Call it with your `x-api-key` header. No body or query parameters are needed.

- `balance` - `[string]` your available balance in CAD, always with 2 decimals and no thousands separator (e.g. `"15230.75"`).
    
- `name` - `[string]` your partner account name.
    

The balance is what is available for withdrawals and refunds. Funds held in your rolling reserve are not included. Deposits are added to the balance once they are completed and settled. Withdrawals and refunds, including their fees, are taken from the balance when they are created.

Possible errors:

- `401` - the API key is invalid.
    
- `409` - the `x-api-key` header is missing.
    
- `500` - the balance could not be retrieved. Please retry later.

Reference: https://interacdocs.nolimit.money/partner-interac-api/partner-balance

## Servers

- `https://sandbox-payments.nolimit.money/interac` (Sandbox, default)
- `https://payments.nolimit.money/interac` (Production)

## Request

### Headers

- `x-api-key` (string, optional)

## Response

### 200

OK

- `data` (PartnerBalanceGetResponsesContentApplicationJsonSchemaData, optional)
- `success` (integer, optional)

## Errors

### 401 Unauthorized Error

Unauthorized

- `error` (PartnerBalanceGetResponsesContentApplicationJsonSchemaError, optional)
- `success` (integer, optional)

### 409 Conflict Error

Conflict

- `error` (PartnerBalanceGetResponsesContentApplicationJsonSchemaError, optional)
- `success` (integer, optional)

## Types

### PartnerBalanceGetResponsesContentApplicationJsonSchemaData

- `balance` (string, optional)
- `name` (string, optional)

### PartnerBalanceGetResponsesContentApplicationJsonSchemaError

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

## Examples

**Response**

```json
{
  "data": {
    "balance": "15230.75",
    "name": "Example Partner Inc."
  },
  "success": 1
}
```

**SDK Code**

```python
import requests

url = "https://sandbox-payments.nolimit.money/interac/partner/balance"

headers = {"x-api-key": "{{kid}}@{{api-key}}"}

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

print(response.json())
```

```javascript
const url = 'https://sandbox-payments.nolimit.money/interac/partner/balance';
const options = {method: 'GET', headers: {'x-api-key': '{{kid}}@{{api-key}}'}};

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

```go
package main

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

func main() {

	url := "https://sandbox-payments.nolimit.money/interac/partner/balance"

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

	req.Header.Add("x-api-key", "{{kid}}@{{api-key}}")

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

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

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

}
```

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

url = URI("https://sandbox-payments.nolimit.money/interac/partner/balance")

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

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '{{kid}}@{{api-key}}'

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

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

HttpResponse<String> response = Unirest.get("https://sandbox-payments.nolimit.money/interac/partner/balance")
  .header("x-api-key", "{{kid}}@{{api-key}}")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://sandbox-payments.nolimit.money/interac/partner/balance', [
  'headers' => [
    'x-api-key' => '{{kid}}@{{api-key}}',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://sandbox-payments.nolimit.money/interac/partner/balance");
var request = new RestRequest(Method.GET);
request.AddHeader("x-api-key", "{{kid}}@{{api-key}}");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["x-api-key": "{{kid}}@{{api-key}}"]

let request = NSMutableURLRequest(url: NSURL(string: "https://sandbox-payments.nolimit.money/interac/partner/balance")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
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()
```