TransactionInfo

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

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

JSON representation
{
  "id": string,
  "apiType": enum (ApiType),
  "transactionType": enum (TransactionType),
  "transactionSubType": enum (TransactionSubType),
  "state": enum (State),
  "errorCode": string,
  "errorMessage": string,
  "createTime": string,
  "bankAdapterRequestIds": string,
  "upiErrorCode": string
}
Fields
id

string

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

apiType

enum (ApiType)

Output only. The API type of the transaction.

transactionType

enum (TransactionType)

Output only. The transaction type.

transactionSubType

enum (TransactionSubType)

Output only. The transaction sub-type.

state

enum (State)

Output only. The transaction's state.

errorCode

string

Output only. Error code of the failed transaction.

errorMessage

string

Output only. Error description for the failed transaction.

createTime

string (Timestamp format)

Output only. The time at which the transaction resource was created 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".

bankAdapterRequestIds

string

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

upiErrorCode

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.

TransactionSubType

The sub-type of a transaction. This value is used only for certain API type and transaction type combinations.

Enums
TRANSACTION_SUB_TYPE_UNSPECIFIED Unspecified transaction sub-type.
COLLECT Collect sub type. This is used in a SETTLE_PAYMENT API type transaction, with transaction type as either CREDIT or DEBIT when the payment was initiated by a collect request.
DEBIT Debit sub type. This is used in a SETTLE_PAYMENT API type transaction, with transaction type as REVERSAL when the original payment was a debit request.
PAY Pay sub type. This is used in a SETTLE_PAYMENT API type transaction, with transaction type as either CREDIT or DEBIT when the payment was initiated by a pay request.
BENEFICIARY Beneficiary subtype. This is used in a COMPLAINT API type transaction, when the complaint / dispute request is initiated / received by the beneficiary bank.
REMITTER Remitter subtype. This is used in a COMPLAINT API type transaction, when the complaint / dispute request is initiated / received by the remitter bank.

State

Specifies the current state of the transaction.

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