Method: projects.financialTransactions.export

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

Export financial 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.
  • TransactionType - Type of the transaction. This will be one of TRANSACTION_TYPE_CREDIT, TRANSACTION_TYPE_DEBIT or TRANSACTION_TYPE_REVERSAL.
  • TransactionSubType - Subtype of the transaction. This will be one of COLLECT, DEBIT or PAY.
  • RequestReceivedTimestamp - Timestamp (in UTC) indicating when the transaction 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.
  • RRN - Retrieval reference number associated with the transaction.
  • PayerVPA - Virtual Payment Address (VPA) of the payer.
  • PayerMobileNumber - Mobile number of the payer.
  • PayerIFSCCode - IFSC code of the payer's bank account.
  • PayerAccountNumber - Payer's bank account number.
  • PayerAccountType - Payer's bank account type.
  • PayeeVPA - Virtual Payment Address (VPA) of the payee.
  • PayeeMobileNumber - Payee's mobile number.
  • PayeeIFSCCode - IFSC code of the payee's bank account.
  • PayeeAccountNumber - Payee's bank account number.
  • PayeeAccountType - Payee's bank account type.
  • PayeeMerchantID - Payee's merchant ID, only if the payee is a merchant.
  • PayeeMerchantName - Payee's merchant name, only if the payee is a merchant.
  • PayeeMCC - Payee's Merchant Category Code (MCC), only if the payee is a merchant.
  • Currency - Currency of the amount involved in the transaction.
  • Amount - Amount involved in the transaction.
  • 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}/financialTransactions: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 financial transaction API. The possible values for transaction type are

  • TRANSACTION_TYPE_CREDIT
  • TRANSACTION_TYPE_DEBIT
  • TRANSACTION_TYPE_REVERSAL

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.financialTransactions.list

For more information, see the IAM documentation.