@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
|
@@ -8,11 +8,11 @@ info:
|
|
|
8
8
|
PISPs should implement the accompanying API - Mojaloop Third Party API (PISP) instead.
|
|
9
9
|
license:
|
|
10
10
|
name: Open API for FSP Interoperability (FSPIOP) (Implementation Friendly Version)
|
|
11
|
-
url:
|
|
11
|
+
url: https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md
|
|
12
12
|
servers:
|
|
13
13
|
- url: /
|
|
14
14
|
paths:
|
|
15
|
-
|
|
15
|
+
/accounts/{ID}:
|
|
16
16
|
parameters:
|
|
17
17
|
- name: ID
|
|
18
18
|
in: path
|
|
@@ -81,7 +81,7 @@ paths:
|
|
|
81
81
|
The PUT /accounts/{ID} response is used to inform the requester of the result of a request for accounts information. The identifier ID given in the call are the values given in the original request.
|
|
82
82
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
|
|
83
83
|
properties:
|
|
84
|
-
|
|
84
|
+
accounts:
|
|
85
85
|
title: AccountList
|
|
86
86
|
type: array
|
|
87
87
|
description: |-
|
|
@@ -97,7 +97,7 @@ paths:
|
|
|
97
97
|
accountNickname:
|
|
98
98
|
title: Name
|
|
99
99
|
type: string
|
|
100
|
-
pattern:
|
|
100
|
+
pattern: ^(?!\s*$)[\w .,'-]{1,128}$
|
|
101
101
|
description: |-
|
|
102
102
|
The API data type Name is a JSON String, restricted by a regular expression to avoid characters which are generally not used in a name.
|
|
103
103
|
|
|
@@ -144,7 +144,7 @@ paths:
|
|
|
144
144
|
$ref: '#/paths/~1consents/post/responses/501'
|
|
145
145
|
'503':
|
|
146
146
|
$ref: '#/paths/~1consents/post/responses/503'
|
|
147
|
-
|
|
147
|
+
/accounts/{ID}/error:
|
|
148
148
|
parameters:
|
|
149
149
|
- $ref: '#/paths/~1accounts~1%7BID%7D/parameters/0'
|
|
150
150
|
- $ref: '#/paths/~1consents/parameters/0'
|
|
@@ -184,8 +184,8 @@ paths:
|
|
|
184
184
|
errorCode:
|
|
185
185
|
title: ErrorCode
|
|
186
186
|
type: string
|
|
187
|
-
pattern:
|
|
188
|
-
description:
|
|
187
|
+
pattern: ^[1-9]\d{3}$
|
|
188
|
+
description: The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.
|
|
189
189
|
example: '5100'
|
|
190
190
|
errorDescription:
|
|
191
191
|
title: ErrorDescription
|
|
@@ -260,12 +260,12 @@ paths:
|
|
|
260
260
|
consentRequestId:
|
|
261
261
|
title: CorrelationId
|
|
262
262
|
type: string
|
|
263
|
-
pattern:
|
|
264
|
-
description:
|
|
263
|
+
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
|
264
|
+
description: Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
|
|
265
265
|
example: b51ec534-ee48-4575-b6a9-ead2955b8069
|
|
266
266
|
userId:
|
|
267
267
|
type: string
|
|
268
|
-
description:
|
|
268
|
+
description: The identifier used in the **GET /accounts/**_{ID}_. Used by the DFSP to correlate an account lookup to a `consentRequest`
|
|
269
269
|
minLength: 1
|
|
270
270
|
maxLength: 128
|
|
271
271
|
scopes:
|
|
@@ -289,7 +289,7 @@ paths:
|
|
|
289
289
|
An entity providing accounts to parties (i.e. a participant) can provide any value for an AccountAddress that is meaningful to that entity. It does not need to provide an address that makes the account identifiable outside the entity's domain.
|
|
290
290
|
IMPORTANT: The policy for defining addresses and the life-cycle of these is at the discretion of the address space owner (the payer DFSP in this case).
|
|
291
291
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
|
|
292
|
-
pattern:
|
|
292
|
+
pattern: ^([0-9A-Za-z_~\-\.]+[0-9A-Za-z_~\-])$
|
|
293
293
|
minLength: 1
|
|
294
294
|
maxLength: 1023
|
|
295
295
|
actions:
|
|
@@ -331,7 +331,7 @@ paths:
|
|
|
331
331
|
callbackUri:
|
|
332
332
|
title: Uri
|
|
333
333
|
type: string
|
|
334
|
-
pattern:
|
|
334
|
+
pattern: ^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?
|
|
335
335
|
minLength: 1
|
|
336
336
|
maxLength: 512
|
|
337
337
|
description: |
|
|
@@ -339,7 +339,7 @@ paths:
|
|
|
339
339
|
extensionList:
|
|
340
340
|
title: ExtensionList
|
|
341
341
|
type: object
|
|
342
|
-
description:
|
|
342
|
+
description: Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
|
|
343
343
|
properties:
|
|
344
344
|
extension:
|
|
345
345
|
type: array
|
|
@@ -393,7 +393,7 @@ paths:
|
|
|
393
393
|
$ref: '#/paths/~1consents/post/responses/501'
|
|
394
394
|
'503':
|
|
395
395
|
$ref: '#/paths/~1consents/post/responses/503'
|
|
396
|
-
|
|
396
|
+
/consentRequests/{ID}:
|
|
397
397
|
parameters:
|
|
398
398
|
- $ref: '#/paths/~1accounts~1%7BID%7D/parameters/0'
|
|
399
399
|
- $ref: '#/paths/~1consents/parameters/0'
|
|
@@ -575,8 +575,8 @@ paths:
|
|
|
575
575
|
properties:
|
|
576
576
|
authToken:
|
|
577
577
|
type: string
|
|
578
|
-
pattern:
|
|
579
|
-
description:
|
|
578
|
+
pattern: ^[A-Za-z0-9-_]+[=]{0,2}$
|
|
579
|
+
description: The API data type BinaryString is a JSON String. The string is a base64url encoding of a string of raw bytes, where padding (character ‘=’) is added at the end of the data if needed to ensure that the string is a multiple of 4 characters. The length restriction indicates the allowed number of characters.
|
|
580
580
|
extensionList:
|
|
581
581
|
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
582
582
|
required:
|
|
@@ -600,7 +600,7 @@ paths:
|
|
|
600
600
|
$ref: '#/paths/~1consents/post/responses/501'
|
|
601
601
|
'503':
|
|
602
602
|
$ref: '#/paths/~1consents/post/responses/503'
|
|
603
|
-
|
|
603
|
+
/consentRequests/{ID}/error:
|
|
604
604
|
parameters:
|
|
605
605
|
- $ref: '#/paths/~1accounts~1%7BID%7D/parameters/0'
|
|
606
606
|
- $ref: '#/paths/~1consents/parameters/0'
|
|
@@ -615,6 +615,7 @@ paths:
|
|
|
615
615
|
put:
|
|
616
616
|
tags:
|
|
617
617
|
- consentRequests
|
|
618
|
+
- sampled
|
|
618
619
|
operationId: NotifyErrorConsentRequests
|
|
619
620
|
summary: NotifyErrorConsentRequests
|
|
620
621
|
description: |
|
|
@@ -681,7 +682,7 @@ paths:
|
|
|
681
682
|
schema:
|
|
682
683
|
type: string
|
|
683
684
|
required: false
|
|
684
|
-
description:
|
|
685
|
+
description: The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty.
|
|
685
686
|
- name: FSPIOP-Encryption
|
|
686
687
|
in: header
|
|
687
688
|
schema:
|
|
@@ -699,13 +700,13 @@ paths:
|
|
|
699
700
|
schema:
|
|
700
701
|
type: string
|
|
701
702
|
required: false
|
|
702
|
-
description:
|
|
703
|
+
description: The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
|
703
704
|
- name: FSPIOP-HTTP-Method
|
|
704
705
|
in: header
|
|
705
706
|
schema:
|
|
706
707
|
type: string
|
|
707
708
|
required: false
|
|
708
|
-
description:
|
|
709
|
+
description: The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
|
709
710
|
post:
|
|
710
711
|
tags:
|
|
711
712
|
- consents
|
|
@@ -914,7 +915,7 @@ paths:
|
|
|
914
915
|
$ref: '#/paths/~1consents/post/responses/400/headers/Content-Length'
|
|
915
916
|
Content-Type:
|
|
916
917
|
$ref: '#/paths/~1consents/post/responses/400/headers/Content-Type'
|
|
917
|
-
|
|
918
|
+
/consents/{ID}:
|
|
918
919
|
parameters:
|
|
919
920
|
- $ref: '#/paths/~1accounts~1%7BID%7D/parameters/0'
|
|
920
921
|
- $ref: '#/paths/~1consents/parameters/0'
|
|
@@ -1141,13 +1142,13 @@ paths:
|
|
|
1141
1142
|
description: |
|
|
1142
1143
|
credential id: identifier of pair of keys, base64 encoded
|
|
1143
1144
|
https://w3c.github.io/webauthn/#ref-for-dom-credential-id
|
|
1144
|
-
minLength:
|
|
1145
|
+
minLength: 20
|
|
1145
1146
|
maxLength: 118
|
|
1146
1147
|
rawId:
|
|
1147
1148
|
type: string
|
|
1148
1149
|
description: |
|
|
1149
1150
|
raw credential id: identifier of pair of keys, base64 encoded
|
|
1150
|
-
minLength:
|
|
1151
|
+
minLength: 20
|
|
1151
1152
|
maxLength: 118
|
|
1152
1153
|
response:
|
|
1153
1154
|
type: object
|
|
@@ -1172,7 +1173,7 @@ paths:
|
|
|
1172
1173
|
additionalProperties: false
|
|
1173
1174
|
type:
|
|
1174
1175
|
type: string
|
|
1175
|
-
description:
|
|
1176
|
+
description: response type, we need only the type of public-key
|
|
1176
1177
|
enum:
|
|
1177
1178
|
- public-key
|
|
1178
1179
|
required:
|
|
@@ -1286,7 +1287,7 @@ paths:
|
|
|
1286
1287
|
$ref: '#/paths/~1consents/post/responses/501'
|
|
1287
1288
|
'503':
|
|
1288
1289
|
$ref: '#/paths/~1consents/post/responses/503'
|
|
1289
|
-
|
|
1290
|
+
/consents/{ID}/error:
|
|
1290
1291
|
parameters:
|
|
1291
1292
|
- $ref: '#/paths/~1accounts~1%7BID%7D/parameters/0'
|
|
1292
1293
|
- $ref: '#/paths/~1consents/parameters/0'
|
|
@@ -1301,6 +1302,7 @@ paths:
|
|
|
1301
1302
|
put:
|
|
1302
1303
|
tags:
|
|
1303
1304
|
- consents
|
|
1305
|
+
- sampled
|
|
1304
1306
|
operationId: NotifyErrorConsents
|
|
1305
1307
|
summary: NotifyErrorConsents
|
|
1306
1308
|
description: |
|
|
@@ -1351,6 +1353,7 @@ paths:
|
|
|
1351
1353
|
summary: PostThirdpartyRequestsAuthorizations
|
|
1352
1354
|
tags:
|
|
1353
1355
|
- authorizations
|
|
1356
|
+
- sampled
|
|
1354
1357
|
parameters:
|
|
1355
1358
|
- $ref: '#/paths/~1consents/post/parameters/0'
|
|
1356
1359
|
- $ref: '#/paths/~1consents/post/parameters/1'
|
|
@@ -1391,7 +1394,7 @@ paths:
|
|
|
1391
1394
|
payer:
|
|
1392
1395
|
allOf:
|
|
1393
1396
|
- $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/payer/allOf/0'
|
|
1394
|
-
description:
|
|
1397
|
+
description: Information about the Payer type, id, sub-type/id, FSP Id in the proposed financial transaction.
|
|
1395
1398
|
payee:
|
|
1396
1399
|
allOf:
|
|
1397
1400
|
- $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/payee/allOf/0'
|
|
@@ -1421,8 +1424,8 @@ paths:
|
|
|
1421
1424
|
subScenario:
|
|
1422
1425
|
title: TransactionSubScenario
|
|
1423
1426
|
type: string
|
|
1424
|
-
pattern:
|
|
1425
|
-
description:
|
|
1427
|
+
pattern: ^[A-Z_]{1,32}$
|
|
1428
|
+
description: Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).
|
|
1426
1429
|
example: LOCALLY_DEFINED_SUBSCENARIO
|
|
1427
1430
|
initiator:
|
|
1428
1431
|
title: TransactionInitiator
|
|
@@ -1469,8 +1472,8 @@ paths:
|
|
|
1469
1472
|
balanceOfPayments:
|
|
1470
1473
|
title: BalanceOfPayments
|
|
1471
1474
|
type: string
|
|
1472
|
-
pattern:
|
|
1473
|
-
description:
|
|
1475
|
+
pattern: ^[1-9]\d{2}$
|
|
1476
|
+
description: (BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed.
|
|
1474
1477
|
example: '123'
|
|
1475
1478
|
required:
|
|
1476
1479
|
- scenario
|
|
@@ -1479,7 +1482,7 @@ paths:
|
|
|
1479
1482
|
expiration:
|
|
1480
1483
|
allOf:
|
|
1481
1484
|
- $ref: '#/paths/~1thirdpartyRequests~1transactions~1%7BID%7D/patch/requestBody/content/application~1json/schema/properties/completedTimestamp'
|
|
1482
|
-
description:
|
|
1485
|
+
description: The time by which the transfer must be completed, set by the payee DFSP.
|
|
1483
1486
|
extensionList:
|
|
1484
1487
|
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
1485
1488
|
required:
|
|
@@ -1513,7 +1516,7 @@ paths:
|
|
|
1513
1516
|
$ref: '#/paths/~1consents/post/responses/501'
|
|
1514
1517
|
'503':
|
|
1515
1518
|
$ref: '#/paths/~1consents/post/responses/503'
|
|
1516
|
-
|
|
1519
|
+
/thirdpartyRequests/authorizations/{ID}:
|
|
1517
1520
|
parameters:
|
|
1518
1521
|
- $ref: '#/paths/~1accounts~1%7BID%7D/parameters/0'
|
|
1519
1522
|
- $ref: '#/paths/~1consents/parameters/0'
|
|
@@ -1534,6 +1537,7 @@ paths:
|
|
|
1534
1537
|
summary: GetThirdpartyRequestsAuthorizationsById
|
|
1535
1538
|
tags:
|
|
1536
1539
|
- authorizations
|
|
1540
|
+
- sampled
|
|
1537
1541
|
parameters:
|
|
1538
1542
|
- $ref: '#/paths/~1consents/post/parameters/0'
|
|
1539
1543
|
responses:
|
|
@@ -1577,7 +1581,7 @@ paths:
|
|
|
1577
1581
|
oneOf:
|
|
1578
1582
|
- title: ThirdpartyRequestsAuthorizationsIDPutResponseRejected
|
|
1579
1583
|
type: object
|
|
1580
|
-
description:
|
|
1584
|
+
description: The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback.
|
|
1581
1585
|
properties:
|
|
1582
1586
|
responseType:
|
|
1583
1587
|
title: AuthorizationResponseTypeRejected
|
|
@@ -1592,7 +1596,7 @@ paths:
|
|
|
1592
1596
|
- responseType
|
|
1593
1597
|
- title: ThirdpartyRequestsAuthorizationsIDPutResponseFIDO
|
|
1594
1598
|
type: object
|
|
1595
|
-
description:
|
|
1599
|
+
description: The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback.
|
|
1596
1600
|
properties:
|
|
1597
1601
|
responseType:
|
|
1598
1602
|
title: AuthorizationResponseType
|
|
@@ -1621,7 +1625,7 @@ paths:
|
|
|
1621
1625
|
additionalProperties: false
|
|
1622
1626
|
- title: ThirdpartyRequestsAuthorizationsIDPutResponseGeneric
|
|
1623
1627
|
type: object
|
|
1624
|
-
description:
|
|
1628
|
+
description: The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback.
|
|
1625
1629
|
properties:
|
|
1626
1630
|
responseType:
|
|
1627
1631
|
$ref: '#/paths/~1thirdpartyRequests~1authorizations~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/1/properties/responseType'
|
|
@@ -1662,7 +1666,7 @@ paths:
|
|
|
1662
1666
|
$ref: '#/paths/~1consents/post/responses/501'
|
|
1663
1667
|
'503':
|
|
1664
1668
|
$ref: '#/paths/~1consents/post/responses/503'
|
|
1665
|
-
|
|
1669
|
+
/thirdpartyRequests/authorizations/{ID}/error:
|
|
1666
1670
|
parameters:
|
|
1667
1671
|
- $ref: '#/paths/~1accounts~1%7BID%7D/parameters/0'
|
|
1668
1672
|
- $ref: '#/paths/~1consents/parameters/0'
|
|
@@ -1734,6 +1738,7 @@ paths:
|
|
|
1734
1738
|
description: The HTTP request POST `/thirdpartyRequests/transactions` is used by a PISP to initiate a 3rd party Transaction request with a DFSP
|
|
1735
1739
|
tags:
|
|
1736
1740
|
- thirdpartyRequests
|
|
1741
|
+
- sampled
|
|
1737
1742
|
parameters:
|
|
1738
1743
|
- $ref: '#/paths/~1consents/post/parameters/0'
|
|
1739
1744
|
- $ref: '#/paths/~1consents/post/parameters/1'
|
|
@@ -1768,8 +1773,8 @@ paths:
|
|
|
1768
1773
|
merchantClassificationCode:
|
|
1769
1774
|
title: MerchantClassificationCode
|
|
1770
1775
|
type: string
|
|
1771
|
-
pattern:
|
|
1772
|
-
description:
|
|
1776
|
+
pattern: ^[\d]{1,4}$
|
|
1777
|
+
description: A limited set of pre-defined numbers. This list would be a limited set of numbers identifying a set of popular merchant types like School Fees, Pubs and Restaurants, Groceries, etc.
|
|
1773
1778
|
name:
|
|
1774
1779
|
title: PartyName
|
|
1775
1780
|
type: string
|
|
@@ -1791,7 +1796,7 @@ paths:
|
|
|
1791
1796
|
type: string
|
|
1792
1797
|
minLength: 1
|
|
1793
1798
|
maxLength: 128
|
|
1794
|
-
pattern:
|
|
1799
|
+
pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
|
|
1795
1800
|
description: First name of the Party (Name Type).
|
|
1796
1801
|
example: Henrik
|
|
1797
1802
|
middleName:
|
|
@@ -1799,7 +1804,7 @@ paths:
|
|
|
1799
1804
|
type: string
|
|
1800
1805
|
minLength: 1
|
|
1801
1806
|
maxLength: 128
|
|
1802
|
-
pattern:
|
|
1807
|
+
pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
|
|
1803
1808
|
description: Middle name of the Party (Name Type).
|
|
1804
1809
|
example: Johannes
|
|
1805
1810
|
lastName:
|
|
@@ -1807,13 +1812,13 @@ paths:
|
|
|
1807
1812
|
type: string
|
|
1808
1813
|
minLength: 1
|
|
1809
1814
|
maxLength: 128
|
|
1810
|
-
pattern:
|
|
1815
|
+
pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
|
|
1811
1816
|
description: Last name of the Party (Name Type).
|
|
1812
1817
|
example: Karlsson
|
|
1813
1818
|
dateOfBirth:
|
|
1814
1819
|
title: DateofBirth (type Date)
|
|
1815
1820
|
type: string
|
|
1816
|
-
pattern:
|
|
1821
|
+
pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$
|
|
1817
1822
|
description: Date of Birth of the Party.
|
|
1818
1823
|
example: '1966-06-16'
|
|
1819
1824
|
required:
|
|
@@ -1852,7 +1857,7 @@ paths:
|
|
|
1852
1857
|
[RFC 3696](https://tools.ietf.org/html/rfc3696).
|
|
1853
1858
|
- PERSONAL_ID - A personal identifier is used as reference to a participant.
|
|
1854
1859
|
Examples of personal identification are passport number, birth certificate
|
|
1855
|
-
number, and national registration number. The identifier number is added in
|
|
1860
|
+
number, and national registration number. The identifier number is added in
|
|
1856
1861
|
the PartyIdentifier element. The personal identifier type is added in the
|
|
1857
1862
|
PartySubIdOrType element.
|
|
1858
1863
|
- BUSINESS - A specific Business (for example, an organization or a company)
|
|
@@ -1876,12 +1881,12 @@ paths:
|
|
|
1876
1881
|
PartySubIdOrType element for identifying an account under an Alias defined
|
|
1877
1882
|
by the PartyIdentifier.
|
|
1878
1883
|
- CONSENT - A Consent represents an agreement between a PISP, a Customer and
|
|
1879
|
-
a DFSP which allows the PISP permission to perform actions on behalf of the
|
|
1880
|
-
customer. A Consent has an authoritative source: either the DFSP who issued
|
|
1884
|
+
a DFSP which allows the PISP permission to perform actions on behalf of the
|
|
1885
|
+
customer. A Consent has an authoritative source: either the DFSP who issued
|
|
1881
1886
|
the Consent, or an Auth Service which administers the Consent.
|
|
1882
1887
|
- THIRD_PARTY_LINK - A Third Party Link represents an agreement between a PISP,
|
|
1883
|
-
a DFSP, and a specific Customer's account at the DFSP. The content of the link
|
|
1884
|
-
is created by the DFSP at the time when it gives permission to the PISP for
|
|
1888
|
+
a DFSP, and a specific Customer's account at the DFSP. The content of the link
|
|
1889
|
+
is created by the DFSP at the time when it gives permission to the PISP for
|
|
1885
1890
|
specific access to a given account.
|
|
1886
1891
|
example: PERSONAL_ID
|
|
1887
1892
|
partyIdentifier:
|
|
@@ -1896,7 +1901,7 @@ paths:
|
|
|
1896
1901
|
type: string
|
|
1897
1902
|
minLength: 1
|
|
1898
1903
|
maxLength: 128
|
|
1899
|
-
description:
|
|
1904
|
+
description: Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
|
|
1900
1905
|
fspId:
|
|
1901
1906
|
title: FspId
|
|
1902
1907
|
type: string
|
|
@@ -1921,7 +1926,7 @@ paths:
|
|
|
1921
1926
|
- SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
|
|
1922
1927
|
- RECEIVE - Amount the Payer would like the Payee to receive, that is, the amount that should be sent to the receiver exclusive of any fees.
|
|
1923
1928
|
example: RECEIVE
|
|
1924
|
-
description:
|
|
1929
|
+
description: SEND for sendAmount, RECEIVE for receiveAmount.
|
|
1925
1930
|
amount:
|
|
1926
1931
|
allOf:
|
|
1927
1932
|
- title: Money
|
|
@@ -1930,7 +1935,7 @@ paths:
|
|
|
1930
1935
|
properties:
|
|
1931
1936
|
currency:
|
|
1932
1937
|
title: Currency
|
|
1933
|
-
description:
|
|
1938
|
+
description: The currency codes defined in [ISO 4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter alphabetic codes are used as the standard naming representation for currencies.
|
|
1934
1939
|
type: string
|
|
1935
1940
|
minLength: 3
|
|
1936
1941
|
maxLength: 3
|
|
@@ -2102,8 +2107,8 @@ paths:
|
|
|
2102
2107
|
amount:
|
|
2103
2108
|
title: Amount
|
|
2104
2109
|
type: string
|
|
2105
|
-
pattern:
|
|
2106
|
-
description:
|
|
2110
|
+
pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
|
|
2111
|
+
description: The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed.
|
|
2107
2112
|
example: '123.45'
|
|
2108
2113
|
required:
|
|
2109
2114
|
- currency
|
|
@@ -2152,7 +2157,7 @@ paths:
|
|
|
2152
2157
|
$ref: '#/paths/~1consents/post/responses/501'
|
|
2153
2158
|
'503':
|
|
2154
2159
|
$ref: '#/paths/~1consents/post/responses/503'
|
|
2155
|
-
|
|
2160
|
+
/thirdpartyRequests/transactions/{ID}:
|
|
2156
2161
|
parameters:
|
|
2157
2162
|
- $ref: '#/paths/~1accounts~1%7BID%7D/parameters/0'
|
|
2158
2163
|
- $ref: '#/paths/~1consents/parameters/0'
|
|
@@ -2219,6 +2224,8 @@ paths:
|
|
|
2219
2224
|
After a PISP requests the creation of a Third Party Transaction request (POST /thirdpartyRequests/transactions) or the status of a previously created Third Party Transaction request (GET /thirdpartyRequests/transactions/{ID}), the DFSP will send this callback.
|
|
2220
2225
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
|
|
2221
2226
|
properties:
|
|
2227
|
+
transactionId:
|
|
2228
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
|
|
2222
2229
|
transactionRequestState:
|
|
2223
2230
|
title: TransactionRequestState
|
|
2224
2231
|
type: string
|
|
@@ -2289,8 +2296,8 @@ paths:
|
|
|
2289
2296
|
completedTimestamp:
|
|
2290
2297
|
title: DateTime
|
|
2291
2298
|
type: string
|
|
2292
|
-
pattern:
|
|
2293
|
-
description:
|
|
2299
|
+
pattern: ^(?:[1-9]\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)T(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:(\.\d{3}))(?:Z|[+-][01]\d:[0-5]\d)$
|
|
2300
|
+
description: The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC).
|
|
2294
2301
|
example: '2016-05-24T08:38:08.699-04:00'
|
|
2295
2302
|
transactionRequestState:
|
|
2296
2303
|
$ref: '#/paths/~1thirdpartyRequests~1transactions~1%7BID%7D/put/requestBody/content/application~1json/schema/properties/transactionRequestState'
|
|
@@ -2336,7 +2343,7 @@ paths:
|
|
|
2336
2343
|
$ref: '#/paths/~1consents/post/responses/501'
|
|
2337
2344
|
'503':
|
|
2338
2345
|
$ref: '#/paths/~1consents/post/responses/503'
|
|
2339
|
-
|
|
2346
|
+
/thirdpartyRequests/transactions/{ID}/error:
|
|
2340
2347
|
parameters:
|
|
2341
2348
|
- $ref: '#/paths/~1accounts~1%7BID%7D/parameters/0'
|
|
2342
2349
|
- $ref: '#/paths/~1consents/parameters/0'
|
|
@@ -2456,13 +2463,13 @@ paths:
|
|
|
2456
2463
|
description: |
|
|
2457
2464
|
credential id: identifier of pair of keys, base64 encoded
|
|
2458
2465
|
https://w3c.github.io/webauthn/#ref-for-dom-credential-id
|
|
2459
|
-
minLength:
|
|
2466
|
+
minLength: 20
|
|
2460
2467
|
maxLength: 118
|
|
2461
2468
|
rawId:
|
|
2462
2469
|
type: string
|
|
2463
2470
|
description: |
|
|
2464
2471
|
raw credential id: identifier of pair of keys, base64 encoded.
|
|
2465
|
-
minLength:
|
|
2472
|
+
minLength: 20
|
|
2466
2473
|
maxLength: 118
|
|
2467
2474
|
response:
|
|
2468
2475
|
type: object
|
|
@@ -2501,7 +2508,7 @@ paths:
|
|
|
2501
2508
|
additionalProperties: false
|
|
2502
2509
|
type:
|
|
2503
2510
|
type: string
|
|
2504
|
-
description:
|
|
2511
|
+
description: response type, we need only the type of public-key
|
|
2505
2512
|
enum:
|
|
2506
2513
|
- public-key
|
|
2507
2514
|
required:
|
|
@@ -2569,7 +2576,7 @@ paths:
|
|
|
2569
2576
|
$ref: '#/paths/~1consents/post/responses/501'
|
|
2570
2577
|
'503':
|
|
2571
2578
|
$ref: '#/paths/~1consents/post/responses/503'
|
|
2572
|
-
|
|
2579
|
+
/thirdpartyRequests/verifications/{ID}:
|
|
2573
2580
|
parameters:
|
|
2574
2581
|
- $ref: '#/paths/~1accounts~1%7BID%7D/parameters/0'
|
|
2575
2582
|
- $ref: '#/paths/~1consents/parameters/0'
|
|
@@ -2670,7 +2677,7 @@ paths:
|
|
|
2670
2677
|
$ref: '#/paths/~1consents/post/responses/501'
|
|
2671
2678
|
'503':
|
|
2672
2679
|
$ref: '#/paths/~1consents/post/responses/503'
|
|
2673
|
-
|
|
2680
|
+
/thirdpartyRequests/verifications/{ID}/error:
|
|
2674
2681
|
parameters:
|
|
2675
2682
|
- $ref: '#/paths/~1accounts~1%7BID%7D/parameters/0'
|
|
2676
2683
|
- $ref: '#/paths/~1consents/parameters/0'
|