Method: projects.financialTransactions.list

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

List financial transactions that satisfy specified filter criteria.

HTTP request

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

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 financialTransactions.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 financialTransactions.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 financial 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 FinancialTransaction are eligible for filtering:

  • transactionType - The transaction type of the financial transaction. Must be one of TransactionType values. For financial transactions, only valid transaction types are TRANSACTION_TYPE_CREDIT, TRANSACTION_TYPE_DEBIT and TRANSACTION_TYPE_REVERSAL. Allowed comparison operators: =.
  • transactionID - The UPI transaction ID of the financial transaction. Allowed comparison operators: =.
  • RRN - The retrieval reference number of the transaction. Allowed comparison operators: =.
  • payerVPA - The VPA of the payer in a financial transaction. Allowed comparison operators: =.
  • payeeVPA - The VPA of the payee in a financial transaction. Allowed comparison operators: =.
  • payerMobileNumber - The mobile number of the payer in a financial transaction. Allowed comparison operators: =.
  • payeeMobileNumber - The mobile number of the payee in a financial transaction. Allowed comparison operators: =.
  • payeeMerchantId - The merchant id of the payee in a financial 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:

  • transactionType = CREDIT - The transaction type is CREDIT.
  • state = SUCCEEDED - The transaction's state is SUCCEEDED.
  • payerVpa = example@okbank - The VPA of the payer is the string _example@okbank_.
  • (transactionType = DEBIT) AND (createTime < "2021-08-15T14:50:00Z")
  • The transaction type is DEBIT and 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 financialTransactions.list method.

JSON representation
{
  "financialTransactions": [
    {
      object (FinancialTransaction)
    }
  ],
  "nextPageToken": string
}
Fields
financialTransactions[]

object (FinancialTransaction)

List of financial transactions satisfying the filtered request.

nextPageToken

string

Pass this token in the ListFinancialTransactionsRequest 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.financialTransactions.list

For more information, see the IAM documentation.

FinancialTransaction

A financial API transaction processed by the issuer switch. In UPI, this maps to the Pay API.

JSON representation
{
  "name": string,
  "info": {
    object (TransactionInfo)
  },
  "retrievalReferenceNumber": string,
  "payer": {
    object (SettlementParticipant)
  },
  "payee": {
    object (SettlementParticipant)
  },
  "amount": {
    object (Money)
  }
}
Fields
name

string

The name of the financial transaction. This uniquely identifies the transaction. Format of name is projects/{project_id}/financialTransactions/{financial_transaction_id}.

info

object (TransactionInfo)

Information about the transaction.

retrievalReferenceNumber

string

Output only. A 12 digit numeric code associated with the request. It could contain leading 0s. In UPI, this is also known as as the customer reference or the UPI transaction ID.

payer

object (SettlementParticipant)

Output only. The payer in the transaction.

payee

object (SettlementParticipant)

Output only. The payee in the transaction.

amount

object (Money)

Output only. The amount for payment settlement in the transaction.