Package google.cloud.paymentgateway.issuerswitch.v1

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

Index

IssuerSwitchResolutions

Creates and resolves UPI complaints and disputes.

CreateComplaint

rpc CreateComplaint(CreateComplaintRequest) returns (Operation)

Create a complaint. The returned Operation type has the following method-specific fields:

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.complaints.create

For more information, see the IAM documentation.

CreateDispute

rpc CreateDispute(CreateDisputeRequest) returns (Operation)

Create a dispute. The returned Operation type has the following method-specific fields:

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.disputes.create

For more information, see the IAM documentation.

ResolveComplaint

rpc ResolveComplaint(ResolveComplaintRequest) returns (Operation)

Resolve a complaint. The returned Operation type has the following method-specific fields:

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform
IAM Permissions

Requires the following IAM permission on the name resource:

  • issuerswitch.complaints.resolve

For more information, see the IAM documentation.

ResolveDispute

rpc ResolveDispute(ResolveDisputeRequest) returns (Operation)

Resolve a dispute. The returned Operation type has the following method-specific fields:

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform
IAM Permissions

Requires the following IAM permission on the name resource:

  • issuerswitch.disputes.resolve

For more information, see the IAM documentation.

IssuerSwitchRules

Manages rules used by the issuer switch's rules engine.

BatchCreateRuleMetadataValues

rpc BatchCreateRuleMetadataValues(BatchCreateRuleMetadataValuesRequest) returns (BatchCreateRuleMetadataValuesResponse)

Create (add) multiple values to the list of values under the specified rule metadata resource.

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.ruleMetadataValues.create

For more information, see the IAM documentation.

BatchDeleteRuleMetadataValues

rpc BatchDeleteRuleMetadataValues(BatchDeleteRuleMetadataValuesRequest) returns (Empty)

Delete (remove) multiple values from the list of values under the specified rules metadata resource.

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.ruleMetadataValues.delete

For more information, see the IAM documentation.

ListRuleMetadata

rpc ListRuleMetadata(ListRuleMetadataRequest) returns (ListRuleMetadataResponse)

List all rule metadata for a given rule identifier.

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

For more information, see the IAM documentation.

ListRuleMetadataValues

rpc ListRuleMetadataValues(ListRuleMetadataValuesRequest) returns (ListRuleMetadataValuesResponse)

List all metadata values for a rule metadata identifier.

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

For more information, see the IAM documentation.

ListRules

rpc ListRules(ListRulesRequest) returns (ListRulesResponse)

List all rules that are applied on transactions by the issuer switch. Rules can be filtered on API type and transaction type.

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

For more information, see the IAM documentation.

IssuerSwitchTransactions

Lists and exports transactions processed by the issuer switch.

ExportComplaintTransactions

rpc ExportComplaintTransactions(ExportComplaintTransactionsRequest) returns (Operation)

Export complaint 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_CHECK_STATUS, TRANSACTION_TYPE_COMPLAINT, TRANSACTION_TYPE_REVERSAL, TRANSACTION_TYPE_DISPUTE, TRANSACTION_TYPE_REFUND or TRANSACTION_TYPE_STATUS_UPDATE.
  • 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.
  • OriginalRRN - RRN of the original payment transaction.
  • BankType - The subtype of the transaction based on the bank involved.
  • OriginalTransactionID - Transaction ID of the original unresolved transaction.
  • RaiseComplaintAdjFlag - Indicates the type of action to raise the complaint.
  • RaiseComplaintAdjCode - Indicates the reason of action to raise the complaint.
  • ResolveComplaintAdjFlag - Indicates the type of action to resolve the complaint.
  • ResolveComplaintAdjCode - Indicates the reason of action to resolve the complaint.
  • RaiseDisputeAdjFlag - Indicates the type of action to raise the dispute.
  • RaiseDisputeAdjCode - Indicates the reason of action to raise the dispute.
  • ResolveDisputeAdjFlag - Indicates the type of action to resolve the dispute.
  • ResolveDisputeAdjCode - Indicates the reason of action to resolve the dispute.
  • Amount - Amount to be resolved.
  • CurrentCycle - Boolean value specifying if the complaint / dispute belongs to current settlement cycle or not.
  • CRN - Defines the Complaint Reference number.
  • AdjTime - Indicates the time when the resolution was done.
  • RespAdjFlag - Indicates the response category type.
  • RespAdjCode - Indicates the response reason used.
  • AdjRemarks - Indicates the additional remarks for the complaint / dispute.
  • 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 service maps the ErrorCode to an appropriate error code that complies with the UPI specification.
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.complaintTransactions.list

For more information, see the IAM documentation.

ExportFinancialTransactions

rpc ExportFinancialTransactions(ExportFinancialTransactionsRequest) returns (Operation)

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

ExportMandateTransactions

rpc ExportMandateTransactions(ExportMandateTransactionsRequest) returns (Operation)

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

ExportMetadataTransactions

rpc ExportMetadataTransactions(ExportMetadataTransactionsRequest) returns (Operation)

Export metadata 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.
  • APIType - The transaction's API type. The value will be of the ApiType enum.
  • TransactionType - Type of the transaction. The value will be of the TransactionType enum.
  • RequestReceivedTimestamp - Timestamp (in UTC) indicating when the transaction's 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 transaction. This will be one of FAILED or SUCCEEDED.
  • OriginVPA - Virtual Payment Address (VPA) of the originator of 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.
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.metadataTransactions.list

For more information, see the IAM documentation.

ListComplaintTransactions

rpc ListComplaintTransactions(ListComplaintTransactionsRequest) returns (ListComplaintTransactionsResponse)

List complaint transactions that satisfy specified filter criteria.

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

For more information, see the IAM documentation.

ListFinancialTransactions

rpc ListFinancialTransactions(ListFinancialTransactionsRequest) returns (ListFinancialTransactionsResponse)

List financial transactions that satisfy specified filter criteria.

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.

ListMandateTransactions

rpc ListMandateTransactions(ListMandateTransactionsRequest) returns (ListMandateTransactionsResponse)

List mandate transactions that satisfy specified filter criteria.

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.

ListMetadataTransactions

rpc ListMetadataTransactions(ListMetadataTransactionsRequest) returns (ListMetadataTransactionsResponse)

List metadata transactions that satisfy the specified filter criteria.

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

For more information, see the IAM documentation.

AccountReference

A reference to uniquely identify an account according to India's UPI standards.

Fields
ifsc_code

string

IFSC code of a bank's branch.

account_type

string

Type of account. Examples include SAVINGS, CURRENT, etc.

account_number

string

Unique number for an account in a bank and branch.

ApiType

The API type for a transaction. Every transaction processed by the issuer switch will be one of these API types.

