@mojaloop/api-snippets 18.3.1 → 18.4.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 +20 -0
- package/audit-ci.jsonc +7 -1
- package/docs/fspiop-rest-v2.0-ISO20022-openapi3-snippets.yaml +0 -2
- package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +1 -1
- package/docs/thirdparty-admin-v2.0-openapi3-snippets.yaml +3705 -0
- package/docs/thirdparty-openapi3-snippets.yaml +5 -5
- package/docs/thirdparty-v1.0-openapi3-snippets.yaml +3802 -0
- package/docs/thirdparty-v2.0-openapi3-snippets.yaml +1825 -0
- package/eslint.config.mjs +70 -0
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification18.yaml +0 -1
- package/fspiop/v2_0_ISO20022/openapi3/components/schemas/FinancialInstitutionIdentification23.yaml +0 -1
- package/lib/fspiop/v2_0/index.js +0 -1
- package/lib/fspiop/v2_0/index.js.map +1 -1
- package/lib/fspiop/v2_0_ISO20022/index.js +0 -1
- package/lib/fspiop/v2_0_ISO20022/index.js.map +1 -1
- package/lib/fspiop/v2_0_ISO20022/json-schemas.json +0 -71
- package/lib/fspiop/v2_0_ISO20022/schemas.d.ts +0 -140
- package/lib/index.js +0 -1
- package/lib/index.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/backend/index.js +0 -1
- package/lib/sdk-scheme-adapter/v2_0_0/backend/index.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/index.js +0 -1
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/index.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_1_0/backend/index.js +0 -1
- package/lib/sdk-scheme-adapter/v2_1_0/backend/index.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/index.js +0 -1
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/index.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +1 -1
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.d.ts +1 -1
- package/lib/thirdparty/v2_0/openapi.d.ts +1726 -0
- package/lib/thirdparty/v2_0/openapi.js +7 -0
- package/lib/thirdparty/v2_0/openapi.js.map +1 -0
- package/package.json +48 -45
- package/sdk-scheme-adapter/v2_1_0/components/schemas/transferRequest.yaml +1 -1
- package/test/dto/{thirdparty.test.ts → thirdparty_v1_0.test.ts} +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/FIDOPublicKeyCredentialAssertion.yaml +2 -2
- package/thirdparty/v1_0/openapi3/components/schemas/FIDOPublicKeyCredentialAttestation.yaml +3 -3
- package/thirdparty/v1_0/openapi3/thirdparty-dfsp-api.yaml +68 -61
- package/thirdparty/v1_0/openapi3/thirdparty-pisp-api.yaml +82 -75
- package/thirdparty/v2_0/openapi3/components/headers/Content-Length.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/headers/Content-Type.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/parameters/Accept.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/parameters/Content-Length.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/parameters/Content-Type.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/parameters/Date.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/parameters/FSPIOP-Destination.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/parameters/FSPIOP-Encryption.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/parameters/FSPIOP-Signature.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/parameters/FSPIOP-Source.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/parameters/FSPIOP-URI.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/parameters/ID.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/parameters/ServiceType.yaml +6 -0
- package/thirdparty/v2_0/openapi3/components/parameters/SubId.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/parameters/Type.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/parameters/X-Forwarded-For.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/responses/200.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/responses/202.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/responses/400.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/responses/401.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/responses/403.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/responses/404.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/responses/405.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/responses/406.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/responses/501.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/responses/503.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/Account.yaml +17 -0
- package/thirdparty/v2_0/openapi3/components/schemas/AccountAddress.yaml +25 -0
- package/thirdparty/v2_0/openapi3/components/schemas/AccountList.yaml +11 -0
- package/thirdparty/v2_0/openapi3/components/schemas/Amount.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/AmountType.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/AuthenticationResponse.yaml +10 -0
- package/thirdparty/v2_0/openapi3/components/schemas/AuthenticatorAssertionResponse.yaml +32 -0
- package/thirdparty/v2_0/openapi3/components/schemas/AuthenticatorAttestationResponse.yaml +23 -0
- package/thirdparty/v2_0/openapi3/components/schemas/AuthorizationResponseType.yaml +8 -0
- package/thirdparty/v2_0/openapi3/components/schemas/AuthorizationResponseTypeAccepted.yaml +6 -0
- package/thirdparty/v2_0/openapi3/components/schemas/AuthorizationResponseTypeRejected.yaml +6 -0
- package/thirdparty/v2_0/openapi3/components/schemas/BinaryString.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestChannelType.yaml +9 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestChannelTypeOTP.yaml +6 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestChannelTypeWeb.yaml +6 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestsIDPatchRequest.yaml +16 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestsIDPutResponseOTP.yaml +30 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestsIDPutResponseWeb.yaml +39 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ConsentRequestsPostRequest.yaml +44 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ConsentStatus.yaml +9 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ConsentStatusIssued.yaml +7 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ConsentStatusRevoked.yaml +7 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ConsentsIDPatchResponseRevoked.yaml +17 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ConsentsIDPatchResponseVerified.yaml +19 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ConsentsIDPutResponseSigned.yaml +23 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ConsentsIDPutResponseVerified.yaml +23 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ConsentsPostRequestAUTH.yaml +33 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ConsentsPostRequestPISP.yaml +32 -0
- package/thirdparty/v2_0/openapi3/components/schemas/CorrelationId.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/CredentialStatusPending.yaml +7 -0
- package/thirdparty/v2_0/openapi3/components/schemas/CredentialStatusVerified.yaml +7 -0
- package/thirdparty/v2_0/openapi3/components/schemas/CredentialType.yaml +11 -0
- package/thirdparty/v2_0/openapi3/components/schemas/Currency.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/DateOfBirth.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/DateTime.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ErrorCode.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ErrorDescription.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ErrorInformation.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/Extension.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ExtensionKey.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ExtensionList.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ExtensionValue.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/FIDOPublicKeyCredentialAssertion.yaml +71 -0
- package/thirdparty/v2_0/openapi3/components/schemas/FIDOPublicKeyCredentialAttestation.yaml +54 -0
- package/thirdparty/v2_0/openapi3/components/schemas/FirstName.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/FspId.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/GenericCredential.yaml +13 -0
- package/thirdparty/v2_0/openapi3/components/schemas/GeoCode.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/IlpCondition.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/IlpFulfilment.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/IlpPacket.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/Integer.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/LastName.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/Latitude.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/Longitude.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/MerchantClassificationCode.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/MiddleName.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/Money.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/Name.yaml +2 -0
- package/thirdparty/v2_0/openapi3/components/schemas/Note.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ParticipantsIDPutResponse.yaml +17 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ParticipantsPostRequest.yaml +20 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ParticipantsTypeIDPutResponse.yaml +8 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ParticipantsTypeIDSubIDPostRequest.yaml +15 -0
- package/thirdparty/v2_0/openapi3/components/schemas/PartiesTypeIDPutResponse.yaml +13 -0
- package/thirdparty/v2_0/openapi3/components/schemas/Party.yaml +15 -0
- package/thirdparty/v2_0/openapi3/components/schemas/PartyComplexName.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/PartyIdInfo.yaml +17 -0
- package/thirdparty/v2_0/openapi3/components/schemas/PartyIdInfoTPLink.yaml +17 -0
- package/thirdparty/v2_0/openapi3/components/schemas/PartyIdType.yaml +58 -0
- package/thirdparty/v2_0/openapi3/components/schemas/PartyIdTypeTPLink.yaml +7 -0
- package/thirdparty/v2_0/openapi3/components/schemas/PartyIdentifier.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/PartyName.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/PartyPersonalInfo.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/PartyResult.yaml +10 -0
- package/thirdparty/v2_0/openapi3/components/schemas/PartySubIdOrType.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/PartyTPLink.yaml +14 -0
- package/thirdparty/v2_0/openapi3/components/schemas/QuotesIDPutResponse.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/QuotesPostRequest.yaml +79 -0
- package/thirdparty/v2_0/openapi3/components/schemas/Scope.yaml +20 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ScopeAction.yaml +14 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ServiceType.yaml +15 -0
- package/thirdparty/v2_0/openapi3/components/schemas/ServicesServiceTypePutResponse.yaml +26 -0
- package/thirdparty/v2_0/openapi3/components/schemas/SignedCredential.yaml +23 -0
- package/thirdparty/v2_0/openapi3/components/schemas/SignedPayloadFIDO.yaml +11 -0
- package/thirdparty/v2_0/openapi3/components/schemas/SignedPayloadGeneric.yaml +11 -0
- package/thirdparty/v2_0/openapi3/components/schemas/SignedPayloadType.yaml +9 -0
- package/thirdparty/v2_0/openapi3/components/schemas/SignedPayloadTypeFIDO.yaml +5 -0
- package/thirdparty/v2_0/openapi3/components/schemas/SignedPayloadTypeGeneric.yaml +5 -0
- package/thirdparty/v2_0/openapi3/components/schemas/Transaction.yaml +43 -0
- package/thirdparty/v2_0/openapi3/components/schemas/TransactionRequestState.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/TransactionState.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/TransactionType.yaml +1 -0
- package/thirdparty/v2_0/openapi3/components/schemas/TransfersPostRequestFIDO.yaml +15 -0
- package/thirdparty/v2_0/openapi3/components/schemas/TransfersPostRequestGeneric.yaml +15 -0
- package/thirdparty/v2_0/openapi3/components/schemas/Uri.yaml +8 -0
- package/thirdparty/v2_0/openapi3/components/schemas/VerifiedCredential.yaml +23 -0
- package/thirdparty/v2_0/openapi3/components/schemas/tppAccountRequestPostRequest.yaml +35 -0
- package/thirdparty/v2_0/openapi3/components/schemas/tppAccountRequestPutResponse.yaml +30 -0
- package/thirdparty/v2_0/openapi3/components/schemas/tppAccountsIDPutResponse.yaml +21 -0
- package/thirdparty/v2_0/openapi3/components/schemas/tppAuthorizationsIDPutResponseFIDO.yaml +15 -0
- package/thirdparty/v2_0/openapi3/components/schemas/tppAuthorizationsIDPutResponseGeneric.yaml +15 -0
- package/thirdparty/v2_0/openapi3/components/schemas/tppAuthorizationsIDPutResponseRejected.yaml +10 -0
- package/thirdparty/v2_0/openapi3/components/schemas/tppAuthorizationsPostRequest.yaml +67 -0
- package/thirdparty/v2_0/openapi3/components/schemas/tppTransactionRequestPostRequest.yaml +60 -0
- package/thirdparty/v2_0/openapi3/components/schemas/tppTransactionRequestPutResponse.yaml +67 -0
- package/thirdparty/v2_0/openapi3/components/schemas/tppTransfersPostRequest.yaml +19 -0
- package/thirdparty/v2_0/openapi3/components/schemas/tppTransfersPutResponse.yaml +25 -0
- package/thirdparty/v2_0/openapi3/components/schemas/tppVerificationsIDPutResponse.yaml +19 -0
- package/thirdparty/v2_0/openapi3/components/schemas/tppVerificationsPostRequestFIDO.yaml +28 -0
- package/thirdparty/v2_0/openapi3/components/schemas/tppVerificationsPostRequestGeneric.yaml +28 -0
- package/thirdparty/v2_0/openapi3/openapi-admin.yaml +99 -0
- package/thirdparty/v2_0/openapi3/openapi.yaml +64 -0
- package/thirdparty/v2_0/openapi3/paths/health.yaml +25 -0
- package/thirdparty/v2_0/openapi3/paths/metrics.yaml +25 -0
- package/thirdparty/v2_0/openapi3/paths/participants.yaml +50 -0
- package/thirdparty/v2_0/openapi3/paths/participants_ID.yaml +49 -0
- package/thirdparty/v2_0/openapi3/paths/participants_ID_error.yaml +51 -0
- package/thirdparty/v2_0/openapi3/paths/participants_Type_ID.yaml +169 -0
- package/thirdparty/v2_0/openapi3/paths/participants_Type_ID_error.yaml +52 -0
- package/thirdparty/v2_0/openapi3/paths/services_ServiceType.yaml +77 -0
- package/thirdparty/v2_0/openapi3/paths/services_ServiceType_error.yaml +49 -0
- package/thirdparty/v2_0/openapi3/paths/tppAccountRequest.yaml +49 -0
- package/thirdparty/v2_0/openapi3/paths/tppAccountRequest_ID.yaml +86 -0
- package/thirdparty/v2_0/openapi3/paths/tppAccountRequest_ID_error.yaml +48 -0
- package/thirdparty/v2_0/openapi3/paths/tppAccounts_ID.yaml +88 -0
- package/thirdparty/v2_0/openapi3/paths/tppAccounts_ID_error.yaml +48 -0
- package/thirdparty/v2_0/openapi3/paths/tppAuthorizations.yaml +51 -0
- package/thirdparty/v2_0/openapi3/paths/tppAuthorizations_ID.yaml +86 -0
- package/thirdparty/v2_0/openapi3/paths/tppAuthorizations_ID_error.yaml +55 -0
- package/thirdparty/v2_0/openapi3/paths/tppConsentRequests.yaml +48 -0
- package/thirdparty/v2_0/openapi3/paths/tppConsentRequests_ID.yaml +123 -0
- package/thirdparty/v2_0/openapi3/paths/tppConsentRequests_ID_error.yaml +48 -0
- package/thirdparty/v2_0/openapi3/paths/tppConsents.yaml +49 -0
- package/thirdparty/v2_0/openapi3/paths/tppConsents_ID.yaml +165 -0
- package/thirdparty/v2_0/openapi3/paths/tppConsents_ID_error.yaml +48 -0
- package/thirdparty/v2_0/openapi3/paths/tppTransactionRequests.yaml +48 -0
- package/thirdparty/v2_0/openapi3/paths/tppTransactionRequests_ID.yaml +83 -0
- package/thirdparty/v2_0/openapi3/paths/tppTransactionRequests_ID_error.yaml +52 -0
- package/thirdparty/v2_0/openapi3/paths/tppTransfers.yaml +47 -0
- package/thirdparty/v2_0/openapi3/paths/tppTransfers_ID.yaml +86 -0
- package/thirdparty/v2_0/openapi3/paths/tppTransfers_ID_error.yaml +52 -0
- package/thirdparty/v2_0/openapi3/paths/tppVerifications.yaml +49 -0
- package/thirdparty/v2_0/openapi3/paths/tppVerifications_ID.yaml +87 -0
- package/thirdparty/v2_0/openapi3/paths/tppVerifications_ID_error.yaml +49 -0
- package/thirdparty/v2_0/openapi3/thirdparty-dfsp-admin-api.template.yaml +53 -0
- package/thirdparty/v2_0/openapi3/thirdparty-dfsp-admin-api.yaml +2633 -0
- package/thirdparty/v2_0/openapi3/thirdparty-pisp-admin-api.template.yaml +57 -0
- package/thirdparty/v2_0/openapi3/thirdparty-pisp-admin-api.yaml +3103 -0
- package/tsconfig.build.json +4 -3
|
@@ -0,0 +1,99 @@
|
|
|
1
|
+
openapi: 3.0.2
|
|
2
|
+
info:
|
|
3
|
+
version: '0.1'
|
|
4
|
+
title: Thirdparty Snippets
|
|
5
|
+
description: |
|
|
6
|
+
Based on sequence diagrams
|
|
7
|
+
(https://github.com/mojaloop/tpp/tree/main/docs/out).
|
|
8
|
+
This is a work in progress.
|
|
9
|
+
license:
|
|
10
|
+
name: TBD
|
|
11
|
+
servers:
|
|
12
|
+
- url: '{protocol}://hostname:<port>/switch/'
|
|
13
|
+
variables:
|
|
14
|
+
protocol:
|
|
15
|
+
enum:
|
|
16
|
+
- http
|
|
17
|
+
- https
|
|
18
|
+
default: https
|
|
19
|
+
paths:
|
|
20
|
+
/interface:
|
|
21
|
+
post:
|
|
22
|
+
description: >-
|
|
23
|
+
Essential path to include schema definitions that are not used so that
|
|
24
|
+
these definitions get included into the openapi-cli bundle api
|
|
25
|
+
definition so that they get converted into typescript definitions.
|
|
26
|
+
operationId: test
|
|
27
|
+
requestBody:
|
|
28
|
+
content:
|
|
29
|
+
application/json:
|
|
30
|
+
schema:
|
|
31
|
+
oneOf:
|
|
32
|
+
- $ref: './components/schemas/ParticipantsIDPutResponse.yaml'
|
|
33
|
+
- $ref: './components/schemas/PartiesTypeIDPutResponse.yaml'
|
|
34
|
+
- $ref: './components/schemas/QuotesIDPutResponse.yaml'
|
|
35
|
+
- $ref: './components/schemas/AuthorizationResponseType.yaml'
|
|
36
|
+
- $ref: './components/schemas/ConsentStatusIssued.yaml'
|
|
37
|
+
- $ref: './components/schemas/IlpFulfilment.yaml'
|
|
38
|
+
- $ref: './components/schemas/Integer.yaml'
|
|
39
|
+
- $ref: './components/schemas/Note.yaml'
|
|
40
|
+
- $ref: './components/schemas/PartyIdInfoTPLink.yaml'
|
|
41
|
+
- $ref: './components/schemas/PartyResult.yaml'
|
|
42
|
+
- $ref: './components/schemas/ServiceType.yaml'
|
|
43
|
+
- $ref: './components/schemas/ParticipantsPostRequest.yaml'
|
|
44
|
+
- $ref: './components/schemas/QuotesPostRequest.yaml'
|
|
45
|
+
responses:
|
|
46
|
+
200:
|
|
47
|
+
description: Ok
|
|
48
|
+
/tppAccountRequest:
|
|
49
|
+
$ref: paths/tppAccountRequest.yaml
|
|
50
|
+
/tppAccountRequest/{ID}:
|
|
51
|
+
$ref: paths/tppAccountRequest_ID.yaml
|
|
52
|
+
/tppAccountRequest/{ID}/error:
|
|
53
|
+
$ref: paths/tppAccountRequest_ID_error.yaml
|
|
54
|
+
/tppAccounts/{ID}:
|
|
55
|
+
$ref: paths/tppAccounts_ID.yaml
|
|
56
|
+
/tppAccounts/{ID}/error:
|
|
57
|
+
$ref: paths/tppAccounts_ID_error.yaml
|
|
58
|
+
/health:
|
|
59
|
+
$ref: paths/health.yaml
|
|
60
|
+
/metrics:
|
|
61
|
+
$ref: paths/metrics.yaml
|
|
62
|
+
/tppConsentRequests:
|
|
63
|
+
$ref: paths/tppConsentRequests.yaml
|
|
64
|
+
/tppConsentRequests/{ID}:
|
|
65
|
+
$ref: paths/tppConsentRequests_ID.yaml
|
|
66
|
+
/tppConsentRequests/{ID}/error:
|
|
67
|
+
$ref: paths/tppConsentRequests_ID_error.yaml
|
|
68
|
+
/tppConsents:
|
|
69
|
+
$ref: paths/tppConsents.yaml
|
|
70
|
+
/tppConsents/{ID}:
|
|
71
|
+
$ref: paths/tppConsents_ID.yaml
|
|
72
|
+
/tppConsents/{ID}/error:
|
|
73
|
+
$ref: paths/tppConsents_ID_error.yaml
|
|
74
|
+
/participants:
|
|
75
|
+
$ref: paths/participants.yaml
|
|
76
|
+
/participants/{ID}:
|
|
77
|
+
$ref: paths/participants_ID.yaml
|
|
78
|
+
/participants/{ID}/error:
|
|
79
|
+
$ref: paths/participants_ID_error.yaml
|
|
80
|
+
/participants/{Type}/{ID}:
|
|
81
|
+
$ref: paths/participants_Type_ID.yaml
|
|
82
|
+
/participants/{Type}/{ID}/error:
|
|
83
|
+
$ref: paths/participants_Type_ID_error.yaml
|
|
84
|
+
/services/{ServiceType}:
|
|
85
|
+
$ref: paths/services_ServiceType.yaml
|
|
86
|
+
/services/{ServiceType}/error:
|
|
87
|
+
$ref: paths/services_ServiceType_error.yaml
|
|
88
|
+
/tppAuthorizations:
|
|
89
|
+
$ref: paths/tppAuthorizations.yaml
|
|
90
|
+
/tppAuthorizations/{ID}:
|
|
91
|
+
$ref: paths/tppAuthorizations_ID.yaml
|
|
92
|
+
/tppAuthorizations/{ID}/error:
|
|
93
|
+
$ref: paths/tppAuthorizations_ID_error.yaml
|
|
94
|
+
/tppVerifications:
|
|
95
|
+
$ref: paths/tppVerifications.yaml
|
|
96
|
+
/tppVerifications/{ID}:
|
|
97
|
+
$ref: paths/tppVerifications_ID.yaml
|
|
98
|
+
/tppVerifications/{ID}/error:
|
|
99
|
+
$ref: paths/tppVerifications_ID_error.yaml
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
openapi: 3.0.2
|
|
2
|
+
info:
|
|
3
|
+
version: '2.0'
|
|
4
|
+
title: Thirdparty Snippets
|
|
5
|
+
description: |
|
|
6
|
+
Based on sequence diagrams
|
|
7
|
+
(https://github.com/mojaloop/tpp/tree/main/docs/out).
|
|
8
|
+
This is a work in progress.
|
|
9
|
+
license:
|
|
10
|
+
name: TBD
|
|
11
|
+
servers:
|
|
12
|
+
- url: '{protocol}://hostname:<port>/switch/'
|
|
13
|
+
variables:
|
|
14
|
+
protocol:
|
|
15
|
+
enum:
|
|
16
|
+
- http
|
|
17
|
+
- https
|
|
18
|
+
default: https
|
|
19
|
+
paths:
|
|
20
|
+
/interface:
|
|
21
|
+
post:
|
|
22
|
+
description: >-
|
|
23
|
+
Essential path to include schema definitions that are not used so that
|
|
24
|
+
these definitions get included into the openapi-cli bundle api
|
|
25
|
+
definition so that they get converted into typescript definitions.
|
|
26
|
+
operationId: test
|
|
27
|
+
requestBody:
|
|
28
|
+
content:
|
|
29
|
+
application/json:
|
|
30
|
+
schema:
|
|
31
|
+
oneOf:
|
|
32
|
+
- $ref: './components/schemas/ParticipantsIDPutResponse.yaml'
|
|
33
|
+
- $ref: './components/schemas/PartiesTypeIDPutResponse.yaml'
|
|
34
|
+
- $ref: './components/schemas/QuotesIDPutResponse.yaml'
|
|
35
|
+
- $ref: './components/schemas/AuthorizationResponseType.yaml'
|
|
36
|
+
- $ref: './components/schemas/ConsentStatusIssued.yaml'
|
|
37
|
+
- $ref: './components/schemas/IlpFulfilment.yaml'
|
|
38
|
+
- $ref: './components/schemas/Integer.yaml'
|
|
39
|
+
- $ref: './components/schemas/Note.yaml'
|
|
40
|
+
- $ref: './components/schemas/PartyIdInfoTPLink.yaml'
|
|
41
|
+
- $ref: './components/schemas/PartyResult.yaml'
|
|
42
|
+
- $ref: './components/schemas/ServiceType.yaml'
|
|
43
|
+
- $ref: './components/schemas/ParticipantsPostRequest.yaml'
|
|
44
|
+
- $ref: './components/schemas/QuotesPostRequest.yaml'
|
|
45
|
+
responses:
|
|
46
|
+
200:
|
|
47
|
+
description: Ok
|
|
48
|
+
/health:
|
|
49
|
+
$ref: paths/health.yaml
|
|
50
|
+
/metrics:
|
|
51
|
+
$ref: paths/metrics.yaml
|
|
52
|
+
/tppTransactionRequests:
|
|
53
|
+
$ref: paths/tppTransactionRequests.yaml
|
|
54
|
+
/tppTransactionRequests/{ID}:
|
|
55
|
+
$ref: paths/tppTransactionRequests_ID.yaml
|
|
56
|
+
/tppTransactionRequests/{ID}/error:
|
|
57
|
+
$ref: paths/tppTransactionRequests_ID_error.yaml
|
|
58
|
+
/tppTransfers:
|
|
59
|
+
$ref: paths/tppTransfers.yaml
|
|
60
|
+
/tppTransfers/{ID}:
|
|
61
|
+
$ref: paths/tppTransfers_ID.yaml
|
|
62
|
+
/tppTransfers/{ID}/error:
|
|
63
|
+
$ref: paths/tppTransfers_ID_error.yaml
|
|
64
|
+
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
get:
|
|
2
|
+
tags:
|
|
3
|
+
- health
|
|
4
|
+
responses:
|
|
5
|
+
200:
|
|
6
|
+
$ref: ../components/responses/200.yaml
|
|
7
|
+
400:
|
|
8
|
+
$ref: ../components/responses/400.yaml
|
|
9
|
+
401:
|
|
10
|
+
$ref: ../components/responses/401.yaml
|
|
11
|
+
403:
|
|
12
|
+
$ref: ../components/responses/403.yaml
|
|
13
|
+
404:
|
|
14
|
+
$ref: ../components/responses/404.yaml
|
|
15
|
+
405:
|
|
16
|
+
$ref: ../components/responses/405.yaml
|
|
17
|
+
406:
|
|
18
|
+
$ref: ../components/responses/406.yaml
|
|
19
|
+
501:
|
|
20
|
+
$ref: ../components/responses/501.yaml
|
|
21
|
+
503:
|
|
22
|
+
$ref: ../components/responses/503.yaml
|
|
23
|
+
operationId: HealthGet
|
|
24
|
+
summary: Health check endpoint
|
|
25
|
+
description: The HTTP request GET /health is used to return the current status of the API.
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
get:
|
|
2
|
+
tags:
|
|
3
|
+
- health
|
|
4
|
+
responses:
|
|
5
|
+
200:
|
|
6
|
+
$ref: ../components/responses/200.yaml
|
|
7
|
+
400:
|
|
8
|
+
$ref: ../components/responses/400.yaml
|
|
9
|
+
401:
|
|
10
|
+
$ref: ../components/responses/401.yaml
|
|
11
|
+
403:
|
|
12
|
+
$ref: ../components/responses/403.yaml
|
|
13
|
+
404:
|
|
14
|
+
$ref: ../components/responses/404.yaml
|
|
15
|
+
405:
|
|
16
|
+
$ref: ../components/responses/405.yaml
|
|
17
|
+
406:
|
|
18
|
+
$ref: ../components/responses/406.yaml
|
|
19
|
+
501:
|
|
20
|
+
$ref: ../components/responses/501.yaml
|
|
21
|
+
503:
|
|
22
|
+
$ref: ../components/responses/503.yaml
|
|
23
|
+
operationId: MetricsGet
|
|
24
|
+
summary: Prometheus metrics endpoint
|
|
25
|
+
description: The HTTP request GET /metrics is used to return metrics for the API.
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
parameters:
|
|
2
|
+
- $ref: ../components/parameters/Content-Type.yaml
|
|
3
|
+
- $ref: ../components/parameters/Date.yaml
|
|
4
|
+
- $ref: ../components/parameters/X-Forwarded-For.yaml
|
|
5
|
+
- $ref: ../components/parameters/FSPIOP-Source.yaml
|
|
6
|
+
- $ref: ../components/parameters/FSPIOP-Destination.yaml
|
|
7
|
+
- $ref: ../components/parameters/FSPIOP-Encryption.yaml
|
|
8
|
+
- $ref: ../components/parameters/FSPIOP-Signature.yaml
|
|
9
|
+
- $ref: ../components/parameters/FSPIOP-URI.yaml
|
|
10
|
+
- $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
|
|
11
|
+
post:
|
|
12
|
+
description: >-
|
|
13
|
+
The HTTP request `POST /participants` is used to create information in the
|
|
14
|
+
server regarding the provided list of identities. This request should be
|
|
15
|
+
used for bulk creation of FSP information for more than one Party. The
|
|
16
|
+
optional currency parameter should indicate that each provided Party
|
|
17
|
+
supports the currency.
|
|
18
|
+
summary: Create bulk participant information
|
|
19
|
+
tags:
|
|
20
|
+
- participants
|
|
21
|
+
operationId: Participants1
|
|
22
|
+
parameters:
|
|
23
|
+
- $ref: ../components/parameters/Accept.yaml
|
|
24
|
+
- $ref: ../components/parameters/Content-Length.yaml
|
|
25
|
+
requestBody:
|
|
26
|
+
description: Participant information to be created.
|
|
27
|
+
required: true
|
|
28
|
+
content:
|
|
29
|
+
application/json:
|
|
30
|
+
schema:
|
|
31
|
+
$ref: ../components/schemas/ParticipantsPostRequest.yaml
|
|
32
|
+
responses:
|
|
33
|
+
'202':
|
|
34
|
+
$ref: ../components/responses/202.yaml
|
|
35
|
+
'400':
|
|
36
|
+
$ref: ../components/responses/400.yaml
|
|
37
|
+
'401':
|
|
38
|
+
$ref: ../components/responses/401.yaml
|
|
39
|
+
'403':
|
|
40
|
+
$ref: ../components/responses/403.yaml
|
|
41
|
+
'404':
|
|
42
|
+
$ref: ../components/responses/404.yaml
|
|
43
|
+
'405':
|
|
44
|
+
$ref: ../components/responses/405.yaml
|
|
45
|
+
'406':
|
|
46
|
+
$ref: ../components/responses/406.yaml
|
|
47
|
+
'501':
|
|
48
|
+
$ref: ../components/responses/501.yaml
|
|
49
|
+
'503':
|
|
50
|
+
$ref: ../components/responses/503.yaml
|
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
parameters:
|
|
2
|
+
#Path
|
|
3
|
+
- $ref: ../components/parameters/ID.yaml
|
|
4
|
+
#Headers
|
|
5
|
+
- $ref: ../components/parameters/Content-Type.yaml
|
|
6
|
+
- $ref: ../components/parameters/Date.yaml
|
|
7
|
+
- $ref: ../components/parameters/X-Forwarded-For.yaml
|
|
8
|
+
- $ref: ../components/parameters/FSPIOP-Source.yaml
|
|
9
|
+
- $ref: ../components/parameters/FSPIOP-Destination.yaml
|
|
10
|
+
- $ref: ../components/parameters/FSPIOP-Encryption.yaml
|
|
11
|
+
- $ref: ../components/parameters/FSPIOP-Signature.yaml
|
|
12
|
+
- $ref: ../components/parameters/FSPIOP-URI.yaml
|
|
13
|
+
- $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
|
|
14
|
+
put:
|
|
15
|
+
description: >-
|
|
16
|
+
The callback `PUT /participants/{ID}` is used to inform the client of the
|
|
17
|
+
result of the creation of the provided list of identities.
|
|
18
|
+
summary: Return bulk participant information
|
|
19
|
+
tags:
|
|
20
|
+
- participants
|
|
21
|
+
operationId: PutParticipantsByID
|
|
22
|
+
parameters:
|
|
23
|
+
- $ref: ../components/parameters/Content-Length.yaml
|
|
24
|
+
requestBody:
|
|
25
|
+
description: Participant information returned.
|
|
26
|
+
required: true
|
|
27
|
+
content:
|
|
28
|
+
application/json:
|
|
29
|
+
schema:
|
|
30
|
+
$ref: ../components/schemas/ParticipantsIDPutResponse.yaml
|
|
31
|
+
responses:
|
|
32
|
+
'200':
|
|
33
|
+
$ref: ../components/responses/200.yaml
|
|
34
|
+
'400':
|
|
35
|
+
$ref: ../components/responses/400.yaml
|
|
36
|
+
'401':
|
|
37
|
+
$ref: ../components/responses/401.yaml
|
|
38
|
+
'403':
|
|
39
|
+
$ref: ../components/responses/403.yaml
|
|
40
|
+
'404':
|
|
41
|
+
$ref: ../components/responses/404.yaml
|
|
42
|
+
'405':
|
|
43
|
+
$ref: ../components/responses/405.yaml
|
|
44
|
+
'406':
|
|
45
|
+
$ref: ../components/responses/406.yaml
|
|
46
|
+
'501':
|
|
47
|
+
$ref: ../components/responses/501.yaml
|
|
48
|
+
'503':
|
|
49
|
+
$ref: ../components/responses/503.yaml
|
|
@@ -0,0 +1,51 @@
|
|
|
1
|
+
parameters:
|
|
2
|
+
#Path
|
|
3
|
+
- $ref: ../components/parameters/ID.yaml
|
|
4
|
+
#Headers
|
|
5
|
+
- $ref: ../components/parameters/Content-Type.yaml
|
|
6
|
+
- $ref: ../components/parameters/Date.yaml
|
|
7
|
+
- $ref: ../components/parameters/X-Forwarded-For.yaml
|
|
8
|
+
- $ref: ../components/parameters/FSPIOP-Source.yaml
|
|
9
|
+
- $ref: ../components/parameters/FSPIOP-Destination.yaml
|
|
10
|
+
- $ref: ../components/parameters/FSPIOP-Encryption.yaml
|
|
11
|
+
- $ref: ../components/parameters/FSPIOP-Signature.yaml
|
|
12
|
+
- $ref: ../components/parameters/FSPIOP-URI.yaml
|
|
13
|
+
- $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
|
|
14
|
+
put:
|
|
15
|
+
description: >-
|
|
16
|
+
If there is an error during FSP information creation in the server, the
|
|
17
|
+
error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI
|
|
18
|
+
should contain the requestId that was used for the creation of the
|
|
19
|
+
participant information.
|
|
20
|
+
summary: Return bulk participant information error
|
|
21
|
+
tags:
|
|
22
|
+
- participants
|
|
23
|
+
operationId: PutParticipantsByIDAndError
|
|
24
|
+
parameters:
|
|
25
|
+
- $ref: ../components/parameters/Content-Length.yaml
|
|
26
|
+
requestBody:
|
|
27
|
+
description: Details of the error returned.
|
|
28
|
+
required: true
|
|
29
|
+
content:
|
|
30
|
+
application/json:
|
|
31
|
+
schema:
|
|
32
|
+
$ref: ../../../../fspiop/v2_0/openapi3/components/schemas/ErrorInformationObject.yaml
|
|
33
|
+
responses:
|
|
34
|
+
'200':
|
|
35
|
+
$ref: ../components/responses/200.yaml
|
|
36
|
+
'400':
|
|
37
|
+
$ref: ../components/responses/400.yaml
|
|
38
|
+
'401':
|
|
39
|
+
$ref: ../components/responses/401.yaml
|
|
40
|
+
'403':
|
|
41
|
+
$ref: ../components/responses/403.yaml
|
|
42
|
+
'404':
|
|
43
|
+
$ref: ../components/responses/404.yaml
|
|
44
|
+
'405':
|
|
45
|
+
$ref: ../components/responses/405.yaml
|
|
46
|
+
'406':
|
|
47
|
+
$ref: ../components/responses/406.yaml
|
|
48
|
+
'501':
|
|
49
|
+
$ref: ../components/responses/501.yaml
|
|
50
|
+
'503':
|
|
51
|
+
$ref: ../components/responses/503.yaml
|
|
@@ -0,0 +1,169 @@
|
|
|
1
|
+
parameters:
|
|
2
|
+
#Path
|
|
3
|
+
- $ref: ../components/parameters/Type.yaml
|
|
4
|
+
- $ref: ../components/parameters/ID.yaml
|
|
5
|
+
#Headers
|
|
6
|
+
- $ref: ../components/parameters/Content-Type.yaml
|
|
7
|
+
- $ref: ../components/parameters/Date.yaml
|
|
8
|
+
- $ref: ../components/parameters/X-Forwarded-For.yaml
|
|
9
|
+
- $ref: ../components/parameters/FSPIOP-Source.yaml
|
|
10
|
+
- $ref: ../components/parameters/FSPIOP-Destination.yaml
|
|
11
|
+
- $ref: ../components/parameters/FSPIOP-Encryption.yaml
|
|
12
|
+
- $ref: ../components/parameters/FSPIOP-Signature.yaml
|
|
13
|
+
- $ref: ../components/parameters/FSPIOP-URI.yaml
|
|
14
|
+
- $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
|
|
15
|
+
post:
|
|
16
|
+
description: >-
|
|
17
|
+
The HTTP request `POST /participants/{Type}/{ID}` (or `POST
|
|
18
|
+
/participants/{Type}/{ID}/{SubId}`) is used to create information in the
|
|
19
|
+
server regarding the provided identity, defined by `{Type}`, `{ID}`, and
|
|
20
|
+
optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or
|
|
21
|
+
`POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList
|
|
22
|
+
element has been added to this reqeust in version v1.1
|
|
23
|
+
summary: Create participant information
|
|
24
|
+
tags:
|
|
25
|
+
- participants
|
|
26
|
+
operationId: ParticipantsByIDAndType
|
|
27
|
+
parameters:
|
|
28
|
+
- $ref: ../components/parameters/Accept.yaml
|
|
29
|
+
- $ref: ../components/parameters/Content-Length.yaml
|
|
30
|
+
requestBody:
|
|
31
|
+
description: Participant information to be created.
|
|
32
|
+
required: true
|
|
33
|
+
content:
|
|
34
|
+
application/json:
|
|
35
|
+
schema:
|
|
36
|
+
$ref: ../components/schemas/ParticipantsTypeIDSubIDPostRequest.yaml
|
|
37
|
+
responses:
|
|
38
|
+
'202':
|
|
39
|
+
$ref: ../components/responses/202.yaml
|
|
40
|
+
'400':
|
|
41
|
+
$ref: ../components/responses/400.yaml
|
|
42
|
+
'401':
|
|
43
|
+
$ref: ../components/responses/401.yaml
|
|
44
|
+
'403':
|
|
45
|
+
$ref: ../components/responses/403.yaml
|
|
46
|
+
'404':
|
|
47
|
+
$ref: ../components/responses/404.yaml
|
|
48
|
+
'405':
|
|
49
|
+
$ref: ../components/responses/405.yaml
|
|
50
|
+
'406':
|
|
51
|
+
$ref: ../components/responses/406.yaml
|
|
52
|
+
'501':
|
|
53
|
+
$ref: ../components/responses/501.yaml
|
|
54
|
+
'503':
|
|
55
|
+
$ref: ../components/responses/503.yaml
|
|
56
|
+
get:
|
|
57
|
+
description: >-
|
|
58
|
+
The HTTP request `GET /participants/{Type}/{ID}` (or `GET
|
|
59
|
+
/participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the
|
|
60
|
+
requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is
|
|
61
|
+
located (for example, `GET /participants/MSISDN/123456789`, or `GET
|
|
62
|
+
/participants/BUSINESS/shoecompany/employee1`). This HTTP request should
|
|
63
|
+
support a query string for filtering of currency. To use filtering of
|
|
64
|
+
currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ`
|
|
65
|
+
should be used, where `XYZ` is the requested currency.
|
|
66
|
+
summary: Look up participant information
|
|
67
|
+
tags:
|
|
68
|
+
- participants
|
|
69
|
+
operationId: ParticipantsByTypeAndID
|
|
70
|
+
parameters:
|
|
71
|
+
- $ref: ../components/parameters/Accept.yaml
|
|
72
|
+
responses:
|
|
73
|
+
'202':
|
|
74
|
+
$ref: ../components/responses/202.yaml
|
|
75
|
+
'400':
|
|
76
|
+
$ref: ../components/responses/400.yaml
|
|
77
|
+
'401':
|
|
78
|
+
$ref: ../components/responses/401.yaml
|
|
79
|
+
'403':
|
|
80
|
+
$ref: ../components/responses/403.yaml
|
|
81
|
+
'404':
|
|
82
|
+
$ref: ../components/responses/404.yaml
|
|
83
|
+
'405':
|
|
84
|
+
$ref: ../components/responses/405.yaml
|
|
85
|
+
'406':
|
|
86
|
+
$ref: ../components/responses/406.yaml
|
|
87
|
+
'501':
|
|
88
|
+
$ref: ../components/responses/501.yaml
|
|
89
|
+
'503':
|
|
90
|
+
$ref: ../components/responses/503.yaml
|
|
91
|
+
put:
|
|
92
|
+
description: >-
|
|
93
|
+
The callback `PUT /participants/{Type}/{ID}` (or `PUT
|
|
94
|
+
/participants/{Type}/{ID}/{SubId}`) is used to inform the client of a
|
|
95
|
+
successful result of the lookup, creation, or deletion of the FSP
|
|
96
|
+
information related to the Party. If the FSP information is deleted, the
|
|
97
|
+
fspId element should be empty; otherwise the element should include the FSP
|
|
98
|
+
information for the Party.
|
|
99
|
+
summary: Return participant information
|
|
100
|
+
tags:
|
|
101
|
+
- participants
|
|
102
|
+
operationId: ParticipantsByTypeAndID3
|
|
103
|
+
parameters:
|
|
104
|
+
- $ref: ../components/parameters/Content-Length.yaml
|
|
105
|
+
requestBody:
|
|
106
|
+
description: Participant information returned.
|
|
107
|
+
required: true
|
|
108
|
+
content:
|
|
109
|
+
application/json:
|
|
110
|
+
schema:
|
|
111
|
+
$ref: ../components/schemas/ParticipantsTypeIDPutResponse.yaml
|
|
112
|
+
responses:
|
|
113
|
+
'200':
|
|
114
|
+
$ref: ../components/responses/200.yaml
|
|
115
|
+
'400':
|
|
116
|
+
$ref: ../components/responses/400.yaml
|
|
117
|
+
'401':
|
|
118
|
+
$ref: ../components/responses/401.yaml
|
|
119
|
+
'403':
|
|
120
|
+
$ref: ../components/responses/403.yaml
|
|
121
|
+
'404':
|
|
122
|
+
$ref: ../components/responses/404.yaml
|
|
123
|
+
'405':
|
|
124
|
+
$ref: ../components/responses/405.yaml
|
|
125
|
+
'406':
|
|
126
|
+
$ref: ../components/responses/406.yaml
|
|
127
|
+
'501':
|
|
128
|
+
$ref: ../components/responses/501.yaml
|
|
129
|
+
'503':
|
|
130
|
+
$ref: ../components/responses/503.yaml
|
|
131
|
+
delete:
|
|
132
|
+
description: >-
|
|
133
|
+
The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE
|
|
134
|
+
/participants/{Type}/{ID}/{SubId}`) is used to delete information in the
|
|
135
|
+
server regarding the provided identity, defined by `{Type}` and `{ID}`) (for
|
|
136
|
+
example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`.
|
|
137
|
+
This HTTP request should support a query string to delete FSP information
|
|
138
|
+
regarding a specific currency only. To delete a specific currency only, the
|
|
139
|
+
HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used,
|
|
140
|
+
where `XYZ` is the requested currency.
|
|
141
|
+
|
|
142
|
+
|
|
143
|
+
**Note:** The Account Lookup System should verify that it is the Party’s
|
|
144
|
+
current FSP that is deleting the FSP information.
|
|
145
|
+
summary: Delete participant information
|
|
146
|
+
tags:
|
|
147
|
+
- participants
|
|
148
|
+
operationId: ParticipantsByTypeAndID2
|
|
149
|
+
parameters:
|
|
150
|
+
- $ref: ../components/parameters/Accept.yaml
|
|
151
|
+
responses:
|
|
152
|
+
'202':
|
|
153
|
+
$ref: ../components/responses/202.yaml
|
|
154
|
+
'400':
|
|
155
|
+
$ref: ../components/responses/400.yaml
|
|
156
|
+
'401':
|
|
157
|
+
$ref: ../components/responses/401.yaml
|
|
158
|
+
'403':
|
|
159
|
+
$ref: ../components/responses/403.yaml
|
|
160
|
+
'404':
|
|
161
|
+
$ref: ../components/responses/404.yaml
|
|
162
|
+
'405':
|
|
163
|
+
$ref: ../components/responses/405.yaml
|
|
164
|
+
'406':
|
|
165
|
+
$ref: ../components/responses/406.yaml
|
|
166
|
+
'501':
|
|
167
|
+
$ref: ../components/responses/501.yaml
|
|
168
|
+
'503':
|
|
169
|
+
$ref: ../components/responses/503.yaml
|
|
@@ -0,0 +1,52 @@
|
|
|
1
|
+
parameters:
|
|
2
|
+
#Path
|
|
3
|
+
- $ref: ../components/parameters/Type.yaml
|
|
4
|
+
- $ref: ../components/parameters/ID.yaml
|
|
5
|
+
#Headers
|
|
6
|
+
- $ref: ../components/parameters/Content-Type.yaml
|
|
7
|
+
- $ref: ../components/parameters/Date.yaml
|
|
8
|
+
- $ref: ../components/parameters/X-Forwarded-For.yaml
|
|
9
|
+
- $ref: ../components/parameters/FSPIOP-Source.yaml
|
|
10
|
+
- $ref: ../components/parameters/FSPIOP-Destination.yaml
|
|
11
|
+
- $ref: ../components/parameters/FSPIOP-Encryption.yaml
|
|
12
|
+
- $ref: ../components/parameters/FSPIOP-Signature.yaml
|
|
13
|
+
- $ref: ../components/parameters/FSPIOP-URI.yaml
|
|
14
|
+
- $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
|
|
15
|
+
put:
|
|
16
|
+
description: >-
|
|
17
|
+
If the server is unable to find, create or delete the associated FSP of the
|
|
18
|
+
provided identity, or another processing error occurred, the error callback
|
|
19
|
+
`PUT /participants/{Type}/{ID}/error` (or `PUT
|
|
20
|
+
/participants/{Type}/{ID}/{SubId}/error`) is used.
|
|
21
|
+
summary: Return participant information error
|
|
22
|
+
tags:
|
|
23
|
+
- participants
|
|
24
|
+
operationId: ParticipantsErrorByTypeAndID
|
|
25
|
+
parameters:
|
|
26
|
+
- $ref: ../components/parameters/Content-Length.yaml
|
|
27
|
+
requestBody:
|
|
28
|
+
description: Details of the error returned.
|
|
29
|
+
required: true
|
|
30
|
+
content:
|
|
31
|
+
application/json:
|
|
32
|
+
schema:
|
|
33
|
+
$ref: ../../../../fspiop/v2_0/openapi3/components/schemas/ErrorInformationObject.yaml
|
|
34
|
+
responses:
|
|
35
|
+
'200':
|
|
36
|
+
$ref: ../components/responses/200.yaml
|
|
37
|
+
'400':
|
|
38
|
+
$ref: ../components/responses/400.yaml
|
|
39
|
+
'401':
|
|
40
|
+
$ref: ../components/responses/401.yaml
|
|
41
|
+
'403':
|
|
42
|
+
$ref: ../components/responses/403.yaml
|
|
43
|
+
'404':
|
|
44
|
+
$ref: ../components/responses/404.yaml
|
|
45
|
+
'405':
|
|
46
|
+
$ref: ../components/responses/405.yaml
|
|
47
|
+
'406':
|
|
48
|
+
$ref: ../components/responses/406.yaml
|
|
49
|
+
'501':
|
|
50
|
+
$ref: ../components/responses/501.yaml
|
|
51
|
+
'503':
|
|
52
|
+
$ref: ../components/responses/503.yaml
|
|
@@ -0,0 +1,77 @@
|
|
|
1
|
+
parameters:
|
|
2
|
+
#Path
|
|
3
|
+
- $ref: ../components/parameters/ServiceType.yaml
|
|
4
|
+
#Headers
|
|
5
|
+
- $ref: ../components/parameters/Content-Type.yaml
|
|
6
|
+
- $ref: ../components/parameters/Date.yaml
|
|
7
|
+
- $ref: ../components/parameters/X-Forwarded-For.yaml
|
|
8
|
+
- $ref: ../components/parameters/FSPIOP-Source.yaml
|
|
9
|
+
- $ref: ../components/parameters/FSPIOP-Destination.yaml
|
|
10
|
+
- $ref: ../components/parameters/FSPIOP-Encryption.yaml
|
|
11
|
+
- $ref: ../components/parameters/FSPIOP-Signature.yaml
|
|
12
|
+
- $ref: ../components/parameters/FSPIOP-URI.yaml
|
|
13
|
+
- $ref: ../components/parameters/FSPIOP-HTTP-Method.yaml
|
|
14
|
+
get:
|
|
15
|
+
operationId: GetServicesByServiceType
|
|
16
|
+
summary: GetServicesByServiceType
|
|
17
|
+
description: |
|
|
18
|
+
The HTTP request `GET /services/{ServiceType}` is used to retrieve the list of participants
|
|
19
|
+
that support a specified service.
|
|
20
|
+
parameters:
|
|
21
|
+
- $ref: ../components/parameters/Accept.yaml
|
|
22
|
+
tags:
|
|
23
|
+
- services
|
|
24
|
+
responses:
|
|
25
|
+
202:
|
|
26
|
+
$ref: ../components/responses/202.yaml
|
|
27
|
+
400:
|
|
28
|
+
$ref: ../components/responses/400.yaml
|
|
29
|
+
401:
|
|
30
|
+
$ref: ../components/responses/401.yaml
|
|
31
|
+
403:
|
|
32
|
+
$ref: ../components/responses/403.yaml
|
|
33
|
+
404:
|
|
34
|
+
$ref: ../components/responses/404.yaml
|
|
35
|
+
405:
|
|
36
|
+
$ref: ../components/responses/405.yaml
|
|
37
|
+
406:
|
|
38
|
+
$ref: ../components/responses/406.yaml
|
|
39
|
+
501:
|
|
40
|
+
$ref: ../components/responses/501.yaml
|
|
41
|
+
503:
|
|
42
|
+
$ref: ../components/responses/503.yaml
|
|
43
|
+
put:
|
|
44
|
+
description: |
|
|
45
|
+
The HTTP request `PUT /services/{ServiceType}` is used to return list of participants
|
|
46
|
+
that support a specified service.
|
|
47
|
+
operationId: PutServicesByServiceType
|
|
48
|
+
summary: PutServicesByServiceType
|
|
49
|
+
tags:
|
|
50
|
+
- services
|
|
51
|
+
parameters:
|
|
52
|
+
- $ref: ../components/parameters/Content-Length.yaml
|
|
53
|
+
requestBody:
|
|
54
|
+
required: true
|
|
55
|
+
content:
|
|
56
|
+
application/json:
|
|
57
|
+
schema:
|
|
58
|
+
$ref: ../components/schemas/ServicesServiceTypePutResponse.yaml
|
|
59
|
+
responses:
|
|
60
|
+
200:
|
|
61
|
+
$ref: ../components/responses/200.yaml
|
|
62
|
+
400:
|
|
63
|
+
$ref: ../components/responses/400.yaml
|
|
64
|
+
401:
|
|
65
|
+
$ref: ../components/responses/401.yaml
|
|
66
|
+
403:
|
|
67
|
+
$ref: ../components/responses/403.yaml
|
|
68
|
+
404:
|
|
69
|
+
$ref: ../components/responses/404.yaml
|
|
70
|
+
405:
|
|
71
|
+
$ref: ../components/responses/405.yaml
|
|
72
|
+
406:
|
|
73
|
+
$ref: ../components/responses/406.yaml
|
|
74
|
+
501:
|
|
75
|
+
$ref: ../components/responses/501.yaml
|
|
76
|
+
503:
|
|
77
|
+
$ref: ../components/responses/503.yaml
|