Method: projects.metadataTransactions.list

Stay organized with collections Save and categorize content based on your preferences.

List metadata transactions that satisfy the specified filter criteria.

HTTP request


Path parameters



Required. The parent resource. The format is projects/{project}.

Query parameters



The maximum number of transactions to return. The service may return fewer than this value. If unspecified or if the specified value is less than 1, at most 50 transactions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. While paginating, you can specify a new page size parameter for each page of transactions to be listed.



A page token, received from a previous metadataTransactions.list call. Specify this parameter to retrieve the next page of transactions.

When paginating, you must specify only the pageToken parameter. The filter that was specified in the initial call to the metadataTransactions.list method that returned the page token will be reused for all further calls where the page token parameter is specified.



An expression that filters the list of metadata transactions.

A filter expression consists of a field name, a comparison operator, and a value for filtering. The value must be a string, a number, or a boolean. The comparison operator must be one of: <, > or =. Filters are not case sensitive.

The following fields in the MetadataTransaction are eligible for filtering:

  • apiType - The API type of the metadata transaction. Must be one of ApiType values. Allowed comparison operators: =.
  • transactionType - The transaction type of the metadata transaction. Must be one of TransactionType values. Allowed comparison operators: =.
  • transactionID - The UPI transaction ID of the metadata transaction. Allowed comparison operators: =.
  • originVPA - The VPA of the orignitator of a metadata transaction. Allowed comparison operators: =.
  • createTime - The time at which the transaction was created (received) by the issuer switch. The value should be in the format YYYY-MM-DDTHH:MM:SSZ. Allowed comparison operators: >, <.
  • state - The state of the transaction. Must be one of TransactionInfo.State values. Allowed comparison operators: =.
  • errorCode - Use this filter to list financial transactions which have failed a particular error code. Allowed comparison operators: =.
  • bankAdapterRequestID - Request ID used when invoking the Bank Adapter API for fulfilling a transaction request. Allowed comparison operators: =.

You can combine multiple expressions by enclosing each expression in parentheses. Expressions are combined with AND logic. No other logical operators are supported.

Here are a few examples:

  • apiType = LIST_ACCOUNTS - - The API type is LIST_ACCOUNTS.
  • state = SUCCEEDED - The transaction's state is SUCCEEDED.
  • (apiType = LIST_ACCOUNTS) AND (createTime < \"2021-08-15T14:50:00Z\") - The API type is LIST_ACCOUNTS and the transaction was received before 2021-08-15 14:50:00 UTC.

Request body

The request body must be empty.

Response body

If successful, the response body contains data with the following structure:

Response for the metadataTransactions.list method.

JSON representation
  "metadataTransactions": [
      object (MetadataTransaction)
  "nextPageToken": string

object (MetadataTransaction)

List of non financial metadata transactions satisfying the filtered request.



Pass this token in the ListMetadataTransactionsRequest to continue to list results. If all results have been returned, this field is an empty string or not present in the response.

Authorization Scopes

Requires the following OAuth scope:


IAM Permissions

Requires the following IAM permission on the parent resource:

  • issuerswitch.metadataTransactions.list

For more information, see the IAM documentation.


A metadata API transaction processed by the issuer switch. This includes UPI APIs such as List Accounts, Balance Enquiry, etc.

JSON representation
  "name": string,
  "info": {
    object (TransactionInfo)
  "originVpa": string


The name of the metadata transaction. This uniquely identifies the transaction. Format of name is projects/{project_id}/metadataTransaction/{metadata_transaction_id}.


object (TransactionInfo)

Information about the transaction.



Output only. Virtual Payment Address (VPA) which originated the request.