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": "18f3a684-ad08-4d5b-91af-d7cbc3e447be"
  }
}
'
{
  "id": "98660050-0d6d-46da-bf9c-412ec834fa25",
  "object": "balance_transaction",
  "amount": 5000,
  "currency": "usd",
  "ending_balance_amount": 5000,
  "transaction_type": "adjustment",
  "balance": "564ef172-f87f-4e92-bc4a-444673da31a7",
  "customer": "18f3a684-ad08-4d5b-91af-d7cbc3e447be",
  "checkout": null,
  "created_at": 1770234839,
  "updated_at": 1770234839
}

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.