All Products
Search
Document Center

BSS OpenAPI:QueryAccountTransactions

Last Updated:Mar 01, 2024

Queries transactions within your Alibaba Cloud 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
bss:DescribeAcccountTranRead
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
TransactionNumberstringNo

The number of the transaction.

133314076
RecordIDstringNo

The ID of the order or bill.

20200302
TransactionChannelSNstringNo

The serial number of the transaction channel.

12342134
CreateTimeStartstringNo

The beginning of the creation time range to query. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2018-01-01T00:00:00Z.

2020-03-05T01:46:09Z
CreateTimeEndstringNo

The end of the creation time range to query. By default, the transactions in the last month are queried. Specify the time in the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. Example: 2018-01-01T00:00:00Z.

2020-03-06T01:55:00Z
PageNumintegerNo

The number of the page to return.

1
PageSizeintegerNo

The number of entries to return on each page.

10
TransactionTypestringNo

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

  • Payment
  • Withdraw
  • Refund
  • Consumption
  • Transfer
  • Adjust
Payment
TransactionFlowstringNo

The type of the transaction flow. If you specify one of the following types for this parameter, the results for the specified type are returned. If the type that you specify does not belong to the following types, no result is returned. If you leave this parameter empty, the results for the following two types are returned by default. Valid values:

  • Income
  • Expense
Income
TransactionChannelstringNo

The transaction channel. If you specify one of the following transaction channels for this parameter, the results for the specified transaction channel are returned. If the transaction channel that you specify does not belong to the following transaction channels, no result is returned. If you leave this parameter empty, the results for all the following transaction channels are returned by default. Valid values:

  • AccountBalance
  • BankTransfer
  • Alipay
  • AntCreditPay
  • OfflineRemittance
  • RegularBankCreditRefund
  • CreditCard
  • MyBankCredit
  • HuaxiaBankCInstallment
  • ApplePay
AccountBalance

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The status code returned.

Success
Messagestring

The message returned.

Successful!
RequestIdstring

The ID of the request.

8634E02D-0942-4B1D-8295-5352FE9A1F39
Successboolean

Indicates whether the request is successful.

true
Dataobject

The data returned.

PageNuminteger

The page number of the returned page.

1
PageSizeinteger

The number of entries returned per page.

10
TotalCountinteger

The total number of returned entries.

10
AccountNamestring

The name of your Alibaba Cloud account.

test@test.aliyunid.com
AccountTransactionsListobject []

The information about transactions.

BillingCyclestring

The billing cycle. Format: YYYY-MM.

2020-03
TransactionChannelstring

The transaction channel.

  • AccountBalance
  • BankTransfer
  • Alipay
  • AntCreditPay
  • OfflineRemittance
  • RegularBankCreditRefund
  • CreditCard
  • MyBankCredit
  • HuaxiaBankCInstallment
  • ApplePay
AccountBalance
RecordIDstring

The number of the order or bill.

2020030242
Remarksstring

The remarks on the transaction.

NAT_GW
Amountstring

The amount.

0
TransactionAccountstring

The transaction account. For example, the account is a recharge account in Alipay or a transfer account.

213562146
TransactionTimestring

The time when the transaction was made.

2020-03-10T02:03:20Z
TransactionTypestring

The type of the transaction.

  • Payment
  • Withdraw
  • Refund
  • Consumption
  • Transfer
  • Adjust
Consumption
TransactionFlowstring

The type of the transaction flow.

  • Income
  • Expense
Expense
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.

1234354325
TransactionNumberstring

The number of the transaction.

43342334
Balancestring

The balance of the account.

0

Examples

Sample success responses

JSONformat

{
  "Code": "Success",
  "Message": "Successful!",
  "RequestId": "8634E02D-0942-4B1D-8295-5352FE9A1F39",
  "Success": true,
  "Data": {
    "PageNum": 1,
    "PageSize": 10,
    "TotalCount": 10,
    "AccountName": "test@test.aliyunid.com",
    "AccountTransactionsList": {
      "AccountTransactionsList": [
        {
          "BillingCycle": "2020-03",
          "TransactionChannel": "AccountBalance",
          "RecordID": "2020030242",
          "Remarks": "NAT_GW",
          "Amount": "0",
          "TransactionAccount": "213562146",
          "TransactionTime": "2020-03-10T02:03:20Z",
          "TransactionType": "Consumption",
          "TransactionFlow": "Expense",
          "FundType": "Cash",
          "TransactionChannelSN": "1234354325",
          "TransactionNumber": "43342334",
          "Balance": "0"
        }
      ]
    }
  }
}

Error codes

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