All Products
Search
Document Center

BSS OpenAPI:QueryAccountTransactionDetails

Last Updated:Mar 01, 2024

Queries the details of transactions within your account.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
bssapi:QueryAccountTransactionDetailsRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TransactionNumberstringNo

The number of the transaction.

410874027490089
RecordIDstringNo

The ID of the order or bill.

2022120336190912
TransactionChannelSNstringNo

The serial number of the transaction channel.

2022112122001470591458665933
CreateTimeStartstringNo

The beginning of the creation time range to query.

2022-01-20
CreateTimeEndstringNo

The end of the creation time range to query.

2022-12-20
TransactionTypestringNo

The type of the transaction.

CHARGE
TransactionChannelstringNo

The transaction channel.

ALIPAY
NextTokenstringNo

The token that is used for paging.

ABEDSDS124DASA
MaxResultsintegerNo

This parameter is invalid.

0

Response parameters

ParameterTypeDescriptionExample
object

The responses.

Codestring

The status code returned.

200
Messagestring

The message returned.

SUCCESS
RequestIdstring

The ID of the request.

asadadad-edafafafaasd
Successboolean

Indicates whether the request is successful.

true
Dataobject

The data returned.

NextTokenstring

The token that is used for paging.

ASHDADS
TotalCountinteger

The total number of entries returned.

100
MaxResultsinteger

This parameter is invalid.

0
AccountNamestring

The name of the account.

yidi
AccountTransactionsListobject []

The details of the transactions within the account.

BillingCyclestring

The billing cycle.

2022-10
TransactionChannelstring

The transaction channel.

ALIPAY
RecordIDstring

The ID of the order or bill.

2022120336190912
Remarksstring

The remarks.

Test
Amountstring

The amount of the transaction.

1.00
TransactionAccountstring

The transaction account.

fortune_test@xxx.com
TransactionTimestring

The time when the transaction was made.

2022-10-01
TransactionTypestring

The type of the transaction. If one of the following transaction types is specified, results for the specified transaction type are returned. If the transaction type that you specified does not belong to the following transaction types, no result is returned. If the parameter is left empty, results for all transaction types are returned. Valid values:

Payment, Withdraw, Refund, Consumption, Transfer, and Adjust.

Consumption
TransactionFlowstring

Indicates whether the transaction is of the income type or the expenditure type. If one of the following types is specified, results for the specific type are returned. If the type that you specified for the parameter does not belong to the following types, no result is returned. If the parameter is left empty, results for transactions of the income and expenditure types are all returned. Valid values:

Income and Expense.

Income
FundTypestring

The type of transaction payment. Valid values:

Cash: pay for the transaction in cash. Deposit: pay for the transaction with deposit. RegularBankCreditRefund: pay for the transaction with credit refund controlled by a bank. DirectPay: directly pay for the transaction.

Cash
TransactionChannelSNstring

The serial number of the transaction channel.

123232434343532
TransactionNumberstring

The number of the transaction.

43342334
Balancestring

The balance of the account.

0

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "SUCCESS",
  "RequestId": "asadadad-edafafafaasd",
  "Success": true,
  "Data": {
    "NextToken": "ASHDADS",
    "TotalCount": 100,
    "MaxResults": 0,
    "AccountName": "yidi",
    "AccountTransactionsList": {
      "AccountTransactionsList": [
        {
          "BillingCycle": "2022-10",
          "TransactionChannel": "ALIPAY",
          "RecordID": "2022120336190912",
          "Remarks": "Test\n",
          "Amount": "1.00",
          "TransactionAccount": "fortune_test@xxx.com",
          "TransactionTime": "2022-10-01",
          "TransactionType": "Consumption",
          "TransactionFlow": "Income",
          "FundType": "Cash",
          "TransactionChannelSN": "123232434343532",
          "TransactionNumber": "43342334",
          "Balance": "0"
        }
      ]
    }
  }
}

Error codes

For a list of error codes, visit the Service error codes.