Skip to content

Commit a285b66

Browse files
Google APIscopybara-github
Google APIs
authored and
copybara-github
committed
fix!: rename BankAdapterInfo to AdapterInfo
feat: add the REFUND sub-type to the enum of transaction sub-types feat: add initiation_mode and purpose_code to TransactionMetadata message PiperOrigin-RevId: 513567363
1 parent 4007192 commit a285b66

1 file changed

Lines changed: 53 additions & 40 deletions

File tree

‎google/cloud/paymentgateway/issuerswitch/v1/transactions.proto‎

Lines changed: 53 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -186,11 +186,11 @@ service IssuerSwitchTransactions {
186186
// The currency codes are defined in ISO 4217.
187187
// 1. `Amount`
188188
// * **Description** - Amount involved in the transaction.
189-
// 1. `BankAdapterRequestIDs`
189+
// 1. `AdapterRequestIDs`
190190
// * **Min Length** - 0 characters
191191
// * **Max Length** - 2,000 characters
192-
// * **Description** - List of Request IDs (colon separated) used when
193-
// invoking the Bank Adapter APIs for fulfilling a transaction request.
192+
// * **Description** - List of adapter request IDs (colon separated) used
193+
// when invoking the Adapter APIs for fulfilling a transaction request.
194194
// 1. `ErrorCode`
195195
// * **Min Length** - 0 characters
196196
// * **Max Length** - 255 characters
@@ -333,11 +333,11 @@ service IssuerSwitchTransactions {
333333
// * **Max Length** - 255 characters
334334
// * **Description** - Virtual Payment Address (VPA) of the originator of
335335
// the transaction.
336-
// 1. `BankAdapterRequestIDs`
336+
// 1. `AdapterRequestIDs`
337337
// * **Min Length** - 0 characters
338338
// * **Max Length** - 2,000 characters
339-
// * **Description** - List of Request IDs (colon separated) used when
340-
// invoking the Bank Adapter APIs for fulfilling a transaction request.
339+
// * **Description** - List of adapter request IDs (colon separated) used
340+
// when invoking the Adapter APIs for fulfilling a transaction request.
341341
// 1. `ErrorCode`
342342
// * **Min Length** - 0 characters
343343
// * **Max Length** - 255 characters
@@ -476,11 +476,11 @@ service IssuerSwitchTransactions {
476476
// * **Description** - Timestamp (in UTC) indicating when was the last
477477
// modification made to the mandate. The format will be as per RFC-3339.
478478
// Example : 2022-11-22T23:00:05Z
479-
// 1. `BankAdapterRequestIDs`
479+
// 1. `AdapterRequestIDs`
480480
// * **Min Length** - 0 characters
481481
// * **Max Length** - 2,000 characters
482-
// * **Description** - List of Request IDs (colon separated) used when
483-
// invoking the Bank Adapter APIs for fulfilling a transaction request.
482+
// * **Description** - List of adapter request IDs (colon separated) used
483+
// when invoking the Adapter APIs for fulfilling a transaction request.
484484
// 1. `ErrorCode`
485485
// * **Min Length** - 0 characters
486486
// * **Max Length** - 255 characters
@@ -623,11 +623,11 @@ service IssuerSwitchTransactions {
623623
// * **Max Length** - 255 characters
624624
// * **Description** - Indicates the additional remarks for the complaint
625625
// / dispute.
626-
// 1. `BankAdapterRequestIDs`
626+
// 1. `AdapterRequestIDs`
627627
// * **Min Length** - 0 characters
628628
// * **Max Length** - 2,000 characters
629-
// * **Description** - List of Request IDs (colon separated) used when
630-
// invoking the Bank Adapter APIs for fulfilling a transaction request.
629+
// * **Description** - List of adapter request IDs (colon separated) used
630+
// when invoking the Adapter APIs for fulfilling a transaction request.
631631
// 1. `ErrorCode`
632632
// * **Min Length** - 0 characters
633633
// * **Max Length** - 255 characters
@@ -674,25 +674,26 @@ message TransactionInfo {
674674
TIMED_OUT = 3;
675675
}
676676

677-
// The sub-type of a transaction. This value is used only for certain API type
677+
// The subtype of a transaction. This value is used only for certain API type
678678
// and transaction type combinations.
679679
enum TransactionSubType {
680-
// Unspecified transaction sub-type.
680+
// Unspecified transaction subtype.
681681
TRANSACTION_SUB_TYPE_UNSPECIFIED = 0;
682682

683-
// Collect sub type. This is used in a `SETTLE_PAYMENT` API type
684-
// transaction, with transaction type as either `CREDIT` or `DEBIT` when the
685-
// payment was initiated by a collect request.
683+
// Collect subtype. This is used in a `SETTLE_PAYMENT` API type
684+
// transaction, with the transaction type as either
685+
// `TRANSACTION_TYPE_CREDIT` or `TRANSACTION_TYPE_DEBIT` when the payment
686+
// was initiated by a collect request.
686687
COLLECT = 1;
687688

688-
// Debit sub type. This is used in a `SETTLE_PAYMENT` API type transaction,
689-
// with transaction type as `REVERSAL` when the original payment was a
690-
// debit request.
689+
// Debit subtype. This is used in a `SETTLE_PAYMENT` API type transaction,
690+
// with the transaction type as `TRANSACTION_TYPE_REVERSAL` when the
691+
// original payment was a debit request.
691692
DEBIT = 2;
692693

693-
// Pay sub type. This is used in a `SETTLE_PAYMENT` API type transaction,
694-
// with transaction type as either `CREDIT` or `DEBIT` when the payment was
695-
// initiated by a pay request.
694+
// Pay subtype. This is used in a `SETTLE_PAYMENT` API type transaction,
695+
// with the transaction type as either `TRANSACTION_TYPE_CREDIT` or
696+
// `TRANSACTION_TYPE_DEBIT` when the payment was initiated by a pay request.
696697
PAY = 3;
697698

698699
// Beneficiary subtype. This is used in a `COMPLAINT` API type transaction,
@@ -704,6 +705,11 @@ message TransactionInfo {
704705
// when the complaint / dispute request is initiated / received by the
705706
// remitter bank.
706707
REMITTER = 5;
708+
709+
// Refund subtype. This is used in a `SETTLE_PAYMENT` API type transaction,
710+
// with the transaction type as `TRANSACTION_TYPE_CREDIT` when the payment
711+
// was initiated in response to a refund.
712+
REFUND = 6;
707713
}
708714

709715
// Common metadata about an API transaction.
@@ -726,6 +732,14 @@ message TransactionInfo {
726732

727733
// Output only. A descriptive note about this API transaction.
728734
string description = 5 [(google.api.field_behavior) = OUTPUT_ONLY];
735+
736+
// Output only. The initiation mode of this API transaction. In UPI, the
737+
// values are as defined by the UPI API specification.
738+
string initiation_mode = 6 [(google.api.field_behavior) = OUTPUT_ONLY];
739+
740+
// Output only. The purpose code of this API transaction. In UPI, the values
741+
// are as defined by the UPI API specification.
742+
string purpose_code = 7 [(google.api.field_behavior) = OUTPUT_ONLY];
729743
}
730744

731745
// All details about any error in the processing of an API transaction.
@@ -742,22 +756,22 @@ message TransactionInfo {
742756
string upi_error_code = 3 [(google.api.field_behavior) = OUTPUT_ONLY];
743757
}
744758

745-
// Information about a bank adapter invocation triggered as part of the
759+
// Information about an adapter invocation triggered as part of the
746760
// processing of an API transaction.
747-
message BankAdapterInfo {
748-
// Metadata about a response that the bank adapter includes in its response
761+
message AdapterInfo {
762+
// Metadata about a response that the adapter includes in its response
749763
// to the issuer switch.
750764
message ResponseMetadata {
751765
// A map of name-value pairs.
752766
map<string, string> values = 1;
753767
}
754768

755-
// Output only. List of Request IDs (colon separated) used when
756-
// invoking the Bank Adapter APIs for fulfilling a transaction request.
769+
// Output only. List of adapter request IDs (colon separated) used when
770+
// invoking the Adapter APIs for fulfilling a transaction request.
757771
string request_ids = 1 [(google.api.field_behavior) = OUTPUT_ONLY];
758772

759-
// Output only. Response metadata included by the bank adapter in its
760-
// response to an API invocation from the issuer switch.
773+
// Output only. Response metadata included by the adapter in its response to
774+
// an API invocation from the issuer switch.
761775
ResponseMetadata response_metadata = 2
762776
[(google.api.field_behavior) = OUTPUT_ONLY];
763777
}
@@ -788,7 +802,7 @@ message TransactionInfo {
788802
TransactionType transaction_type = 3
789803
[(google.api.field_behavior) = OUTPUT_ONLY];
790804

791-
// Output only. The transaction sub-type.
805+
// Output only. The transaction subtype.
792806
TransactionSubType transaction_sub_type = 4
793807
[(google.api.field_behavior) = OUTPUT_ONLY];
794808

@@ -803,10 +817,9 @@ message TransactionInfo {
803817
TransactionErrorDetails error_details = 7
804818
[(google.api.field_behavior) = OUTPUT_ONLY];
805819

806-
// Output only. Information about the bank adapter invocation from the issuer
820+
// Output only. Information about the adapter invocation from the issuer
807821
// switch for processing this API transaction.
808-
BankAdapterInfo bank_adapter_info = 8
809-
[(google.api.field_behavior) = OUTPUT_ONLY];
822+
AdapterInfo adapter_info = 8 [(google.api.field_behavior) = OUTPUT_ONLY];
810823

811824
// Risk information as provided by the payments orchestrator.
812825
repeated TransactionRiskInfo risk_info = 9;
@@ -1117,8 +1130,8 @@ message ListMetadataTransactionsRequest {
11171130
// * `errorCode` - Use this filter to list financial transactions which
11181131
// have failed a particular error code. Allowed comparison operators:
11191132
// `=`.
1120-
// * `bankAdapterRequestID` - Request ID used when invoking the Bank
1121-
// Adapter API for fulfilling a transaction request. Allowed comparison
1133+
// * `adapterRequestID` - Adapter request ID used when invoking the Bank or
1134+
// Card Adapter API for fulfilling a transaction request. Allowed comparison
11221135
// operators: `=`.
11231136
//
11241137
// You can combine multiple expressions by enclosing each expression in
@@ -1202,8 +1215,8 @@ message ListFinancialTransactionsRequest {
12021215
// values. Allowed comparison operators: `=`.
12031216
// * `errorCode` - Use this filter to list financial transactions which
12041217
// have failed a particular error code. Allowed comparison operators: `=`.
1205-
// * `bankAdapterRequestID` - Request ID used when invoking the Bank
1206-
// Adapter API for fulfilling a transaction request. Allowed comparison
1218+
// * `adapterRequestID` - Adapter request ID used when invoking the Bank or
1219+
// Card Adapter API for fulfilling a transaction request. Allowed comparison
12071220
// operators: `=`.
12081221
//
12091222
// You can combine multiple expressions by enclosing each expression in
@@ -1301,8 +1314,8 @@ message ListMandateTransactionsRequest {
13011314
// * `errorCode` - Use this filter to list mandate transactions which
13021315
// have failed a particular error code. Allowed comparison
13031316
// operators: `=`.
1304-
// * `bankAdapterRequestID` - Request ID used when invoking the Bank
1305-
// Adapter API for fulfilling a transaction request. Allowed comparison
1317+
// * `adapterRequestID` - Adapter request ID used when invoking the Bank or
1318+
// Card Adapter API for fulfilling a transaction request. Allowed comparison
13061319
// operators: `=`.
13071320
// You can combine multiple expressions by enclosing each expression in
13081321
// parentheses. Expressions are combined with AND logic. No other logical

0 commit comments

Comments
 (0)