Enums
API_TYPE_UNSPECIFIED Unspecified API type.
BALANCE Balance API. Maps to UPI's BalEnq API. This is a metadata transaction API.
CHECK_STATUS Check transaction status API. Maps to UPI's ChkTxn API. This is a metadata transaction API.
COMPLAINT Complaint API. Maps to UPI's Complaint API. This is a dispute and issue resolution API.
HEART_BEAT Heart beat API. Maps to UPI's Hbt API. This is a metadata transaction API.
INITIATE_REGISTRATION Initiate registration API. Maps to UPI's Otp API. This is a metadata transaction API.
LIST_ACCOUNTS List accounts API. Maps to UPI's ListAccount API. This is a metadata transaction API.
MANDATE Mandate API. Maps to UPI's Mandate API. This is a metadata transaction API.
SETTLE_PAYMENT Payment settlement API. Maps to UPI's Pay API. This is a financial transaction API.
UPDATE_CREDENTIALS Update credentials API. Maps to UPI's SetCre API. This is a metadata transaction API.
VALIDATE_REGISTRATION Validate registration API. Maps to UPI's RegMob API. This is a metadata transaction API.
VOUCHER_CONFIRMATION Voucher confirmation API. Maps to UPI's VoucherConfirmation API.

BatchCreateRuleMetadataValuesRequest

Request body for the BatchCreateRuleMetadataValues method.

Fields
parent

string

The parent resource shared by all ruleMetadataValue being created. The format is projects/{project}/rules/{rule}/metadata/{metadata}. The CreateRuleMetadataValueRequest.parent field in the CreateRuleMetadataValueRequest messages contained in this request must match this field.

requests[]

CreateRuleMetadataValueRequest

Required. The request message specifying the resources to create. A maximum of 1000 RuleMetadataValues can be created in a batch.

BatchCreateRuleMetadataValuesResponse

Response body for the BatchCreateRuleMetadataValues method.

Fields
rule_metadata_value[]

RuleMetadataValue

List of RuleMetadataValue created.

BatchDeleteRuleMetadataValuesRequest

Request body for the BatchDeleteRuleMetadataValues method.

Fields
parent

string

The parent resource shared by all RuleMetadataValues being deleted. The format is projects/{project}/rules/{rule}/metadata/{metadata}. If this is set, the parent of all of the RuleMetadataValues specified in the list of names must match this field.

names[]

string

Required. The names of the rule metadata values to delete. A maximum of 1000 RuleMetadataValue can be deleted in a batch. Format: projects/{project}/rules/{rule}/metadata/{metadata}/values/{value}

CaseDetails

Details of the complaint or dispute.

Fields
original_transaction

OriginalTransaction

Required. Details of original transaction.

transaction_sub_type

TransactionSubType

Required. Initiator of the complaint / dispute.

amount

Money

Required. The adjustment amount in URCS for the complaint / dispute. This maps to reqAdjAmount in complaint request.

original_settlement_response_code

string

The original response code which has been updated in the complaint Response. This should map to settlement response code currently available in URCS system.

current_cycle

bool

Required. Set to true if the complaint / dispute belongs to current settlement cycle, false otherwise.

CaseResponse

Response to the complaint or dispute.

Fields
complaint_reference_number

string

Complaint Reference Number(CRN) sent by UPI as a reference against the generated complaint / dispute.

amount

Money

The adjustment amount of the response. This maps to adjAmt in complaint response.

adjustment_flag

string

The adjustment flag in response to the complaint. This maps adjustment flag in URCS for the complaint transaction to Resp.Ref.adjFlag in complaint response.

adjustment_code

string

The adjustment code in response to the complaint. This maps reason code in URCS for the complaint transaction to Resp.Ref.adjCode in complaint response.

adjustment_reference_id

string

It defines the Adjustment Reference ID which has been updated in the complaint response. This maps to adjRefID in complaint response.

adjustment_remarks

string

Adjustment Remarks. This maps to adjRemarks in complaint response.

approval_number

string

The Approval Reference Number. This maps to approvalNum in complaint response.

process_status

string

Process Status of the transaction. This maps to procStatus in complaint response.

adjustment_time

Timestamp

The adjustment timestamp when bank performs the adjustment for the received complaint request. This maps to adjTs in complaint response.

Union field participant. The details of the participant of the original financial transaction. participant can be only one of the following:
payer

SettlementParticipant

The payer in the original financial transaction.

payee

SettlementParticipant

The payee in the original financial transaction.

Complaint

A complaint processed by the issuer switch.

Fields
name

string

The name of the complaint. This uniquely identifies the complaint. Format of name is projects/{project_id}/complaints/{complaint_id}.

raise_complaint_adjustment

RaiseComplaintAdjustment

The reason for raising the complaint. This maps adjustment flag and reason code for the complaint to reqAdjFlag and reqAdjCode in complaint request respectively while raising a complaint.

details

CaseDetails

Required. Details required for raising / resolving a complaint.

response

CaseResponse

Output only. Response to the raised / resolved complaint.

resolve_complaint_adjustment

ResolveComplaintAdjustment

The reason for resolving the complaint. It provides adjustment values while resolving and for already resolved complaints. This maps adjustment flag and reason code for the complaint to reqAdjFlag and reqAdjCode in complaint request respectively when a complete resolution is done via Resolve Complaint API otherwise maps to respAdjFlag and respAdjCode in complaint response respectively when a complaint request from UPI is directly resolved by issuer switch.

ComplaintTransaction

A complaint API transaction processed by the issuer switch. In UPI, this maps to the Complaint API.

Fields
name

string

The name of the complaint transaction. This uniquely identifies the transaction. Format of name is projects/{project_id}/complaintTransactions/{complaint_transaction_id}.

info

TransactionInfo

Information about the transaction.

Union field case. Information about the complaint transaction. It can be one of Complaint or Dispute. case can be only one of the following:
complaint

Complaint

Output only. Information about the complaint transaction when it is of type complaint.

dispute

Dispute

Output only. Information about the complaint transaction when it is of type dispute.

CreateComplaintMetadata

Metadata for CreateComplaint.

CreateComplaintRequest

Request for the CreateComplaint method.

Fields
parent

string

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

complaint

Complaint

Required. The complaint to be raised.

CreateDisputeMetadata

Metadata for CreateDispute.

CreateDisputeRequest

Request for the CreateDispute method.

Fields
parent

string

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

dispute

Dispute

Required. The dispute to be raised.

CreateRuleMetadataValueRequest

Request for creating a single RuleMetadataValue.

Fields
parent

string

Required. The parent resource where this RuleMetadataValue will be created. The format is projects/{project}/rules/{rule}/metadata/{metadata}.

rule_metadata_value

RuleMetadataValue

Required. The rule metadata value to create or add to a list.

Dispute

A dispute processed by the issuer switch.

Fields
name

