pub struct ListFinancialTransactionsRequest {
    pub parent: String,
    pub page_size: i32,
    pub page_token: String,
    pub filter: String,
}
Expand description

Request for the ListFinancialTransactions method. Callers can request for transactions to be filtered by the given filter criteria and specified pagination parameters.

Fields§

§parent: String

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

§page_size: i32

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.

§page_token: String

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

When paginating, you must specify only the page_token parameter. The filter that was specified in the initial call to the ListFinancialTransactions 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:

  • 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: =.
  • 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: >, <.

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:

  • rrn = 123456789123 - The RRN is 123456789123.
  • payerVpa = example@goog - The VPA of the payer is the string example@goog.
  • (payeeVpa = example@goog) AND (createTime < "2021-08-15T14:50:00Z")
  • The VPA of the payee is example@goog 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.

Trait Implementations§

source§

impl Clone for ListFinancialTransactionsRequest

source§

fn clone(&self) -> ListFinancialTransactionsRequest

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for ListFinancialTransactionsRequest

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl Default for ListFinancialTransactionsRequest

source§

fn default() -> Self

Returns the “default value” for a type. Read more
source§

impl Message for ListFinancialTransactionsRequest

source§

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.
source§

fn clear(&mut self)

Clears the message, resetting all fields to their default.
source§

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message to a buffer. Read more
source§

fn encode_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message to a newly allocated buffer.
source§

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>
where Self: Sized,

Encodes the message with a length-delimiter to a buffer. Read more
source§

fn encode_length_delimited_to_vec(&self) -> Vec<u8>
where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.
source§

fn decode(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes an instance of the message from a buffer. Read more
source§

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>
where Self: Default,

Decodes a length-delimited instance of the message from the buffer.
source§

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self. Read more
source§

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>
where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.
source§

impl PartialEq for ListFinancialTransactionsRequest

source§

fn eq(&self, other: &ListFinancialTransactionsRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for ListFinancialTransactionsRequest

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more