@mojaloop/api-snippets 12.8.0 → 13.0.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/CHANGELOG.md +32 -0
- package/docs/fspiop-rest-v1.0-openapi3-snippets.yaml +2 -0
- package/docs/fspiop-rest-v1.1-openapi3-snippets.yaml +2 -0
- package/docs/thirdparty-openapi3-snippets.yaml +832 -1082
- package/fspiop/v1_0/openapi3/components/schemas/Currency.yaml +2 -0
- package/fspiop/v1_1/openapi3/components/schemas/Currency.yaml +2 -0
- package/lib/fspiop/v1_0/openapi.d.ts +1 -1
- package/lib/fspiop/v1_1/openapi.d.ts +1 -1
- package/lib/thirdparty/index.d.ts +9 -5
- package/lib/thirdparty/openapi.d.ts +2325 -2925
- package/package.json +4 -2
- package/tests/dto/thirdparty.test.ts +37 -25
- package/thirdparty/openapi3/components/schemas/Account.yaml +2 -2
- package/thirdparty/openapi3/components/schemas/AccountAddress.yaml +7 -0
- package/thirdparty/openapi3/components/schemas/AccountsIDPutResponse.yaml +2 -1
- package/thirdparty/openapi3/components/schemas/ConsentRequestsIDPatchRequest.yaml +1 -1
- package/thirdparty/openapi3/components/schemas/ConsentRequestsIDPutResponseOTP.yaml +8 -8
- package/thirdparty/openapi3/components/schemas/ConsentRequestsIDPutResponseWeb.yaml +11 -11
- package/thirdparty/openapi3/components/schemas/ConsentRequestsPostRequest.yaml +12 -5
- package/thirdparty/openapi3/components/schemas/ConsentStatus.yaml +9 -0
- package/thirdparty/openapi3/components/schemas/ConsentStatusIssued.yaml +7 -0
- package/thirdparty/openapi3/components/schemas/ConsentStatusRevoked.yaml +7 -0
- package/thirdparty/openapi3/components/schemas/ConsentsIDPatchResponseRevoked.yaml +1 -1
- package/thirdparty/openapi3/components/schemas/ConsentsIDPatchResponseVerified.yaml +1 -1
- package/thirdparty/openapi3/components/schemas/ConsentsIDPutResponseSigned.yaml +2 -0
- package/thirdparty/openapi3/components/schemas/ConsentsIDPutResponseVerified.yaml +2 -0
- package/thirdparty/openapi3/components/schemas/ConsentsPostRequestAUTH.yaml +6 -1
- package/thirdparty/openapi3/components/schemas/ConsentsPostRequestPISP.yaml +10 -6
- package/thirdparty/openapi3/components/schemas/CredentialStatusPending.yaml +7 -0
- package/thirdparty/openapi3/components/schemas/CredentialStatusVerified.yaml +7 -0
- package/thirdparty/openapi3/components/schemas/CredentialType.yaml +2 -0
- package/thirdparty/openapi3/components/schemas/FIDOPublicKeyCredentialAttestation.yaml +6 -6
- package/thirdparty/openapi3/components/schemas/GenericCredential.yaml +13 -0
- package/thirdparty/openapi3/components/schemas/Scope.yaml +6 -9
- package/thirdparty/openapi3/components/schemas/ScopeAction.yaml +12 -0
- package/thirdparty/openapi3/components/schemas/ServicesServiceTypePutResponse.yaml +2 -0
- package/thirdparty/openapi3/components/schemas/SignedCredential.yaml +5 -6
- package/thirdparty/openapi3/components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseFIDO.yaml +2 -2
- package/thirdparty/openapi3/components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseGeneric.yaml +2 -2
- package/thirdparty/openapi3/components/schemas/ThirdpartyRequestsTransactionsIDPutResponse.yaml +0 -3
- package/thirdparty/openapi3/components/schemas/ThirdpartyRequestsTransactionsPostRequest.yaml +8 -3
- package/thirdparty/openapi3/components/schemas/ThirdpartyRequestsVerificationsPostRequestFIDO.yaml +2 -2
- package/thirdparty/openapi3/components/schemas/ThirdpartyRequestsVerificationsPostRequestGeneric.yaml +2 -2
- package/thirdparty/openapi3/components/schemas/Uri.yaml +8 -0
- package/thirdparty/openapi3/openapi.yaml +0 -14
- package/thirdparty/openapi3/paths/consentRequests.yaml +2 -1
- package/thirdparty/openapi3/paths/consentRequests_ID.yaml +41 -5
- package/thirdparty/openapi3/paths/consents.yaml +2 -2
- package/thirdparty/openapi3/paths/consents_ID.yaml +8 -5
- package/thirdparty/openapi3/paths/thirdpartyRequests_authorizations.yaml +3 -30
- package/thirdparty/openapi3/paths/thirdpartyRequests_authorizations_ID.yaml +36 -14
- package/thirdparty/openapi3/paths/thirdpartyRequests_transactions.yaml +6 -27
- package/thirdparty/openapi3/paths/thirdpartyRequests_transactions_ID.yaml +0 -2
- package/thirdparty/openapi3/paths/thirdpartyRequests_verifications.yaml +0 -13
- package/thirdparty/openapi3/paths/thirdpartyRequests_verifications_ID.yaml +32 -0
- package/thirdparty/openapi3/thirdparty-dfsp-api.template.yaml +53 -0
- package/thirdparty/openapi3/thirdparty-dfsp-api.yaml +2637 -0
- package/thirdparty/openapi3/thirdparty-pisp-api.template.yaml +57 -0
- package/thirdparty/openapi3/thirdparty-pisp-api.yaml +2842 -0
- package/thirdparty/openapi3/components/schemas/AccountId.yaml +0 -9
- package/thirdparty/openapi3/components/schemas/AuthenticationInfo.yaml +0 -11
- package/thirdparty/openapi3/components/schemas/ConsentScopeType.yaml +0 -9
- package/thirdparty/openapi3/components/schemas/ConsentStatusTypeRevoked.yaml +0 -7
- package/thirdparty/openapi3/components/schemas/ConsentStatusTypeVerified.yaml +0 -7
- package/thirdparty/openapi3/paths/thirdpartyRequests_transactions_tsa.yaml +0 -73
package/thirdparty/openapi3/components/schemas/ThirdpartyRequestsTransactionsIDPutResponse.yaml
CHANGED
|
@@ -2,10 +2,7 @@ title: ThirdpartyRequestsTransactionsIDPutResponse
|
|
|
2
2
|
type: object
|
|
3
3
|
description: 'The object sent in the PUT /thirdPartyRequests/transactions/{ID} request.'
|
|
4
4
|
properties:
|
|
5
|
-
transactionId:
|
|
6
|
-
$ref: ./CorrelationId.yaml
|
|
7
5
|
transactionRequestState:
|
|
8
6
|
$ref: ./TransactionRequestState.yaml
|
|
9
7
|
required:
|
|
10
|
-
- transactionId
|
|
11
8
|
- transactionRequestState
|
package/thirdparty/openapi3/components/schemas/ThirdpartyRequestsTransactionsPostRequest.yaml
CHANGED
|
@@ -6,9 +6,9 @@ properties:
|
|
|
6
6
|
allOf:
|
|
7
7
|
- $ref: ./CorrelationId.yaml
|
|
8
8
|
description: >
|
|
9
|
-
Common ID between the
|
|
10
|
-
should be reused for resends of the same transaction request.
|
|
11
|
-
should be generated for each new transaction request.
|
|
9
|
+
Common ID between the PISP and the Payer DFSP for the transaction request object.
|
|
10
|
+
The ID should be reused for resends of the same transaction request.
|
|
11
|
+
A new ID should be generated for each new transaction request.
|
|
12
12
|
payee:
|
|
13
13
|
allOf:
|
|
14
14
|
- $ref: ./Party.yaml
|
|
@@ -29,6 +29,11 @@ properties:
|
|
|
29
29
|
allOf:
|
|
30
30
|
- $ref: ./TransactionType.yaml
|
|
31
31
|
description: Type of transaction.
|
|
32
|
+
note:
|
|
33
|
+
type: string
|
|
34
|
+
minLength: 1
|
|
35
|
+
maxLength: 256
|
|
36
|
+
description: A memo that will be attached to the transaction.
|
|
32
37
|
expiration:
|
|
33
38
|
type: string
|
|
34
39
|
description: >
|
package/thirdparty/openapi3/components/schemas/ThirdpartyRequestsVerificationsPostRequestFIDO.yaml
CHANGED
|
@@ -16,11 +16,11 @@ properties:
|
|
|
16
16
|
the signed challenge against.
|
|
17
17
|
signedPayloadType:
|
|
18
18
|
$ref: ./SignedPayloadTypeFIDO.yaml
|
|
19
|
-
|
|
19
|
+
fidoSignedPayload:
|
|
20
20
|
$ref: ./FIDOPublicKeyCredentialAssertion.yaml
|
|
21
21
|
required:
|
|
22
22
|
- verificationRequestId
|
|
23
23
|
- challenge
|
|
24
24
|
- consentId
|
|
25
25
|
- signedPayloadType
|
|
26
|
-
-
|
|
26
|
+
- fidoSignedPayload
|
|
@@ -16,11 +16,11 @@ properties:
|
|
|
16
16
|
the signed challenge against.
|
|
17
17
|
signedPayloadType:
|
|
18
18
|
$ref: ./SignedPayloadTypeGeneric.yaml
|
|
19
|
-
|
|
19
|
+
genericSignedPayload:
|
|
20
20
|
$ref: ./BinaryString.yaml
|
|
21
21
|
required:
|
|
22
22
|
- verificationRequestId
|
|
23
23
|
- challenge
|
|
24
24
|
- consentId
|
|
25
25
|
- signedPayloadType
|
|
26
|
-
-
|
|
26
|
+
- genericSignedPayload
|
|
@@ -0,0 +1,8 @@
|
|
|
1
|
+
title: Uri
|
|
2
|
+
type: string
|
|
3
|
+
pattern: '^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?'
|
|
4
|
+
minLength: 1
|
|
5
|
+
maxLength: 512
|
|
6
|
+
description: >
|
|
7
|
+
The API data type Uri is a JSON string in a canonical format that is restricted by a \
|
|
8
|
+
regular expression for interoperability reasons.
|
|
@@ -50,18 +50,6 @@ paths:
|
|
|
50
50
|
$ref: paths/accounts_ID.yaml
|
|
51
51
|
/accounts/{ID}/error:
|
|
52
52
|
$ref: paths/accounts_ID_error.yaml
|
|
53
|
-
# Note: this resource is deprecated in the latest API Draft, and will
|
|
54
|
-
# be removed in the next MAJOR version release of API-Snippets
|
|
55
|
-
# Please use /thirdpartyRequests/authorizations instead
|
|
56
|
-
# TODO: remove in next major version release
|
|
57
|
-
/authorizations:
|
|
58
|
-
$ref: paths/authorizations.yaml
|
|
59
|
-
# Note: this resource is deprecated in the latest API Draft, and will
|
|
60
|
-
# be removed in the next MAJOR version release of API-Snippets
|
|
61
|
-
# Please use /thirdpartyRequests/authorizations/{ID} instead
|
|
62
|
-
# TODO: remove in next major version release
|
|
63
|
-
/authorizations/{ID}:
|
|
64
|
-
$ref: paths/authorizations_ID.yaml
|
|
65
53
|
/health:
|
|
66
54
|
$ref: paths/health.yaml
|
|
67
55
|
/metrics:
|
|
@@ -94,8 +82,6 @@ paths:
|
|
|
94
82
|
$ref: paths/services_ServiceType_error.yaml
|
|
95
83
|
/thirdpartyRequests/transactions:
|
|
96
84
|
$ref: paths/thirdpartyRequests_transactions.yaml
|
|
97
|
-
/thirdpartyRequests/transactions-tsa:
|
|
98
|
-
$ref: paths/thirdpartyRequests_transactions_tsa.yaml
|
|
99
85
|
/thirdpartyRequests/transactions/{ID}:
|
|
100
86
|
$ref: paths/thirdpartyRequests_transactions_ID.yaml
|
|
101
87
|
/thirdpartyRequests/transactions/{ID}/error:
|
|
@@ -16,7 +16,8 @@ post:
|
|
|
16
16
|
operationId: CreateConsentRequest
|
|
17
17
|
summary: CreateConsentRequest
|
|
18
18
|
description: |
|
|
19
|
-
|
|
19
|
+
The HTTP request **POST /consentRequests** is used to request a DFSP to grant access to one or more
|
|
20
|
+
accounts owned by a customer of the DFSP for the PISP who sends the request.
|
|
20
21
|
parameters:
|
|
21
22
|
- $ref: ../components/parameters/Accept.yaml
|
|
22
23
|
- $ref: ../components/parameters/Content-Length.yaml
|
|
@@ -11,6 +11,37 @@ parameters:
|
|
|
11
11
|
- $ref: ../components/parameters/FSPIOP-Signature.yaml
|
|
12
12
|
- $ref: ../components/parameters/FSPIOP-URI.yaml
|
|
13
13
|
- $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
|
|
14
|
+
get:
|
|
15
|
+
operationId: GetConsentRequestsById
|
|
16
|
+
summary: GetConsentRequestsById
|
|
17
|
+
description: |
|
|
18
|
+
The HTTP request `GET /consentRequests/{ID}` is used to get information about a previously
|
|
19
|
+
requested consent. The *{ID}* in the URI should contain the consentRequestId that was assigned to the
|
|
20
|
+
request by the PISP when the PISP originated the request.
|
|
21
|
+
tags:
|
|
22
|
+
- consentRequests
|
|
23
|
+
- sampled
|
|
24
|
+
parameters:
|
|
25
|
+
- $ref: ../components/parameters/Accept.yaml
|
|
26
|
+
responses:
|
|
27
|
+
202:
|
|
28
|
+
$ref: ../components/responses/202.yaml
|
|
29
|
+
400:
|
|
30
|
+
$ref: ../components/responses/400.yaml
|
|
31
|
+
401:
|
|
32
|
+
$ref: ../components/responses/401.yaml
|
|
33
|
+
403:
|
|
34
|
+
$ref: ../components/responses/403.yaml
|
|
35
|
+
404:
|
|
36
|
+
$ref: ../components/responses/404.yaml
|
|
37
|
+
405:
|
|
38
|
+
$ref: ../components/responses/405.yaml
|
|
39
|
+
406:
|
|
40
|
+
$ref: ../components/responses/406.yaml
|
|
41
|
+
501:
|
|
42
|
+
$ref: ../components/responses/501.yaml
|
|
43
|
+
503:
|
|
44
|
+
$ref: ../components/responses/503.yaml
|
|
14
45
|
put:
|
|
15
46
|
tags:
|
|
16
47
|
- consentRequests
|
|
@@ -18,10 +49,15 @@ put:
|
|
|
18
49
|
operationId: UpdateConsentRequest
|
|
19
50
|
summary: UpdateConsentRequest
|
|
20
51
|
description: |
|
|
21
|
-
DFSP
|
|
52
|
+
A DFSP uses this callback to (1) inform the PISP that the consentRequest has been accepted,
|
|
53
|
+
and (2) communicate to the PISP which `authChannel` it should use to authenticate their user
|
|
54
|
+
with.
|
|
22
55
|
|
|
23
|
-
|
|
24
|
-
|
|
56
|
+
When a PISP requests a series of permissions from a DFSP on behalf of a DFSP’s customer, not all
|
|
57
|
+
the permissions requested may be granted by the DFSP. Conversely, the out-of-band authorization
|
|
58
|
+
process may result in additional privileges being granted by the account holder to the PISP. The
|
|
59
|
+
**PUT /consentRequests/**_{ID}_ resource returns the current state of the permissions relating to a
|
|
60
|
+
particular authorization request.
|
|
25
61
|
parameters:
|
|
26
62
|
- $ref: ../components/parameters/Content-Length.yaml
|
|
27
63
|
requestBody:
|
|
@@ -58,8 +94,8 @@ patch:
|
|
|
58
94
|
operationId: PatchConsentRequest
|
|
59
95
|
summary: PatchConsentRequest
|
|
60
96
|
description: >
|
|
61
|
-
|
|
62
|
-
|
|
97
|
+
After the user completes an out-of-band authorization with the DFSP, the PISP will receive
|
|
98
|
+
a token which they can use to prove to the DFSP that the user trusts this PISP.
|
|
63
99
|
parameters:
|
|
64
100
|
- $ref: ../components/parameters/Accept.yaml
|
|
65
101
|
- $ref: ../components/parameters/Content-Length.yaml
|
|
@@ -16,8 +16,8 @@ post:
|
|
|
16
16
|
operationId: PostConsents
|
|
17
17
|
summary: PostConsents
|
|
18
18
|
description: >
|
|
19
|
-
|
|
20
|
-
DFSP
|
|
19
|
+
The **POST /consents** request is used to request the creation of a consent for interactions between
|
|
20
|
+
a PISP and the DFSP who owns the account which a PISP’s customer wants to allow the PISP access to.
|
|
21
21
|
parameters:
|
|
22
22
|
- $ref: ../components/parameters/Accept.yaml
|
|
23
23
|
- $ref: ../components/parameters/Content-Length.yaml
|
|
@@ -13,9 +13,9 @@ parameters:
|
|
|
13
13
|
- $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
|
|
14
14
|
get:
|
|
15
15
|
description: >
|
|
16
|
-
The
|
|
17
|
-
|
|
18
|
-
|
|
16
|
+
The **GET /consents/**_{ID}_ resource allows a party to enquire after the status of a consent. The
|
|
17
|
+
*{ID}* used in the URI of the request should be the consent request ID which was used to identify
|
|
18
|
+
the consent when it was created.
|
|
19
19
|
tags:
|
|
20
20
|
- consents
|
|
21
21
|
operationId: GetConsent
|
|
@@ -135,9 +135,12 @@ put:
|
|
|
135
135
|
$ref: ../components/responses/503.yaml
|
|
136
136
|
delete:
|
|
137
137
|
description: |
|
|
138
|
-
|
|
138
|
+
Used by PISP, DFSP
|
|
139
139
|
|
|
140
|
-
|
|
140
|
+
The **DELETE /consents/**_{ID}_ request is used to request the revocation of a previously agreed consent.
|
|
141
|
+
For tracing and auditing purposes, the switch should be sure not to delete the consent physically;
|
|
142
|
+
instead, information relating to the consent should be marked as deleted and requests relating to the
|
|
143
|
+
consent should not be honoured.
|
|
141
144
|
operationId: DeleteConsentByID
|
|
142
145
|
parameters:
|
|
143
146
|
- $ref: ../components/parameters/Accept.yaml
|
|
@@ -11,8 +11,8 @@ parameters:
|
|
|
11
11
|
- $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
|
|
12
12
|
post:
|
|
13
13
|
description: >
|
|
14
|
-
The HTTP request
|
|
15
|
-
|
|
14
|
+
The HTTP request **POST /thirdpartyRequests/authorizations** is used to request the validation by a
|
|
15
|
+
customer for the transfer described in the request.
|
|
16
16
|
operationId: PostThirdpartyRequestsAuthorizations
|
|
17
17
|
summary: PostThirdpartyRequestsAuthorizations
|
|
18
18
|
tags:
|
|
@@ -28,39 +28,12 @@ post:
|
|
|
28
28
|
application/json:
|
|
29
29
|
schema:
|
|
30
30
|
$ref: ../components/schemas/ThirdpartyRequestsAuthorizationsPostRequest.yaml
|
|
31
|
-
example:
|
|
32
|
-
authorizationRequestId: 33333333-0000-0000-0000-000000000000
|
|
33
|
-
transactionRequestId: '00000000-0000-0000-0000-000000000000'
|
|
34
|
-
challenge: '<base64 encoded binary - the encoded challenge>'
|
|
35
|
-
transferAmount:
|
|
36
|
-
amount: "100"
|
|
37
|
-
currency: "USD"
|
|
38
|
-
payeeReceiveAmount:
|
|
39
|
-
amount: "99"
|
|
40
|
-
currency: "USD"
|
|
41
|
-
fees:
|
|
42
|
-
amount: "1"
|
|
43
|
-
currency: "USD"
|
|
44
|
-
payee:
|
|
45
|
-
partyIdInfo:
|
|
46
|
-
partyIdType: 'MSISDN'
|
|
47
|
-
partyIdentifier: '+44 1234 5678'
|
|
48
|
-
fspId: 'dfspb'
|
|
49
|
-
payer:
|
|
50
|
-
partyIdType: 'THIRD_PARTY_LINK'
|
|
51
|
-
partyIdentifier: 'qwerty-123456'
|
|
52
|
-
fspId: 'dfspa'
|
|
53
|
-
transactionType:
|
|
54
|
-
scenario: "TRANSFER"
|
|
55
|
-
initiator: "PAYER"
|
|
56
|
-
initiatorType: "CONSUMER"
|
|
57
|
-
expiration: "2020-06-15T12:00:00.000"
|
|
58
31
|
responses:
|
|
59
32
|
202:
|
|
60
33
|
$ref: ../components/responses/202.yaml
|
|
61
34
|
400:
|
|
62
35
|
$ref: ../components/responses/400.yaml
|
|
63
|
-
401:
|
|
36
|
+
401:
|
|
64
37
|
$ref: ../components/responses/401.yaml
|
|
65
38
|
403:
|
|
66
39
|
$ref: ../components/responses/403.yaml
|
|
@@ -11,11 +11,44 @@ parameters:
|
|
|
11
11
|
- $ref: ../components/parameters/FSPIOP-Signature.yaml
|
|
12
12
|
- $ref: ../components/parameters/FSPIOP-URI.yaml
|
|
13
13
|
- $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
|
|
14
|
+
get:
|
|
15
|
+
description: |
|
|
16
|
+
The HTTP request **GET /thirdpartyRequests/authorizations/**_{ID}_ is used to get information relating
|
|
17
|
+
to a previously issued authorization request. The *{ID}* in the request should match the
|
|
18
|
+
`authorizationRequestId` which was given when the authorization request was created.
|
|
19
|
+
operationId: GetThirdpartyRequestsAuthorizationsById
|
|
20
|
+
summary: GetThirdpartyRequestsAuthorizationsById
|
|
21
|
+
tags:
|
|
22
|
+
- authorizations
|
|
23
|
+
parameters:
|
|
24
|
+
- $ref: ../components/parameters/Accept.yaml
|
|
25
|
+
responses:
|
|
26
|
+
202:
|
|
27
|
+
$ref: ../components/responses/202.yaml
|
|
28
|
+
400:
|
|
29
|
+
$ref: ../components/responses/400.yaml
|
|
30
|
+
401:
|
|
31
|
+
$ref: ../components/responses/401.yaml
|
|
32
|
+
403:
|
|
33
|
+
$ref: ../components/responses/403.yaml
|
|
34
|
+
404:
|
|
35
|
+
$ref: ../components/responses/404.yaml
|
|
36
|
+
405:
|
|
37
|
+
$ref: ../components/responses/405.yaml
|
|
38
|
+
406:
|
|
39
|
+
$ref: ../components/responses/406.yaml
|
|
40
|
+
501:
|
|
41
|
+
$ref: ../components/responses/501.yaml
|
|
42
|
+
503:
|
|
43
|
+
$ref: ../components/responses/503.yaml
|
|
14
44
|
put:
|
|
15
45
|
description: |
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
46
|
+
After receiving the **POST /thirdpartyRequests/authorizations**, the PISP will present the details of the
|
|
47
|
+
transaction to their user, and request that the client sign the `challenge` field using the credential
|
|
48
|
+
they previously registered.
|
|
49
|
+
|
|
50
|
+
The signed challenge will be sent back by the PISP in **PUT /thirdpartyRequests/authorizations/**_{ID}_:
|
|
51
|
+
|
|
19
52
|
operationId: PutThirdpartyRequestsAuthorizationsById
|
|
20
53
|
summary: PutThirdpartyRequestsAuthorizationsById
|
|
21
54
|
tags:
|
|
@@ -32,17 +65,6 @@ put:
|
|
|
32
65
|
- $ref: '../components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseRejected.yaml'
|
|
33
66
|
- $ref: '../components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseFIDO.yaml'
|
|
34
67
|
- $ref: '../components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseGeneric.yaml'
|
|
35
|
-
example:
|
|
36
|
-
signedPayloadType: FIDO
|
|
37
|
-
signedPayload:
|
|
38
|
-
id: 45c-TkfkjQovQeAWmOy-RLBHEJ_e4jYzQYgD8VdbkePgM5d98BaAadadNYrknxgH0jQEON8zBydLgh1EqoC9DA
|
|
39
|
-
rawId: 45c+TkfkjQovQeAWmOy+RLBHEJ/e4jYzQYgD8VdbkePgM5d98BaAadadNYrknxgH0jQEON8zBydLgh1EqoC9DA==
|
|
40
|
-
response:
|
|
41
|
-
authenticatorData: SZYN5YgOjGh0NBcPZHZgW4/krrmihjLHmVzzuoMdl2MBAAAACA==
|
|
42
|
-
clientDataJSON: eyJ0eXBlIjoid2ViYXV0aG4uZ2V0IiwiY2hhbGxlbmdlIjoiQUFBQUFBQUFBQUFBQUFBQUFBRUNBdyIsIm9yaWdpbiI6Imh0dHA6Ly9sb2NhbGhvc3Q6NDIxODEiLCJjcm9zc09yaWdpbiI6ZmFsc2UsIm90aGVyX2tleXNfY2FuX2JlX2FkZGVkX2hlcmUiOiJkbyBub3QgY29tcGFyZSBjbGllbnREYXRhSlNPTiBhZ2FpbnN0IGEgdGVtcGxhdGUuIFNlZSBodHRwczovL2dvby5nbC95YWJQZXgifQ==
|
|
43
|
-
signature: MEUCIDcJRBu5aOLJVc/sPyECmYi23w8xF35n3RNhyUNVwQ2nAiEA+Lnd8dBn06OKkEgAq00BVbmH87ybQHfXlf1Y4RJqwQ8=
|
|
44
|
-
type: 'public-key'
|
|
45
|
-
|
|
46
68
|
responses:
|
|
47
69
|
200:
|
|
48
70
|
$ref: ../components/responses/200.yaml
|
|
@@ -10,6 +10,11 @@ parameters:
|
|
|
10
10
|
- $ref: ../components/parameters/FSPIOP-URI.yaml
|
|
11
11
|
- $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
|
|
12
12
|
post:
|
|
13
|
+
operationId: ThirdpartyRequestsTransactionsPost
|
|
14
|
+
summary: ThirdpartyRequestsTransactionsPost
|
|
15
|
+
description: The HTTP request POST `/thirdpartyRequests/transactions` is used by a PISP to initiate a 3rd party Transaction request with a DFSP
|
|
16
|
+
tags:
|
|
17
|
+
- thirdpartyRequests
|
|
13
18
|
parameters:
|
|
14
19
|
#Headers
|
|
15
20
|
- $ref: ../components/parameters/Accept.yaml
|
|
@@ -21,26 +26,6 @@ post:
|
|
|
21
26
|
application/json:
|
|
22
27
|
schema:
|
|
23
28
|
$ref: ../components/schemas/ThirdpartyRequestsTransactionsPostRequest.yaml
|
|
24
|
-
example:
|
|
25
|
-
transactionRequestId: '8d34f91d-d078-4077-8263-2c047876fcf6'
|
|
26
|
-
payee:
|
|
27
|
-
partyIdInfo:
|
|
28
|
-
partyIdType: 'MSISDN'
|
|
29
|
-
partyIdentifier: '+44 1234 5678'
|
|
30
|
-
fspId: 'dfspb'
|
|
31
|
-
payer:
|
|
32
|
-
partyIdType: 'THIRD_PARTY_LINK'
|
|
33
|
-
partyIdentifier: 'qwerty-123456'
|
|
34
|
-
fspId: 'dfspa'
|
|
35
|
-
amountType: 'SEND'
|
|
36
|
-
amount:
|
|
37
|
-
amount: '100'
|
|
38
|
-
currency: 'USD'
|
|
39
|
-
transactionType:
|
|
40
|
-
scenario: 'TRANSFER'
|
|
41
|
-
initiator: 'PAYER'
|
|
42
|
-
initiatorType: 'CONSUMER'
|
|
43
|
-
expiration: '2020-07-15T22:17:28.985-01:00'
|
|
44
29
|
responses:
|
|
45
30
|
202:
|
|
46
31
|
$ref: ../components/responses/202.yaml
|
|
@@ -59,10 +44,4 @@ post:
|
|
|
59
44
|
501:
|
|
60
45
|
$ref: ../components/responses/501.yaml
|
|
61
46
|
503:
|
|
62
|
-
$ref: ../components/responses/503.yaml
|
|
63
|
-
operationId: CreateThirdpartyTransactionRequests
|
|
64
|
-
summary: CreateThirdpartyTransactionRequests
|
|
65
|
-
description: The HTTP request POST `/thirdpartyRequests/transactions` is used by a PISP to initiate a 3rd party Transaction request with a DFSP
|
|
66
|
-
tags:
|
|
67
|
-
- thirdpartyRequests
|
|
68
|
-
- sampled
|
|
47
|
+
$ref: ../components/responses/503.yaml
|
|
@@ -64,7 +64,6 @@ put:
|
|
|
64
64
|
schema:
|
|
65
65
|
$ref: ../components/schemas/ThirdpartyRequestsTransactionsIDPutResponse.yaml
|
|
66
66
|
example:
|
|
67
|
-
transactionId: '11111111-0000-0000-0000-000000000000'
|
|
68
67
|
transactionRequestState: 'RECEIVED'
|
|
69
68
|
responses:
|
|
70
69
|
200:
|
|
@@ -106,7 +105,6 @@ patch:
|
|
|
106
105
|
schema:
|
|
107
106
|
$ref: ../components/schemas/ThirdpartyRequestsTransactionsIDPatchResponse.yaml
|
|
108
107
|
example:
|
|
109
|
-
transactionId: '11111111-0000-0000-0000-000000000000'
|
|
110
108
|
transactionRequestState: 'ACCEPTED'
|
|
111
109
|
transactionState: 'COMMITTED'
|
|
112
110
|
responses:
|
|
@@ -29,19 +29,6 @@ post:
|
|
|
29
29
|
oneOf:
|
|
30
30
|
- $ref: ../components/schemas/ThirdpartyRequestsVerificationsPostRequestFIDO.yaml
|
|
31
31
|
- $ref: ../components/schemas/ThirdpartyRequestsVerificationsPostRequestGeneric.yaml
|
|
32
|
-
example:
|
|
33
|
-
verificationRequestId: '44444444-0000-0000-0000-000000000000'
|
|
34
|
-
challenge: '<base64 encoded binary - the encoded challenge>'
|
|
35
|
-
consentId: '8d34f91d-d078-4077-8263-2c0498dhbjr'
|
|
36
|
-
signedPayloadType: FIDO
|
|
37
|
-
signedPayload:
|
|
38
|
-
id: 45c-TkfkjQovQeAWmOy-RLBHEJ_e4jYzQYgD8VdbkePgM5d98BaAadadNYrknxgH0jQEON8zBydLgh1EqoC9DA
|
|
39
|
-
rawId: 45c+TkfkjQovQeAWmOy+RLBHEJ/e4jYzQYgD8VdbkePgM5d98BaAadadNYrknxgH0jQEON8zBydLgh1EqoC9DA==
|
|
40
|
-
response:
|
|
41
|
-
authenticatorData: SZYN5YgOjGh0NBcPZHZgW4/krrmihjLHmVzzuoMdl2MBAAAACA==
|
|
42
|
-
clientDataJSON: eyJ0eXBlIjoid2ViYXV0aG4uZ2V0IiwiY2hhbGxlbmdlIjoiQUFBQUFBQUFBQUFBQUFBQUFBRUNBdyIsIm9yaWdpbiI6Imh0dHA6Ly9sb2NhbGhvc3Q6NDIxODEiLCJjcm9zc09yaWdpbiI6ZmFsc2UsIm90aGVyX2tleXNfY2FuX2JlX2FkZGVkX2hlcmUiOiJkbyBub3QgY29tcGFyZSBjbGllbnREYXRhSlNPTiBhZ2FpbnN0IGEgdGVtcGxhdGUuIFNlZSBodHRwczovL2dvby5nbC95YWJQZXgifQ==
|
|
43
|
-
signature: MEUCIDcJRBu5aOLJVc/sPyECmYi23w8xF35n3RNhyUNVwQ2nAiEA+Lnd8dBn06OKkEgAq00BVbmH87ybQHfXlf1Y4RJqwQ8=
|
|
44
|
-
type: 'public-key'
|
|
45
32
|
responses:
|
|
46
33
|
202:
|
|
47
34
|
$ref: ../components/responses/202.yaml
|
|
@@ -11,6 +11,38 @@ parameters:
|
|
|
11
11
|
- $ref: ../components/parameters/FSPIOP-Signature.yaml
|
|
12
12
|
- $ref: ../components/parameters/FSPIOP-URI.yaml
|
|
13
13
|
- $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
|
|
14
|
+
get:
|
|
15
|
+
tags:
|
|
16
|
+
- thirdpartyRequests
|
|
17
|
+
- sampled
|
|
18
|
+
operationId: GetThirdpartyRequestsVerificationsById
|
|
19
|
+
summary: GetThirdpartyRequestsVerificationsById
|
|
20
|
+
description: |
|
|
21
|
+
The HTTP request `/thirdpartyRequests/verifications/{ID}` is used to get
|
|
22
|
+
information regarding a previously created or requested authorization. The *{ID}*
|
|
23
|
+
in the URI should contain the verification request ID
|
|
24
|
+
parameters:
|
|
25
|
+
#Headers
|
|
26
|
+
- $ref: ../components/parameters/Accept.yaml
|
|
27
|
+
responses:
|
|
28
|
+
202:
|
|
29
|
+
$ref: ../components/responses/202.yaml
|
|
30
|
+
400:
|
|
31
|
+
$ref: ../components/responses/400.yaml
|
|
32
|
+
401:
|
|
33
|
+
$ref: ../components/responses/401.yaml
|
|
34
|
+
403:
|
|
35
|
+
$ref: ../components/responses/403.yaml
|
|
36
|
+
404:
|
|
37
|
+
$ref: ../components/responses/404.yaml
|
|
38
|
+
405:
|
|
39
|
+
$ref: ../components/responses/405.yaml
|
|
40
|
+
406:
|
|
41
|
+
$ref: ../components/responses/406.yaml
|
|
42
|
+
501:
|
|
43
|
+
$ref: ../components/responses/501.yaml
|
|
44
|
+
503:
|
|
45
|
+
$ref: ../components/responses/503.yaml
|
|
14
46
|
put:
|
|
15
47
|
tags:
|
|
16
48
|
- thirdpartyRequests
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
openapi: 3.0.2
|
|
2
|
+
info:
|
|
3
|
+
title: Mojaloop Third Party API (DFSP)
|
|
4
|
+
version: '1.0'
|
|
5
|
+
description: >
|
|
6
|
+
A Mojaloop API for DFSPs supporting Third Party functions.
|
|
7
|
+
|
|
8
|
+
DFSPs who want to enable Payment Initiation Service Providers
|
|
9
|
+
(PISPs) to perform actions on behalf of a DFSP's user should
|
|
10
|
+
implement this API.
|
|
11
|
+
|
|
12
|
+
PISPs should implement the accompanying API - Mojaloop Third
|
|
13
|
+
Party API (PISP) instead.
|
|
14
|
+
license:
|
|
15
|
+
name: Open API for FSP Interoperability (FSPIOP) (Implementation Friendly Version)
|
|
16
|
+
url: https://github.com/mojaloop/mojaloop-specification/blob/master/LICENSE.md
|
|
17
|
+
servers:
|
|
18
|
+
- url: /
|
|
19
|
+
paths:
|
|
20
|
+
/accounts/{ID}:
|
|
21
|
+
$ref: 'paths/accounts_ID.yaml'
|
|
22
|
+
/accounts/{ID}/error:
|
|
23
|
+
$ref: 'paths/accounts_ID_error.yaml'
|
|
24
|
+
/consentRequests:
|
|
25
|
+
$ref: 'paths/consentRequests.yaml'
|
|
26
|
+
/consentRequests/{ID}:
|
|
27
|
+
$ref: 'paths/consentRequests_ID.yaml'
|
|
28
|
+
/consentRequests/{ID}/error:
|
|
29
|
+
$ref: 'paths/consentRequests_ID_error.yaml'
|
|
30
|
+
/consents:
|
|
31
|
+
$ref: 'paths/consents.yaml'
|
|
32
|
+
/consents/{ID}:
|
|
33
|
+
$ref: 'paths/consents_ID.yaml'
|
|
34
|
+
/consents/{ID}/error:
|
|
35
|
+
$ref: 'paths/consents_ID_error.yaml'
|
|
36
|
+
/thirdpartyRequests/authorizations:
|
|
37
|
+
$ref: 'paths/thirdpartyRequests_authorizations.yaml'
|
|
38
|
+
/thirdpartyRequests/authorizations/{ID}:
|
|
39
|
+
$ref: 'paths/thirdpartyRequests_authorizations_ID.yaml'
|
|
40
|
+
/thirdpartyRequests/authorizations/{ID}/error:
|
|
41
|
+
$ref: 'paths/thirdpartyRequests_authorizations_ID_error.yaml'
|
|
42
|
+
/thirdpartyRequests/transactions:
|
|
43
|
+
$ref: 'paths/thirdpartyRequests_transactions.yaml'
|
|
44
|
+
/thirdpartyRequests/transactions/{ID}:
|
|
45
|
+
$ref: 'paths/thirdpartyRequests_transactions_ID.yaml'
|
|
46
|
+
/thirdpartyRequests/transactions/{ID}/error:
|
|
47
|
+
$ref: 'paths/thirdpartyRequests_transactions_ID_error.yaml'
|
|
48
|
+
/thirdpartyRequests/verifications:
|
|
49
|
+
$ref: 'paths/thirdpartyRequests_verifications.yaml'
|
|
50
|
+
/thirdpartyRequests/verifications/{ID}:
|
|
51
|
+
$ref: 'paths/thirdpartyRequests_verifications_ID.yaml'
|
|
52
|
+
/thirdpartyRequests/verifications/{ID}/error:
|
|
53
|
+
$ref: 'paths/thirdpartyRequests_verifications_ID_error.yaml'
|