Skip to main content
GET
/
v1
/
balance
/
transactions
List balance transactions
curl --request GET \
  --url https://api.kyren.top/v1/balance/transactions \
  --header 'x-api-key: <api-key>'
{
  "code": 0,
  "message": "success",
  "data": {
    "items": [
      {
        "id": "btx_ghi789",
        "type": "PAYMENT",
        "amount": "9.29",
        "currency": "USD",
        "availableAfter": "1250.00",
        "pendingAfter": "350.00",
        "frozenAfter": "0.00",
        "sourceType": "order",
        "sourceId": "order_def456",
        "description": "Payment received for order order_def456",
        "createdAt": 1736932500000
      }
    ],
    "pagination": {
      "page": 1,
      "size": 20,
      "total": 1,
      "totalPages": 1
    }
  }
}

Authorizations

​
x-api-key
string
header
required

Your API key. Public production API-key endpoints accept kyren_live_* keys. Staging credentials are environment-specific and must be used only with the staging environment for which Kyren issued them.

Query Parameters

​
type
enum<string>

Filter by transaction type

  • PAYMENT — Payment received (added to pending)
  • SETTLEMENT — Funds settled (pending → available)
  • PAYOUT — Payout deducted from available
  • FREEZE / UNFREEZE — Funds frozen or released
  • CHARGEBACK — Chargeback deduction
  • CHARGEBACK_FEE — Chargeback fee deduction
  • ROLLING_RESERVE — Rolling reserve hold
  • ROLLING_RESERVE_RELEASE — Rolling reserve release
  • ROLLING_RESERVE_OFFSET — Rolling reserve used to offset chargeback loss
  • ADMIN_RECHARGE — Manual admin recharge
  • REFUND — Refund deduction
  • FEE — Fee deduction
Available options:
PAYMENT,
SETTLEMENT,
PAYOUT,
FREEZE,
UNFREEZE,
CHARGEBACK,
CHARGEBACK_FEE,
ROLLING_RESERVE,
ROLLING_RESERVE_RELEASE,
ROLLING_RESERVE_OFFSET,
ADMIN_RECHARGE,
REFUND,
FEE
​
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
​
size
integer
default:20

Number of items per page

Required range: 1 <= x <= 100

Response

A paginated list of balance transactions

​
code
integer
Example:

0

​
message
string
Example:

"success"

​
data
object