@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 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/parameters/FSPIOP-Signature.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/parameters/FSPIOP-Source.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/parameters/FSPIOP-URI.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/parameters/ID.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/parameters/SubId.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/parameters/Type.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/parameters/X-Forwarded-For.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/responses/200.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/responses/202.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/responses/400.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/responses/401.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/responses/403.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/responses/404.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/responses/405.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/responses/406.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/responses/501.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/responses/503.yaml'
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
title: Account
|
|
2
|
+
type: object
|
|
3
|
+
description: >-
|
|
4
|
+
Data model for the complex type Account.
|
|
5
|
+
|
|
6
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v2.0.0/api/thirdparty/data-models.md#3211-account
|
|
7
|
+
properties:
|
|
8
|
+
accountNickname:
|
|
9
|
+
$ref: ./Name.yaml
|
|
10
|
+
address:
|
|
11
|
+
$ref: ./AccountAddress.yaml
|
|
12
|
+
currency:
|
|
13
|
+
$ref: ./Currency.yaml
|
|
14
|
+
required:
|
|
15
|
+
- accountNickname
|
|
16
|
+
- address
|
|
17
|
+
- currency
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
title: AccountAddress
|
|
2
|
+
type: string
|
|
3
|
+
description: >-
|
|
4
|
+
The AccountAddress data type is a variable length string with a maximum size
|
|
5
|
+
of 1023 characters and consists of:
|
|
6
|
+
|
|
7
|
+
Alphanumeric characters, upper or lower case. (Addresses are case-sensitive
|
|
8
|
+
so that they can contain data encoded in formats such as base64url.)
|
|
9
|
+
|
|
10
|
+
- Underscore (_)
|
|
11
|
+
- Tilde (~)
|
|
12
|
+
- Hyphen (-)
|
|
13
|
+
- Period (.) Addresses MUST NOT end in a period (.) character
|
|
14
|
+
|
|
15
|
+
An entity providing accounts to parties (i.e. a participant) can provide any
|
|
16
|
+
value for an AccountAddress that is meaningful to that entity.
|
|
17
|
+
It does not need to provide an address that makes the account identifiable
|
|
18
|
+
outside the entity's domain.
|
|
19
|
+
|
|
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
|
+
|
|
22
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
|
|
23
|
+
pattern: '^([0-9A-Za-z_~\-\.]+[0-9A-Za-z_~\-])$'
|
|
24
|
+
minLength: 1
|
|
25
|
+
maxLength: 1023
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
title: AccountList
|
|
2
|
+
type: array
|
|
3
|
+
description: >-
|
|
4
|
+
The AccountList data model is used to hold information about the accounts
|
|
5
|
+
that a party controls.
|
|
6
|
+
|
|
7
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v2.0.0/api/thirdparty/data-models.md#3213-accountlist
|
|
8
|
+
items:
|
|
9
|
+
$ref: ./Account.yaml
|
|
10
|
+
minItems: 1
|
|
11
|
+
maxItems: 256
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/Amount.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/AmountType.yaml'
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
title: AuthenticationResponse
|
|
2
|
+
type: string
|
|
3
|
+
enum:
|
|
4
|
+
- VERIFIED
|
|
5
|
+
description: >-
|
|
6
|
+
The AuthenticationResponse enumeration describes the result of authenticating
|
|
7
|
+
verification request.
|
|
8
|
+
|
|
9
|
+
Below are the allowed values for the enumeration AuthenticationResponse.
|
|
10
|
+
- VERIFIED - The challenge was correctly signed.
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
title: FIDOPublicKeyCredentialAssertion
|
|
2
|
+
type: object
|
|
3
|
+
description: >-
|
|
4
|
+
A data model representing an AssertionStatement from WebAuthN.
|
|
5
|
+
|
|
6
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v2.0.0/api/thirdparty/data-models.md#32130-authenticatorassertionresponse
|
|
7
|
+
properties:
|
|
8
|
+
authenticatorData:
|
|
9
|
+
type: string
|
|
10
|
+
description: |
|
|
11
|
+
Authenticator data object.
|
|
12
|
+
minLength: 49
|
|
13
|
+
maxLength: 256
|
|
14
|
+
clientDataJSON:
|
|
15
|
+
type: string
|
|
16
|
+
description: |
|
|
17
|
+
JSON string with client data.
|
|
18
|
+
minLength: 121
|
|
19
|
+
maxLength: 512
|
|
20
|
+
signature:
|
|
21
|
+
type: string
|
|
22
|
+
description: |
|
|
23
|
+
The signature generated by the private key associated with this credential.
|
|
24
|
+
minLength: 59
|
|
25
|
+
maxLength: 256
|
|
26
|
+
userHandle:
|
|
27
|
+
type: string
|
|
28
|
+
description: |
|
|
29
|
+
This field is optionally provided by the authenticator, and
|
|
30
|
+
represents the user.id that was supplied during registration.
|
|
31
|
+
minLength: 1
|
|
32
|
+
maxLength: 88
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
title: AuthenticatorAttestationResponse
|
|
2
|
+
type: object
|
|
3
|
+
description: |
|
|
4
|
+
A data model representing an AttestationStatement from WebAuthN.
|
|
5
|
+
|
|
6
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v2.0.0/api/thirdparty/data-models.md#32129-authenticatorattestationresponse
|
|
7
|
+
properties:
|
|
8
|
+
clientDataJSON:
|
|
9
|
+
type: string
|
|
10
|
+
description: |
|
|
11
|
+
JSON string with client data
|
|
12
|
+
minLength: 121
|
|
13
|
+
maxLength: 512
|
|
14
|
+
attestationObject:
|
|
15
|
+
type: string
|
|
16
|
+
description: |
|
|
17
|
+
CBOR.encoded attestation object
|
|
18
|
+
minLength: 306
|
|
19
|
+
maxLength: 2048
|
|
20
|
+
required:
|
|
21
|
+
- clientDataJSON
|
|
22
|
+
- attestationObject
|
|
23
|
+
additionalProperties: false
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/BinaryString.yaml'
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
title: ConsentRequestChannelType
|
|
2
|
+
type: string
|
|
3
|
+
enum:
|
|
4
|
+
- WEB
|
|
5
|
+
- OTP
|
|
6
|
+
description: |
|
|
7
|
+
The auth channel being used for the consent request.
|
|
8
|
+
- WEB - DFSP can support authorization via a web-based login.
|
|
9
|
+
- OTP - DFSP can support authorization via a One Time PIN.
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
title: ConsentRequestsIDPatchRequest
|
|
2
|
+
type: object
|
|
3
|
+
description: >-
|
|
4
|
+
Used by: PISP
|
|
5
|
+
|
|
6
|
+
After the user completes an out-of-band authorization with the DFSP,
|
|
7
|
+
the PISP will receive a token which they can use to prove to the DFSP
|
|
8
|
+
that the user trusts this PISP.
|
|
9
|
+
|
|
10
|
+
properties:
|
|
11
|
+
authToken:
|
|
12
|
+
$ref: ./BinaryString.yaml
|
|
13
|
+
extensionList:
|
|
14
|
+
$ref: ./ExtensionList.yaml
|
|
15
|
+
required:
|
|
16
|
+
- authToken
|
|
@@ -0,0 +1,30 @@
|
|
|
1
|
+
title: ConsentRequestsIDPutResponseOTP
|
|
2
|
+
type: object
|
|
3
|
+
description: |
|
|
4
|
+
The object sent in a `PUT /tppConsentRequests/{ID}` request.
|
|
5
|
+
|
|
6
|
+
Schema used in the request consent phase of the account linking OTP/SMS flow.
|
|
7
|
+
properties:
|
|
8
|
+
scopes:
|
|
9
|
+
type: array
|
|
10
|
+
minLength: 1
|
|
11
|
+
maxLength: 256
|
|
12
|
+
items:
|
|
13
|
+
$ref: ./Scope.yaml
|
|
14
|
+
authChannels:
|
|
15
|
+
type: array
|
|
16
|
+
minLength: 1
|
|
17
|
+
maxLength: 1
|
|
18
|
+
items:
|
|
19
|
+
$ref: ./ConsentRequestChannelTypeOTP.yaml
|
|
20
|
+
# The callback uri that the user will be redirected to after completing the
|
|
21
|
+
# out of band WEB authentication with the DFSP. Used to allow the DFSP to
|
|
22
|
+
# whitelist the PISP's url ahead of time.
|
|
23
|
+
callbackUri:
|
|
24
|
+
$ref: ./Uri.yaml
|
|
25
|
+
extensionList:
|
|
26
|
+
$ref: ./ExtensionList.yaml
|
|
27
|
+
required:
|
|
28
|
+
- scopes
|
|
29
|
+
- authChannels
|
|
30
|
+
additionalProperties: false
|
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
title: ConsentRequestsIDPutResponseWeb
|
|
2
|
+
type: object
|
|
3
|
+
description: |
|
|
4
|
+
The object sent in a `PUT /tppConsentRequests/{ID}` request.
|
|
5
|
+
|
|
6
|
+
Schema used in the request consent phase of the account linking web flow,
|
|
7
|
+
the result is the PISP being instructed on a specific URL where this
|
|
8
|
+
supposed user should be redirected. This URL should be a place where
|
|
9
|
+
the user can prove their identity (e.g., by logging in).
|
|
10
|
+
properties:
|
|
11
|
+
scopes:
|
|
12
|
+
type: array
|
|
13
|
+
minLength: 1
|
|
14
|
+
maxLength: 256
|
|
15
|
+
items:
|
|
16
|
+
$ref: ./Scope.yaml
|
|
17
|
+
authChannels:
|
|
18
|
+
type: array
|
|
19
|
+
minLength: 1
|
|
20
|
+
maxLength: 1
|
|
21
|
+
items:
|
|
22
|
+
$ref: ./ConsentRequestChannelTypeWeb.yaml
|
|
23
|
+
# The callback uri that the user will be redirected to after completing the
|
|
24
|
+
# out of band WEB authentication with the DFSP. Used to allow the DFSP to
|
|
25
|
+
# whitelist the PISP's url ahead of time.
|
|
26
|
+
callbackUri:
|
|
27
|
+
$ref: ./Uri.yaml
|
|
28
|
+
# The callback uri that the pisp app should redirect to for user to complete their
|
|
29
|
+
# login.
|
|
30
|
+
authUri:
|
|
31
|
+
$ref: ./Uri.yaml
|
|
32
|
+
extensionList:
|
|
33
|
+
$ref: ./ExtensionList.yaml
|
|
34
|
+
required:
|
|
35
|
+
- scopes
|
|
36
|
+
- authChannels
|
|
37
|
+
- callbackUri
|
|
38
|
+
- authUri
|
|
39
|
+
additionalProperties: false
|
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
title: ConsentRequestsPostRequest
|
|
2
|
+
type: object
|
|
3
|
+
description: >-
|
|
4
|
+
Used by: PISP
|
|
5
|
+
|
|
6
|
+
The HTTP request POST /tppConsentRequests is used to request a DFSP to grant
|
|
7
|
+
access to one or more accounts owned by a customer of the DFSP for the
|
|
8
|
+
PISP who sends the request.
|
|
9
|
+
|
|
10
|
+
Callback and data model for POST /tppConsentRequests:
|
|
11
|
+
|
|
12
|
+
Callback: PUT /tppConsentRequests/{ID}
|
|
13
|
+
Error callback: PUT /tppConsentRequests/{ID}/error
|
|
14
|
+
|
|
15
|
+
properties:
|
|
16
|
+
consentRequestId:
|
|
17
|
+
$ref: ./CorrelationId.yaml
|
|
18
|
+
partyIdInfo:
|
|
19
|
+
$ref: ./PartyIdInfo.yaml
|
|
20
|
+
scopes:
|
|
21
|
+
type: array
|
|
22
|
+
minLength: 1
|
|
23
|
+
maxLength: 256
|
|
24
|
+
items:
|
|
25
|
+
$ref: ./Scope.yaml
|
|
26
|
+
authChannels:
|
|
27
|
+
type: array
|
|
28
|
+
minLength: 1
|
|
29
|
+
maxLength: 256
|
|
30
|
+
items:
|
|
31
|
+
$ref: ./ConsentRequestChannelType.yaml
|
|
32
|
+
# The callback uri that the user will be redirected to after completing the
|
|
33
|
+
# out of band WEB authentication with the DFSP. Used to allow the DFSP to
|
|
34
|
+
# whitelist the PISP's url ahead of time.
|
|
35
|
+
callbackUri:
|
|
36
|
+
$ref: ./Uri.yaml
|
|
37
|
+
extensionList:
|
|
38
|
+
$ref: ./ExtensionList.yaml
|
|
39
|
+
required:
|
|
40
|
+
- consentRequestId
|
|
41
|
+
- partyIdInfo
|
|
42
|
+
- scopes
|
|
43
|
+
- authChannels
|
|
44
|
+
- callbackUri
|
|
@@ -0,0 +1,17 @@
|
|
|
1
|
+
title: ConsentsIDPatchResponseRevoked
|
|
2
|
+
description: |
|
|
3
|
+
PATCH /tppConsents/{ID} request object.
|
|
4
|
+
|
|
5
|
+
Sent to both the PISP and DFSP when a consent is revoked.
|
|
6
|
+
Used in the "Unlinking" part of the Account Unlinking flow.
|
|
7
|
+
type: object
|
|
8
|
+
properties:
|
|
9
|
+
status:
|
|
10
|
+
$ref: ./ConsentStatusRevoked.yaml
|
|
11
|
+
revokedAt:
|
|
12
|
+
$ref: ./DateTime.yaml
|
|
13
|
+
extensionList:
|
|
14
|
+
$ref: ./ExtensionList.yaml
|
|
15
|
+
required:
|
|
16
|
+
- status
|
|
17
|
+
- revokedAt
|
|
@@ -0,0 +1,19 @@
|
|
|
1
|
+
title: ConsentsIDPatchResponseVerified
|
|
2
|
+
description: |
|
|
3
|
+
PATCH /tppConsents/{ID} request object.
|
|
4
|
+
|
|
5
|
+
Sent by the DFSP to the PISP when a consent is issued and verified.
|
|
6
|
+
Used in the "Register Credential" part of the Account linking flow.
|
|
7
|
+
type: object
|
|
8
|
+
properties:
|
|
9
|
+
credential:
|
|
10
|
+
type: object
|
|
11
|
+
properties:
|
|
12
|
+
status:
|
|
13
|
+
$ref: ./CredentialStatusVerified.yaml
|
|
14
|
+
required:
|
|
15
|
+
- status
|
|
16
|
+
extensionList:
|
|
17
|
+
$ref: ./ExtensionList.yaml
|
|
18
|
+
required:
|
|
19
|
+
- credential
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
title: ConsentsIDPutResponseSigned
|
|
2
|
+
type: object
|
|
3
|
+
description: >
|
|
4
|
+
The HTTP request `PUT /tppConsents/{ID}` is used by the PISP to update a Consent
|
|
5
|
+
with a signed challenge and register a credential.
|
|
6
|
+
|
|
7
|
+
Called by a `PISP` to after signing a challenge. Sent to a DFSP for
|
|
8
|
+
verification.
|
|
9
|
+
properties:
|
|
10
|
+
status:
|
|
11
|
+
$ref: ./ConsentStatusIssued.yaml
|
|
12
|
+
scopes:
|
|
13
|
+
type: array
|
|
14
|
+
items:
|
|
15
|
+
$ref: ./Scope.yaml
|
|
16
|
+
credential:
|
|
17
|
+
$ref: ./SignedCredential.yaml
|
|
18
|
+
extensionList:
|
|
19
|
+
$ref: ./ExtensionList.yaml
|
|
20
|
+
required:
|
|
21
|
+
- scopes
|
|
22
|
+
- credential
|
|
23
|
+
additionalProperties: false
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
title: ConsentsIDPutResponseVerified
|
|
2
|
+
type: object
|
|
3
|
+
description: >
|
|
4
|
+
The HTTP request `PUT /tppConsents/{ID}` is used by the DFSP or Auth-Service to
|
|
5
|
+
update a Consent object once it has been Verified.
|
|
6
|
+
|
|
7
|
+
Called by a `auth-service` to notify a DFSP that a credential has
|
|
8
|
+
been verified and registered.
|
|
9
|
+
properties:
|
|
10
|
+
status:
|
|
11
|
+
$ref: ./ConsentStatusIssued.yaml
|
|
12
|
+
scopes:
|
|
13
|
+
type: array
|
|
14
|
+
items:
|
|
15
|
+
$ref: ./Scope.yaml
|
|
16
|
+
credential:
|
|
17
|
+
$ref: ./VerifiedCredential.yaml
|
|
18
|
+
extensionList:
|
|
19
|
+
$ref: ./ExtensionList.yaml
|
|
20
|
+
required:
|
|
21
|
+
- scopes
|
|
22
|
+
- credential
|
|
23
|
+
additionalProperties: false
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
title: ConsentPostRequestAUTH
|
|
2
|
+
type: object
|
|
3
|
+
description: |
|
|
4
|
+
The object sent in a `POST /tppConsents` request to the Auth-Service
|
|
5
|
+
by a DFSP to store registered Consent and credential
|
|
6
|
+
properties:
|
|
7
|
+
consentId:
|
|
8
|
+
allOf:
|
|
9
|
+
- $ref: ./CorrelationId.yaml
|
|
10
|
+
description: |
|
|
11
|
+
Common ID between the PISP and FSP for the Consent object
|
|
12
|
+
determined by the DFSP who creates the Consent.
|
|
13
|
+
consentRequestId:
|
|
14
|
+
$ref: ./CorrelationId.yaml
|
|
15
|
+
scopes:
|
|
16
|
+
minLength: 1
|
|
17
|
+
maxLength: 256
|
|
18
|
+
type: array
|
|
19
|
+
items:
|
|
20
|
+
$ref: ./Scope.yaml
|
|
21
|
+
credential:
|
|
22
|
+
allOf:
|
|
23
|
+
- $ref: ./SignedCredential.yaml
|
|
24
|
+
status:
|
|
25
|
+
$ref: ./ConsentStatus.yaml
|
|
26
|
+
extensionList:
|
|
27
|
+
$ref: ./ExtensionList.yaml
|
|
28
|
+
required:
|
|
29
|
+
- consentId
|
|
30
|
+
- scopes
|
|
31
|
+
- credential
|
|
32
|
+
- status
|
|
33
|
+
additionalProperties: false
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
title: ConsentPostRequestPISP
|
|
2
|
+
type: object
|
|
3
|
+
description: |
|
|
4
|
+
The provisional Consent object sent by the DFSP in `POST /tppConsents`.
|
|
5
|
+
properties:
|
|
6
|
+
consentId:
|
|
7
|
+
allOf:
|
|
8
|
+
- $ref: ./CorrelationId.yaml
|
|
9
|
+
description: |
|
|
10
|
+
Common ID between the PISP and the Payer DFSP for the consent object. The ID
|
|
11
|
+
should be reused for re-sends of the same consent. A new ID should be generated
|
|
12
|
+
for each new consent.
|
|
13
|
+
consentRequestId:
|
|
14
|
+
allOf:
|
|
15
|
+
- $ref: ./CorrelationId.yaml
|
|
16
|
+
description: |
|
|
17
|
+
The ID given to the original consent request on which this consent is based.
|
|
18
|
+
scopes:
|
|
19
|
+
type: array
|
|
20
|
+
minLength: 1
|
|
21
|
+
maxLength: 256
|
|
22
|
+
items:
|
|
23
|
+
$ref: ./Scope.yaml
|
|
24
|
+
status:
|
|
25
|
+
$ref: ./ConsentStatus.yaml
|
|
26
|
+
extensionList:
|
|
27
|
+
$ref: ./ExtensionList.yaml
|
|
28
|
+
required:
|
|
29
|
+
- consentId
|
|
30
|
+
- consentRequestId
|
|
31
|
+
- scopes
|
|
32
|
+
- status
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/CorrelationId.yaml'
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
title: CredentialType
|
|
2
|
+
type: string
|
|
3
|
+
enum:
|
|
4
|
+
- FIDO
|
|
5
|
+
- GENERIC
|
|
6
|
+
description: >-
|
|
7
|
+
The type of the Credential.
|
|
8
|
+
- "FIDO" - The credential is based on a FIDO challenge. Its payload is a FIDOPublicKeyCredentialAttestation object.
|
|
9
|
+
- "GENERIC" - The credential is based on a simple public key validation. Its payload is a GenericCredential object.
|
|
10
|
+
|
|
11
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v2.0.0/api/thirdparty/data-models.md#3226-credentialtype
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/Currency.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/DateOfBirth.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/DateTime.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/ErrorCode.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/ErrorDescription.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/ErrorInformation.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/Extension.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/ExtensionKey.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/ExtensionList.yaml'
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
$ref: '../../../../../fspiop/v2_0/openapi3/components/schemas/ExtensionValue.yaml'
|