English

简体中文

English

简体中文

Appearance

About Finance Account ​

Access scope

Multiple access scopes needed — refer to each endpoint for access scope requirements.

Finance Account is the financial management component of GenPayment, providing comprehensive finance management capabilities. Merchants can track the source and flow of each payment transaction, enabling precise finance management.

Core Concepts

  • Finance Account: Records merchant transaction settlement finance status, including funds in settlement, settled funds, and withdrawn funds.

Core Functions

  • Query Finance Account: Retrieve finance balance information at each stage, including currency and amount details.
  • Query Finance Details: Track the movement (settlement, withdrawal, etc.) of each payment transaction.

Endpoints

GET /api/202412/balance: Get balance account

FinanceAccount Object ​

Finance Account is the core capability of GenPayment, which provides complete fund management capabilities. Through this module, merchants can query the source and flow of each fund after successful payment, achieving precise fund management.

Properties ​

balanceobject
Fianance Account.
- Hide child properties
settlementedAmountstring
The amount to be withdrawn that has been settlemented in the account.
financeIdstring
Unique identifier for financial accounts.
currencystring
The currency of the funds.
settlingAmountstring
Transaction completed and pending settlement amount.
bash
{
  "balance": {
    "settlingAmount": "123123",
    "settlementedAmount": "1000",
    "financeId": "FI123123",
    "currency": "USD"
  }
}

GET Get balance account ​

Get shop balance account details.

Access scope

Requires ANY of the following access scopes: read_finance_account write_finance_account

Endpoint

GET /api/202412/balance 

Request Params

{}

Response Data

balanceobject
Fianance account.
- Hide child properties
settlementedAmountstring
The amount to be withdrawn that has been settlemented in the account.
financeIdstring
Unique identifier for financial accounts.
currencystring
The currency of the funds.
settlingAmountstring
Transaction completed and pending settlement amount.
bash
curl -X GET \ 
https://{shop}.genmystore.com/api/202412/balance" \ 
-H "X-Genstore-Access-Token: {access_token}" \
json
HTTP/1.1 200 OK
{
  "balance": {
    "settlingAmount": "123123",
    "settlementedAmount": "1000",
    "financeId": "FI123123",
    "currency": "USD"
  }
}