Method: projects.complaintTransactions.list

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

List complaint transactions that satisfy specified filter criteria.

HTTP request

GET https://issuerswitch.googleapis.com/v1/{parent}/complaintTransactions

Path parameters

Parameters
parent

string

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

Query parameters

Parameters
pageSize

integer

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.

pageToken

string

A page token, received from a previous complaintTransactions.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 complaintTransactions.list method that returned the page token will be reused for all further calls where the page token parameter is specified.

filter

string

An expression that filters the list of complaint 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 Complaint are eligible for filtering:

  • transactionID - The transaction ID of the complaint transaction. Allowed comparison operators: =.
  • transactionType - The transaction type of the complaint transaction. Must be one of TransactionType values. For complaint transactions, only valid transaction types are TRANSACTION_TYPE_CHECK_STATUS, TRANSACTION_TYPE_COMPLAINT, TRANSACTION_TYPE_REVERSAL, TRANSACTION_TYPE_DISPUTE, TRANSACTION_TYPE_REFUND or TRANSACTION_TYPE_STATUS_UPDATE. Allowed comparison operators: =.
  • originalRRN - The retrieval reference number of the original transaction for which complaint / dispute was raised / resolved. 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 complaint transactions which have failed a particular error code. 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:

  • state = SUCCEEDED - The transaction's state is SUCCEEDED.
  • (createTime < "2021-08-15T14:50:00Z")`
  • The transaction was received before 2021-08-15 14:50:00 UTC.
  • createTime > "2021-08-15T14:50:00Z" AND createTime < "2021-08-16T14:50:00Z" - The transaction was received between 2021-08-15 14:50:00 UTC and 2021-08-16 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 ListComplaintTransactionsResponse method.

JSON representation
{
  "complaintTransactions": [
    {
      object (ComplaintTransaction)
    }
  ],
  "nextPageToken": string
}
Fields
complaintTransactions[]

object (ComplaintTransaction)

List of complaint transactions satisfying the filtered request.

nextPageToken

string

Pass this token in the ListComplaintTransactionsRequest 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:

  • https://www.googleapis.com/auth/cloud-platform

IAM Permissions

Requires the following IAM permission on the parent resource:

  • issuerswitch.complaintTransactions.list

For more information, see the IAM documentation.

ComplaintTransaction

A complaint API transaction processed by the issuer switch. In UPI, this maps to the Complaint API.

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

  // Union field case can be only one of the following:
  "complaint": {
    object (Complaint)
  },
  "dispute": {
    object (Dispute)
  }
  // End of list of possible types for union field case.
}
Fields
name

string

The name of the complaint transaction. This uniquely identifies the transaction. Format of name is projects/{project_id}/complaintTransactions/{complaint_transaction_id}.

info

object (TransactionInfo)

Information about the transaction.

Union field case. Information about the complaint transaction. It can be one of Complaint or Dispute. case can be only one of the following:
complaint

object (Complaint)

Output only. Information about the complaint transaction when it is of type complaint.

dispute

object (Dispute)

Output only. Information about the complaint transaction when it is of type dispute.