Get held balance
curl --request GET \
--url https://app.dimepayments.com/api/funds/balance \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"data": []
}'import requests
url = "https://app.dimepayments.com/api/funds/balance"
payload = { "data": [] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({data: []})
};
fetch('https://app.dimepayments.com/api/funds/balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.dimepayments.com/api/funds/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.dimepayments.com/api/funds/balance"
payload := strings.NewReader("{\n \"data\": []\n}")
req, _ := http.NewRequest("GET", 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(string(body))
}HttpResponse<String> response = Unirest.get("https://app.dimepayments.com/api/funds/balance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.dimepayments.com/api/funds/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": []\n}"
response = http.request(request)
puts response.read_body{
"data": {
"sid": "91828382",
"available": 6492.87,
"pending": 0,
"reserve": 0,
"at_risk": 1250,
"owed_to_split": 40.15,
"unresolved": 0,
"release_fee": 30,
"releasable": 5172.72,
"ach_settlement_days": 7,
"ach_out_enabled": true,
"ach_out_limit_remaining": 19999999.99
}
}{
"data": {
"message": "Permission Denied."
}
}{
"data": {
"message": "No such Merchant"
}
}{
"data": {
"message": "This merchant's funds are not held; they settle automatically."
}
}{
"data": {
"message": "The processor could not be reached. Try again shortly."
}
}Held funds
Get held balance
The merchant’s current balance at the processor, and how much of it is releasable today.
Only available for merchants on a fund-holding tier. Everyone else has no held balance by definition — their money sweeps automatically — and this returns 422 rather than a misleading zero.
releasable is the figure to pay attention to, and the one a release is
checked against. It is available less four things:
at_risk— ACH payments that have funded but are still inside the settlement window, where the customer’s bank can return the debit. Clears by waiting;ach_settlement_dayssays how long.owed_to_split— a share of takings already promised to another account and not yet moved. Clears tonight, without anyone acting.unresolved— releases already requested and not yet confirmed.release_fee— what the release itself will cost.
GET
/
api
/
funds
/
balance
Get held balance
curl --request GET \
--url https://app.dimepayments.com/api/funds/balance \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"data": []
}'import requests
url = "https://app.dimepayments.com/api/funds/balance"
payload = { "data": [] }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.get(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({data: []})
};
fetch('https://app.dimepayments.com/api/funds/balance', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://app.dimepayments.com/api/funds/balance",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_POSTFIELDS => json_encode([
'data' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://app.dimepayments.com/api/funds/balance"
payload := strings.NewReader("{\n \"data\": []\n}")
req, _ := http.NewRequest("GET", 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(string(body))
}HttpResponse<String> response = Unirest.get("https://app.dimepayments.com/api/funds/balance")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"data\": []\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.dimepayments.com/api/funds/balance")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"data\": []\n}"
response = http.request(request)
puts response.read_body{
"data": {
"sid": "91828382",
"available": 6492.87,
"pending": 0,
"reserve": 0,
"at_risk": 1250,
"owed_to_split": 40.15,
"unresolved": 0,
"release_fee": 30,
"releasable": 5172.72,
"ach_settlement_days": 7,
"ach_out_enabled": true,
"ach_out_limit_remaining": 19999999.99
}
}{
"data": {
"message": "Permission Denied."
}
}{
"data": {
"message": "No such Merchant"
}
}{
"data": {
"message": "This merchant's funds are not held; they settle automatically."
}
}{
"data": {
"message": "The processor could not be reached. Try again shortly."
}
}
