Skip to main content
POST
/
v1
/
balance_transactions
Create
curl --request POST \
  --url https://{defaultHost}/v1/balance_transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "balance_transaction": {
    "amount": 5000,
    "currency": "usd",
    "customer": "6cfb70ff-f83e-4453-af42-37cfab0ad32d"
  }
}
'
import requests

url = "https://{defaultHost}/v1/balance_transactions"

payload = { "balance_transaction": {
"amount": 5000,
"currency": "usd",
"customer": "6cfb70ff-f83e-4453-af42-37cfab0ad32d"
} }
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({
balance_transaction: {
amount: 5000,
currency: 'usd',
customer: '6cfb70ff-f83e-4453-af42-37cfab0ad32d'
}
})
};

fetch('https://{defaultHost}/v1/balance_transactions', 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://{defaultHost}/v1/balance_transactions",
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([
'balance_transaction' => [
'amount' => 5000,
'currency' => 'usd',
'customer' => '6cfb70ff-f83e-4453-af42-37cfab0ad32d'
]
]),
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://{defaultHost}/v1/balance_transactions"

payload := strings.NewReader("{\n \"balance_transaction\": {\n \"amount\": 5000,\n \"currency\": \"usd\",\n \"customer\": \"6cfb70ff-f83e-4453-af42-37cfab0ad32d\"\n }\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://{defaultHost}/v1/balance_transactions")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"balance_transaction\": {\n \"amount\": 5000,\n \"currency\": \"usd\",\n \"customer\": \"6cfb70ff-f83e-4453-af42-37cfab0ad32d\"\n }\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://{defaultHost}/v1/balance_transactions")

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 \"balance_transaction\": {\n \"amount\": 5000,\n \"currency\": \"usd\",\n \"customer\": \"6cfb70ff-f83e-4453-af42-37cfab0ad32d\"\n }\n}"

response = http.request(request)
puts response.read_body
{
  "id": "b94aa842-6252-49ed-ae07-16c2989940a7",
  "object": "balance_transaction",
  "amount": 5000,
  "currency": "usd",
  "ending_balance_amount": 5000,
  "transaction_type": "adjustment",
  "balance": "268e9d11-80b3-442f-91d8-ad328f17ffec",
  "customer": "6cfb70ff-f83e-4453-af42-37cfab0ad32d",
  "checkout": null,
  "created_at": 1782485805,
  "updated_at": 1782485805
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
balance_transaction
object

Response

200 - application/json

Success

id
string | null

The UUID of the specific object.

object
string

A string describing the object type returned.

amount
integer

The amount of the transaction. A negative value is a credit for the customer’s balance, and a positive value is a debit to the customer’s balance.

currency
string

Three-letter ISO currency code, in lowercase.

balance

Expandable – The associated balance ID.

customer

Expandable – The associated customer ID.

ending_balance_amount
integer

The balance amount after the transaction was applied.

checkout

Expandable – The associated checkout ID.

transaction_type
string

One of either adjustment, applied_to_checkout, checkout_below_currency_minimum, or checkout_credit. Balance transactions created through the API are always adjustment transactions.

created_at
integer | null

Time at which the object was created. Measured in seconds since the Unix epoch.

updated_at
integer | null

Time at which the object was last updated. Measured in seconds since the Unix epoch.