QueryAccountTransactions - BSS OpenAPI - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
TransactionNumber	string	No	The number of the transaction.	133314076
RecordID	string	No	The ID of the order or bill.	20200302
TransactionChannelSN	string	No	The serial number of the transaction channel.	12342134
CreateTimeStart	string	No	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
CreateTimeEnd	string	No	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
PageNum	integer	No	The number of the page to return. Default value is 1.	1
PageSize	integer	No	The number of entries to return on each page. Default value is 20.	10
TransactionType	string	No	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
TransactionFlow	string	No	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
TransactionChannel	string	No	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

Parameter	Type	Description	Example
	object
Code	string	The status code returned.	Success
Message	string	The message returned.	Successful！
RequestId	string	The ID of the request.	8634E02D-0942-4B1D-8295-5352FE9A1F39
Success	boolean	Indicates whether the request is successful.	true
Data	object	The data returned.
PageNum	integer	The page number of the returned page.	1
PageSize	integer	The number of entries returned per page.	10
TotalCount	integer	The total number of returned entries.	10
AccountName	string	The name of your Alibaba Cloud account.	test@test.aliyunid.com
AccountTransactionsList	array<object>	The information about transactions.
	object
BillingCycle	string	The billing cycle. Format: YYYY-MM.	2020-03
TransactionChannel	string	The transaction channel. AccountBalance BankTransfer Alipay AntCreditPay OfflineRemittance RegularBankCreditRefund CreditCard MyBankCredit HuaxiaBankCInstallment ApplePay	AccountBalance
RecordID	string	The number of the order or bill.	2020030242
Remarks	string	The remarks on the transaction.	NAT_GW
Amount	string	The amount.	0
TransactionAccount	string	The transaction account. For example, the account is a recharge account in Alipay or a transfer account.	213562146
TransactionTime	string	The time when the transaction was made.	2020-03-10T02:03:20Z
TransactionType	string	The type of the transaction. Payment Withdraw Refund Consumption Transfer Adjust	Consumption
TransactionFlow	string	The type of the transaction flow. Income Expense	Expense
FundType	string	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
TransactionChannelSN	string	The serial number of the transaction channel.	1234354325
TransactionNumber	string	The number of the transaction.	43342334
Balance	string	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.