string

The name of the dispute. This uniquely identifies the dispute. Format of name is projects/{project_id}/disputes/{dispute_id}.

raise_dispute_adjustment

RaiseDisputeAdjustment

The reason for raising the dispute. This maps adjustment flag and reason code for the dispute to reqAdjFlag and reqAdjCode in complaint request respectively while raising a dispute.

details

CaseDetails

Required. Details required for raising/resolving dispute.

response

CaseResponse

Output only. Response to the raised/resolved dispute.

resolve_dispute_adjustment

ResolveDisputeAdjustment

The reason for resolving the dispute. It provides adjustment values while resolving and for already resolved disputes. This maps adjustment flag and reason code for the dispute to reqAdjFlag and reqAdjCode in dispute request respectively while resolving a dispute.

ExportComplaintTransactionsMetadata

Metadata for ExportComplaintTransactions.

ExportComplaintTransactionsRequest

Request for the ExportComplaintTransactions method.

Fields
parent

string

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

transaction_type

TransactionType

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

  • TRANSACTION_TYPE_CHECK_STATUS
  • TRANSACTION_TYPE_COMPLAINT
  • TRANSACTION_TYPE_DISPUTE
  • TRANSACTION_TYPE_REFUND
  • TRANSACTION_TYPE_REVERSAL
  • TRANSACTION_TYPE_STATUS_UPDATE

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

start_time

Timestamp

The start time for the query.

end_time

Timestamp

The end time for the query.

ExportComplaintTransactionsResponse

Response for the ExportComplaintTransactions method.

Fields
target_uri

string

URI of the exported file.

ExportFinancialTransactionsMetadata

Metadata for ExportFinancialTransactions.

ExportFinancialTransactionsRequest

Request for the ExportFinancialTransactions method.

Fields
parent

string

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

transaction_type

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.

start_time

Timestamp

The start time for the query.

end_time

Timestamp

The end time for the query.

ExportFinancialTransactionsResponse

Response for the ExportFinancialTransactions method.

Fields
target_uri

string

URI of the exported file.

ExportMandateTransactionsMetadata

Metadata for ExportMandateTransactions.

ExportMandateTransactionsRequest

Request for the ExportMandateTransactions method.

Fields
parent

string

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

transaction_type

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.

start_time

Timestamp

The start time for the query.

end_time

Timestamp

The end time for the query.

ExportMandateTransactionsResponse

Response for the ExportMandateTransactions method.

Fields
target_uri

string

URI of the exported file.

ExportMetadataTransactionsMetadata

Metadata for ExportMetadataTransactions.

ExportMetadataTransactionsRequest

Request for the ExportMetadataTransactions method.

Fields
parent

string

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

api_type

ApiType

API type of the metadata transaction API. The possible values for API type are

  • BALANCE
  • CHECK_STATUS
  • HEART_BEAT
  • INITIATE_REGISTRATION
  • LIST_ACCOUNTS
  • UPDATE_CREDENTIALS
  • VALIDATE_REGISTRATION

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

start_time

Timestamp

The start time for the query.

end_time

Timestamp

The end time for the query.

ExportMetadataTransactionsResponse

Response for the ExportMetadataTransactions method.

Fields
target_uri

string

URI of the exported file.

FinancialTransaction

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

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

TransactionInfo

Information about the transaction.

retrieval_reference_number

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

SettlementParticipant

Output only. The payer in the transaction.

payee

SettlementParticipant

Output only. The payee in the transaction.

amount

Money

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

ListComplaintTransactionsRequest

Request for the ListComplaintTransactions 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

