Method: projects.mandateTransactions.list

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

List mandate transactions that satisfy specified filter criteria.

HTTP request

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

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 mandateTransactions.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 mandateTransactions.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 mandate 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 Mandate are eligible for filtering:

  • uniqueMandateNumber - UPI Unique Mandate Number (UMN). Allowed comparison operators: =.
  • transactionID - The transaction ID of the mandate transaction. Allowed comparison operators: =.
  • transactionType - The transaction type of the mandate transaction. Must be one of TransactionType values. For mandate transactions, only valid transaction types are TRANSACTION_TYPE_CREATE, TRANSACTION_TYPE_REVOKE and TRANSACTION_TYPE_UPDATE. Allowed comparison operators: =.
  • payerVPA - The VPA of the payer in a mandate transaction. Allowed comparison operators: =.
  • payeeVPA - The VPA of the payee in a mandate transaction. Allowed comparison operators: =.
  • payeeMerchantID - The merchant ID of the payee in a mandate transaction. Allowed comparison operators: =.
  • payerMobileNumber - The mobile number of the payer in a mandate transaction. Allowed comparison operators: =.
  • payeeMobileNumber - The mobile number of the payee in a mandate 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: =.
  • recurrencePattern - The recurrence pattern of the mandate. Must be one of MandateTransaction.RecurrencePatternType values. Allowed comparison operators: =.
  • startDate - The start date of the mandate. The value should be in the format YYYY-MM-DD. Allowed comparison operators: < and >.
  • endDate - The end date of the mandate. The value should be in the format YYYY-MM-DD. Allowed comparison operators: < and >.
  • errorCode - Use this filter to list mandate 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: * recurrencePattern = MONTHLY - The recurrence pattern type is monthly. * state = SUCCEEDED - The transaction's state is SUCCEEDED. * payerVPA = example@okbank - The VPA of the payer is the string _example@okbank_. * (payerVPA = example@okbank) AND (createTime < "2021-08-15T14:50:00Z") - The payer VPA example@okbank 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. * startDate > "2021-08-15" AND startDate < "2021-08-17" - The start date for mandate is between 2021-08-15 and 2021-08-17.

Request body

The request body must be empty.

Response body

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

Response for the ListMandateTransactionsResponse method.

JSON representation
{
  "mandateTransactions": [
    {
      object (MandateTransaction)
    }
  ],
  "nextPageToken": string
}
Fields
mandateTransactions[]

object (MandateTransaction)

List of mandate transactions satisfying the filtered request.

nextPageToken

string

Pass this token in the ListMandateTransactionsRequest 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.mandateTransactions.list

For more information, see the IAM documentation.

MandateTransaction

A mandate processed by the issuer switch. In UPI, this maps to the Mandate API.

JSON representation
{
  "name": string,
  "transactionInfo": {
    object (TransactionInfo)
  },
  "uniqueMandateNumber": string,
  "payerVpa": string,
  "payeeVpa": string,
  "payeeMerchantId": string,
  "payerMobileNumber": string,
  "payeeMobileNumber": string,
  "recurrencePattern": enum (RecurrencePatternType),
  "recurrenceRuleType": enum (RecurrenceRuleType),
  "recurrenceRuleValue": integer,
  "startDate": {
    object (Date)
  },
  "endDate": {
    object (Date)
  },
  "revokable": boolean,
  "amount": number,
  "amountRule": enum (AmountRuleType),
  "approvalReference": string,
  "blockFunds": boolean,
  "lastUpdateTime": string
}
Fields
name

string

The name of the mandate transaction. This uniquely identifies the transaction. Format of name is projects/{project_id}/mandateTransactions/{mandate_transaction_id}.

transactionInfo

object (TransactionInfo)

Information about the transaction.

uniqueMandateNumber

string

Output only. This maps to Unique Mandate Number (UMN) in UPI specification.

payerVpa

string

Output only. The virtual payment address (VPA) of the payer.

payeeVpa

string

Output only. The virtual payment address (VPA) of the payee.

payeeMerchantId

string

Output only. A unique identifier for merchant.

payerMobileNumber

string

Output only. The mobile number of the payer consisting of total twelve digits where first two digits of country code (for eg. 91 for India) and then ten digits mobile number. For eg. 911234567890

payeeMobileNumber

string

Output only. The mobile number of the payer consisting of total twelve digits where first two digits of country code (for eg. 91 for India) and then ten digits mobile number. For eg. 911234567890

recurrencePattern

enum (RecurrencePatternType)

Output only. The type of recurrence pattern of the mandate.

recurrenceRuleType

enum (RecurrenceRuleType)

Output only. The type of recurrence rule of the mandate.

recurrenceRuleValue

integer

Output only. The recurrence rule value of the mandate. This is a value from 1 to 31.

startDate

object (Date)

Output only. The start date of the mandate.

endDate

object (Date)

Output only. The end date of the mandate.

revokable

boolean

Output only. If true, this specifies mandate can be revoked.

amount

number

Output only. The amount of the mandate.

amountRule

enum (AmountRuleType)

Output only. The amount rule type of the mandate.

approvalReference

string

Output only. The Block funds reference generated by the bank, this will be available only when Recurrence is ONETIME.

blockFunds

boolean

Output only. If true, this specifies the mandate transaction requested funds to be blocked.

lastUpdateTime

string (Timestamp format)

Output only. The last time at which the mandate resource was modified by the issuer switch.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

RecurrencePatternType

RecurrencePatternType specifies the recurrence pattern type of the mandate.

Enums
RECURRENCE_PATTERN_TYPE_UNSPECIFIED Unspecified recurrence pattern.
AS_PRESENTED As presented recurrence pattern.
BIMONTHLY Bi monthly recurrence pattern.
DAILY Daily recurrence pattern.
FORTNIGHTLY Bi weekly recurrence pattern.
HALF_YEARLY Half yearly recurrence pattern.
MONTHLY Monthly recurrence pattern.
ONE_TIME One time recurrence pattern.
QUARTERLY Quarterly recurrence pattern.
WEEKLY Weekly recurrence pattern.
YEARLY Yearly recurrence pattern.

RecurrenceRuleType

RecurrenceRuleType specifies the recurrence rule type of mandate.

Enums
RECURRENCE_RULE_TYPE_UNSPECIFIED Unspecified recurrence rule type.
AFTER After recurrence rule type.
BEFORE Before recurrence rule type.
ON On recurrence rule type.

Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following:

  • A full date, with non-zero year, month, and day values.
  • A month and day, with a zero year (for example, an anniversary).
  • A year on its own, with a zero month and a zero day.
  • A year and month, with a zero day (for example, a credit card expiration date).

Related types:

JSON representation
{
  "year": integer,
  "month": integer,
  "day": integer
}
Fields
year

integer

Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.

month

integer

Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.

day

integer

Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.

AmountRuleType

AmountRuleType specifies the type of rule associated with the mandate amount.

Enums
AMOUNT_RULE_TYPE_UNSPECIFIED Unspecified amount rule.
EXACT Exact amount rule. Amount specified is the exact amount for which mandate could be granted.
MAX Max amount rule. Amount specified is the maximum amount for which mandate could be granted.