Skip to content

Get own balance and ledger​

GET
/v2/credits

Requires a user identity. Credits have no cash refund or automatic top-up API.

Authorizations​

bearerAuth

OAuth access token or an API key on operations declaring x-api-key-scopes. Example header - Authorization Bearer sk_<64 lowercase hex characters>.

Type
HTTP (bearer)
or
basicAuth
Type
HTTP (basic)

Parameters​

Query Parameters

limit
Type
integer
Minimum
1
Maximum
100
Default
20
cursor

Ledger UUID returned as nextCursor; must identify an existing transaction for this user.

Type
string
Format
"uuid"

Responses​

Balance and a page of immutable ledger entries; credit amounts are decimal strings and ledger IDs are UUIDs.

application/json
JSON
{
  
"balance": "string",
  
"topupAmounts": [
  
  
"10000"
  
],
  
"transactions": [
  
  
{
  
  
  
"id": "123e4567-e89b-12d3-a456-426614174000",
  
  
  
"userSub": "string",
  
  
  
"type": "TOPUP",
  
  
  
"amount": "string",
  
  
  
"balanceAfter": "string",
  
  
  
"createdAt": "2024-01-01T00:00:00Z",
  
  
  
"orderId": "string",
  
  
  
"appiepayTransactionId": "string",
  
  
  
"reason": "string"
  
  
}
  
],
  
"nextCursor": "123e4567-e89b-12d3-a456-426614174000"
}

Playground​

Authorization
Variables
Key
Value

Samples​

상호명: 스텔라아이티 주식회사
대표자: 홍윤석
주소: 서울특별시 금천구 디지털로9길 32, 비동 504-2호 (가산동, 갑을그레이트밸리)
사업자등록번호: 832-86-02374
전화번호: 1533-7848
이메일주소: contact@stella-it.com
통판업신고번호: 2024-서울금천-1834