int32

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 ListComplaintTransactions 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 ListComplaintTransactions 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 complaint 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 Complaint are eligible for filtering:

  • transactionID - The transaction ID of the complaint transaction. Allowed comparison operators: =.
  • transactionType - The transaction type of the complaint transaction. Must be one of TransactionType values. For complaint transactions, only valid transaction types are TRANSACTION_TYPE_CHECK_STATUS, TRANSACTION_TYPE_COMPLAINT, TRANSACTION_TYPE_REVERSAL, TRANSACTION_TYPE_DISPUTE, TRANSACTION_TYPE_REFUND or TRANSACTION_TYPE_STATUS_UPDATE. Allowed comparison operators: =.
  • originalRRN - The retrieval reference number of the original transaction for which complaint / dispute was raised / resolved. 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 complaint transactions which have failed a particular error code. 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:

  • state = SUCCEEDED - The transaction's state is SUCCEEDED.
  • (createTime < "2021-08-15T14:50:00Z")`
  • 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.

ListComplaintTransactionsResponse

Response for the ListComplaintTransactionsResponse method.

Fields
complaint_transactions[]

ComplaintTransaction

List of complaint transactions satisfying the filtered request.

next_page_token

string

Pass this token in the ListComplaintTransactionsRequest to continue to list results. If all results have been returned, this field is an empty string or not present in the response.

ListFinancialTransactionsRequest

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

int32

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:

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

ListFinancialTransactionsResponse

Response for the ListFinancialTransactions method.

Fields
financial_transactions[]

FinancialTransaction

List of financial transactions satisfying the filtered request.

next_page_token

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.

ListMandateTransactionsRequest

Request for the ListMandateTransactions 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

int32

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

ListMandateTransactionsResponse

Response for the ListMandateTransactionsResponse method.

Fields
mandate_transactions[]

MandateTransaction

List of mandate transactions satisfying the filtered request.

next_page_token

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.

ListMetadataTransactionsRequest

Request for the ListMetadataTransactions 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

int32

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 ListMetadataTransactions 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 ListMetadataTransactions 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 metadata 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 MetadataTransaction are eligible for filtering:

  • apiType - The API type of the metadata transaction. Must be one of ApiType values. Allowed comparison operators: =.
  • transactionType - The transaction type of the metadata transaction. Must be one of TransactionType values. Allowed comparison operators: =.
  • transactionID - The UPI transaction ID of the metadata transaction. Allowed comparison operators: =.
  • originVPA - The VPA of the orignitator of a metadata 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:

  • apiType = LIST_ACCOUNTS - - The API type is LIST_ACCOUNTS.
  • state = SUCCEEDED - The transaction's state is SUCCEEDED.
  • (apiType = LIST_ACCOUNTS) AND (create_time < \"2021-08-15T14:50:00Z\") - The API type is LIST_ACCOUNTS and the transaction was received before 2021-08-15 14:50:00 UTC.

ListMetadataTransactionsResponse

Response for the ListMetadataTransactions method.

Fields
metadata_transactions[]

MetadataTransaction

List of non financial metadata transactions satisfying the filtered request.

next_page_token

string

Pass this token in the ListMetadataTransactionsRequest to continue to list results. If all results have been returned, this field is an empty string or not present in the response.

ListRuleMetadataRequest

Request body for the ListRuleMetadata method.

Fields
parent

string

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

page_size

int32

The maximum number of rule metadata to return. The service may return fewer than this value. If unspecified or if the specified value is less than 50, at most 50 rule metadata will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_token

string

A page token, received from a previous ListRuleMetadataRequest call. Specify this parameter to retrieve the next page of rule metadata.

ListRuleMetadataResponse

Response body for the ListRuleMetadata method.

Fields
rule_metadata[]

RuleMetadata

List of rule metadata associated with the rule.

next_page_token

string

Pass this token in a subsequent ListRuleMetadataRequest call to continue to list results. If all results have been returned, this field is an empty string or not present in the response.

total_size

int64

Total number of rule metadata matching request criteria across all pages.

ListRuleMetadataValuesRequest

Request body for the ListRuleMetadataValues method.

Fields
parent

string

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

page_size

int32

The maximum number of metadata values to return. The service may return fewer than this value. If unspecified or if the specified value is less than 1, at most 50 rule metadata values will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_token

string

A page token received from a previous ListRuleMetadataValuesRequest call. Specify this parameter to retrieve the next page of rule metadata values.

ListRuleMetadataValuesResponse

Response body for ListRuleMetadataValues. Contains a List of values for a given rule metadata resource.

Fields
rule_metadata_values[]

RuleMetadataValue

List of values for a given rule metadata resource identifier.

next_page_token

string

Pass this token in a subsequent ListRuleMetadataValuesRequest call to continue to list results. If all results have been returned, this field is an empty string or not present in the response.

ListRulesRequest

Request body for the ListRules method.

Fields
parent

string

Required. The parent resource must have the format of projects/{project}.

page_size

int32

The maximum number of rules to return. The service may return fewer than this value. If unspecified or if the specified value is less than 50, at most 50 rules will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

page_token

string

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

ListRulesResponse

Response body for the ListRules method.

Fields
rules[]

Rule

List of rules satisfying the specified filter criteria.

next_page_token

string

Pass this token in a subsequent ListRulesRequest call to continue to list results. If all results have been returned, this field is an empty string or not present in the response.

total_size

int64

Total number of rules matching request criteria across all pages.

MandateTransaction

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

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

transaction_info

TransactionInfo

Information about the transaction.

unique_mandate_number

string

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

payer_vpa

string

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

payee_vpa

string

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

payee_merchant_id

string

Output only. A unique identifier for merchant.

payer_mobile_number

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

payee_mobile_number

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

recurrence_pattern

RecurrencePatternType

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

recurrence_rule_type

RecurrenceRuleType

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

recurrence_rule_value

int32

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

start_date

Date

Output only. The start date of the mandate.

end_date

Date

Output only. The end date of the mandate.

revokable

bool

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

amount

double

Output only. The amount of the mandate.

amount_rule

AmountRuleType

Output only. The amount rule type of the mandate.

approval_reference

string

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

block_funds

bool

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

last_update_time

Timestamp

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

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.

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.

MerchantAdditionalInfo

Additional merchant information specific to India's UPI requirements.

Fields
category_code

string

Merchant Category Code (MCC) as specified by UPI. This is a four-digit number listed in ISO 18245 for retail financial services.

store_id

string

A unique identifier for the merchant store where the payment settlement transaction occurred.

terminal_id

string

A unique identifier for the POS terminal in the store where the payment settlement transaction occurred.

type

Type

Indicates the type of merchant.

genre

Genre

Indicates the genre of the merchant.

onboarding_type

OnboardingType

Indicates the merchant's onboarding type.

ownership_type

OwnershipType

Indicates the merchant's owner type.

Genre

Indicates whether the merchant is an online or offline merchant.

Enums
GENRE_UNSPECIFIED Unspecified merchant genre.
OFFLINE Offline merchant
ONLINE Online merchant.

OnboardingType

Indicates whether the merchant has been onboarded by a bank or an aggregator.

Enums
ONBOARDING_TYPE_UNSPECIFIED Unspecified merchant onboarding type.
AGGREGATOR Onboarded by aggreagator.
BANK Onboarded by bank.
NETWORK Onboarded by the UPI network.
TPAP Onboarded by the TPAP.

OwnershipType

Indicates the ownership type of the merchant.

Enums
OWNERSHIP_TYPE_UNSPECIFIED Unspecified merchant ownership type.
PROPRIETARY Properietary ownership.
PARTNERSHIP Partnership ownership.
PUBLIC Public ownership.
PRIVATE Private ownership.
OTHERS Other ownership model.

Type

Indicates the merchant's type as a small or large merchant.

Enums
TYPE_UNSPECIFIED Unspecified merchant type.
LARGE Large merchant.
SMALL Small merchant.

MerchantInfo

A merchant entity participating in a payment settlement transaction.

Fields
id

string

A unique identifier for the merchant.

merchant

MerchantName

The name of the merchant who is a party in the payment. Includes multiple possible names for the merchant.

additional_info

MerchantAdditionalInfo

Additional information about the merchant.

MerchantName

The name of a merchant who is a participant in a payment settlement transaction. Includes multiple possible names for the merchant.

Fields
brand

string

The brand name of the merchant.

legal

string

The merchant's legal name.

franchise

string

The franchise name under which the merchant operates.

MetadataTransaction

A metadata API transaction processed by the issuer switch. This includes UPI APIs such as List Accounts, Balance Enquiry, etc.

Fields
name

string

The name of the metadata transaction. This uniquely identifies the transaction. Format of name is projects/{project_id}/metadataTransaction/{metadata_transaction_id}.

info

TransactionInfo

Information about the transaction.

origin_vpa

string

Output only. Virtual Payment Address (VPA) which originated the request.

OriginalTransaction

Details of original transaction.

Fields
transaction_id

string

Required. Uniquely identifies the original transaction. This maps to the Txn.Id value of the original transaction in India's UPI system.

retrieval_reference_number

string

Required. Retrieval Reference Number (RRN) of the original transaction.

request_time

Timestamp

Timestamp of the original transaction request.

Participant

A participant in a transaction processed by the issuer switch.

Fields
virtual_payment_address

string

The virtual payment address (VPA) of the participant.

persona

Persona

The persona of the participant.

user

string

The name of the participant.

Persona

The type of the participant.

Enums
PERSONA_UNSPECIFIED Unspecified persona.
ENTITY Participant is an entity.
PERSON Participant is a person.

RaiseComplaintAdjustment

The adjusment flag and reason code for raising complaint.

Fields
adjustment_flag

AdjustmentFlag

Required. The adjustment flag in URCS for the complaint transaction. This maps to reqAdjFlag in complaint request and respAdjFlag in complaint response.

adjustment_code

ReasonCode

Required. The adjustment code in URCS for the complaint transaction. This maps to reqAdjCode in complaint request.

AdjustmentFlag

The adjusment flag for raising complaint.

Enums
ADJUSTMENT_FLAG_UNSPECIFIED Unspecified adjustment flag.
RAISE Complaint Raise. This flag maps to the PBRB adjustment flag as defined in NPCI's UDIR specification.

ReasonCode

The reason for raising complaint.

Enums
REASON_CODE_UNSPECIFIED Unspecified reason code.
CUSTOMER_ACCOUNT_NOT_REVERSED Customer account has not yet reversed for a declined pay transaction. This reason code maps to the U005 reason code as defined in NPCI's UDIR specification.
GOODS_SERVICES_NOT_PROVIDED Goods / services are not provided for approved transaction. This reason code maps to the U008 reason code as defined in NPCI's UDIR specification.
CUSTOMER_ACCOUNT_NOT_CREDITED_BACK Customer account not credited back for declined transaction. This reason code maps to the U009 reason code as defined in NPCI's UDIR specification.
BENEFICIARY_ACCOUNT_NOT_CREDITED Beneficiary account is not credited for successful pay transaction. This reason code maps to the U010 reason code as defined in NPCI's UDIR specification.
GOODS_SERVICES_CREDIT_NOT_PROCESSED Credit not processed for cancelled or returned goods and services. This reason code maps to the U021 reason code as defined in NPCI's UDIR specification.
MERCHANT_NOT_RECEIVED_CONFIRMATION Account debited but transaction confirmation not received at merchant location. This reason code maps to the U022 reason code as defined in NPCI's UDIR specification.
PAID_BY_ALTERNATE_MEANS Paid by alternate means / Duplicate payment. This reason code maps to the U023 reason code as defined in NPCI's UDIR specification.

RaiseDisputeAdjustment

The adjusment flag and reason code for raising dispute.

Fields
adjustment_flag

AdjustmentFlag

Required. The adjustment flag in URCS for the complaint transaction. This maps to reqAdjFlag in dispute request and respAdjFlag in dispute response.

adjustment_code

ReasonCode

Required. The adjustment code in URCS for the complaint transaction. This maps to reqAdjCode in dispute request.

AdjustmentFlag

The adjusment flag for raising dispute.

Enums
ADJUSTMENT_FLAG_UNSPECIFIED Unspecified adjustment flag.
CHARGEBACK_RAISE Chargeback Raise. This flag maps to the B adjustment flag as defined in NPCI's UDIR specification.
FRAUD_CHARGEBACK_RAISE Fraud Chargeback Raise. This flag maps to the FC adjustment flag as defined in NPCI's UDIR specification.
WRONG_CREDIT_CHARGEBACK_RAISE Wrong Credit Chargeback Raise. This flag maps to the WC adjustment flag as defined in NPCI's UDIR specification.
DEFERRED_CHARGEBACK_RAISE Deferred Chargeback Raise. This flag maps to the FB adjustment flag as defined in NPCI's UDIR specification.
PRE_ARBITRATION_RAISE Pre-Arbitration Raise. This flag maps to the P adjustment flag as defined in NPCI's UDIR specification.
DEFERRED_PRE_ARBITRATION_RAISE Deferred Pre-Arbitration Raise. This flag maps to the FP adjustment flag as defined in NPCI's UDIR specification.
ARBITRATION_RAISE Arbitration Raise. This flag maps to the AR adjustment flag as defined in NPCI's UDIR specification.
DEFERRED_ARBITRATION_RAISE Deferred Arbitration Raise. This flag maps to the FAR adjustment flag as defined in NPCI's UDIR specification.

ReasonCode

The reason for raising dispute.

Enums
REASON_CODE_UNSPECIFIED Unspecified reason code.
CHARGEBACK_RAISE_REMITTER_DEBITED_BENEFICIARY_NOT_CREDITED Remitter account is debited but beneficiary account is not credited. This reason code maps to the 108 reason code as defined in NPCI's UDIR specification.
PRE_ARBITRATION_RAISE_BENEFICIARY_NOT_CREDITED Remitter bank customer still disputes that beneficiary account is not credited. This reason code maps to the 109 reason code as defined in NPCI's UDIR specification.
DEFERRED_CHARGEBACK_RAISE_BENEFICIARY_NOT_CREDITED TCC has been raised but customer still complaining that beneficiary account is not credited. This reason code maps to the 121 reason code as defined in NPCI's UDIR specification.
DEFERRED_PRE_ARBITRATION_RAISE_BENEFICIARY_NOT_CREDITED Customer is still complaining for not crediting the beneficiary customer account. This reason code maps to the 124 reason code as defined in NPCI's UDIR specification.
DEFERRED_ARBITRATION_RAISE_DEFERRED_CHARGEBACK_PRE_ARBITRATION_REJECTED Customer is complaining even after raising Deferred Chargeback and Pre-Arbitration on Deferred Chargeback where both have been rejected by beneficiary bank. This reason code maps to the 127 reason code as defined in NPCI's UDIR specification.
CHARGEBACK_ON_FRAUD Chargeback on fraudulent transaction. This reason code maps to the 128 reason code as defined in NPCI's UDIR specification.
GOODS_SERVICES_CREDIT_NOT_PROCESSED Credit not processed for cancelled or returned goods and services. This reason code maps to the 1061 reason code as defined in NPCI's UDIR specification.
GOODS_SERVICES_DEFECTIVE Goods and services not as described / defective. This reason code maps to the 1062 reason code as defined in NPCI's UDIR specification.
PAID_BY_ALTERNATE_MEANS Paid by alternate means. This reason code maps to the 1063 reason code as defined in NPCI's UDIR specification.
GOODS_SERVICES_NOT_RECEIVED Goods or services not provided / not received. This reason code maps to the 1064 reason code as defined in NPCI's UDIR specification.
MERCHANT_NOT_RECEIVED_CONFIRMATION Account debited but transaction confirmation not received at merchant location. This reason code maps to the 1065 reason code for chargeback raise and deferred chargeback raise as defined in NPCI's UDIR specification.
TRANSACTION_NOT_STEELED Transaction not steeled within the specified timeframes. This reason code maps to the 1081 reason code as defined in NPCI's UDIR specification.
DUPLICATE_TRANSACTION Duplicate / Multiple transaction. This reason code maps to the 1084 reason code as defined in NPCI's UDIR specification.
CHARGEBACK_CARD_HOLDER_CHARGED_MORE Card holder was charged more than the transaction amount. This reason code maps to the 1085 reason code for Chargeback raise dispute as defined in NPCI's UDIR specification.
CUSTOMER_CLAIMING_GOODS_SERVICES_NOT_DELIVERED Customer is still claiming that services are not delivered. This reason code maps to the 1097 reason code as defined in NPCI's UDIR specification.
PARTIES_DENIED Both the parties denied to agree. This reason code maps to the 1100 reason code as defined in NPCI's UDIR specification.
FUNDS_TRANSFERRED_TO_UNINTENDED_BENEFICIARY Customer transferred funds to the unintended beneficiary account. This reason code maps to the WC1 reason code as defined in NPCI's UDIR specification.

ResolveComplaintAdjustment

The adjusment flag and reason code for resolving the complaint.

Fields
adjustment_flag

AdjustmentFlag

Required. The adjustment flag in URCS for the complaint transaction. This maps to reqAdjFlag in complaint request and respAdjFlag in complaint response.

adjustment_code

ReasonCode

Required. The adjustment code in URCS for the complaint transaction. This maps to reqAdjCode in complaint request.

AdjustmentFlag

The adjusment flag for resolving the complaint.

Enums
ADJUSTMENT_FLAG_UNSPECIFIED Unspecified adjustment flag.
DEBIT_REVERSAL_CONFIRMATION Debit Reversal Confirmation. This flag maps to the DRC adjustment flag as defined in NPCI's UDIR specification.
RETURN Return. This flag maps to the RET adjustment flag as defined in NPCI's UDIR specification.
REFUND_REVERSAL_CONFIRMATION Refund Reversal Confirmation. This flag maps to the RRC adjustment flag as defined in NPCI's UDIR specification.
TRANSACTION_CREDIT_CONFIRMATION Transaction Credit Confirmation. This flag maps to the TCC adjustment flag as defined in NPCI's UDIR specification.

ReasonCode

The complaint resolution reason code.

Enums
REASON_CODE_UNSPECIFIED Unspecified reason code.
COMPLAINT_RESOLVED_ONLINE Customer account has been reversed online for DRC dispute or beneficiary account has been credited online for TCC dispute. This reason code maps to the 102 reason code as defined in NPCI's UDIR specification.
COMPLAINT_RESOLVED_NOW_OR_MANUALLY Customer account has been reversed now or manually post reconciliation for DRC dispute or beneficiary account has been credited now or manually post reconciliation for TCC dispute. This reason code maps to the 103 reason code as defined in NPCI's UDIR specification.
ORIGINAL_TRANSACTION_NOT_DONE Online decline response failed. This reason code maps to the 104 reason code as defined in NPCI's UDIR specification.
RET_ACCOUNT_CLOSED Account closed. This reason code maps to the 114 reason code for RET dispute as defined in NPCI's UDIR specification.
RET_ACCOUNT_DOES_NOT_EXIST Account does not exist. This reason code maps to the 115 reason code for RET dispute as defined in NPCI's UDIR specification.
RET_PARTY_INSTRUCTIONS Party instructions. This reason code maps to the 116 reason code for RET dispute as defined in NPCI's UDIR specification.
RET_NRI_ACCOUNT NRI account. This reason code maps to the 117 reason code for RET dispute as defined in NPCI's UDIR specification.
RET_CREDIT_FREEZED Credit freezed. This reason code maps to the 118 reason code for RET dispute as defined in NPCI's UDIR specification.
RET_INVALID_BENEFICIARY_DETAILS Invalid beneficiary details. This reason code maps to the 119 reason code for RET dispute as defined in NPCI's UDIR specification.
RET_ANY_OTHER_REASON Any other reason. This reason code maps to the 120 reason code for RET dispute as defined in NPCI's UDIR specification.
RET_BENEFICIARY_CANNOT_CREDIT Beneficiary bank unable to credit their customer account. This reason code maps to the 1094 reason code for RET dispute as defined in NPCI's UDIR specification.
RET_MERCHANT_NOT_RECEIVED_CONFIRMATION Account debited but transaction confirmation not received at merchant location. This reason code maps to the 1065 reason code for Credit adjustment and RET dispute as defined in NPCI's UDIR specification.
RRC_CUSTOMER_ACCOUNT_CREDITED Customer account has been credited. This reason code maps to the 501 reason code for Refund reversal confirmation dispute as defined in NPCI's UDIR specification.

ResolveComplaintMetadata

Metadata for ResolveComplaint.

ResolveComplaintRequest

Request for the ResolveComplaint method.

Fields
complaint

Complaint

Required. The complaint to be resolved.

ResolveDisputeAdjustment

The adjusment flag and reason code for resolving the dispute.

Fields
adjustment_flag

AdjustmentFlag

Required. The adjustment flag in URCS for the complaint transaction. This maps to reqAdjFlag in dispute request and respAdjFlag in dispute response.

adjustment_code

ReasonCode

Required. The adjustment code in URCS for the complaint transaction. This maps to reqAdjCode in dispute request.

AdjustmentFlag

The adjusment flag for resolving the dispute.

Enums
ADJUSTMENT_FLAG_UNSPECIFIED Unspecified adjustment flag.
RE_PRESENTMENT_RAISE Re-presentment Raise. This flag maps to the R adjustment flag as defined in NPCI's UDIR specification.
DEFERRED_RE_PRESENTMENT_RAISE Deferred Re-presentment Raise. This flag maps to the FR adjustment flag as defined in NPCI's UDIR specification.
CHARGEBACK_ACCEPTANCE Chargeback Acceptance. This flag maps to the A adjustment flag as defined in NPCI's UDIR specification.
DEFERRED_CHARGEBACK_ACCEPTANCE Deferred Chargeback Acceptance. This flag maps to the FA adjustment flag as defined in NPCI's UDIR specification.
PRE_ARBITRATION_ACCEPTANCE Pre-Arbitration Acceptance. This flag maps to the AP adjustment flag as defined in NPCI's UDIR specification.
DEFERRED_PRE_ARBITRATION_ACCEPTANCE Deferred Pre-Arbitration Acceptance. This flag maps to the FAP adjustment flag as defined in NPCI's UDIR specification.
PRE_ARBITRATION_DECLINED Pre-Arbitration Declined. This flag maps to the PR adjustment flag as defined in NPCI's UDIR specification.
DEFERRED_PRE_ARBITRATION_DECLINED Deferred Pre-Arbitration Declined. This flag maps to the FPR adjustment flag as defined in NPCI's UDIR specification.
ARBITRATION_ACCEPTANCE Arbitration Acceptance. This flag maps to the ACA adjustment flag as defined in NPCI's UDIR specification.
ARBITRATION_CONTINUATION Arbitration Continuation. This flag maps to the ACC adjustment flag as defined in NPCI's UDIR specification.
ARBITRATION_WITHDRAWN Arbitration Withdrawn. This flag maps to the ACW adjustment flag as defined in NPCI's UDIR specification.
ARBITRATION_VERDICT Arbitration Verdict. This flag maps to the ACV adjustment flag as defined in NPCI's UDIR specification.
CREDIT_ADJUSTMENT Credit Adjustment. This flag maps to the C adjustment flag as defined in NPCI's UDIR specification.
FRAUD_CHARGEBACK_REPRESENTMENT Fraud Chargeback Representment. This flag maps to the FCR adjustment flag as defined in NPCI's UDIR specification.
FRAUD_CHARGEBACK_ACCEPT Fraud Chargeback Accept. This flag maps to the FCA adjustment flag as defined in NPCI's UDIR specification.
WRONG_CREDIT_REPRESENTMENT Wrong Credit Representment. This flag maps to the WR adjustment flag as defined in NPCI's UDIR specification.
WRONG_CREDIT_CHARGEBACK_ACCEPTANCE Wrong Credit Chargeback Acceptance. This flag maps to the WA adjustment flag as defined in NPCI's UDIR specification.
MANUAL_ADJUSTMENT Manual Adjustment. This flag maps to the MA adjustment flag as defined in NPCI's UDIR specification.

ReasonCode

The dispute resolution reason code.

Enums
REASON_CODE_UNSPECIFIED Unspecified reason code.
CHARGEBACK_BENEFICIARY_CANNOT_CREDIT_OR_PRE_ARBITRATION_DUPLICATE_PROCESS Beneficiary bank unable to credit their customer account for Chargeback Acceptance dispute or duplicate processing for Pre Arbitration Acceptance dispute. This reason code maps to the 111 reason code as defined in NPCI's UDIR specification.
PRE_ARBITRATION_DECLINED_BENEFICIARY_CREDITED_ONLINE Beneficiary account has been credited online. This reason code maps to the 112 reason code for Pre-arbitration declined dispute as defined in NPCI's UDIR specification.
PRE_ARBITRATION_DECLINED_BENEFICIARY_CREDITED_MANUALLY Beneficiary account has been credited manually post reconciliation. This reason code maps to the 113 reason code for Pre-arbitration declined dispute as defined in NPCI's UDIR specification.
DEFERRED_CHARGEBACK_ACCEPTANCE_ACCOUNT_NOT_CREDITED_TCC_RAISED Customer account is not credited, TCC raised inadvertently. This reason code maps to the 122 reason code as defined in NPCI's UDIR specification.
DEFERRED_RE_PRESENTMENT_RAISE_ACCOUNT_CREDITED_TCC_RAISED Customer account is credited successfully and TCC raised accordingly. This reason code maps to the 123 reason code as defined in NPCI's UDIR specification.
DEFERRED_PRE_ARBITRATION_ACCEPTANCE_ACCOUNT_NOT_CREDITED Customer account is not credited, TCC and Re-Presentment raised inadvertently. This reason code maps to the 125 reason code as defined in NPCI's UDIR specification.
DEFERRED_PRE_ARBITRATION_DECLINED_ACCOUNT_CREDITED Customer account is credited successfully and TCC and Re-Presentment raised accordingly. This reason code maps to the 126 reason code as defined in NPCI's UDIR specification.
FRAUD_CHARGEBACK_ACCEPT_AMOUNT_RECOVERED_FROM_FRAUDULENT_ACCOUNT Amount has been recovered successfully from the fraudulent customer account. This reason code maps to the 129 reason code as defined in NPCI's UDIR specification.
FRAUD_CHARGEBACK_REPRESENTMENT_LIEN_MARKED_INSUFFICIENT_BALANCE Lien marked however, customer account is not having sufficient balance to debit. This reason code maps to the 130 reason code for Fraud chargeback representment dispute as defined in NPCI's UDIR specification.
FRAUD_CHARGEBACK_REPRESENTMENT_FIR_NOT_PROVIDED FIR Copy not provided for the disputed transaction. This reason code maps to the 131 reason code as defined in NPCI's UDIR specification.
FRAUD_CHARGEBACK_REPRESENTMENT_REASON_OTHERS Other reason for Fraud chargeback representment dispute. This reason code maps to the 132 reason code as defined in NPCI's UDIR specification.
RE_PRESENTMENT_RAISE_BENEFICIARY_CREDITED_ONLINE Beneficiary account credited online. This reason code maps to the 208 reason code for Re-presentment raise dispute as defined in NPCI's UDIR specification.
RE_PRESENTMENT_RAISE_BENEFICIARY_CREDITED_MANUALLY Beneficiary account credited manually post reconciliation. This reason code maps to the 209 reason code for Re-presentment raise dispute as defined in NPCI's UDIR specification.
CREDIT_ADJUSTMENT_GOODS_SERVICES_CREDIT_NOT_PROCESSED Credit not processed for cancelled or returned goods and services. This reason code maps to the 1061 reason code as defined in NPCI's UDIR specification.
CREDIT_ADJUSTMENT_GOODS_SERVICES_DEFECTIVE Goods and Services not as described / defective. This reason code maps to the 1062 reason code as defined in NPCI's UDIR specification.
CREDIT_ADJUSTMENT_PAID_BY_ALTERNATE_MEANS Paid by alternate means. This reason code maps to the 1063 reason code as defined in NPCI's UDIR specification.
CREDIT_ADJUSTMENT_GOODS_SERVICES_NOT_RECEIVED Goods or Services Not Provided / Not Received. This reason code maps to the 1064 reason code as defined in NPCI's UDIR specification.
CREDIT_ADJUSTMENT_MERCHANT_NOT_RECEIVED_CONFIRMATION Account debited but transaction confirmation not received at merchant location. This reason code maps to the 1065 reason code for Credit adjustment as defined in NPCI's UDIR specification.
CREDIT_ADJUSTMENT_DUPLICATE_TRANSACTION Duplicate /Multiple Transaction. This reason code maps to the 1084 reason code as defined in NPCI's UDIR specification.
CREDIT_ADJUSTMENT_REASON_OTHERS Other reason for Credit adjustment. This reason code maps to the 1090 reason code as defined in NPCI's UDIR specification.
CREDIT_ADJUSTMENT_NON_MATCHING_ACCOUNT_NUMBER Non Matching account number. This reason code maps to the 1091 reason code as defined in NPCI's UDIR specification.
CREDIT_ADJUSTMENT_CARD_HOLDER_CHARGED_MORE Card holder was charged more than the transaction amount. This reason code maps to the 1092 reason code as defined in NPCI's UDIR specification.
CREDIT_ADJUSTMENT_CREDIT_NOT_PROCESSED Credit not Processed. This reason code maps to the 1093 reason code as defined in NPCI's UDIR specification.
CREDIT_ADJUSTMENT_BENEFICIARY_CANNOT_CREDIT Beneficiary bank unable to credit their customer account. This reason code maps to the 1094 reason code for Credit Adjustment dispute as defined in NPCI's UDIR specification.
CHARGEBACK_ACCEPTANCE_MERCHANT_CANNOT_PROVIDE_SERVICE Merchant was unable to provide the service. This reason code maps to the 1095 reason code as defined in NPCI's UDIR specification.
RE_PRESENTMENT_RAISE_GOODS_SERVICES_PROVIDED Services/Goods provided see the supporting document. This reason code maps to the 1096 reason code as defined in NPCI's UDIR specification.
PRE_ARBITRATION_DECLINED_SERVICES_PROVIDED_LATER Services provided later see supporting documents. This reason code maps to the 1098 reason code as defined in NPCI's UDIR specification.
PRE_ARBITRATION_ACCEPTANCE_SERVICES_NOT_PROVIDED_BY_MERCHANT Services not provided by the merchant. This reason code maps to the 1099 reason code as defined in NPCI's UDIR specification.
ARBITRATION_ACCEPTANCE_ILLEGIBLE_FULFILMENT Illegible Fulfilment. This reason code maps to the 1101 reason code for arbitration acceptance dispute as defined in NPCI's UDIR specification.
ARBITRATION_CONTINUATION_CUSTOMER_STILL_NOT_RECEIVED_SERVICE Customer has still not received the service. This reason code maps to the 1102 reason code as defined in NPCI's UDIR specification.
ARBITRATION_WITHDRAWN_CUSTOMER_RECEIVED_SERVICE_LATER Customer has received the service later. This reason code maps to the 1103 reason code as defined in NPCI's UDIR specification.
ARBITRATION_VERDICT_PANEL_VERDICT Panel will give the verdict. This reason code maps to the 1104 reason code as defined in NPCI's UDIR specification.
MANUAL_ADJUSTMENT_REASON Manual adjustment. This reason code maps to the 2001 reason code as defined in NPCI's UDIR specification.
ATTRIBUTING_CUSTOMER Attributing to the Customer. This reason code maps to the AC reason code as defined in NPCI's UDIR specification.
ATTRIBUTING_TECHNICAL_ISSUE Attributing to the Technical issue at bank/aggregator/merchant. This reason code maps to the AT reason code as defined in NPCI's UDIR specification.
WRONG_CREDIT_CHARGEBACK_ACCEPTANCE_AMOUNT_RECOVERED Amount has been recovered successfully from the unintended customer account. This reason code maps to the WC2 reason code as defined in NPCI's UDIR specification.
WRONG_CREDIT_REPRESENTMENT_LIEN_MARKED_INSUFFICIENT_BALANCE Lien marked however customer account is not having sufficient balance to debit the customer account. This reason code maps to the WC3 reason code for Wrong credit representment dispute as defined in NPCI's UDIR specification.
WRONG_CREDIT_REPRESENTMENT_CUSTOMER_INACCESSIBLE Customer is not accessible for obtaining debit confirmation. This reason code maps to the WC4 reason code as defined in NPCI's UDIR specification.
WRONG_CREDIT_REPRESENTMENT_REASON_OTHERS Other reason for Wrong credit representment. This reason code maps to the WC5 reason code as defined in NPCI's UDIR specification.

ResolveDisputeMetadata

Metadata for ResolveDispute.

ResolveDisputeRequest

Request for the ResolveDispute method.

Fields
dispute

Dispute

Required. The dispute to be resolved.

Rule

A rule that is executed by the issuer switch while processing an API transaction.

Fields
name

string

The unique identifier for this resource. Format: projects/{project}/rules/{rule}

rule_description

string

The description of the rule.

api_type

ApiType

The API Type for which this rule gets executed. A value of API_TYPE_UNSPECIFIED indicates that the rule is executed for all API transactions.

transaction_type

TransactionType

The transaction type for which this rule gets executed. A value of TRANSACTION_TYPE_UNSPECIFIED indicates that the rule is executed for all transaction types.

RuleMetadata

The metadata associated with a rule. This defines data that are used by the rule during execution.

Fields
name

string

The unique identifier for this resource. Format: projects/{project}/rules/{rule}/metadata/{metadata}

description

string

The description of the rule metadata.

type

Type

Type of rule metadata.

Type

The type of metadata.

Enums
TYPE_UNSPECIFIED Unspecified type.
LIST List type. Indicates that the metadata contains a list of values which the rule requires for execution.

RuleMetadataValue

Represent a single value in a rule's metadata.

Fields
name

string

Output only. The unique identifier for this resource. Format: projects/{project}/rules/{rule}/metadata/{metadata}/values/{value}

Union field value. The value of the resource which could be of type string or AccountReference. The metadata values for rules BlockedPayeeAccountReqPayDebitRule, BlockedPayerAccountReqPayDebitRule, BlockedPayeeAccountReqPayCreditRule and BlockedPayerAccountReqPayCreditRule should be of type AccountReference. For all other rules, metadata values should be of type string.

The length of the value field depends on the type of the value being used for the rule metadata. The following are the minimum and maximum lengths for the different types of values.

Value Type Minimum Length Maximum Length
Bank account IFSC 11 11
Bank account number 1 255
Device identifier 1 255
Mobile number 12 12
Virtual private address (VPA) 3 255

value can be only one of the following:

id

string

The value for string metadata.

account_reference

AccountReference

The value for account reference metadata.

SettlementParticipant

A participant in a payment settlement transaction processed by the issuer switch. The participant could either be the payer or the payee in the transaction.

Fields
participant

Participant

The participant information.

account

AccountReference

Unique identification of an account according to India's UPI standards.

merchant_info

MerchantInfo

Information about a merchant who is a participant in the payment. This field will be specified only if the participant is a merchant.

mobile

string

Output only. The mobile number of the participant.

device_id

string

Output only. The device id of the participant.

TransactionInfo

Information about a transaction processed by the issuer switch. The fields in this type are common across both financial and metadata transactions.

Fields
id

string

Output only. An identifier that is mandatorily present in every transaction processed via UPI. This maps to UPI's transaction ID.

api_type

ApiType

Output only. The API type of the transaction.

transaction_type

TransactionType

Output only. The transaction type.

transaction_sub_type

TransactionSubType

Output only. The transaction sub-type.

state

State

Output only. The transaction's state.

error_code

string

Output only. Error code of the failed transaction.

error_message

string

Output only. Error description for the failed transaction.

create_time

Timestamp

Output only. The time at which the transaction resource was created by the issuer switch.

bank_adapter_request_ids

string

Output only. List of Request IDs (colon separated) used when invoking the Bank Adapter APIs for fulfilling a transaction request.

upi_error_code

string

Output only. Error code as per the UPI specification. The issuer switch maps the ErrorCode to an appropriate error code that complies with the UPI specification.

State

Specifies the current state of the transaction.

Enums
STATE_UNSPECIFIED Unspecified state.
SUCCEEDED The transaction has successfully completed.