@mojaloop/api-snippets 17.0.4-snapshot.1 → 17.0.5-snapshot.0
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/CHANGELOG.md +7 -0
- package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +169 -135
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/json-schemas.json +2438 -2369
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +88 -69
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.d.ts +1969 -1897
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js +3 -5
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/types.d.ts +3 -5
- package/package.json +6 -6
- package/sdk-scheme-adapter/v2_0_0/components/parameters/requestToPayId.yaml +8 -0
- package/sdk-scheme-adapter/v2_0_0/components/schemas/requestToPayResponse.yaml +27 -6
- package/sdk-scheme-adapter/v2_0_0/outbound/openapi.yaml +2 -0
- package/sdk-scheme-adapter/v2_0_0/outbound/paths/requestToPay_requestToPayId.yaml +30 -0
|
@@ -99,16 +99,14 @@ var Schemas;
|
|
|
99
99
|
Schemas.quotesPostResponse = json_schemas_json_1.default.quotesPostResponse;
|
|
100
100
|
Schemas.errorQuotesResponse = json_schemas_json_1.default.errorQuotesResponse;
|
|
101
101
|
Schemas.requestToPayRequest = json_schemas_json_1.default.requestToPayRequest;
|
|
102
|
-
Schemas.AuthenticationType = json_schemas_json_1.default.AuthenticationType;
|
|
103
|
-
Schemas.TransactionRequestState = json_schemas_json_1.default.TransactionRequestState;
|
|
104
|
-
Schemas.requestToPayResponse = json_schemas_json_1.default.requestToPayResponse;
|
|
105
|
-
Schemas.requestToPayTransferRequest = json_schemas_json_1.default.requestToPayTransferRequest;
|
|
106
102
|
Schemas.transferStatus = json_schemas_json_1.default.transferStatus;
|
|
103
|
+
Schemas.requestToPayResponse = json_schemas_json_1.default.requestToPayResponse;
|
|
107
104
|
Schemas.QuotesIDPutResponse = json_schemas_json_1.default.QuotesIDPutResponse;
|
|
108
105
|
Schemas.TransfersIDPutResponse = json_schemas_json_1.default.TransfersIDPutResponse;
|
|
109
|
-
Schemas.requestToPayTransferResponse = json_schemas_json_1.default.requestToPayTransferResponse;
|
|
110
106
|
Schemas.transferResponse = json_schemas_json_1.default.transferResponse;
|
|
111
107
|
Schemas.errorTransferResponse = json_schemas_json_1.default.errorTransferResponse;
|
|
108
|
+
Schemas.requestToPayTransferRequest = json_schemas_json_1.default.requestToPayTransferRequest;
|
|
109
|
+
Schemas.requestToPayTransferResponse = json_schemas_json_1.default.requestToPayTransferResponse;
|
|
112
110
|
Schemas.transferContinuationAcceptOTP = json_schemas_json_1.default.transferContinuationAcceptOTP;
|
|
113
111
|
Schemas.TransfersPostRequest = json_schemas_json_1.default.TransfersPostRequest;
|
|
114
112
|
Schemas.simpleTransfersPostRequest = json_schemas_json_1.default.simpleTransfersPostRequest;
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../../src/sdk-scheme-adapter/v2_0_0/outbound/schemas.ts"],"names":[],"mappings":";AAAA,oDAAoD;;;;AAEpD,kEAAkE;AAElE,oFAA6C;AAE7C,IAAiB,OAAO,
|
|
1
|
+
{"version":3,"file":"schemas.js","sourceRoot":"","sources":["../../../../src/sdk-scheme-adapter/v2_0_0/outbound/schemas.ts"],"names":[],"mappings":";AAAA,oDAAoD;;;;AAEpD,kEAAkE;AAElE,oFAA6C;AAE7C,IAAiB,OAAO,CA4GvB;AA5GD,WAAiB,OAAO;IACT,mBAAW,GAAG,2BAAW,CAAC,WAAW,CAAA;IACrC,uBAAe,GAAG,2BAAW,CAAC,eAAe,CAAA;IAC7C,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,gBAAQ,GAAG,2BAAW,CAAC,QAAQ,CAAA;IAC/B,uBAAe,GAAG,2BAAW,CAAC,eAAe,CAAA;IAC7C,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,6BAAqB,GAAG,2BAAW,CAAC,qBAAqB,CAAA;IACzD,6BAAqB,GAAG,2BAAW,CAAC,qBAAqB,CAAA;IACzD,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,oBAAY,GAAG,2BAAW,CAAC,YAAY,CAAA;IACvC,sBAAc,GAAG,2BAAW,CAAC,cAAc,CAAA;IAC3C,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,6BAAqB,GAAG,2BAAW,CAAC,qBAAqB,CAAA;IACzD,gCAAwB,GAAG,2BAAW,CAAC,wBAAwB,CAAA;IAC/D,YAAI,GAAG,2BAAW,CAAC,IAAI,CAAA;IACvB,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,kBAAU,GAAG,2BAAW,CAAC,UAAU,CAAA;IACnC,gBAAQ,GAAG,2BAAW,CAAC,QAAQ,CAAA;IAC/B,mBAAW,GAAG,2BAAW,CAAC,WAAW,CAAA;IACrC,kCAA0B,GAAG,2BAAW,CAAC,0BAA0B,CAAA;IACnE,aAAK,GAAG,2BAAW,CAAC,KAAK,CAAA;IACzB,8BAAsB,GAAG,2BAAW,CAAC,sBAAsB,CAAA;IAC3D,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,kBAAU,GAAG,2BAAW,CAAC,UAAU,CAAA;IACnC,cAAM,GAAG,2BAAW,CAAC,MAAM,CAAA;IAC3B,+BAAuB,GAAG,2BAAW,CAAC,uBAAuB,CAAA;IAC7D,8BAAsB,GAAG,2BAAW,CAAC,sBAAsB,CAAA;IAC3D,YAAI,GAAG,2BAAW,CAAC,IAAI,CAAA;IACvB,uBAAe,GAAG,2BAAW,CAAC,eAAe,CAAA;IAC7C,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,gBAAQ,GAAG,2BAAW,CAAC,QAAQ,CAAA;IAC/B,0BAAkB,GAAG,2BAAW,CAAC,kBAAkB,CAAA;IACnD,aAAK,GAAG,2BAAW,CAAC,KAAK,CAAA;IACzB,gBAAQ,GAAG,2BAAW,CAAC,QAAQ,CAAA;IAC/B,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,eAAO,GAAG,2BAAW,CAAC,OAAO,CAAA;IAC7B,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,oBAAY,GAAG,2BAAW,CAAC,YAAY,CAAA;IACvC,kBAAU,GAAG,2BAAW,CAAC,UAAU,CAAA;IACnC,6BAAqB,GAAG,2BAAW,CAAC,qBAAqB,CAAA;IACzD,yBAAiB,GAAG,2BAAW,CAAC,iBAAiB,CAAA;IACjD,8BAAsB,GAAG,2BAAW,CAAC,sBAAsB,CAAA;IAC3D,uBAAe,GAAG,2BAAW,CAAC,eAAe,CAAA;IAC7C,+BAAuB,GAAG,2BAAW,CAAC,uBAAuB,CAAA;IAC7D,6BAAqB,GAAG,2BAAW,CAAC,qBAAqB,CAAA;IACzD,+BAAuB,GAAG,2BAAW,CAAC,uBAAuB,CAAA;IAC7D,uBAAe,GAAG,2BAAW,CAAC,eAAe,CAAA;IAC7C,8BAAsB,GAAG,2BAAW,CAAC,sBAAsB,CAAA;IAC3D,mBAAW,GAAG,2BAAW,CAAC,WAAW,CAAA;IACrC,iBAAS,GAAG,2BAAW,CAAC,SAAS,CAAA;IACjC,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,yBAAiB,GAAG,2BAAW,CAAC,iBAAiB,CAAA;IACjD,aAAK,GAAG,2BAAW,CAAC,KAAK,CAAA;IACzB,yCAAiC,GAAG,2BAAW,CAAC,iCAAiC,CAAA;IACjF,8BAAsB,GAAG,2BAAW,CAAC,sBAAsB,CAAA;IAC3D,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,qBAAa,GAAG,2BAAW,CAAC,aAAa,CAAA;IACzC,gCAAwB,GAAG,2BAAW,CAAC,wBAAwB,CAAA;IAC/D,4BAAoB,GAAG,2BAAW,CAAC,oBAAoB,CAAA;IACvD,iCAAyB,GAAG,2BAAW,CAAC,yBAAyB,CAAA;IACjE,+CAAuC,GAAG,2BAAW,CAAC,uCAAuC,CAAA;IAC7F,uCAA+B,GAAG,2BAAW,CAAC,+BAA+B,CAAA;IAC7E,8CAAsC,GAAG,2BAAW,CAAC,sCAAsC,CAAA;IAC3F,uCAA+B,GAAG,2BAAW,CAAC,+BAA+B,CAAA;IAC7E,8CAAsC,GAAG,2BAAW,CAAC,sCAAsC,CAAA;IAC3F,kBAAU,GAAG,2BAAW,CAAC,UAAU,CAAA;IACnC,+CAAuC,GAAG,2BAAW,CAAC,uCAAuC,CAAA;IAC7F,+CAAuC,GAAG,2BAAW,CAAC,uCAAuC,CAAA;IAC7F,0BAAkB,GAAG,2BAAW,CAAC,kBAAkB,CAAA;IACnD,2BAAmB,GAAG,2BAAW,CAAC,mBAAmB,CAAA;IACrD,oCAA4B,GAAG,2BAAW,CAAC,4BAA4B,CAAA;IACvE,kCAA0B,GAAG,2BAAW,CAAC,0BAA0B,CAAA;IACnE,8BAAsB,GAAG,2BAAW,CAAC,sBAAsB,CAAA;IAC3D,2BAAmB,GAAG,2BAAW,CAAC,mBAAmB,CAAA;IACrD,2BAAmB,GAAG,2BAAW,CAAC,mBAAmB,CAAA;IACrD,4BAAoB,GAAG,2BAAW,CAAC,oBAAoB,CAAA;IACvD,oBAAY,GAAG,2BAAW,CAAC,YAAY,CAAA;IACvC,cAAM,GAAG,2BAAW,CAAC,MAAM,CAAA;IAC3B,yBAAiB,GAAG,2BAAW,CAAC,iBAAiB,CAAA;IACjD,uBAAe,GAAG,2BAAW,CAAC,eAAe,CAAA;IAC7C,yBAAiB,GAAG,2BAAW,CAAC,iBAAiB,CAAA;IACjD,+BAAuB,GAAG,2BAAW,CAAC,uBAAuB,CAAA;IAC7D,0BAAkB,GAAG,2BAAW,CAAC,kBAAkB,CAAA;IACnD,2BAAmB,GAAG,2BAAW,CAAC,mBAAmB,CAAA;IACrD,2BAAmB,GAAG,2BAAW,CAAC,mBAAmB,CAAA;IACrD,sBAAc,GAAG,2BAAW,CAAC,cAAc,CAAA;IAC3C,4BAAoB,GAAG,2BAAW,CAAC,oBAAoB,CAAA;IACvD,2BAAmB,GAAG,2BAAW,CAAC,mBAAmB,CAAA;IACrD,8BAAsB,GAAG,2BAAW,CAAC,sBAAsB,CAAA;IAC3D,wBAAgB,GAAG,2BAAW,CAAC,gBAAgB,CAAA;IAC/C,6BAAqB,GAAG,2BAAW,CAAC,qBAAqB,CAAA;IACzD,mCAA2B,GAAG,2BAAW,CAAC,2BAA2B,CAAA;IACrE,oCAA4B,GAAG,2BAAW,CAAC,4BAA4B,CAAA;IACvE,qCAA6B,GAAG,2BAAW,CAAC,6BAA6B,CAAA;IACzE,4BAAoB,GAAG,2BAAW,CAAC,oBAAoB,CAAA;IACvD,kCAA0B,GAAG,2BAAW,CAAC,0BAA0B,CAAA;IACnE,mCAA2B,GAAG,2BAAW,CAAC,2BAA2B,CAAA;IACrE,oCAA4B,GAAG,2BAAW,CAAC,4BAA4B,CAAA;IACvE,uBAAe,GAAG,2BAAW,CAAC,eAAe,CAAA;IAC7C,8BAAsB,GAAG,2BAAW,CAAC,sBAAsB,CAAA;AAC1E,CAAC,EA5GgB,OAAO,GAAP,eAAO,KAAP,eAAO,QA4GvB"}
|
|
@@ -93,16 +93,14 @@ export declare namespace Types {
|
|
|
93
93
|
type quotesPostResponse = components['schemas']['quotesPostResponse'];
|
|
94
94
|
type errorQuotesResponse = components['schemas']['errorQuotesResponse'];
|
|
95
95
|
type requestToPayRequest = components['schemas']['requestToPayRequest'];
|
|
96
|
-
type AuthenticationType = components['schemas']['AuthenticationType'];
|
|
97
|
-
type TransactionRequestState = components['schemas']['TransactionRequestState'];
|
|
98
|
-
type requestToPayResponse = components['schemas']['requestToPayResponse'];
|
|
99
|
-
type requestToPayTransferRequest = components['schemas']['requestToPayTransferRequest'];
|
|
100
96
|
type transferStatus = components['schemas']['transferStatus'];
|
|
97
|
+
type requestToPayResponse = components['schemas']['requestToPayResponse'];
|
|
101
98
|
type QuotesIDPutResponse = components['schemas']['QuotesIDPutResponse'];
|
|
102
99
|
type TransfersIDPutResponse = components['schemas']['TransfersIDPutResponse'];
|
|
103
|
-
type requestToPayTransferResponse = components['schemas']['requestToPayTransferResponse'];
|
|
104
100
|
type transferResponse = components['schemas']['transferResponse'];
|
|
105
101
|
type errorTransferResponse = components['schemas']['errorTransferResponse'];
|
|
102
|
+
type requestToPayTransferRequest = components['schemas']['requestToPayTransferRequest'];
|
|
103
|
+
type requestToPayTransferResponse = components['schemas']['requestToPayTransferResponse'];
|
|
106
104
|
type transferContinuationAcceptOTP = components['schemas']['transferContinuationAcceptOTP'];
|
|
107
105
|
type TransfersPostRequest = components['schemas']['TransfersPostRequest'];
|
|
108
106
|
type simpleTransfersPostRequest = components['schemas']['simpleTransfersPostRequest'];
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mojaloop/api-snippets",
|
|
3
|
-
"version": "17.0.
|
|
3
|
+
"version": "17.0.5-snapshot.0",
|
|
4
4
|
"description": "Mojaloop API specification reusable snippets",
|
|
5
5
|
"main": "lib/index.js",
|
|
6
6
|
"types": "lib/index.d.ts",
|
|
@@ -86,10 +86,10 @@
|
|
|
86
86
|
"@commitlint/config-conventional": "^17.6.1",
|
|
87
87
|
"@redocly/openapi-cli": "^1.0.0-beta.94",
|
|
88
88
|
"@types/jest": "^29.5.1",
|
|
89
|
-
"@typescript-eslint/eslint-plugin": "^5.59.
|
|
90
|
-
"@typescript-eslint/parser": "^5.59.
|
|
89
|
+
"@typescript-eslint/eslint-plugin": "^5.59.1",
|
|
90
|
+
"@typescript-eslint/parser": "^5.59.1",
|
|
91
91
|
"diff": "^5.1.0",
|
|
92
|
-
"eslint": "^8.
|
|
92
|
+
"eslint": "^8.39.0",
|
|
93
93
|
"eslint-config-prettier": "^8.8.0",
|
|
94
94
|
"eslint-config-standard": "^17.0.0",
|
|
95
95
|
"eslint-import-resolver-typescript": "^3.5.5",
|
|
@@ -102,10 +102,10 @@
|
|
|
102
102
|
"husky": "4.3.8",
|
|
103
103
|
"jest": "^29.5.0",
|
|
104
104
|
"jest-junit": "^16.0.0",
|
|
105
|
-
"lint-staged": "^13.2.
|
|
105
|
+
"lint-staged": "^13.2.2",
|
|
106
106
|
"npm-audit-resolver": "^3.0.0-RC.0",
|
|
107
107
|
"npm-check-updates": "^16.10.8",
|
|
108
|
-
"prettier": "^2.8.
|
|
108
|
+
"prettier": "^2.8.8",
|
|
109
109
|
"standard-version": "^9.5.0",
|
|
110
110
|
"swagger-cli": "^4.0.4",
|
|
111
111
|
"ts-jest": "^29.1.0",
|
|
@@ -1,16 +1,23 @@
|
|
|
1
1
|
type: object
|
|
2
2
|
required:
|
|
3
|
-
-
|
|
3
|
+
- requestToPayId
|
|
4
4
|
- from
|
|
5
5
|
- to
|
|
6
6
|
- amountType
|
|
7
7
|
- currency
|
|
8
8
|
- amount
|
|
9
9
|
- transactionType
|
|
10
|
-
-
|
|
10
|
+
- currentState
|
|
11
11
|
properties:
|
|
12
|
+
requestToPayId:
|
|
13
|
+
$ref: ./CorrelationId.yaml
|
|
12
14
|
transactionRequestId:
|
|
13
15
|
$ref: ./CorrelationId.yaml
|
|
16
|
+
homeTransactionId:
|
|
17
|
+
type: string
|
|
18
|
+
description: >-
|
|
19
|
+
Transaction ID from the DFSP backend, used to reconcile transactions
|
|
20
|
+
between the Switch and DFSP backend systems.
|
|
14
21
|
from:
|
|
15
22
|
$ref: ./transferParty.yaml
|
|
16
23
|
to:
|
|
@@ -25,7 +32,21 @@ properties:
|
|
|
25
32
|
$ref: ./TransactionScenario.yaml
|
|
26
33
|
subScenario:
|
|
27
34
|
$ref: ./TransactionSubScenario.yaml
|
|
28
|
-
|
|
29
|
-
$ref: ./
|
|
30
|
-
|
|
31
|
-
|
|
35
|
+
currentState:
|
|
36
|
+
$ref: ./transferStatus.yaml
|
|
37
|
+
getPartiesResponse:
|
|
38
|
+
type: object
|
|
39
|
+
required:
|
|
40
|
+
- body
|
|
41
|
+
properties:
|
|
42
|
+
body:
|
|
43
|
+
type: object
|
|
44
|
+
headers:
|
|
45
|
+
type: object
|
|
46
|
+
lastError:
|
|
47
|
+
description: >
|
|
48
|
+
Object representing the last error to occur during a transfer process.
|
|
49
|
+
This may be a Mojaloop API error returned from another entity in the
|
|
50
|
+
scheme or an object representing other types of error e.g. exceptions that
|
|
51
|
+
may occur inside the scheme adapter.
|
|
52
|
+
$ref: ./transferError.yaml
|
|
@@ -44,6 +44,8 @@ paths:
|
|
|
44
44
|
$ref: paths/quotes.yaml
|
|
45
45
|
/requestToPay:
|
|
46
46
|
$ref: paths/requestToPay.yaml
|
|
47
|
+
/requestToPay/{requestToPayId}:
|
|
48
|
+
$ref: paths/requestToPay_requestToPayId.yaml
|
|
47
49
|
/requestToPayTransfer:
|
|
48
50
|
$ref: paths/requestToPayTransfer.yaml
|
|
49
51
|
/requestToPayTransfer/{requestToPayTransactionId}:
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
put:
|
|
2
|
+
summary: >-
|
|
3
|
+
Continues a request funds from sender that has paused at the party resolution stage in order to accept or
|
|
4
|
+
reject party information
|
|
5
|
+
description: >
|
|
6
|
+
The HTTP request `PUT /requestToPay/{requestToPayId}` is used to continue a
|
|
7
|
+
transfer initiated via the `POST /requestToPay` method that has halted after
|
|
8
|
+
party lookup stage.
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
The request body should contain the "acceptParty" property set to `true` as required to continue the transfer.
|
|
12
|
+
|
|
13
|
+
See the description of the `POST /requestToPay` HTTP method for more
|
|
14
|
+
information on modes of transfer.
|
|
15
|
+
tags:
|
|
16
|
+
- RequestToPay
|
|
17
|
+
requestBody:
|
|
18
|
+
content:
|
|
19
|
+
application/json:
|
|
20
|
+
schema:
|
|
21
|
+
$ref: ../../components/schemas/transferContinuationAcceptParty.yaml
|
|
22
|
+
parameters:
|
|
23
|
+
- $ref: ../../components/parameters/requestToPayId.yaml
|
|
24
|
+
responses:
|
|
25
|
+
'200':
|
|
26
|
+
$ref: ../../components/responses/requestToPaySuccess.yaml
|
|
27
|
+
'500':
|
|
28
|
+
$ref: ../../components/responses/transferServerError.yaml
|
|
29
|
+
'504':
|
|
30
|
+
$ref: ../../components/responses/transferTimeout.yaml
|