Top up sandbox balance

POST

business

funding-account

sandbox-balance

Top up the current Business's sandbox Cleff Account (sandbox only)

curl --request POST \
  --url https://api.example.com/v1/business/funding-account/sandbox-balance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "available_balance_minor": 123,
  "total_balance_minor": 123,
  "currency": "<string>"
}
'

import requests

url = "https://api.example.com/v1/business/funding-account/sandbox-balance"

payload = {
    "available_balance_minor": 123,
    "total_balance_minor": 123,
    "currency": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({available_balance_minor: 123, total_balance_minor: 123, currency: '<string>'})
};

fetch('https://api.example.com/v1/business/funding-account/sandbox-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://api.example.com/v1/business/funding-account/sandbox-balance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'available_balance_minor' => 123,
    'total_balance_minor' => 123,
    'currency' => '<string>'
  ]),
  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://api.example.com/v1/business/funding-account/sandbox-balance"

	payload := strings.NewReader("{\n  \"available_balance_minor\": 123,\n  \"total_balance_minor\": 123,\n  \"currency\": \"<string>\"\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(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/business/funding-account/sandbox-balance")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"available_balance_minor\": 123,\n  \"total_balance_minor\": 123,\n  \"currency\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/business/funding-account/sandbox-balance")

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  \"available_balance_minor\": 123,\n  \"total_balance_minor\": 123,\n  \"currency\": \"<string>\"\n}"

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

{
  "currency": "<string>",
  "available_balance_minor": 123,
  "total_balance_minor": 123,
  "status": "pending",
  "reported_at": "2023-11-07T05:31:56Z",
  "deposit_instructions": {
    "bank_name": "<string>",
    "routing_number": "<string>",
    "account_number": "<string>",
    "account_holder_name": "<string>",
    "reference": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Cleff API key issued to a Business that self-registers via POST /v1/registration

Body

application/json

available_balance_minor

number

required

Available balance to set, in minor units. Max 9007199254740991.

Required range: x <= 9007199254740991

total_balance_minor

number

required

Total balance to set, in minor units. Max 9007199254740991.

Required range: x <= 9007199254740991

currency

string

ISO 4217 currency code; defaults to the account currency.

Response

currency

string

required

available_balance_minor

number

required

Available balance, in minor units.

total_balance_minor

number

required

Total balance, in minor units.

status

enum<string>

required

Neutral account status derived server-side: 'pending' until the provider first reports, 'active' thereafter, 'suspended' when frozen.

Available options:

pending,

active,

suspended

reported_at

string<date-time> | null

required

Instant Cleff last applied a balance report from the provider — the balance is only as fresh as this. Always Cleff's own clock, whether the provider pushed the balance or Cleff polled for it, so it is directly comparable with the timestamps on your payouts. A report that arrives out of order is discarded and does not move this. Null until the first report lands (status 'pending').

deposit_instructions

object | null

required

The coordinates the Business funds this account with; absent on non-Checkbook paths.

Show child attributes

⌘I

Top up the current Business's sandbox Cleff Account (sandbox only)

curl --request POST \
  --url https://api.example.com/v1/business/funding-account/sandbox-balance \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "available_balance_minor": 123,
  "total_balance_minor": 123,
  "currency": "<string>"
}
'

import requests

url = "https://api.example.com/v1/business/funding-account/sandbox-balance"

payload = {
    "available_balance_minor": 123,
    "total_balance_minor": 123,
    "currency": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({available_balance_minor: 123, total_balance_minor: 123, currency: '<string>'})
};

fetch('https://api.example.com/v1/business/funding-account/sandbox-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://api.example.com/v1/business/funding-account/sandbox-balance",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'available_balance_minor' => 123,
    'total_balance_minor' => 123,
    'currency' => '<string>'
  ]),
  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://api.example.com/v1/business/funding-account/sandbox-balance"

	payload := strings.NewReader("{\n  \"available_balance_minor\": 123,\n  \"total_balance_minor\": 123,\n  \"currency\": \"<string>\"\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(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/v1/business/funding-account/sandbox-balance")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"available_balance_minor\": 123,\n  \"total_balance_minor\": 123,\n  \"currency\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/v1/business/funding-account/sandbox-balance")

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  \"available_balance_minor\": 123,\n  \"total_balance_minor\": 123,\n  \"currency\": \"<string>\"\n}"

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

{
  "currency": "<string>",
  "available_balance_minor": 123,
  "total_balance_minor": 123,
  "status": "pending",
  "reported_at": "2023-11-07T05:31:56Z",
  "deposit_instructions": {
    "bank_name": "<string>",
    "routing_number": "<string>",
    "account_number": "<string>",
    "account_holder_name": "<string>",
    "reference": "<string>"
  }
}

Basics

Reference

Top up sandbox balance

Authorizations

Body

Response