Method: projects.mandateTransactions.export

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

Export mandate transactions received within the specified time range as a file into a configured target location. The returned Operation type has the following method-specific fields:

The exported file will be in the standard CSV format where each row in the file represents a transaction. The file has the following fields in order:

  • TransactionID - UPI transaction ID.
  • UniqueMandateNumber - UPI Unique Mandate Number.
  • TransactionType - Type of the transaction. This will be one of TRANSACTION_TYPE_CREATE, TRANSACTION_TYPE_REVOKE or TRANSACTION_TYPE_UPDATE.
  • RequestReceivedTimestamp - Timestamp (in UTC) indicating when the mandate API request was received by the issuer switch.
  • CreationTime - Timestamp (in UTC) indicating when the issuer switch created the transaction resource for processing the transaction.
  • State - State of the transaction. This will be one of FAILED or SUCCEEDED.
  • PayerVPA - Virtual Payment Address (VPA) of the payer.
  • PayerMobileNumber - Mobile number of the payer.
  • PayeeVPA - Virtual Payment Address (VPA) of the payee.
  • PayeeMobileNumber - Mobile number of the payee.
  • PayeeMerchantID - Payee's merchant ID.
  • Amount - Amount specified in the mandate.
  • RecurrencePattern - Reccurence pattern of the mandate. The value will be of the [MandateTransaction.RecurrencePattern][] enum.
  • RecurrenceRuleType - Reccurrence rule type of the mandate. The value will be of the MandateTransaction.RecurrenceRuleType enum.
  • RecurrenceRuleValue - Recurrence rule value of the mandate.
  • Revokeable - Boolean value specifying if the mandate is revokable.
  • StartDate - The start date of the mandate in YYYY-MM-DD format.
  • EndDate - The end date of the mandate in YYYY-MM-DD format.
  • AmountRuleType - The amount rule of the mandate. The value will be of the MandateTransaction.AmountRuleType enum.
  • ApprovalReference - The block funds reference generated by the bank, if funds have been blocked for the mandate. This column have a value only when the RecurrencePattern is ONETIME.
  • BlockFunds - Boolean value specifying if the mandate transaction requested to block funds.
  • LastUpdateTime - Timestamp (in UTC) indicating when was the last modification made to the mandate.
  • BankAdapterRequestIDs - List of Request IDs (colon separated) used when invoking the Bank Adapter APIs for fulfilling a transaction request.
  • ErrorCode - Error code of the failed transaction.
  • ErrorMessage - Error description for the failed transaction.
  • UPIErrorCode - Error code as per the UPI specification. The issuer switch maps the ErrorCode to an appropriate error code that complies with the UPI specification.

HTTP request

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

Path parameters

Parameters
parent

string

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

Request body

The request body contains data with the following structure:

JSON representation
{
  "transactionType": enum (TransactionType),
  "startTime": string,
  "endTime": string
}
Fields
transactionType

enum (TransactionType)

Transaction type for the mandate transaction API. The possible values for transaction type are

  • TRANSACTION_TYPE_CREATE
  • TRANSACTION_TYPE_REVOKE
  • TRANSACTION_TYPE_UPDATE

If no transaction type is specified, records of all the above transaction types will be exported.

startTime

string (Timestamp format)

The start time for the query.

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".

endTime

string (Timestamp format)

The end time for the query.

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".

Response body

If successful, the response body contains an instance of Operation.

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.