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
1Maximum
100Default
20cursor
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"
{
}