Skip to main content

Account

The Account object represents the merchant's collection entity in the GStable system.

GStable's account system is deeply bound to on-chain addresses, but for security and compliance, account creation, modification, and deletion operations must be completed in the GStable Dashboard. The API only provides read-only permissions, primarily used to query the necessary accountId and settlement configuration when programmatically creating Payment Links or Checkout Sessions.

Dashboard Management Only

Accounts involve sensitive fund settlement address configurations, so the API does not support creation or modification. Please go to the Dashboard for management.

Account Limit

For easier management, each merchant is allowed to create a maximum of 20 collection accounts.

Account Object

Core Attributes

AttributeTypeDescription
accountIdStringUnique identifier for the account (e.g., acc_example_...).
accountNameStringAccount alias configured by the merchant in the Dashboard.
accountAddressStringTarget wallet address for fund settlement.
accountTypeStringAccount type. Currently only supports EVM::ADDR (EVM compatible chain address).
settlementCurrenciesArrayList of settlement currencies supported by this account (e.g., polygon::usdc).
versionStringAccount version number. Used to distinguish cases where the same address is deleted and recreated.
statusStringAccount status. Currently only normal.

Get Account Detail

GET /account/detail/:accountId

Retrieve detailed configuration information by Account ID.

Request Parameters

This interface passes the ID via URL Path Parameter.

ParameterTypeRequiredDescription
accountIdStringAccount ID.

Request Example

GET /account/detail/acc_example_merchant_03

Response Example

{
"code": 0,
"message": "success",
"data": {
"accountName": "Main Business Collection",
"accountId": "acc_example_merchant_03",
"version": "ver_example_04",
"accountAddress": "0x0000000000000000000000000000000000000006",
"accountType": "EVM::ADDR",
"settlementCurrencies": [
"polygon::usdc",
"arbitrumone::usdt"
],
"createAt": "2025-12-18 01:59:02",
"updateAt": "2026-01-03 10:18:01",
"status": "normal"
}
}

Get Account List

GET /account/list

Retrieve all collection accounts under the current merchant. Since the platform limits the maximum number of accounts to 20, this interface does not paginate and returns full data directly.

Request Example

GET /account/list

Response Example

{
"code": 0,
"message": "success",
"data": [
{
"accountName": "Main Business Collection",
"accountId": "acc_example_merchant_03",
"version": "ver_example_04",
"accountAddress": "0x0000000000000000000000000000000000000006",
"accountType": "EVM::ADDR",
"settlementCurrencies": [
"polygon::usdc"
],
"createAt": "2025-12-18 01:59:02",
"updateAt": "2026-01-03 10:18:01",
"status": "normal"
},
{
"accountName": "Backup Collection",
"accountId": "acc_AnotherIDExample123",
"version": "ver_example_...",
"accountAddress": "0x0000000000000000000000000000000000000008",
"accountType": "EVM::ADDR",
"settlementCurrencies": [
"polygon::usdt"
],
"createAt": "2025-12-20 10:00:00",
"updateAt": "2025-12-20 10:00:00",
"status": "normal"
}
]
}