@mojaloop/api-snippets 17.2.0-snapshot.1 → 17.2.0-snapshot.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +3 -1
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/json-schemas.json +18 -84
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +2 -1
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.d.ts +9 -61
- package/package.json +1 -1
- package/sdk-scheme-adapter/v2_0_0/components/schemas/requestToPayTransferRequest.yaml +3 -1
|
@@ -2399,7 +2399,9 @@ components:
|
|
|
2399
2399
|
amount:
|
|
2400
2400
|
$ref: '#/components/schemas/Amount'
|
|
2401
2401
|
scenario:
|
|
2402
|
-
$ref: '#/components/schemas/
|
|
2402
|
+
$ref: '#/components/schemas/TransactionScenario'
|
|
2403
|
+
subScenario:
|
|
2404
|
+
$ref: '#/components/schemas/TransactionSubScenario'
|
|
2403
2405
|
initiator:
|
|
2404
2406
|
$ref: '#/components/schemas/TransactionInitiator'
|
|
2405
2407
|
initiatorType:
|
|
@@ -21144,90 +21144,24 @@
|
|
|
21144
21144
|
"example": "123.45"
|
|
21145
21145
|
},
|
|
21146
21146
|
"scenario": {
|
|
21147
|
-
"title": "
|
|
21148
|
-
"type": "
|
|
21149
|
-
"
|
|
21150
|
-
|
|
21151
|
-
"
|
|
21152
|
-
|
|
21153
|
-
|
|
21154
|
-
|
|
21155
|
-
|
|
21156
|
-
|
|
21157
|
-
|
|
21158
|
-
|
|
21159
|
-
|
|
21160
|
-
|
|
21161
|
-
|
|
21162
|
-
|
|
21163
|
-
|
|
21164
|
-
|
|
21165
|
-
"title": "TransactionSubScenario",
|
|
21166
|
-
"type": "string",
|
|
21167
|
-
"pattern": "^[A-Z_]{1,32}$",
|
|
21168
|
-
"description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).",
|
|
21169
|
-
"example": "LOCALLY_DEFINED_SUBSCENARIO"
|
|
21170
|
-
},
|
|
21171
|
-
"initiator": {
|
|
21172
|
-
"title": "TransactionInitiator",
|
|
21173
|
-
"type": "string",
|
|
21174
|
-
"enum": [
|
|
21175
|
-
"PAYER",
|
|
21176
|
-
"PAYEE"
|
|
21177
|
-
],
|
|
21178
|
-
"description": "Below are the allowed values for the enumeration.\n- PAYER - Sender of funds is initiating the transaction. The account to send from is either owned by the Payer or is connected to the Payer in some way.\n- PAYEE - Recipient of the funds is initiating the transaction by sending a transaction request. The Payer must approve the transaction, either automatically by a pre-generated OTP or by pre-approval of the Payee, or by manually approving in his or her own Device.",
|
|
21179
|
-
"example": "PAYEE"
|
|
21180
|
-
},
|
|
21181
|
-
"initiatorType": {
|
|
21182
|
-
"title": "TransactionInitiatorType",
|
|
21183
|
-
"type": "string",
|
|
21184
|
-
"enum": [
|
|
21185
|
-
"CONSUMER",
|
|
21186
|
-
"AGENT",
|
|
21187
|
-
"BUSINESS",
|
|
21188
|
-
"DEVICE"
|
|
21189
|
-
],
|
|
21190
|
-
"description": "Below are the allowed values for the enumeration.\n- CONSUMER - Consumer is the initiator of the transaction.\n- AGENT - Agent is the initiator of the transaction.\n- BUSINESS - Business is the initiator of the transaction.\n- DEVICE - Device is the initiator of the transaction.",
|
|
21191
|
-
"example": "CONSUMER"
|
|
21192
|
-
},
|
|
21193
|
-
"refundInfo": {
|
|
21194
|
-
"title": "Refund",
|
|
21195
|
-
"type": "object",
|
|
21196
|
-
"description": "Data model for the complex type Refund.",
|
|
21197
|
-
"properties": {
|
|
21198
|
-
"originalTransactionId": {
|
|
21199
|
-
"title": "CorrelationId",
|
|
21200
|
-
"type": "string",
|
|
21201
|
-
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
|
|
21202
|
-
"description": "Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).",
|
|
21203
|
-
"example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
|
|
21204
|
-
},
|
|
21205
|
-
"refundReason": {
|
|
21206
|
-
"title": "RefundReason",
|
|
21207
|
-
"type": "string",
|
|
21208
|
-
"minLength": 1,
|
|
21209
|
-
"maxLength": 128,
|
|
21210
|
-
"description": "Reason for the refund.",
|
|
21211
|
-
"example": "Free text indicating reason for the refund."
|
|
21212
|
-
}
|
|
21213
|
-
},
|
|
21214
|
-
"required": [
|
|
21215
|
-
"originalTransactionId"
|
|
21216
|
-
]
|
|
21217
|
-
},
|
|
21218
|
-
"balanceOfPayments": {
|
|
21219
|
-
"title": "BalanceOfPayments",
|
|
21220
|
-
"type": "string",
|
|
21221
|
-
"pattern": "^[1-9]\\d{2}$",
|
|
21222
|
-
"description": "(BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed.",
|
|
21223
|
-
"example": "123"
|
|
21224
|
-
}
|
|
21225
|
-
},
|
|
21226
|
-
"required": [
|
|
21227
|
-
"scenario",
|
|
21228
|
-
"initiator",
|
|
21229
|
-
"initiatorType"
|
|
21230
|
-
]
|
|
21147
|
+
"title": "TransactionScenario",
|
|
21148
|
+
"type": "string",
|
|
21149
|
+
"enum": [
|
|
21150
|
+
"DEPOSIT",
|
|
21151
|
+
"WITHDRAWAL",
|
|
21152
|
+
"TRANSFER",
|
|
21153
|
+
"PAYMENT",
|
|
21154
|
+
"REFUND"
|
|
21155
|
+
],
|
|
21156
|
+
"description": "Below are the allowed values for the enumeration.\n- DEPOSIT - Used for performing a Cash-In (deposit) transaction. In a normal scenario, electronic funds are transferred from a Business account to a Consumer account, and physical cash is given from the Consumer to the Business User.\n- WITHDRAWAL - Used for performing a Cash-Out (withdrawal) transaction. In a normal scenario, electronic funds are transferred from a Consumer’s account to a Business account, and physical cash is given from the Business User to the Consumer.\n- TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.\n- PAYMENT - Usually used for performing a transaction from a Consumer to a Merchant or Organization, but could also be for a B2B (Business to Business) payment. The transaction could be online for a purchase in an Internet store, in a physical store where both the Consumer and Business User are present, a bill payment, a donation, and so on.\n- REFUND - Used for performing a refund of transaction.",
|
|
21157
|
+
"example": "DEPOSIT"
|
|
21158
|
+
},
|
|
21159
|
+
"subScenario": {
|
|
21160
|
+
"title": "TransactionSubScenario",
|
|
21161
|
+
"type": "string",
|
|
21162
|
+
"pattern": "^[A-Z_]{1,32}$",
|
|
21163
|
+
"description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).",
|
|
21164
|
+
"example": "LOCALLY_DEFINED_SUBSCENARIO"
|
|
21231
21165
|
},
|
|
21232
21166
|
"initiator": {
|
|
21233
21167
|
"title": "TransactionInitiator",
|
|
@@ -1222,7 +1222,8 @@ export interface components {
|
|
|
1222
1222
|
amountType: components["schemas"]["AmountType"];
|
|
1223
1223
|
currency: components["schemas"]["Currency"];
|
|
1224
1224
|
amount: components["schemas"]["Amount"];
|
|
1225
|
-
scenario: components["schemas"]["
|
|
1225
|
+
scenario: components["schemas"]["TransactionScenario"];
|
|
1226
|
+
subScenario?: components["schemas"]["TransactionSubScenario"];
|
|
1226
1227
|
initiator: components["schemas"]["TransactionInitiator"];
|
|
1227
1228
|
initiatorType: components["schemas"]["TransactionInitiatorType"];
|
|
1228
1229
|
note?: components["schemas"]["Note"];
|
|
@@ -10623,68 +10623,16 @@ export declare namespace Schemas {
|
|
|
10623
10623
|
scenario: {
|
|
10624
10624
|
title: string;
|
|
10625
10625
|
type: string;
|
|
10626
|
+
enum: string[];
|
|
10626
10627
|
description: string;
|
|
10627
|
-
|
|
10628
|
-
|
|
10629
|
-
|
|
10630
|
-
|
|
10631
|
-
|
|
10632
|
-
|
|
10633
|
-
|
|
10634
|
-
|
|
10635
|
-
subScenario: {
|
|
10636
|
-
title: string;
|
|
10637
|
-
type: string;
|
|
10638
|
-
pattern: string;
|
|
10639
|
-
description: string;
|
|
10640
|
-
example: string;
|
|
10641
|
-
};
|
|
10642
|
-
initiator: {
|
|
10643
|
-
title: string;
|
|
10644
|
-
type: string;
|
|
10645
|
-
enum: string[];
|
|
10646
|
-
description: string;
|
|
10647
|
-
example: string;
|
|
10648
|
-
};
|
|
10649
|
-
initiatorType: {
|
|
10650
|
-
title: string;
|
|
10651
|
-
type: string;
|
|
10652
|
-
enum: string[];
|
|
10653
|
-
description: string;
|
|
10654
|
-
example: string;
|
|
10655
|
-
};
|
|
10656
|
-
refundInfo: {
|
|
10657
|
-
title: string;
|
|
10658
|
-
type: string;
|
|
10659
|
-
description: string;
|
|
10660
|
-
properties: {
|
|
10661
|
-
originalTransactionId: {
|
|
10662
|
-
title: string;
|
|
10663
|
-
type: string;
|
|
10664
|
-
pattern: string;
|
|
10665
|
-
description: string;
|
|
10666
|
-
example: string;
|
|
10667
|
-
};
|
|
10668
|
-
refundReason: {
|
|
10669
|
-
title: string;
|
|
10670
|
-
type: string;
|
|
10671
|
-
minLength: number;
|
|
10672
|
-
maxLength: number;
|
|
10673
|
-
description: string;
|
|
10674
|
-
example: string;
|
|
10675
|
-
};
|
|
10676
|
-
};
|
|
10677
|
-
required: string[];
|
|
10678
|
-
};
|
|
10679
|
-
balanceOfPayments: {
|
|
10680
|
-
title: string;
|
|
10681
|
-
type: string;
|
|
10682
|
-
pattern: string;
|
|
10683
|
-
description: string;
|
|
10684
|
-
example: string;
|
|
10685
|
-
};
|
|
10686
|
-
};
|
|
10687
|
-
required: string[];
|
|
10628
|
+
example: string;
|
|
10629
|
+
};
|
|
10630
|
+
subScenario: {
|
|
10631
|
+
title: string;
|
|
10632
|
+
type: string;
|
|
10633
|
+
pattern: string;
|
|
10634
|
+
description: string;
|
|
10635
|
+
example: string;
|
|
10688
10636
|
};
|
|
10689
10637
|
initiator: {
|
|
10690
10638
|
title: string;
|
package/package.json
CHANGED