@mojaloop/api-snippets 17.2.3 → 17.2.5
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 +14 -0
- package/README.md +1 -1
- package/audit-ci.jsonc +8 -0
- package/docs/dist/openapi.yaml +2 -2
- package/docs/fspiop-rest-v1.0-openapi3-snippets.yaml +2 -2
- package/docs/fspiop-rest-v1.1-openapi3-snippets.yaml +4 -4
- package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +1 -1
- package/docs/thirdparty-openapi3-snippets.yaml +19 -19
- package/fspiop/v1_0/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +1 -1
- package/fspiop/v1_0/openapi3/components/parameters/FSPIOP-URI.yaml +1 -1
- package/fspiop/v1_1/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +1 -1
- package/fspiop/v1_1/openapi3/components/parameters/FSPIOP-URI.yaml +1 -1
- package/fspiop/v1_1/openapi3/openapi.yaml +2 -2
- package/lib/fspiop/v1_0/openapi.d.ts +3 -2
- package/lib/fspiop/v1_1/openapi.d.ts +3 -2
- package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +1 -0
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +1 -0
- package/lib/thirdparty/openapi.d.ts +19 -18
- package/package.json +18 -17
- package/sdk-bulk.yaml +1 -1
- package/sdk-outbound-old.yaml +1 -1
- package/sdk-scheme-adapter/v2_0_0/outbound/openapi.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/Account.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/AccountAddress.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/AccountList.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/AccountsIDPutResponse.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/AuthenticatorAssertionResponse.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/AuthenticatorAttestationResponse.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/ConsentRequestsIDPatchRequest.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/ConsentRequestsPostRequest.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/CredentialType.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/FIDOPublicKeyCredentialAssertion.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/Scope.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/ServiceType.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/ServicesServiceTypePutResponse.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsAuthorizationsPostRequest.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsTransactionsIDPatchResponse.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsTransactionsIDPutResponse.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsTransactionsPostRequest.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsVerificationsIDPutResponse.yaml +1 -1
- package/thirdparty/v1_0/openapi3/openapi.yaml +1 -1
- package/thirdparty/v1_0/openapi3/thirdparty-dfsp-api.template.yaml +1 -1
- package/thirdparty/v1_0/openapi3/thirdparty-dfsp-api.yaml +17 -17
- package/thirdparty/v1_0/openapi3/thirdparty-pisp-api.template.yaml +1 -1
- package/thirdparty/v1_0/openapi3/thirdparty-pisp-api.yaml +17 -17
package/package.json
CHANGED
@@ -1,12 +1,12 @@
|
|
1
1
|
{
|
2
2
|
"name": "@mojaloop/api-snippets",
|
3
|
-
"version": "17.2.
|
3
|
+
"version": "17.2.5",
|
4
4
|
"description": "Mojaloop API specification reusable snippets",
|
5
5
|
"main": "lib/index.js",
|
6
6
|
"types": "lib/index.d.ts",
|
7
7
|
"scripts": {
|
8
|
-
"audit:
|
9
|
-
"audit:check": "
|
8
|
+
"audit:fix": "npm audit fix",
|
9
|
+
"audit:check": "npx audit-ci --config ./audit-ci.jsonc",
|
10
10
|
"build": "npm run build:openapi; npm run build:dto; npm run build:schemas; tsc -p ./tsconfig.build.json",
|
11
11
|
"build:dto": "npm run build:dto:v1.0; npm run build:dto:v1.1; npm run build:dto:thirdparty; npm run build:dto:sdk-scheme-adapter;",
|
12
12
|
"build:schemas": "npm run build:schemas:sdk-scheme-adapter:backend; npm run build:schemas:sdk-scheme-adapter:outbound;",
|
@@ -28,11 +28,12 @@
|
|
28
28
|
"build:schemas:sdk-scheme-adapter:outbound": "npx ts-node --transpile-only src/scripts/json-schema-generator.ts docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml src/sdk-scheme-adapter/v2_0_0/outbound",
|
29
29
|
"lint": "eslint --ext ts --ext js test src",
|
30
30
|
"lint:fix": "eslint --fix --ext ts --ext js test src",
|
31
|
-
"prepare": "npm run build",
|
31
|
+
"prepare": "husky install && npm run build",
|
32
32
|
"dep:check": "ncu -e 2",
|
33
33
|
"dep:update": "ncu -u",
|
34
34
|
"release": "standard-version --releaseCommitMessageFormat 'chore(release): {{currentTag}} [skip ci]'",
|
35
35
|
"snapshot": "standard-version --no-verify --skip.changelog --prerelease snapshot --releaseCommitMessageFormat 'chore(snapshot): {{currentTag}}'",
|
36
|
+
"test": "npm run test:unit",
|
36
37
|
"test:unit": "jest --testMatch '**/test/dto/*.(test|spec).ts'"
|
37
38
|
},
|
38
39
|
"lint-staged": {
|
@@ -63,7 +64,7 @@
|
|
63
64
|
"js-yaml": "^4.1.0",
|
64
65
|
"json-refs": "^3.0.15",
|
65
66
|
"openapi-types": "^12.1.3",
|
66
|
-
"openapi-typescript": "^6.
|
67
|
+
"openapi-typescript": "^6.6.1",
|
67
68
|
"ts-auto-mock": "^3.7.1"
|
68
69
|
},
|
69
70
|
"overrides": {
|
@@ -74,34 +75,34 @@
|
|
74
75
|
"@commitlint/cli": "^17.7.1",
|
75
76
|
"@commitlint/config-conventional": "^17.7.0",
|
76
77
|
"@redocly/openapi-cli": "^1.0.0-beta.94",
|
77
|
-
"@types/jest": "^29.5.
|
78
|
-
"@typescript-eslint/eslint-plugin": "^6.
|
79
|
-
"@typescript-eslint/parser": "^6.
|
78
|
+
"@types/jest": "^29.5.4",
|
79
|
+
"@typescript-eslint/eslint-plugin": "^6.7.0",
|
80
|
+
"@typescript-eslint/parser": "^6.7.0",
|
81
|
+
"audit-ci": "^6.6.1",
|
80
82
|
"diff": "^5.1.0",
|
81
|
-
"eslint": "^8.
|
83
|
+
"eslint": "^8.49.0",
|
82
84
|
"eslint-config-prettier": "^9.0.0",
|
83
85
|
"eslint-config-standard": "^17.1.0",
|
84
86
|
"eslint-import-resolver-typescript": "^3.6.0",
|
85
87
|
"eslint-plugin-cucumber": "^2.0.0",
|
86
|
-
"eslint-plugin-import": "^2.28.
|
88
|
+
"eslint-plugin-import": "^2.28.1",
|
87
89
|
"eslint-plugin-node": "^11.1.0",
|
88
90
|
"eslint-plugin-prettier": "^5.0.0",
|
89
91
|
"eslint-plugin-promise": "^6.1.1",
|
90
92
|
"eslint-plugin-standard": "^5.0.0",
|
91
93
|
"husky": "8.0.3",
|
92
|
-
"jest": "^29.
|
94
|
+
"jest": "^29.7.0",
|
93
95
|
"jest-junit": "^16.0.0",
|
94
|
-
"lint-staged": "^14.0.
|
95
|
-
"npm-
|
96
|
-
"
|
97
|
-
"prettier": "^3.0.2",
|
96
|
+
"lint-staged": "^14.0.1",
|
97
|
+
"npm-check-updates": "^16.14.2",
|
98
|
+
"prettier": "^3.0.3",
|
98
99
|
"standard-version": "^9.5.0",
|
99
100
|
"swagger-cli": "^4.0.4",
|
100
101
|
"ts-jest": "^29.1.1",
|
101
102
|
"ts-node": "^10.9.1",
|
102
103
|
"ts-patch": "^3.0.2",
|
103
|
-
"tslib": "^2.6.
|
104
|
-
"typescript": "^5.
|
104
|
+
"tslib": "^2.6.2",
|
105
|
+
"typescript": "^5.2.2"
|
105
106
|
},
|
106
107
|
"publishConfig": {
|
107
108
|
"registry": "https://registry.npmjs.org/"
|
package/sdk-bulk.yaml
CHANGED
@@ -17,7 +17,7 @@ info:
|
|
17
17
|
the term "FSP" is equal to the term "DFSP".
|
18
18
|
license:
|
19
19
|
name: Apache License Version 2.0, January 2004
|
20
|
-
url: https://github.com/mojaloop/documentation/blob/
|
20
|
+
url: https://github.com/mojaloop/documentation/blob/main/LICENSE.md
|
21
21
|
version: 1.0.0
|
22
22
|
paths:
|
23
23
|
/:
|
package/sdk-outbound-old.yaml
CHANGED
@@ -17,7 +17,7 @@ info:
|
|
17
17
|
the term "FSP" is equal to the term "DFSP".
|
18
18
|
license:
|
19
19
|
name: 'Apache License Version 2.0, January 2004'
|
20
|
-
url: 'https://github.com/mojaloop/documentation/blob/
|
20
|
+
url: 'https://github.com/mojaloop/documentation/blob/main/LICENSE.md'
|
21
21
|
version: 2.0.0
|
22
22
|
paths:
|
23
23
|
/:
|
@@ -17,7 +17,7 @@ info:
|
|
17
17
|
the term "FSP" is equal to the term "DFSP".
|
18
18
|
license:
|
19
19
|
name: Apache License Version 2.0, January 2004
|
20
|
-
url: https://github.com/mojaloop/documentation/blob/
|
20
|
+
url: https://github.com/mojaloop/documentation/blob/main/LICENSE.md
|
21
21
|
version: 1.0.0
|
22
22
|
paths:
|
23
23
|
/:
|
@@ -3,7 +3,7 @@ type: object
|
|
3
3
|
description: >-
|
4
4
|
Data model for the complex type Account.
|
5
5
|
|
6
|
-
https://github.com/mojaloop/documentation/blob/
|
6
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account
|
7
7
|
properties:
|
8
8
|
accountNickname:
|
9
9
|
$ref: ./Name.yaml
|
@@ -19,7 +19,7 @@ description: >-
|
|
19
19
|
|
20
20
|
IMPORTANT: The policy for defining addresses and the life-cycle of these is at the discretion of the address space owner (the payer DFSP in this case).
|
21
21
|
|
22
|
-
https://github.com/mojaloop/documentation/blob/
|
22
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
|
23
23
|
pattern: '^([0-9A-Za-z_~\-\.]+[0-9A-Za-z_~\-])$'
|
24
24
|
minLength: 1
|
25
25
|
maxLength: 1023
|
@@ -4,7 +4,7 @@ description: >-
|
|
4
4
|
The AccountList data model is used to hold information about the accounts
|
5
5
|
that a party controls.
|
6
6
|
|
7
|
-
https://github.com/mojaloop/documentation/blob/
|
7
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist
|
8
8
|
items:
|
9
9
|
$ref: ./Account.yaml
|
10
10
|
minItems: 1
|
@@ -11,7 +11,7 @@ description: >-
|
|
11
11
|
of a request for accounts information. The identifier ID given in the call
|
12
12
|
are the values given in the original request.
|
13
13
|
|
14
|
-
https://github.com/mojaloop/documentation/blob/
|
14
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
|
15
15
|
properties:
|
16
16
|
accounts:
|
17
17
|
$ref: ./AccountList.yaml
|
@@ -3,7 +3,7 @@ type: object
|
|
3
3
|
description: >-
|
4
4
|
A data model representing an AssertionStatement from WebAuthN.
|
5
5
|
|
6
|
-
https://github.com/mojaloop/documentation/blob/
|
6
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32130-authenticatorassertionresponse
|
7
7
|
properties:
|
8
8
|
authenticatorData:
|
9
9
|
type: string
|
@@ -3,7 +3,7 @@ type: object
|
|
3
3
|
description: |
|
4
4
|
A data model representing an AttestationStatement from WebAuthN.
|
5
5
|
|
6
|
-
https://github.com/mojaloop/documentation/blob/
|
6
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32129-authenticatorattestationresponse
|
7
7
|
properties:
|
8
8
|
clientDataJSON:
|
9
9
|
type: string
|
@@ -7,7 +7,7 @@ description: >-
|
|
7
7
|
the PISP will receive a token which they can use to prove to the DFSP
|
8
8
|
that the user trusts this PISP.
|
9
9
|
|
10
|
-
https://github.com/mojaloop/documentation/blob/
|
10
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid
|
11
11
|
properties:
|
12
12
|
authToken:
|
13
13
|
$ref: ./BinaryString.yaml
|
@@ -13,7 +13,7 @@ description: >-
|
|
13
13
|
Error callback: PUT /consentRequests/{ID}/error
|
14
14
|
Data model - see below url
|
15
15
|
|
16
|
-
https://github.com/mojaloop/documentation/blob/
|
16
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests
|
17
17
|
properties:
|
18
18
|
consentRequestId:
|
19
19
|
$ref: ./CorrelationId.yaml
|
@@ -8,4 +8,4 @@ description: >-
|
|
8
8
|
- "FIDO" - The credential is based on a FIDO challenge. Its payload is a FIDOPublicKeyCredentialAttestation object.
|
9
9
|
- "GENERIC" - The credential is based on a simple public key validation. Its payload is a GenericCredential object.
|
10
10
|
|
11
|
-
https://github.com/mojaloop/documentation/blob/
|
11
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype
|
@@ -8,7 +8,7 @@ description: |
|
|
8
8
|
Javascript ArrayBuffer.
|
9
9
|
For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
|
10
10
|
|
11
|
-
https://github.com/mojaloop/documentation/blob/
|
11
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
|
12
12
|
properties:
|
13
13
|
id:
|
14
14
|
type: string
|
@@ -5,7 +5,7 @@ description: >-
|
|
5
5
|
an account on which access types can be requested or granted.
|
6
6
|
It also defines the access types which are requested or granted.
|
7
7
|
|
8
|
-
https://github.com/mojaloop/documentation/blob/
|
8
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope
|
9
9
|
properties:
|
10
10
|
address:
|
11
11
|
$ref: ./AccountAddress.yaml
|
@@ -8,7 +8,7 @@ description: >-
|
|
8
8
|
- PISP - Enum used to query for PISPs.
|
9
9
|
- AUTH_SERVICE - Participants which provide Authentication Services.
|
10
10
|
|
11
|
-
https://github.com/mojaloop/documentation/blob/
|
11
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3229-servicetype
|
12
12
|
enum:
|
13
13
|
- THIRD_PARTY_DFSP
|
14
14
|
- PISP
|
@@ -12,7 +12,7 @@ description: >-
|
|
12
12
|
Error Callback - PUT /services/{ServiceType}/error
|
13
13
|
Data Model - Empty body
|
14
14
|
|
15
|
-
https://github.com/mojaloop/documentation/blob/
|
15
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31531-put-servicesservicetype
|
16
16
|
properties:
|
17
17
|
providers:
|
18
18
|
type: array
|
package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsAuthorizationsPostRequest.yaml
CHANGED
@@ -11,7 +11,7 @@ description: >-
|
|
11
11
|
Error Callback - PUT /thirdpartyRequests/authorizations/{ID}/error
|
12
12
|
Data Model - See below url
|
13
13
|
|
14
|
-
https://github.com/mojaloop/documentation/blob/
|
14
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
15
15
|
type: object
|
16
16
|
properties:
|
17
17
|
authorizationRequestId:
|
@@ -12,7 +12,7 @@ description: >-
|
|
12
12
|
The {ID} given in the query string should be the transactionRequestId which
|
13
13
|
was originally used by the PISP to identify the transaction request.
|
14
14
|
|
15
|
-
https://github.com/mojaloop/documentation/blob/
|
15
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
16
16
|
properties:
|
17
17
|
completedTimestamp:
|
18
18
|
$ref: ./DateTime.yaml
|
package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsTransactionsIDPutResponse.yaml
CHANGED
@@ -8,7 +8,7 @@ description: >-
|
|
8
8
|
Third Party Transaction request (GET /thirdpartyRequests/transactions/{ID}),
|
9
9
|
the DFSP will send this callback.
|
10
10
|
|
11
|
-
https://github.com/mojaloop/documentation/blob/
|
11
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
|
12
12
|
properties:
|
13
13
|
transactionId:
|
14
14
|
$ref: ./CorrelationId.yaml
|
package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsTransactionsPostRequest.yaml
CHANGED
@@ -11,7 +11,7 @@ description: >-
|
|
11
11
|
Error Callback - PUT /thirdpartyRequests/transactions/{ID}/error
|
12
12
|
Data Model - See link below
|
13
13
|
|
14
|
-
https://github.com/mojaloop/documentation/blob/
|
14
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions
|
15
15
|
properties:
|
16
16
|
transactionRequestId:
|
17
17
|
allOf:
|
@@ -9,7 +9,7 @@ description: >-
|
|
9
9
|
which was used to request the check, or the {ID} that was used in the
|
10
10
|
GET /thirdpartyRequests/verifications/{ID}.
|
11
11
|
|
12
|
-
https://github.com/mojaloop/documentation/blob/
|
12
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31821-put-thirdpartyrequestsverificationsid
|
13
13
|
properties:
|
14
14
|
authenticationResponse:
|
15
15
|
$ref: ./AuthenticationResponse.yaml
|
@@ -13,7 +13,7 @@ info:
|
|
13
13
|
Party API (PISP) instead.
|
14
14
|
license:
|
15
15
|
name: Open API for FSP Interoperability (FSPIOP) (Implementation Friendly Version)
|
16
|
-
url: https://github.com/mojaloop/mojaloop-specification/blob/
|
16
|
+
url: https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md
|
17
17
|
servers:
|
18
18
|
- url: /
|
19
19
|
paths:
|
@@ -8,7 +8,7 @@ info:
|
|
8
8
|
PISPs should implement the accompanying API - Mojaloop Third Party API (PISP) instead.
|
9
9
|
license:
|
10
10
|
name: Open API for FSP Interoperability (FSPIOP) (Implementation Friendly Version)
|
11
|
-
url: 'https://github.com/mojaloop/mojaloop-specification/blob/
|
11
|
+
url: 'https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md'
|
12
12
|
servers:
|
13
13
|
- url: /
|
14
14
|
paths:
|
@@ -79,20 +79,20 @@ paths:
|
|
79
79
|
Callback and data model information for GET /accounts/{ID}:
|
80
80
|
Callback - PUT /accounts/{ID} Error Callback - PUT /accounts/{ID}/error Data Model - Empty body
|
81
81
|
The PUT /accounts/{ID} response is used to inform the requester of the result of a request for accounts information. The identifier ID given in the call are the values given in the original request.
|
82
|
-
https://github.com/mojaloop/documentation/blob/
|
82
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
|
83
83
|
properties:
|
84
84
|
accountList:
|
85
85
|
title: AccountList
|
86
86
|
type: array
|
87
87
|
description: |-
|
88
88
|
The AccountList data model is used to hold information about the accounts that a party controls.
|
89
|
-
https://github.com/mojaloop/documentation/blob/
|
89
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist
|
90
90
|
items:
|
91
91
|
title: Account
|
92
92
|
type: object
|
93
93
|
description: |-
|
94
94
|
Data model for the complex type Account.
|
95
|
-
https://github.com/mojaloop/documentation/blob/
|
95
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account
|
96
96
|
properties:
|
97
97
|
accountNickname:
|
98
98
|
title: Name
|
@@ -255,7 +255,7 @@ paths:
|
|
255
255
|
The HTTP request POST /consentRequests is used to request a DFSP to grant access to one or more accounts owned by a customer of the DFSP for the PISP who sends the request.
|
256
256
|
Callback and data model for POST /consentRequests:
|
257
257
|
Callback: PUT /consentRequests/{ID} Error callback: PUT /consentRequests/{ID}/error Data model - see below url
|
258
|
-
https://github.com/mojaloop/documentation/blob/
|
258
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests
|
259
259
|
properties:
|
260
260
|
consentRequestId:
|
261
261
|
title: CorrelationId
|
@@ -277,7 +277,7 @@ paths:
|
|
277
277
|
type: object
|
278
278
|
description: |-
|
279
279
|
The Scope element contains an identifier defining, in the terms of a DFSP, an account on which access types can be requested or granted. It also defines the access types which are requested or granted.
|
280
|
-
https://github.com/mojaloop/documentation/blob/
|
280
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope
|
281
281
|
properties:
|
282
282
|
address:
|
283
283
|
title: AccountAddress
|
@@ -288,7 +288,7 @@ paths:
|
|
288
288
|
- Underscore (_) - Tilde (~) - Hyphen (-) - Period (.) Addresses MUST NOT end in a period (.) character
|
289
289
|
An entity providing accounts to parties (i.e. a participant) can provide any value for an AccountAddress that is meaningful to that entity. It does not need to provide an address that makes the account identifiable outside the entity's domain.
|
290
290
|
IMPORTANT: The policy for defining addresses and the life-cycle of these is at the discretion of the address space owner (the payer DFSP in this case).
|
291
|
-
https://github.com/mojaloop/documentation/blob/
|
291
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
|
292
292
|
pattern: '^([0-9A-Za-z_~\-\.]+[0-9A-Za-z_~\-])$'
|
293
293
|
minLength: 1
|
294
294
|
maxLength: 1023
|
@@ -571,7 +571,7 @@ paths:
|
|
571
571
|
description: |-
|
572
572
|
Used by: PISP
|
573
573
|
After the user completes an out-of-band authorization with the DFSP, the PISP will receive a token which they can use to prove to the DFSP that the user trusts this PISP.
|
574
|
-
https://github.com/mojaloop/documentation/blob/
|
574
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid
|
575
575
|
properties:
|
576
576
|
authToken:
|
577
577
|
type: string
|
@@ -699,13 +699,13 @@ paths:
|
|
699
699
|
schema:
|
700
700
|
type: string
|
701
701
|
required: false
|
702
|
-
description: 'The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/
|
702
|
+
description: 'The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).'
|
703
703
|
- name: FSPIOP-HTTP-Method
|
704
704
|
in: header
|
705
705
|
schema:
|
706
706
|
type: string
|
707
707
|
required: false
|
708
|
-
description: 'The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/
|
708
|
+
description: 'The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).'
|
709
709
|
post:
|
710
710
|
tags:
|
711
711
|
- consents
|
@@ -1102,7 +1102,7 @@ paths:
|
|
1102
1102
|
- GENERIC
|
1103
1103
|
description: |-
|
1104
1104
|
The type of the Credential. - "FIDO" - The credential is based on a FIDO challenge. Its payload is a FIDOPublicKeyCredentialAttestation object. - "GENERIC" - The credential is based on a simple public key validation. Its payload is a GenericCredential object.
|
1105
|
-
https://github.com/mojaloop/documentation/blob/
|
1105
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype
|
1106
1106
|
status:
|
1107
1107
|
title: CredentialStatusPending
|
1108
1108
|
type: string
|
@@ -1366,7 +1366,7 @@ paths:
|
|
1366
1366
|
The HTTP request POST /thirdpartyRequests/authorizations is used to request the validation by a customer for the transfer described in the request.
|
1367
1367
|
Callback and data model information for POST /thirdpartyRequests/authorizations:
|
1368
1368
|
Callback - PUT /thirdpartyRequests/authorizations/{ID} Error Callback - PUT /thirdpartyRequests/authorizations/{ID}/error Data Model - See below url
|
1369
|
-
https://github.com/mojaloop/documentation/blob/
|
1369
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
1370
1370
|
type: object
|
1371
1371
|
properties:
|
1372
1372
|
authorizationRequestId:
|
@@ -1750,7 +1750,7 @@ paths:
|
|
1750
1750
|
The HTTP request POST /thirdpartyRequests/transactions is used to request the creation of a transaction request on the server for the transfer described in the request.
|
1751
1751
|
Callback and data model information for POST /thirdpartyRequests/transactions:
|
1752
1752
|
Callback - PUT /thirdpartyRequests/transactions/{ID} Error Callback - PUT /thirdpartyRequests/transactions/{ID}/error Data Model - See link below
|
1753
|
-
https://github.com/mojaloop/documentation/blob/
|
1753
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions
|
1754
1754
|
properties:
|
1755
1755
|
transactionRequestId:
|
1756
1756
|
allOf:
|
@@ -2217,7 +2217,7 @@ paths:
|
|
2217
2217
|
description: |-
|
2218
2218
|
Used by: DFSP
|
2219
2219
|
After a PISP requests the creation of a Third Party Transaction request (POST /thirdpartyRequests/transactions) or the status of a previously created Third Party Transaction request (GET /thirdpartyRequests/transactions/{ID}), the DFSP will send this callback.
|
2220
|
-
https://github.com/mojaloop/documentation/blob/
|
2220
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
|
2221
2221
|
properties:
|
2222
2222
|
transactionRequestState:
|
2223
2223
|
title: TransactionRequestState
|
@@ -2284,7 +2284,7 @@ paths:
|
|
2284
2284
|
The issuing PISP will expect a response to their request for a transfer which describes the finalized state of the requested transfer.
|
2285
2285
|
This response will be given by a PATCH call on the /thirdpartyRequests/transactions/{ID} resource.
|
2286
2286
|
The {ID} given in the query string should be the transactionRequestId which was originally used by the PISP to identify the transaction request.
|
2287
|
-
https://github.com/mojaloop/documentation/blob/
|
2287
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
2288
2288
|
properties:
|
2289
2289
|
completedTimestamp:
|
2290
2290
|
title: DateTime
|
@@ -2449,7 +2449,7 @@ paths:
|
|
2449
2449
|
Javascript ArrayBuffer.
|
2450
2450
|
For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
|
2451
2451
|
|
2452
|
-
https://github.com/mojaloop/documentation/blob/
|
2452
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
|
2453
2453
|
properties:
|
2454
2454
|
id:
|
2455
2455
|
type: string
|
@@ -2635,7 +2635,7 @@ paths:
|
|
2635
2635
|
description: |-
|
2636
2636
|
Used by: Auth Service
|
2637
2637
|
The callback PUT /thirdpartyRequests/verifications/{ID} is used to inform the client of the result of an authorization check. The {ID} in the URI should contain the authorizationRequestId which was used to request the check, or the {ID} that was used in the GET /thirdpartyRequests/verifications/{ID}.
|
2638
|
-
https://github.com/mojaloop/documentation/blob/
|
2638
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31821-put-thirdpartyrequestsverificationsid
|
2639
2639
|
properties:
|
2640
2640
|
authenticationResponse:
|
2641
2641
|
title: AuthenticationResponse
|
@@ -11,7 +11,7 @@ info:
|
|
11
11
|
Party API (DFSP) instead.
|
12
12
|
license:
|
13
13
|
name: Open API for FSP Interoperability (FSPIOP) (Implementation Friendly Version)
|
14
|
-
url: https://github.com/mojaloop/mojaloop-specification/blob/
|
14
|
+
url: https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md
|
15
15
|
servers:
|
16
16
|
- url: /
|
17
17
|
paths:
|