@mojaloop/api-snippets 13.0.7 → 13.0.10
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 +21 -0
- package/CODEOWNERS +1 -1
- package/docs/thirdparty-openapi3-snippets.yaml +15 -1
- package/lib/thirdparty/openapi.d.ts +10 -2
- package/package.json +4 -4
- package/thirdparty/v1_0/openapi3/components/headers/Content-Length.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/headers/Content-Type.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/parameters/Accept.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/parameters/Content-Length.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/parameters/Content-Type.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/parameters/Date.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/parameters/FSPIOP-Destination.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/parameters/FSPIOP-Encryption.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/parameters/FSPIOP-Signature.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/parameters/FSPIOP-Source.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/parameters/FSPIOP-URI.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/parameters/ID.yaml +1 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/parameters/ServiceType.yaml +0 -0
- package/thirdparty/v1_0/openapi3/components/parameters/SubId.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/parameters/Type.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/parameters/X-Forwarded-For.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/responses/200.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/responses/202.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/responses/400.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/responses/401.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/responses/403.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/responses/404.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/responses/405.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/responses/406.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/responses/501.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/responses/503.yaml +1 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/Account.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/AccountAddress.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/AccountList.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/AccountsIDPutResponse.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/Amount.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/AmountType.yaml +1 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/AuthenticationResponse.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/AuthenticatorAssertionResponse.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/AuthenticatorAttestationResponse.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/AuthorizationResponseType.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/AuthorizationResponseTypeAccepted.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/AuthorizationResponseTypeRejected.yaml +0 -0
- package/thirdparty/v1_0/openapi3/components/schemas/BinaryString.yaml +1 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentRequestChannelType.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentRequestChannelTypeOTP.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentRequestChannelTypeWeb.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentRequestsIDPatchRequest.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentRequestsIDPutResponseOTP.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentRequestsIDPutResponseWeb.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentRequestsPostRequest.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentStatus.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentStatusIssued.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentStatusRevoked.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentsIDPatchResponseRevoked.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentsIDPatchResponseVerified.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentsIDPutResponseSigned.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentsIDPutResponseVerified.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentsPostRequestAUTH.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ConsentsPostRequestPISP.yaml +0 -0
- package/thirdparty/v1_0/openapi3/components/schemas/CorrelationId.yaml +1 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/CredentialStatusPending.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/CredentialStatusVerified.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/CredentialType.yaml +0 -0
- package/thirdparty/v1_0/openapi3/components/schemas/Currency.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/DateOfBirth.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/DateTime.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/ErrorCode.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/ErrorDescription.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/ErrorInformation.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/Extension.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/ExtensionKey.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/ExtensionList.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/ExtensionValue.yaml +1 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/FIDOPublicKeyCredentialAssertion.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/FIDOPublicKeyCredentialAttestation.yaml +0 -0
- package/thirdparty/v1_0/openapi3/components/schemas/FirstName.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/FspId.yaml +1 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/GenericCredential.yaml +0 -0
- package/thirdparty/v1_0/openapi3/components/schemas/GeoCode.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/IlpCondition.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/IlpFulfilment.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/IlpPacket.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/Integer.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/LastName.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/Latitude.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/Longitude.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/MerchantClassificationCode.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/MiddleName.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/Money.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/Name.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/Note.yaml +1 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ParticipantsIDPutResponse.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ParticipantsPostRequest.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ParticipantsTypeIDPutResponse.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ParticipantsTypeIDSubIDPostRequest.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/PartiesTypeIDPutResponse.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/Party.yaml +0 -0
- package/thirdparty/v1_0/openapi3/components/schemas/PartyComplexName.yaml +1 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/PartyIdInfo.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/PartyIdInfoTPLink.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/PartyIdType.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/PartyIdTypeTPLink.yaml +0 -0
- package/thirdparty/v1_0/openapi3/components/schemas/PartyIdentifier.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/PartyName.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/PartyPersonalInfo.yaml +1 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/PartyResult.yaml +0 -0
- package/thirdparty/v1_0/openapi3/components/schemas/PartySubIdOrType.yaml +1 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/PartyTPLink.yaml +0 -0
- package/thirdparty/v1_0/openapi3/components/schemas/QuotesIDPutResponse.yaml +1 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/QuotesPostRequest.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/Scope.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ScopeAction.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ServiceType.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ServicesServiceTypePutResponse.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/SignedCredential.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/SignedPayloadFIDO.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/SignedPayloadGeneric.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/SignedPayloadType.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/SignedPayloadTypeFIDO.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/SignedPayloadTypeGeneric.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseFIDO.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseGeneric.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseRejected.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsAuthorizationsPostRequest.yaml +1 -1
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsTransactionsIDPatchResponse.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsTransactionsIDPutResponse.yaml +2 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsTransactionsPostRequest.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsVerificationsIDPutResponse.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsVerificationsPostRequestFIDO.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/ThirdpartyRequestsVerificationsPostRequestGeneric.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/Transaction.yaml +0 -0
- package/thirdparty/v1_0/openapi3/components/schemas/TransactionRequestState.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/TransactionState.yaml +1 -0
- package/thirdparty/v1_0/openapi3/components/schemas/TransactionType.yaml +1 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/Uri.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/components/schemas/VerifiedCredential.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/openapi.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/accounts_ID.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/accounts_ID_error.yaml +1 -1
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/consentRequests.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/consentRequests_ID.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/consentRequests_ID_error.yaml +1 -1
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/consents.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/consents_ID.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/consents_ID_error.yaml +1 -1
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/health.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/metrics.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/participants.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/participants_ID.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/participants_ID_error.yaml +1 -1
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/participants_Type_ID.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/participants_Type_ID_error.yaml +1 -1
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/services_ServiceType.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/services_ServiceType_error.yaml +1 -1
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_authorizations.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_authorizations_ID.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_authorizations_ID_error.yaml +1 -1
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_transactions.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_transactions_ID.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_transactions_ID_error.yaml +1 -1
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_verifications.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_verifications_ID.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/paths/thirdpartyRequests_verifications_ID_error.yaml +1 -1
- package/thirdparty/{openapi3 → v1_0/openapi3}/thirdparty-dfsp-api.template.yaml +0 -0
- package/thirdparty/{openapi3 → v1_0/openapi3}/thirdparty-dfsp-api.yaml +443 -347
- package/thirdparty/{openapi3 → v1_0/openapi3}/thirdparty-pisp-api.template.yaml +7 -7
- package/thirdparty/{openapi3 → v1_0/openapi3}/thirdparty-pisp-api.yaml +435 -342
- package/thirdparty/openapi3/components/headers/Content-Length.yaml +0 -1
- package/thirdparty/openapi3/components/headers/Content-Type.yaml +0 -1
- package/thirdparty/openapi3/components/parameters/Accept.yaml +0 -1
- package/thirdparty/openapi3/components/parameters/Content-Length.yaml +0 -1
- package/thirdparty/openapi3/components/parameters/Content-Type.yaml +0 -1
- package/thirdparty/openapi3/components/parameters/Date.yaml +0 -1
- package/thirdparty/openapi3/components/parameters/FSPIOP-Destination.yaml +0 -1
- package/thirdparty/openapi3/components/parameters/FSPIOP-Encryption.yaml +0 -1
- package/thirdparty/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +0 -1
- package/thirdparty/openapi3/components/parameters/FSPIOP-Signature.yaml +0 -1
- package/thirdparty/openapi3/components/parameters/FSPIOP-Source.yaml +0 -1
- package/thirdparty/openapi3/components/parameters/FSPIOP-URI.yaml +0 -1
- package/thirdparty/openapi3/components/parameters/ID.yaml +0 -1
- package/thirdparty/openapi3/components/parameters/SubId.yaml +0 -1
- package/thirdparty/openapi3/components/parameters/Type.yaml +0 -1
- package/thirdparty/openapi3/components/parameters/X-Forwarded-For.yaml +0 -1
- package/thirdparty/openapi3/components/responses/200.yaml +0 -1
- package/thirdparty/openapi3/components/responses/202.yaml +0 -1
- package/thirdparty/openapi3/components/responses/400.yaml +0 -1
- package/thirdparty/openapi3/components/responses/401.yaml +0 -1
- package/thirdparty/openapi3/components/responses/403.yaml +0 -1
- package/thirdparty/openapi3/components/responses/404.yaml +0 -1
- package/thirdparty/openapi3/components/responses/405.yaml +0 -1
- package/thirdparty/openapi3/components/responses/406.yaml +0 -1
- package/thirdparty/openapi3/components/responses/501.yaml +0 -1
- package/thirdparty/openapi3/components/responses/503.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/Amount.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/AmountType.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/BinaryString.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/CorrelationId.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/Currency.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/DateOfBirth.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/DateTime.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/ErrorCode.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/ErrorDescription.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/ErrorInformation.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/Extension.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/ExtensionKey.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/ExtensionList.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/ExtensionValue.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/FirstName.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/FspId.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/GeoCode.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/IlpCondition.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/IlpFulfilment.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/IlpPacket.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/Integer.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/LastName.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/Latitude.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/Longitude.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/MerchantClassificationCode.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/MiddleName.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/Money.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/Name.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/Note.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/PartyComplexName.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/PartyIdentifier.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/PartyName.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/PartyPersonalInfo.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/PartySubIdOrType.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/QuotesIDPutResponse.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/TransactionRequestState.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/TransactionState.yaml +0 -1
- package/thirdparty/openapi3/components/schemas/TransactionType.yaml +0 -1
|
@@ -75,15 +75,24 @@ paths:
|
|
|
75
75
|
schema:
|
|
76
76
|
title: AccountsIDPutResponse
|
|
77
77
|
type: object
|
|
78
|
-
description:
|
|
78
|
+
description: |-
|
|
79
|
+
Callback and data model information for GET /accounts/{ID}:
|
|
80
|
+
Callback - PUT /accounts/{ID} Error Callback - PUT /accounts/{ID}/error Data Model - Empty body
|
|
81
|
+
The PUT /accounts/{ID} response is used to inform the requester of the result of a request for accounts information. The identifier ID given in the call are the values given in the original request.
|
|
82
|
+
https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
|
|
79
83
|
properties:
|
|
80
84
|
accountList:
|
|
81
|
-
|
|
85
|
+
title: AccountList
|
|
82
86
|
type: array
|
|
87
|
+
description: |-
|
|
88
|
+
The AccountList data model is used to hold information about the accounts that a party controls.
|
|
89
|
+
https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist
|
|
83
90
|
items:
|
|
84
91
|
title: Account
|
|
85
92
|
type: object
|
|
86
|
-
description:
|
|
93
|
+
description: |-
|
|
94
|
+
Data model for the complex type Account.
|
|
95
|
+
https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account
|
|
87
96
|
properties:
|
|
88
97
|
accountNickname:
|
|
89
98
|
title: Name
|
|
@@ -96,182 +105,17 @@ paths:
|
|
|
96
105
|
|
|
97
106
|
**Note:** In some programming languages, Unicode support must be specifically enabled. For example, if Java is used, the flag UNICODE_CHARACTER_CLASS must be enabled to allow Unicode characters.
|
|
98
107
|
address:
|
|
99
|
-
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/scopes/items/address'
|
|
108
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/scopes/items/properties/address'
|
|
100
109
|
currency:
|
|
101
|
-
|
|
102
|
-
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.'
|
|
103
|
-
type: string
|
|
104
|
-
minLength: 3
|
|
105
|
-
maxLength: 3
|
|
106
|
-
enum:
|
|
107
|
-
- AED
|
|
108
|
-
- AFN
|
|
109
|
-
- ALL
|
|
110
|
-
- AMD
|
|
111
|
-
- ANG
|
|
112
|
-
- AOA
|
|
113
|
-
- ARS
|
|
114
|
-
- AUD
|
|
115
|
-
- AWG
|
|
116
|
-
- AZN
|
|
117
|
-
- BAM
|
|
118
|
-
- BBD
|
|
119
|
-
- BDT
|
|
120
|
-
- BGN
|
|
121
|
-
- BHD
|
|
122
|
-
- BIF
|
|
123
|
-
- BMD
|
|
124
|
-
- BND
|
|
125
|
-
- BOB
|
|
126
|
-
- BRL
|
|
127
|
-
- BSD
|
|
128
|
-
- BTN
|
|
129
|
-
- BWP
|
|
130
|
-
- BYN
|
|
131
|
-
- BZD
|
|
132
|
-
- CAD
|
|
133
|
-
- CDF
|
|
134
|
-
- CHF
|
|
135
|
-
- CLP
|
|
136
|
-
- CNY
|
|
137
|
-
- COP
|
|
138
|
-
- CRC
|
|
139
|
-
- CUC
|
|
140
|
-
- CUP
|
|
141
|
-
- CVE
|
|
142
|
-
- CZK
|
|
143
|
-
- DJF
|
|
144
|
-
- DKK
|
|
145
|
-
- DOP
|
|
146
|
-
- DZD
|
|
147
|
-
- EGP
|
|
148
|
-
- ERN
|
|
149
|
-
- ETB
|
|
150
|
-
- EUR
|
|
151
|
-
- FJD
|
|
152
|
-
- FKP
|
|
153
|
-
- GBP
|
|
154
|
-
- GEL
|
|
155
|
-
- GGP
|
|
156
|
-
- GHS
|
|
157
|
-
- GIP
|
|
158
|
-
- GMD
|
|
159
|
-
- GNF
|
|
160
|
-
- GTQ
|
|
161
|
-
- GYD
|
|
162
|
-
- HKD
|
|
163
|
-
- HNL
|
|
164
|
-
- HRK
|
|
165
|
-
- HTG
|
|
166
|
-
- HUF
|
|
167
|
-
- IDR
|
|
168
|
-
- ILS
|
|
169
|
-
- IMP
|
|
170
|
-
- INR
|
|
171
|
-
- IQD
|
|
172
|
-
- IRR
|
|
173
|
-
- ISK
|
|
174
|
-
- JEP
|
|
175
|
-
- JMD
|
|
176
|
-
- JOD
|
|
177
|
-
- JPY
|
|
178
|
-
- KES
|
|
179
|
-
- KGS
|
|
180
|
-
- KHR
|
|
181
|
-
- KMF
|
|
182
|
-
- KPW
|
|
183
|
-
- KRW
|
|
184
|
-
- KWD
|
|
185
|
-
- KYD
|
|
186
|
-
- KZT
|
|
187
|
-
- LAK
|
|
188
|
-
- LBP
|
|
189
|
-
- LKR
|
|
190
|
-
- LRD
|
|
191
|
-
- LSL
|
|
192
|
-
- LYD
|
|
193
|
-
- MAD
|
|
194
|
-
- MDL
|
|
195
|
-
- MGA
|
|
196
|
-
- MKD
|
|
197
|
-
- MMK
|
|
198
|
-
- MNT
|
|
199
|
-
- MOP
|
|
200
|
-
- MRO
|
|
201
|
-
- MUR
|
|
202
|
-
- MVR
|
|
203
|
-
- MWK
|
|
204
|
-
- MXN
|
|
205
|
-
- MYR
|
|
206
|
-
- MZN
|
|
207
|
-
- NAD
|
|
208
|
-
- NGN
|
|
209
|
-
- NIO
|
|
210
|
-
- NOK
|
|
211
|
-
- NPR
|
|
212
|
-
- NZD
|
|
213
|
-
- OMR
|
|
214
|
-
- PAB
|
|
215
|
-
- PEN
|
|
216
|
-
- PGK
|
|
217
|
-
- PHP
|
|
218
|
-
- PKR
|
|
219
|
-
- PLN
|
|
220
|
-
- PYG
|
|
221
|
-
- QAR
|
|
222
|
-
- RON
|
|
223
|
-
- RSD
|
|
224
|
-
- RUB
|
|
225
|
-
- RWF
|
|
226
|
-
- SAR
|
|
227
|
-
- SBD
|
|
228
|
-
- SCR
|
|
229
|
-
- SDG
|
|
230
|
-
- SEK
|
|
231
|
-
- SGD
|
|
232
|
-
- SHP
|
|
233
|
-
- SLL
|
|
234
|
-
- SOS
|
|
235
|
-
- SPL
|
|
236
|
-
- SRD
|
|
237
|
-
- STD
|
|
238
|
-
- SVC
|
|
239
|
-
- SYP
|
|
240
|
-
- SZL
|
|
241
|
-
- THB
|
|
242
|
-
- TJS
|
|
243
|
-
- TMT
|
|
244
|
-
- TND
|
|
245
|
-
- TOP
|
|
246
|
-
- TRY
|
|
247
|
-
- TTD
|
|
248
|
-
- TVD
|
|
249
|
-
- TWD
|
|
250
|
-
- TZS
|
|
251
|
-
- UAH
|
|
252
|
-
- UGX
|
|
253
|
-
- USD
|
|
254
|
-
- UYU
|
|
255
|
-
- UZS
|
|
256
|
-
- VEF
|
|
257
|
-
- VND
|
|
258
|
-
- VUV
|
|
259
|
-
- WST
|
|
260
|
-
- XAF
|
|
261
|
-
- XCD
|
|
262
|
-
- XDR
|
|
263
|
-
- XOF
|
|
264
|
-
- XPF
|
|
265
|
-
- XTS
|
|
266
|
-
- XXX
|
|
267
|
-
- YER
|
|
268
|
-
- ZAR
|
|
269
|
-
- ZMW
|
|
270
|
-
- ZWD
|
|
110
|
+
$ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/amount/allOf/0/properties/currency'
|
|
271
111
|
required:
|
|
272
112
|
- accountNickname
|
|
273
|
-
-
|
|
113
|
+
- address
|
|
274
114
|
- currency
|
|
115
|
+
minItems: 1
|
|
116
|
+
maxItems: 256
|
|
117
|
+
extensionList:
|
|
118
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
275
119
|
required:
|
|
276
120
|
- accounts
|
|
277
121
|
example:
|
|
@@ -350,7 +194,7 @@ paths:
|
|
|
350
194
|
maxLength: 128
|
|
351
195
|
description: Error description string.
|
|
352
196
|
extensionList:
|
|
353
|
-
$ref: '#/paths/~
|
|
197
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
354
198
|
required:
|
|
355
199
|
- errorCode
|
|
356
200
|
- errorDescription
|
|
@@ -406,7 +250,12 @@ paths:
|
|
|
406
250
|
schema:
|
|
407
251
|
title: ConsentRequestsPostRequest
|
|
408
252
|
type: object
|
|
409
|
-
description:
|
|
253
|
+
description: |-
|
|
254
|
+
Used by: PISP
|
|
255
|
+
The HTTP request POST /consentRequests is used to request a DFSP to grant access to one or more accounts owned by a customer of the DFSP for the PISP who sends the request.
|
|
256
|
+
Callback and data model for POST /consentRequests:
|
|
257
|
+
Callback: PUT /consentRequests/{ID} Error callback: PUT /consentRequests/{ID}/error Data model - see below url
|
|
258
|
+
https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests
|
|
410
259
|
properties:
|
|
411
260
|
consentRequestId:
|
|
412
261
|
title: CorrelationId
|
|
@@ -426,13 +275,20 @@ paths:
|
|
|
426
275
|
items:
|
|
427
276
|
title: Scope
|
|
428
277
|
type: object
|
|
429
|
-
description:
|
|
278
|
+
description: |-
|
|
279
|
+
The Scope element contains an identifier defining, in the terms of a DFSP, an account on which access types can be requested or granted. It also defines the access types which are requested or granted.
|
|
280
|
+
https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope
|
|
430
281
|
properties:
|
|
431
282
|
address:
|
|
432
283
|
title: AccountAddress
|
|
433
284
|
type: string
|
|
434
|
-
description:
|
|
435
|
-
|
|
285
|
+
description: |-
|
|
286
|
+
The AccountAddress data type is a variable length string with a maximum size of 1023 characters and consists of:
|
|
287
|
+
Alphanumeric characters, upper or lower case. (Addresses are case-sensitive so that they can contain data encoded in formats such as base64url.)
|
|
288
|
+
- Underscore (_) - Tilde (~) - Hyphen (-) - Period (.) Addresses MUST NOT end in a period (.) character
|
|
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
|
+
IMPORTANT: The policy for defining addresses and the life-cycle of these is at the discretion of the address space owner (the payer DFSP in this case).
|
|
291
|
+
https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
|
|
436
292
|
pattern: '^([0-9A-Za-z_~\-\.]+[0-9A-Za-z_~\-])$'
|
|
437
293
|
minLength: 1
|
|
438
294
|
maxLength: 1023
|
|
@@ -443,16 +299,18 @@ paths:
|
|
|
443
299
|
items:
|
|
444
300
|
title: ScopeAction
|
|
445
301
|
type: string
|
|
302
|
+
description: |
|
|
303
|
+
The ScopeAction element contains an access type which a PISP can request
|
|
304
|
+
from a DFSP, or which a DFSP can grant to a PISP.
|
|
305
|
+
It must be a member of the appropriate enumeration.
|
|
306
|
+
|
|
307
|
+
- ACCOUNTS_GET_BALANCE: PISP can request a balance for the linked account
|
|
308
|
+
- ACCOUNTS_TRANSFER: PISP can request a transfer of funds from the linked account in the DFSP
|
|
309
|
+
- ACCOUNTS_STATEMENT: PISP can request a statement of individual transactions on a user's account
|
|
446
310
|
enum:
|
|
447
311
|
- ACCOUNTS_GET_BALANCE
|
|
448
312
|
- ACCOUNTS_TRANSFER
|
|
449
313
|
- ACCOUNTS_STATEMENT
|
|
450
|
-
description: |
|
|
451
|
-
The permissions allowed on a given account by a DFSP as defined in
|
|
452
|
-
a consent object
|
|
453
|
-
- ACCOUNTS_GET_BALANCE: PISP can request a balance for the linked account
|
|
454
|
-
- ACCOUNTS_TRANSFER: PISP can request a transfer of funds from the linked account in the DFSP
|
|
455
|
-
- ACCOUNTS_STATEMENT: PISP can request a statement of individual transactions on a user’s account
|
|
456
314
|
required:
|
|
457
315
|
- address
|
|
458
316
|
- actions
|
|
@@ -467,9 +325,9 @@ paths:
|
|
|
467
325
|
- WEB
|
|
468
326
|
- OTP
|
|
469
327
|
description: |
|
|
470
|
-
The auth channel being used for the
|
|
471
|
-
-
|
|
472
|
-
-
|
|
328
|
+
The auth channel being used for the consent request.
|
|
329
|
+
- WEB - DFSP can support authorization via a web-based login.
|
|
330
|
+
- OTP - DFSP can support authorization via a One Time PIN.
|
|
473
331
|
callbackUri:
|
|
474
332
|
title: Uri
|
|
475
333
|
type: string
|
|
@@ -478,6 +336,38 @@ paths:
|
|
|
478
336
|
maxLength: 512
|
|
479
337
|
description: |
|
|
480
338
|
The API data type Uri is a JSON string in a canonical format that is restricted by a regular expression for interoperability reasons.
|
|
339
|
+
extensionList:
|
|
340
|
+
title: ExtensionList
|
|
341
|
+
type: object
|
|
342
|
+
description: 'Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.'
|
|
343
|
+
properties:
|
|
344
|
+
extension:
|
|
345
|
+
type: array
|
|
346
|
+
items:
|
|
347
|
+
title: Extension
|
|
348
|
+
type: object
|
|
349
|
+
description: Data model for the complex type Extension.
|
|
350
|
+
properties:
|
|
351
|
+
key:
|
|
352
|
+
title: ExtensionKey
|
|
353
|
+
type: string
|
|
354
|
+
minLength: 1
|
|
355
|
+
maxLength: 32
|
|
356
|
+
description: Extension key.
|
|
357
|
+
value:
|
|
358
|
+
title: ExtensionValue
|
|
359
|
+
type: string
|
|
360
|
+
minLength: 1
|
|
361
|
+
maxLength: 128
|
|
362
|
+
description: Extension value.
|
|
363
|
+
required:
|
|
364
|
+
- key
|
|
365
|
+
- value
|
|
366
|
+
minItems: 1
|
|
367
|
+
maxItems: 16
|
|
368
|
+
description: Number of Extension elements.
|
|
369
|
+
required:
|
|
370
|
+
- extension
|
|
481
371
|
required:
|
|
482
372
|
- consentRequestId
|
|
483
373
|
- userId
|
|
@@ -585,7 +475,7 @@ paths:
|
|
|
585
475
|
minLength: 1
|
|
586
476
|
maxLength: 256
|
|
587
477
|
items:
|
|
588
|
-
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/scopes/items'
|
|
478
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/scopes/items'
|
|
589
479
|
authChannels:
|
|
590
480
|
type: array
|
|
591
481
|
minLength: 1
|
|
@@ -596,11 +486,13 @@ paths:
|
|
|
596
486
|
enum:
|
|
597
487
|
- WEB
|
|
598
488
|
description: |
|
|
599
|
-
The web auth channel being used for PUT consentRequest/{ID} request.
|
|
489
|
+
The web auth channel being used for `PUT /consentRequest/{ID}` request.
|
|
600
490
|
callbackUri:
|
|
601
|
-
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/callbackUri'
|
|
491
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/callbackUri'
|
|
602
492
|
authUri:
|
|
603
|
-
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/callbackUri'
|
|
493
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/callbackUri'
|
|
494
|
+
extensionList:
|
|
495
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
604
496
|
required:
|
|
605
497
|
- scopes
|
|
606
498
|
- authChannels
|
|
@@ -619,7 +511,7 @@ paths:
|
|
|
619
511
|
minLength: 1
|
|
620
512
|
maxLength: 256
|
|
621
513
|
items:
|
|
622
|
-
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/scopes/items'
|
|
514
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/scopes/items'
|
|
623
515
|
authChannels:
|
|
624
516
|
type: array
|
|
625
517
|
minLength: 1
|
|
@@ -630,9 +522,11 @@ paths:
|
|
|
630
522
|
enum:
|
|
631
523
|
- OTP
|
|
632
524
|
description: |
|
|
633
|
-
The OTP auth channel being used for PUT
|
|
525
|
+
The OTP auth channel being used for `PUT /consentRequests/{ID}` request.
|
|
634
526
|
callbackUri:
|
|
635
|
-
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/callbackUri'
|
|
527
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/callbackUri'
|
|
528
|
+
extensionList:
|
|
529
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
636
530
|
required:
|
|
637
531
|
- scopes
|
|
638
532
|
- authChannels
|
|
@@ -674,12 +568,17 @@ paths:
|
|
|
674
568
|
schema:
|
|
675
569
|
title: ConsentRequestsIDPatchRequest
|
|
676
570
|
type: object
|
|
677
|
-
description:
|
|
571
|
+
description: |-
|
|
572
|
+
Used by: PISP
|
|
573
|
+
After the user completes an out-of-band authorization with the DFSP, the PISP will receive a token which they can use to prove to the DFSP that the user trusts this PISP.
|
|
574
|
+
https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid
|
|
678
575
|
properties:
|
|
679
576
|
authToken:
|
|
680
577
|
type: string
|
|
681
578
|
pattern: '^[A-Za-z0-9-_]+[=]{0,2}$'
|
|
682
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
|
+
extensionList:
|
|
581
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
683
582
|
required:
|
|
684
583
|
- authToken
|
|
685
584
|
responses:
|
|
@@ -845,19 +744,21 @@ paths:
|
|
|
845
744
|
properties:
|
|
846
745
|
consentId:
|
|
847
746
|
allOf:
|
|
848
|
-
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/consentRequestId'
|
|
747
|
+
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
|
|
849
748
|
description: |
|
|
850
749
|
Common ID between the PISP and FSP for the Consent object
|
|
851
750
|
determined by the DFSP who creates the Consent.
|
|
751
|
+
consentRequestId:
|
|
752
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
|
|
852
753
|
scopes:
|
|
853
754
|
minLength: 1
|
|
854
755
|
maxLength: 256
|
|
855
756
|
type: array
|
|
856
757
|
items:
|
|
857
|
-
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/scopes/items'
|
|
758
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/scopes/items'
|
|
858
759
|
credential:
|
|
859
760
|
allOf:
|
|
860
|
-
- $ref: '#/paths/~1consents~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/0/credential'
|
|
761
|
+
- $ref: '#/paths/~1consents~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/0/properties/credential'
|
|
861
762
|
status:
|
|
862
763
|
title: ConsentStatus
|
|
863
764
|
type: string
|
|
@@ -868,6 +769,8 @@ paths:
|
|
|
868
769
|
Allowed values for the enumeration ConsentStatus
|
|
869
770
|
- ISSUED - The consent has been issued by the DFSP
|
|
870
771
|
- REVOKED - The consent has been revoked
|
|
772
|
+
extensionList:
|
|
773
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
871
774
|
required:
|
|
872
775
|
- consentId
|
|
873
776
|
- scopes
|
|
@@ -881,14 +784,14 @@ paths:
|
|
|
881
784
|
properties:
|
|
882
785
|
consentId:
|
|
883
786
|
allOf:
|
|
884
|
-
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/consentRequestId'
|
|
787
|
+
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
|
|
885
788
|
description: |
|
|
886
789
|
Common ID between the PISP and the Payer DFSP for the consent object. The ID
|
|
887
|
-
should be reused for
|
|
790
|
+
should be reused for re-sends of the same consent. A new ID should be generated
|
|
888
791
|
for each new consent.
|
|
889
792
|
consentRequestId:
|
|
890
793
|
allOf:
|
|
891
|
-
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/consentRequestId'
|
|
794
|
+
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
|
|
892
795
|
description: |
|
|
893
796
|
The ID given to the original consent request on which this consent is based.
|
|
894
797
|
scopes:
|
|
@@ -896,9 +799,11 @@ paths:
|
|
|
896
799
|
minLength: 1
|
|
897
800
|
maxLength: 256
|
|
898
801
|
items:
|
|
899
|
-
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/scopes/items'
|
|
802
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/scopes/items'
|
|
900
803
|
status:
|
|
901
|
-
$ref: '#/paths/~1consents/post/requestBody/content/application~1json/schema/oneOf/0/status'
|
|
804
|
+
$ref: '#/paths/~1consents/post/requestBody/content/application~1json/schema/oneOf/0/properties/status'
|
|
805
|
+
extensionList:
|
|
806
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
902
807
|
required:
|
|
903
808
|
- consentId
|
|
904
809
|
- consentRequestId
|
|
@@ -917,7 +822,7 @@ paths:
|
|
|
917
822
|
description: Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses.
|
|
918
823
|
properties:
|
|
919
824
|
errorInformation:
|
|
920
|
-
$ref: '#/paths/~1accounts~1%7BID%7D~1error/put/requestBody/content/application~1json/schema/errorInformation'
|
|
825
|
+
$ref: '#/paths/~1accounts~1%7BID%7D~1error/put/requestBody/content/application~1json/schema/properties/errorInformation'
|
|
921
826
|
headers:
|
|
922
827
|
Content-Length:
|
|
923
828
|
required: false
|
|
@@ -1023,7 +928,7 @@ paths:
|
|
|
1023
928
|
- $ref: '#/paths/~1consents/parameters/8'
|
|
1024
929
|
get:
|
|
1025
930
|
description: |
|
|
1026
|
-
The **GET /consents/**_{ID}_ resource allows a party to enquire after the status of a consent. The
|
|
931
|
+
The **GET /consents/**_{ID}_ resource allows a party to enquire after the status of a consent. The *{ID}* used in the URI of the request should be the consent request ID which was used to identify the consent when it was created.
|
|
1027
932
|
tags:
|
|
1028
933
|
- consents
|
|
1029
934
|
operationId: GetConsent
|
|
@@ -1077,7 +982,7 @@ paths:
|
|
|
1077
982
|
description: |
|
|
1078
983
|
PATCH /consents/{ID} request object.
|
|
1079
984
|
|
|
1080
|
-
Sent by the DFSP to the PISP when a consent is verified.
|
|
985
|
+
Sent by the DFSP to the PISP when a consent is issued and verified.
|
|
1081
986
|
Used in the "Register Credential" part of the Account linking flow.
|
|
1082
987
|
type: object
|
|
1083
988
|
properties:
|
|
@@ -1085,7 +990,7 @@ paths:
|
|
|
1085
990
|
type: object
|
|
1086
991
|
properties:
|
|
1087
992
|
status:
|
|
1088
|
-
title:
|
|
993
|
+
title: CredentialStatusVerified
|
|
1089
994
|
type: string
|
|
1090
995
|
enum:
|
|
1091
996
|
- VERIFIED
|
|
@@ -1094,6 +999,8 @@ paths:
|
|
|
1094
999
|
- "VERIFIED" - The Credential is valid and verified.
|
|
1095
1000
|
required:
|
|
1096
1001
|
- status
|
|
1002
|
+
extensionList:
|
|
1003
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
1097
1004
|
required:
|
|
1098
1005
|
- credential
|
|
1099
1006
|
- title: ConsentsIDPatchResponseRevoked
|
|
@@ -1105,7 +1012,7 @@ paths:
|
|
|
1105
1012
|
type: object
|
|
1106
1013
|
properties:
|
|
1107
1014
|
status:
|
|
1108
|
-
title:
|
|
1015
|
+
title: ConsentStatusRevoked
|
|
1109
1016
|
type: string
|
|
1110
1017
|
enum:
|
|
1111
1018
|
- REVOKED
|
|
@@ -1113,7 +1020,9 @@ paths:
|
|
|
1113
1020
|
Allowed values for the enumeration ConsentStatus
|
|
1114
1021
|
- REVOKED - The consent has been revoked
|
|
1115
1022
|
revokedAt:
|
|
1116
|
-
$ref: '#/paths/~1thirdpartyRequests~1transactions~1%7BID%7D/patch/requestBody/content/application~1json/schema/completedTimestamp'
|
|
1023
|
+
$ref: '#/paths/~1thirdpartyRequests~1transactions~1%7BID%7D/patch/requestBody/content/application~1json/schema/properties/completedTimestamp'
|
|
1024
|
+
extensionList:
|
|
1025
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
1117
1026
|
required:
|
|
1118
1027
|
- status
|
|
1119
1028
|
- revokedAt
|
|
@@ -1162,18 +1071,18 @@ paths:
|
|
|
1162
1071
|
The HTTP request `PUT /consents/{ID}` is used by the PISP to update a Consent with a signed challenge and register a credential.
|
|
1163
1072
|
Called by a `PISP` to after signing a challenge. Sent to a DFSP for verification.
|
|
1164
1073
|
properties:
|
|
1165
|
-
scopes:
|
|
1166
|
-
type: array
|
|
1167
|
-
items:
|
|
1168
|
-
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/scopes/items'
|
|
1169
1074
|
status:
|
|
1170
|
-
title:
|
|
1075
|
+
title: ConsentStatusIssued
|
|
1171
1076
|
type: string
|
|
1172
1077
|
enum:
|
|
1173
1078
|
- ISSUED
|
|
1174
1079
|
description: |-
|
|
1175
1080
|
Allowed values for the enumeration ConsentStatus
|
|
1176
1081
|
- ISSUED - The consent has been issued by the DFSP
|
|
1082
|
+
scopes:
|
|
1083
|
+
type: array
|
|
1084
|
+
items:
|
|
1085
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/scopes/items'
|
|
1177
1086
|
credential:
|
|
1178
1087
|
title: SignedCredential
|
|
1179
1088
|
type: object
|
|
@@ -1191,12 +1100,11 @@ paths:
|
|
|
1191
1100
|
enum:
|
|
1192
1101
|
- FIDO
|
|
1193
1102
|
- GENERIC
|
|
1194
|
-
description:
|
|
1195
|
-
The type of the Credential.
|
|
1196
|
-
-
|
|
1197
|
-
- "GENERIC" - A Generic public/private keypair
|
|
1103
|
+
description: |-
|
|
1104
|
+
The type of the Credential. - "FIDO" - The credential is based on a FIDO challenge. Its payload is a FIDOPublicKeyCredentialAttestation object. - "GENERIC" - The credential is based on a simple public key validation. Its payload is a GenericCredential object.
|
|
1105
|
+
https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype
|
|
1198
1106
|
status:
|
|
1199
|
-
title:
|
|
1107
|
+
title: CredentialStatusPending
|
|
1200
1108
|
type: string
|
|
1201
1109
|
enum:
|
|
1202
1110
|
- PENDING
|
|
@@ -1207,61 +1115,21 @@ paths:
|
|
|
1207
1115
|
title: GenericCredential
|
|
1208
1116
|
type: object
|
|
1209
1117
|
description: |
|
|
1210
|
-
A publicKey + signature of a challenge for a generic public/private keypair
|
|
1118
|
+
A publicKey + signature of a challenge for a generic public/private keypair.
|
|
1211
1119
|
properties:
|
|
1212
1120
|
publicKey:
|
|
1213
|
-
$ref: '#/paths/~1consentRequests~1%7BID%7D/patch/requestBody/content/application~1json/schema/authToken'
|
|
1121
|
+
$ref: '#/paths/~1consentRequests~1%7BID%7D/patch/requestBody/content/application~1json/schema/properties/authToken'
|
|
1214
1122
|
signature:
|
|
1215
|
-
$ref: '#/paths/~1consentRequests~1%7BID%7D/patch/requestBody/content/application~1json/schema/authToken'
|
|
1123
|
+
$ref: '#/paths/~1consentRequests~1%7BID%7D/patch/requestBody/content/application~1json/schema/properties/authToken'
|
|
1216
1124
|
required:
|
|
1217
1125
|
- publicKey
|
|
1218
1126
|
- signature
|
|
1219
1127
|
additionalProperties: false
|
|
1220
1128
|
fidoPayload:
|
|
1221
|
-
$ref: '#/paths/~1consents~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/1/credential/payload'
|
|
1222
|
-
required:
|
|
1223
|
-
- credentialType
|
|
1224
|
-
- status
|
|
1225
|
-
additionalProperties: false
|
|
1226
|
-
required:
|
|
1227
|
-
- scopes
|
|
1228
|
-
- credential
|
|
1229
|
-
additionalProperties: false
|
|
1230
|
-
- title: ConsentsIDPutResponseVerified
|
|
1231
|
-
type: object
|
|
1232
|
-
description: |
|
|
1233
|
-
The HTTP request `PUT /consents/{ID}` is used by the DFSP or Auth-Service to update a Consent object once it has been Verified.
|
|
1234
|
-
Called by a `auth-service` to notify a DFSP that a credential has been verified and registered.
|
|
1235
|
-
properties:
|
|
1236
|
-
scopes:
|
|
1237
|
-
type: array
|
|
1238
|
-
items:
|
|
1239
|
-
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/scopes/items'
|
|
1240
|
-
status:
|
|
1241
|
-
$ref: '#/paths/~1consents~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/0/status'
|
|
1242
|
-
credential:
|
|
1243
|
-
title: VerifiedCredential
|
|
1244
|
-
type: object
|
|
1245
|
-
description: |
|
|
1246
|
-
A credential used to allow a user to prove their identity and access
|
|
1247
|
-
to an account with a DFSP.
|
|
1248
|
-
|
|
1249
|
-
VerifiedCredential is a special formatting of the credential to allow us to be
|
|
1250
|
-
more explicit about the `status` field - it should only ever be VERIFIED when
|
|
1251
|
-
updating a credential.
|
|
1252
|
-
properties:
|
|
1253
|
-
credentialType:
|
|
1254
|
-
$ref: '#/paths/~1consents~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/0/credential/credentialType'
|
|
1255
|
-
status:
|
|
1256
|
-
type: string
|
|
1257
|
-
enum:
|
|
1258
|
-
- VERIFIED
|
|
1259
|
-
description: 'The Credential is valid, and ready to be used by the PISP.'
|
|
1260
|
-
payload:
|
|
1261
1129
|
title: FIDOPublicKeyCredentialAttestation
|
|
1262
1130
|
type: object
|
|
1263
1131
|
description: |
|
|
1264
|
-
A data model representing a FIDO Attestation result. Derived from
|
|
1132
|
+
A data model representing a FIDO Attestation result. Derived from
|
|
1265
1133
|
[`PublicKeyCredential` Interface](https://w3c.github.io/webauthn/#iface-pkcredential).
|
|
1266
1134
|
|
|
1267
1135
|
The `PublicKeyCredential` interface represents the below fields with
|
|
@@ -1315,8 +1183,50 @@ paths:
|
|
|
1315
1183
|
required:
|
|
1316
1184
|
- credentialType
|
|
1317
1185
|
- status
|
|
1318
|
-
- payload
|
|
1319
1186
|
additionalProperties: false
|
|
1187
|
+
extensionList:
|
|
1188
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
1189
|
+
required:
|
|
1190
|
+
- scopes
|
|
1191
|
+
- credential
|
|
1192
|
+
additionalProperties: false
|
|
1193
|
+
- title: ConsentsIDPutResponseVerified
|
|
1194
|
+
type: object
|
|
1195
|
+
description: |
|
|
1196
|
+
The HTTP request `PUT /consents/{ID}` is used by the DFSP or Auth-Service to update a Consent object once it has been Verified.
|
|
1197
|
+
Called by a `auth-service` to notify a DFSP that a credential has been verified and registered.
|
|
1198
|
+
properties:
|
|
1199
|
+
status:
|
|
1200
|
+
$ref: '#/paths/~1consents~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/0/properties/status'
|
|
1201
|
+
scopes:
|
|
1202
|
+
type: array
|
|
1203
|
+
items:
|
|
1204
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/scopes/items'
|
|
1205
|
+
credential:
|
|
1206
|
+
title: VerifiedCredential
|
|
1207
|
+
type: object
|
|
1208
|
+
description: |
|
|
1209
|
+
A credential used to allow a user to prove their identity and access
|
|
1210
|
+
to an account with a DFSP.
|
|
1211
|
+
|
|
1212
|
+
VerifiedCredential is a special formatting of Credential to allow us to be
|
|
1213
|
+
more explicit about the `status` field - it should only ever be VERIFIED when
|
|
1214
|
+
updating a credential.
|
|
1215
|
+
properties:
|
|
1216
|
+
credentialType:
|
|
1217
|
+
$ref: '#/paths/~1consents~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/0/properties/credential/properties/credentialType'
|
|
1218
|
+
status:
|
|
1219
|
+
$ref: '#/paths/~1consents~1%7BID%7D/patch/requestBody/content/application~1json/schema/oneOf/0/properties/credential/properties/status'
|
|
1220
|
+
genericPayload:
|
|
1221
|
+
$ref: '#/paths/~1consents~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/0/properties/credential/properties/genericPayload'
|
|
1222
|
+
fidoPayload:
|
|
1223
|
+
$ref: '#/paths/~1consents~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/0/properties/credential/properties/fidoPayload'
|
|
1224
|
+
required:
|
|
1225
|
+
- credentialType
|
|
1226
|
+
- status
|
|
1227
|
+
additionalProperties: false
|
|
1228
|
+
extensionList:
|
|
1229
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
1320
1230
|
required:
|
|
1321
1231
|
- scopes
|
|
1322
1232
|
- credential
|
|
@@ -1451,35 +1361,40 @@ paths:
|
|
|
1451
1361
|
application/json:
|
|
1452
1362
|
schema:
|
|
1453
1363
|
title: ThirdpartyRequestsAuthorizationsPostRequest
|
|
1454
|
-
description:
|
|
1364
|
+
description: |-
|
|
1365
|
+
Used by: DFSP
|
|
1366
|
+
The HTTP request POST /thirdpartyRequests/authorizations is used to request the validation by a customer for the transfer described in the request.
|
|
1367
|
+
Callback and data model information for POST /thirdpartyRequests/authorizations:
|
|
1368
|
+
Callback - PUT /thirdpartyRequests/authorizations/{ID} Error Callback - PUT /thirdpartyRequests/authorizations/{ID}/error Data Model - See below url
|
|
1369
|
+
https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
|
1455
1370
|
type: object
|
|
1456
1371
|
properties:
|
|
1457
1372
|
authorizationRequestId:
|
|
1458
|
-
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/consentRequestId'
|
|
1373
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
|
|
1459
1374
|
transactionRequestId:
|
|
1460
|
-
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/consentRequestId'
|
|
1375
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
|
|
1461
1376
|
challenge:
|
|
1462
1377
|
type: string
|
|
1463
1378
|
description: The challenge that the PISP's client is to sign
|
|
1464
1379
|
transferAmount:
|
|
1465
1380
|
allOf:
|
|
1466
|
-
- $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/amount/allOf/0'
|
|
1467
|
-
description: The amount that will be debited from the sending customer
|
|
1381
|
+
- $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/amount/allOf/0'
|
|
1382
|
+
description: The amount that will be debited from the sending customer's account as a consequence of the transaction.
|
|
1468
1383
|
payeeReceiveAmount:
|
|
1469
1384
|
allOf:
|
|
1470
|
-
- $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/amount/allOf/0'
|
|
1471
|
-
description: The amount that will be credited to the receiving customer
|
|
1385
|
+
- $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/amount/allOf/0'
|
|
1386
|
+
description: The amount that will be credited to the receiving customer's account as a consequence of the transaction.
|
|
1472
1387
|
fees:
|
|
1473
1388
|
allOf:
|
|
1474
|
-
- $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/amount/allOf/0'
|
|
1389
|
+
- $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/amount/allOf/0'
|
|
1475
1390
|
description: The amount of fees that the paying customer will be charged as part of the transaction.
|
|
1476
1391
|
payer:
|
|
1477
1392
|
allOf:
|
|
1478
|
-
- $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/payer/allOf/0'
|
|
1393
|
+
- $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/payer/allOf/0'
|
|
1479
1394
|
description: 'Information about the Payer type, id, sub-type/id, FSP Id in the proposed financial transaction.'
|
|
1480
1395
|
payee:
|
|
1481
1396
|
allOf:
|
|
1482
|
-
- $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/payee/allOf/0'
|
|
1397
|
+
- $ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/payee/allOf/0'
|
|
1483
1398
|
description: Information about the Payee in the proposed financial transaction.
|
|
1484
1399
|
transactionType:
|
|
1485
1400
|
title: TransactionType
|
|
@@ -1541,7 +1456,7 @@ paths:
|
|
|
1541
1456
|
description: Data model for the complex type Refund.
|
|
1542
1457
|
properties:
|
|
1543
1458
|
originalTransactionId:
|
|
1544
|
-
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/consentRequestId'
|
|
1459
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
|
|
1545
1460
|
refundReason:
|
|
1546
1461
|
title: RefundReason
|
|
1547
1462
|
type: string
|
|
@@ -1563,40 +1478,10 @@ paths:
|
|
|
1563
1478
|
- initiatorType
|
|
1564
1479
|
expiration:
|
|
1565
1480
|
allOf:
|
|
1566
|
-
- $ref: '#/paths/~1thirdpartyRequests~1transactions~1%7BID%7D/patch/requestBody/content/application~1json/schema/completedTimestamp'
|
|
1481
|
+
- $ref: '#/paths/~1thirdpartyRequests~1transactions~1%7BID%7D/patch/requestBody/content/application~1json/schema/properties/completedTimestamp'
|
|
1567
1482
|
description: 'The time by which the transfer must be completed, set by the payee DFSP.'
|
|
1568
1483
|
extensionList:
|
|
1569
|
-
|
|
1570
|
-
type: object
|
|
1571
|
-
description: 'Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.'
|
|
1572
|
-
properties:
|
|
1573
|
-
extension:
|
|
1574
|
-
type: array
|
|
1575
|
-
items:
|
|
1576
|
-
title: Extension
|
|
1577
|
-
type: object
|
|
1578
|
-
description: Data model for the complex type Extension.
|
|
1579
|
-
properties:
|
|
1580
|
-
key:
|
|
1581
|
-
title: ExtensionKey
|
|
1582
|
-
type: string
|
|
1583
|
-
minLength: 1
|
|
1584
|
-
maxLength: 32
|
|
1585
|
-
description: Extension key.
|
|
1586
|
-
value:
|
|
1587
|
-
title: ExtensionValue
|
|
1588
|
-
type: string
|
|
1589
|
-
minLength: 1
|
|
1590
|
-
maxLength: 128
|
|
1591
|
-
description: Extension value.
|
|
1592
|
-
required:
|
|
1593
|
-
- key
|
|
1594
|
-
- value
|
|
1595
|
-
minItems: 1
|
|
1596
|
-
maxItems: 16
|
|
1597
|
-
description: Number of Extension elements.
|
|
1598
|
-
required:
|
|
1599
|
-
- extension
|
|
1484
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
1600
1485
|
required:
|
|
1601
1486
|
- authorizationRequestId
|
|
1602
1487
|
- transactionRequestId
|
|
@@ -1690,17 +1575,19 @@ paths:
|
|
|
1690
1575
|
application/json:
|
|
1691
1576
|
schema:
|
|
1692
1577
|
oneOf:
|
|
1693
|
-
- title:
|
|
1578
|
+
- title: ThirdpartyRequestsAuthorizationsIDPutResponseRejected
|
|
1694
1579
|
type: object
|
|
1695
1580
|
description: 'The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback.'
|
|
1696
1581
|
properties:
|
|
1697
1582
|
responseType:
|
|
1698
|
-
title:
|
|
1583
|
+
title: AuthorizationResponseTypeRejected
|
|
1699
1584
|
description: |
|
|
1700
1585
|
The customer rejected the terms of the transfer.
|
|
1701
1586
|
type: string
|
|
1702
1587
|
enum:
|
|
1703
1588
|
- REJECTED
|
|
1589
|
+
extensionList:
|
|
1590
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
1704
1591
|
required:
|
|
1705
1592
|
- responseType
|
|
1706
1593
|
- title: ThirdpartyRequestsAuthorizationsIDPutResponseFIDO
|
|
@@ -1715,16 +1602,19 @@ paths:
|
|
|
1715
1602
|
enum:
|
|
1716
1603
|
- ACCEPTED
|
|
1717
1604
|
signedPayload:
|
|
1605
|
+
title: SignedPayloadFIDO
|
|
1718
1606
|
type: object
|
|
1719
1607
|
properties:
|
|
1720
1608
|
signedPayloadType:
|
|
1721
|
-
$ref: '#/paths/~1thirdpartyRequests~1verifications/post/requestBody/content/application~1json/schema/oneOf/0/signedPayloadType'
|
|
1609
|
+
$ref: '#/paths/~1thirdpartyRequests~1verifications/post/requestBody/content/application~1json/schema/oneOf/0/properties/signedPayloadType'
|
|
1722
1610
|
fidoSignedPayload:
|
|
1723
|
-
$ref: '#/paths/~1thirdpartyRequests~1verifications/post/requestBody/content/application~1json/schema/oneOf/0/fidoSignedPayload'
|
|
1611
|
+
$ref: '#/paths/~1thirdpartyRequests~1verifications/post/requestBody/content/application~1json/schema/oneOf/0/properties/fidoSignedPayload'
|
|
1724
1612
|
required:
|
|
1725
1613
|
- signedPayloadType
|
|
1726
1614
|
- fidoSignedPayload
|
|
1727
1615
|
additionalProperties: false
|
|
1616
|
+
extensionList:
|
|
1617
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
1728
1618
|
required:
|
|
1729
1619
|
- responseType
|
|
1730
1620
|
- signedPayload
|
|
@@ -1734,18 +1624,21 @@ paths:
|
|
|
1734
1624
|
description: 'The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback.'
|
|
1735
1625
|
properties:
|
|
1736
1626
|
responseType:
|
|
1737
|
-
$ref: '#/paths/~1thirdpartyRequests~1authorizations~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/1/responseType'
|
|
1627
|
+
$ref: '#/paths/~1thirdpartyRequests~1authorizations~1%7BID%7D/put/requestBody/content/application~1json/schema/oneOf/1/properties/responseType'
|
|
1738
1628
|
signedPayload:
|
|
1629
|
+
title: SignedPayloadGeneric
|
|
1739
1630
|
type: object
|
|
1740
1631
|
properties:
|
|
1741
1632
|
signedPayloadType:
|
|
1742
|
-
$ref: '#/paths/~1thirdpartyRequests~1verifications/post/requestBody/content/application~1json/schema/oneOf/1/signedPayloadType'
|
|
1633
|
+
$ref: '#/paths/~1thirdpartyRequests~1verifications/post/requestBody/content/application~1json/schema/oneOf/1/properties/signedPayloadType'
|
|
1743
1634
|
genericSignedPayload:
|
|
1744
|
-
$ref: '#/paths/~1consentRequests~1%7BID%7D/patch/requestBody/content/application~1json/schema/authToken'
|
|
1635
|
+
$ref: '#/paths/~1consentRequests~1%7BID%7D/patch/requestBody/content/application~1json/schema/properties/authToken'
|
|
1745
1636
|
required:
|
|
1746
1637
|
- signedPayloadType
|
|
1747
1638
|
- genericSignedPayload
|
|
1748
1639
|
additionalProperties: false
|
|
1640
|
+
extensionList:
|
|
1641
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
1749
1642
|
required:
|
|
1750
1643
|
- responseType
|
|
1751
1644
|
- signedPayload
|
|
@@ -1852,13 +1745,18 @@ paths:
|
|
|
1852
1745
|
schema:
|
|
1853
1746
|
title: ThirdpartyRequestsTransactionsPostRequest
|
|
1854
1747
|
type: object
|
|
1855
|
-
description:
|
|
1748
|
+
description: |-
|
|
1749
|
+
Used by: PISP
|
|
1750
|
+
The HTTP request POST /thirdpartyRequests/transactions is used to request the creation of a transaction request on the server for the transfer described in the request.
|
|
1751
|
+
Callback and data model information for POST /thirdpartyRequests/transactions:
|
|
1752
|
+
Callback - PUT /thirdpartyRequests/transactions/{ID} Error Callback - PUT /thirdpartyRequests/transactions/{ID}/error Data Model - See link below
|
|
1753
|
+
https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions
|
|
1856
1754
|
properties:
|
|
1857
1755
|
transactionRequestId:
|
|
1858
1756
|
allOf:
|
|
1859
|
-
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/consentRequestId'
|
|
1757
|
+
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
|
|
1860
1758
|
description: |
|
|
1861
|
-
Common ID between the PISP and the Payer DFSP for the transaction request object. The ID should be reused for resends of the same transaction request.
|
|
1759
|
+
Common ID between the PISP and the Payer DFSP for the transaction request object. The ID should be reused for resends of the same transaction request. A new ID should be generated for each new transaction request.
|
|
1862
1760
|
payee:
|
|
1863
1761
|
allOf:
|
|
1864
1762
|
- title: Party
|
|
@@ -1866,7 +1764,7 @@ paths:
|
|
|
1866
1764
|
description: Data model for the complex type Party.
|
|
1867
1765
|
properties:
|
|
1868
1766
|
partyIdInfo:
|
|
1869
|
-
$ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/payer/allOf/0'
|
|
1767
|
+
$ref: '#/paths/~1thirdpartyRequests~1transactions/post/requestBody/content/application~1json/schema/properties/payer/allOf/0'
|
|
1870
1768
|
merchantClassificationCode:
|
|
1871
1769
|
title: MerchantClassificationCode
|
|
1872
1770
|
type: string
|
|
@@ -1954,7 +1852,7 @@ paths:
|
|
|
1954
1852
|
[RFC 3696](https://tools.ietf.org/html/rfc3696).
|
|
1955
1853
|
- PERSONAL_ID - A personal identifier is used as reference to a participant.
|
|
1956
1854
|
Examples of personal identification are passport number, birth certificate
|
|
1957
|
-
number, and national registration number. The identifier number is added in
|
|
1855
|
+
number, and national registration number. The identifier number is added in
|
|
1958
1856
|
the PartyIdentifier element. The personal identifier type is added in the
|
|
1959
1857
|
PartySubIdOrType element.
|
|
1960
1858
|
- BUSINESS - A specific Business (for example, an organization or a company)
|
|
@@ -1978,12 +1876,12 @@ paths:
|
|
|
1978
1876
|
PartySubIdOrType element for identifying an account under an Alias defined
|
|
1979
1877
|
by the PartyIdentifier.
|
|
1980
1878
|
- CONSENT - A Consent represents an agreement between a PISP, a Customer and
|
|
1981
|
-
a DFSP which allows the PISP permission to perform actions on behalf of the
|
|
1982
|
-
customer. A Consent has an authoritative source: either the DFSP who issued
|
|
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
|
|
1983
1881
|
the Consent, or an Auth Service which administers the Consent.
|
|
1984
1882
|
- THIRD_PARTY_LINK - A Third Party Link represents an agreement between a PISP,
|
|
1985
|
-
a DFSP, and a specific Customer's account at the DFSP. The content of the link
|
|
1986
|
-
is created by the DFSP at the time when it gives permission to the PISP for
|
|
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
|
|
1987
1885
|
specific access to a given account.
|
|
1988
1886
|
example: PERSONAL_ID
|
|
1989
1887
|
partyIdentifier:
|
|
@@ -2006,7 +1904,7 @@ paths:
|
|
|
2006
1904
|
maxLength: 32
|
|
2007
1905
|
description: FSP identifier.
|
|
2008
1906
|
extensionList:
|
|
2009
|
-
$ref: '#/paths/~
|
|
1907
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
2010
1908
|
required:
|
|
2011
1909
|
- partyIdType
|
|
2012
1910
|
- partyIdentifier
|
|
@@ -2031,7 +1929,176 @@ paths:
|
|
|
2031
1929
|
description: Data model for the complex type Money.
|
|
2032
1930
|
properties:
|
|
2033
1931
|
currency:
|
|
2034
|
-
|
|
1932
|
+
title: Currency
|
|
1933
|
+
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
|
+
type: string
|
|
1935
|
+
minLength: 3
|
|
1936
|
+
maxLength: 3
|
|
1937
|
+
enum:
|
|
1938
|
+
- AED
|
|
1939
|
+
- AFN
|
|
1940
|
+
- ALL
|
|
1941
|
+
- AMD
|
|
1942
|
+
- ANG
|
|
1943
|
+
- AOA
|
|
1944
|
+
- ARS
|
|
1945
|
+
- AUD
|
|
1946
|
+
- AWG
|
|
1947
|
+
- AZN
|
|
1948
|
+
- BAM
|
|
1949
|
+
- BBD
|
|
1950
|
+
- BDT
|
|
1951
|
+
- BGN
|
|
1952
|
+
- BHD
|
|
1953
|
+
- BIF
|
|
1954
|
+
- BMD
|
|
1955
|
+
- BND
|
|
1956
|
+
- BOB
|
|
1957
|
+
- BRL
|
|
1958
|
+
- BSD
|
|
1959
|
+
- BTN
|
|
1960
|
+
- BWP
|
|
1961
|
+
- BYN
|
|
1962
|
+
- BZD
|
|
1963
|
+
- CAD
|
|
1964
|
+
- CDF
|
|
1965
|
+
- CHF
|
|
1966
|
+
- CLP
|
|
1967
|
+
- CNY
|
|
1968
|
+
- COP
|
|
1969
|
+
- CRC
|
|
1970
|
+
- CUC
|
|
1971
|
+
- CUP
|
|
1972
|
+
- CVE
|
|
1973
|
+
- CZK
|
|
1974
|
+
- DJF
|
|
1975
|
+
- DKK
|
|
1976
|
+
- DOP
|
|
1977
|
+
- DZD
|
|
1978
|
+
- EGP
|
|
1979
|
+
- ERN
|
|
1980
|
+
- ETB
|
|
1981
|
+
- EUR
|
|
1982
|
+
- FJD
|
|
1983
|
+
- FKP
|
|
1984
|
+
- GBP
|
|
1985
|
+
- GEL
|
|
1986
|
+
- GGP
|
|
1987
|
+
- GHS
|
|
1988
|
+
- GIP
|
|
1989
|
+
- GMD
|
|
1990
|
+
- GNF
|
|
1991
|
+
- GTQ
|
|
1992
|
+
- GYD
|
|
1993
|
+
- HKD
|
|
1994
|
+
- HNL
|
|
1995
|
+
- HRK
|
|
1996
|
+
- HTG
|
|
1997
|
+
- HUF
|
|
1998
|
+
- IDR
|
|
1999
|
+
- ILS
|
|
2000
|
+
- IMP
|
|
2001
|
+
- INR
|
|
2002
|
+
- IQD
|
|
2003
|
+
- IRR
|
|
2004
|
+
- ISK
|
|
2005
|
+
- JEP
|
|
2006
|
+
- JMD
|
|
2007
|
+
- JOD
|
|
2008
|
+
- JPY
|
|
2009
|
+
- KES
|
|
2010
|
+
- KGS
|
|
2011
|
+
- KHR
|
|
2012
|
+
- KMF
|
|
2013
|
+
- KPW
|
|
2014
|
+
- KRW
|
|
2015
|
+
- KWD
|
|
2016
|
+
- KYD
|
|
2017
|
+
- KZT
|
|
2018
|
+
- LAK
|
|
2019
|
+
- LBP
|
|
2020
|
+
- LKR
|
|
2021
|
+
- LRD
|
|
2022
|
+
- LSL
|
|
2023
|
+
- LYD
|
|
2024
|
+
- MAD
|
|
2025
|
+
- MDL
|
|
2026
|
+
- MGA
|
|
2027
|
+
- MKD
|
|
2028
|
+
- MMK
|
|
2029
|
+
- MNT
|
|
2030
|
+
- MOP
|
|
2031
|
+
- MRO
|
|
2032
|
+
- MUR
|
|
2033
|
+
- MVR
|
|
2034
|
+
- MWK
|
|
2035
|
+
- MXN
|
|
2036
|
+
- MYR
|
|
2037
|
+
- MZN
|
|
2038
|
+
- NAD
|
|
2039
|
+
- NGN
|
|
2040
|
+
- NIO
|
|
2041
|
+
- NOK
|
|
2042
|
+
- NPR
|
|
2043
|
+
- NZD
|
|
2044
|
+
- OMR
|
|
2045
|
+
- PAB
|
|
2046
|
+
- PEN
|
|
2047
|
+
- PGK
|
|
2048
|
+
- PHP
|
|
2049
|
+
- PKR
|
|
2050
|
+
- PLN
|
|
2051
|
+
- PYG
|
|
2052
|
+
- QAR
|
|
2053
|
+
- RON
|
|
2054
|
+
- RSD
|
|
2055
|
+
- RUB
|
|
2056
|
+
- RWF
|
|
2057
|
+
- SAR
|
|
2058
|
+
- SBD
|
|
2059
|
+
- SCR
|
|
2060
|
+
- SDG
|
|
2061
|
+
- SEK
|
|
2062
|
+
- SGD
|
|
2063
|
+
- SHP
|
|
2064
|
+
- SLL
|
|
2065
|
+
- SOS
|
|
2066
|
+
- SPL
|
|
2067
|
+
- SRD
|
|
2068
|
+
- STD
|
|
2069
|
+
- SVC
|
|
2070
|
+
- SYP
|
|
2071
|
+
- SZL
|
|
2072
|
+
- THB
|
|
2073
|
+
- TJS
|
|
2074
|
+
- TMT
|
|
2075
|
+
- TND
|
|
2076
|
+
- TOP
|
|
2077
|
+
- TRY
|
|
2078
|
+
- TTD
|
|
2079
|
+
- TVD
|
|
2080
|
+
- TWD
|
|
2081
|
+
- TZS
|
|
2082
|
+
- UAH
|
|
2083
|
+
- UGX
|
|
2084
|
+
- USD
|
|
2085
|
+
- UYU
|
|
2086
|
+
- UZS
|
|
2087
|
+
- VEF
|
|
2088
|
+
- VND
|
|
2089
|
+
- VUV
|
|
2090
|
+
- WST
|
|
2091
|
+
- XAF
|
|
2092
|
+
- XCD
|
|
2093
|
+
- XDR
|
|
2094
|
+
- XOF
|
|
2095
|
+
- XPF
|
|
2096
|
+
- XTS
|
|
2097
|
+
- XXX
|
|
2098
|
+
- YER
|
|
2099
|
+
- ZAR
|
|
2100
|
+
- ZMW
|
|
2101
|
+
- ZWD
|
|
2035
2102
|
amount:
|
|
2036
2103
|
title: Amount
|
|
2037
2104
|
type: string
|
|
@@ -2044,7 +2111,7 @@ paths:
|
|
|
2044
2111
|
description: Requested amount to be transferred from the Payer to Payee.
|
|
2045
2112
|
transactionType:
|
|
2046
2113
|
allOf:
|
|
2047
|
-
- $ref: '#/paths/~1thirdpartyRequests~1authorizations/post/requestBody/content/application~1json/schema/transactionType'
|
|
2114
|
+
- $ref: '#/paths/~1thirdpartyRequests~1authorizations/post/requestBody/content/application~1json/schema/properties/transactionType'
|
|
2048
2115
|
description: Type of transaction.
|
|
2049
2116
|
note:
|
|
2050
2117
|
type: string
|
|
@@ -2056,6 +2123,8 @@ paths:
|
|
|
2056
2123
|
description: |
|
|
2057
2124
|
Date and time until when the transaction request is valid. It can be set to get a quick failure in case the peer FSP takes too long to respond.
|
|
2058
2125
|
example: '2016-05-24T08:38:08.699-04:00'
|
|
2126
|
+
extensionList:
|
|
2127
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
2059
2128
|
required:
|
|
2060
2129
|
- transactionRequestId
|
|
2061
2130
|
- payee
|
|
@@ -2145,7 +2214,10 @@ paths:
|
|
|
2145
2214
|
schema:
|
|
2146
2215
|
title: ThirdpartyRequestsTransactionsIDPutResponse
|
|
2147
2216
|
type: object
|
|
2148
|
-
description:
|
|
2217
|
+
description: |-
|
|
2218
|
+
Used by: DFSP
|
|
2219
|
+
After a PISP requests the creation of a Third Party Transaction request (POST /thirdpartyRequests/transactions) or the status of a previously created Third Party Transaction request (GET /thirdpartyRequests/transactions/{ID}), the DFSP will send this callback.
|
|
2220
|
+
https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
|
|
2149
2221
|
properties:
|
|
2150
2222
|
transactionRequestState:
|
|
2151
2223
|
title: TransactionRequestState
|
|
@@ -2162,6 +2234,8 @@ paths:
|
|
|
2162
2234
|
- ACCEPTED - Payer has approved the transaction.
|
|
2163
2235
|
- REJECTED - Payer has rejected the transaction.
|
|
2164
2236
|
example: RECEIVED
|
|
2237
|
+
extensionList:
|
|
2238
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
2165
2239
|
required:
|
|
2166
2240
|
- transactionRequestState
|
|
2167
2241
|
example:
|
|
@@ -2205,7 +2279,12 @@ paths:
|
|
|
2205
2279
|
schema:
|
|
2206
2280
|
title: ThirdpartyRequestsTransactionsIDPatchResponse
|
|
2207
2281
|
type: object
|
|
2208
|
-
description:
|
|
2282
|
+
description: |-
|
|
2283
|
+
Used by: DFSP
|
|
2284
|
+
The issuing PISP will expect a response to their request for a transfer which describes the finalized state of the requested transfer.
|
|
2285
|
+
This response will be given by a PATCH call on the /thirdpartyRequests/transactions/{ID} resource.
|
|
2286
|
+
The {ID} given in the query string should be the transactionRequestId which was originally used by the PISP to identify the transaction request.
|
|
2287
|
+
https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
|
2209
2288
|
properties:
|
|
2210
2289
|
completedTimestamp:
|
|
2211
2290
|
title: DateTime
|
|
@@ -2214,7 +2293,7 @@ paths:
|
|
|
2214
2293
|
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).'
|
|
2215
2294
|
example: '2016-05-24T08:38:08.699-04:00'
|
|
2216
2295
|
transactionRequestState:
|
|
2217
|
-
$ref: '#/paths/~1thirdpartyRequests~1transactions~1%7BID%7D/put/requestBody/content/application~1json/schema/transactionRequestState'
|
|
2296
|
+
$ref: '#/paths/~1thirdpartyRequests~1transactions~1%7BID%7D/put/requestBody/content/application~1json/schema/properties/transactionRequestState'
|
|
2218
2297
|
transactionState:
|
|
2219
2298
|
title: TransactionState
|
|
2220
2299
|
type: string
|
|
@@ -2230,6 +2309,8 @@ paths:
|
|
|
2230
2309
|
- COMPLETED - Payee FSP has successfully performed the transaction.
|
|
2231
2310
|
- REJECTED - Payee FSP has failed to perform the transaction.
|
|
2232
2311
|
example: RECEIVED
|
|
2312
|
+
extensionList:
|
|
2313
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
2233
2314
|
required:
|
|
2234
2315
|
- transactionRequestState
|
|
2235
2316
|
- transactionState
|
|
@@ -2341,13 +2422,13 @@ paths:
|
|
|
2341
2422
|
properties:
|
|
2342
2423
|
verificationRequestId:
|
|
2343
2424
|
allOf:
|
|
2344
|
-
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/consentRequestId'
|
|
2425
|
+
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
|
|
2345
2426
|
challenge:
|
|
2346
2427
|
type: string
|
|
2347
2428
|
description: Base64 encoded bytes - The challenge generated by the DFSP.
|
|
2348
2429
|
consentId:
|
|
2349
2430
|
allOf:
|
|
2350
|
-
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/consentRequestId'
|
|
2431
|
+
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
|
|
2351
2432
|
description: |
|
|
2352
2433
|
The id of the stored consent object that contains the credential with which to verify
|
|
2353
2434
|
the signed challenge against.
|
|
@@ -2361,9 +2442,14 @@ paths:
|
|
|
2361
2442
|
title: FIDOPublicKeyCredentialAssertion
|
|
2362
2443
|
type: object
|
|
2363
2444
|
description: |
|
|
2364
|
-
|
|
2365
|
-
|
|
2366
|
-
|
|
2445
|
+
A data model representing a FIDO Assertion result.
|
|
2446
|
+
Derived from PublicKeyCredential Interface in WebAuthN.
|
|
2447
|
+
|
|
2448
|
+
The PublicKeyCredential interface represents the below fields with a Type of
|
|
2449
|
+
Javascript ArrayBuffer.
|
|
2450
|
+
For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
|
|
2451
|
+
|
|
2452
|
+
https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
|
|
2367
2453
|
properties:
|
|
2368
2454
|
id:
|
|
2369
2455
|
type: string
|
|
@@ -2424,6 +2510,8 @@ paths:
|
|
|
2424
2510
|
- response
|
|
2425
2511
|
- type
|
|
2426
2512
|
additionalProperties: false
|
|
2513
|
+
extensionList:
|
|
2514
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
2427
2515
|
required:
|
|
2428
2516
|
- verificationRequestId
|
|
2429
2517
|
- challenge
|
|
@@ -2436,13 +2524,13 @@ paths:
|
|
|
2436
2524
|
properties:
|
|
2437
2525
|
verificationRequestId:
|
|
2438
2526
|
allOf:
|
|
2439
|
-
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/consentRequestId'
|
|
2527
|
+
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
|
|
2440
2528
|
challenge:
|
|
2441
2529
|
type: string
|
|
2442
2530
|
description: Base64 encoded bytes - The challenge generated by the DFSP.
|
|
2443
2531
|
consentId:
|
|
2444
2532
|
allOf:
|
|
2445
|
-
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/consentRequestId'
|
|
2533
|
+
- $ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/consentRequestId'
|
|
2446
2534
|
description: |
|
|
2447
2535
|
The id of the stored consent object that contains the credential with which to verify
|
|
2448
2536
|
the signed challenge against.
|
|
@@ -2453,7 +2541,9 @@ paths:
|
|
|
2453
2541
|
- GENERIC
|
|
2454
2542
|
description: Describes a challenge that has been signed with a private key
|
|
2455
2543
|
genericSignedPayload:
|
|
2456
|
-
$ref: '#/paths/~1consentRequests~1%7BID%7D/patch/requestBody/content/application~1json/schema/authToken'
|
|
2544
|
+
$ref: '#/paths/~1consentRequests~1%7BID%7D/patch/requestBody/content/application~1json/schema/properties/authToken'
|
|
2545
|
+
extensionList:
|
|
2546
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
2457
2547
|
required:
|
|
2458
2548
|
- verificationRequestId
|
|
2459
2549
|
- challenge
|
|
@@ -2528,12 +2618,10 @@ paths:
|
|
|
2528
2618
|
- sampled
|
|
2529
2619
|
operationId: PutThirdpartyRequestsVerificationsById
|
|
2530
2620
|
summary: PutThirdpartyRequestsVerificationsById
|
|
2531
|
-
description:
|
|
2532
|
-
The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by the Auth-Service to inform
|
|
2533
|
-
the
|
|
2534
|
-
|
|
2535
|
-
If the validation fails, The Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`
|
|
2536
|
-
instead.
|
|
2621
|
+
description: |-
|
|
2622
|
+
The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by the Auth-Service to inform the DFSP of a successful result in validating the verification of a Thirdparty Transaction Request.
|
|
2623
|
+
If the validation fails, the auth-service will send back `PUT /thirdpartyRequests/verifications/{ID}` with `authenticationResponse: 'REJECTED'`.
|
|
2624
|
+
In unplanned error cases the Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`.
|
|
2537
2625
|
parameters:
|
|
2538
2626
|
- $ref: '#/paths/~1consents/post/parameters/1'
|
|
2539
2627
|
requestBody:
|
|
@@ -2544,13 +2632,21 @@ paths:
|
|
|
2544
2632
|
schema:
|
|
2545
2633
|
title: ThirdpartyRequestsVerificationsIDPutResponse
|
|
2546
2634
|
type: object
|
|
2547
|
-
description:
|
|
2635
|
+
description: |-
|
|
2636
|
+
Used by: Auth Service
|
|
2637
|
+
The callback PUT /thirdpartyRequests/verifications/{ID} is used to inform the client of the result of an authorization check. The {ID} in the URI should contain the authorizationRequestId which was used to request the check, or the {ID} that was used in the GET /thirdpartyRequests/verifications/{ID}.
|
|
2638
|
+
https://github.com/mojaloop/documentation/blob/master/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31821-put-thirdpartyrequestsverificationsid
|
|
2548
2639
|
properties:
|
|
2549
2640
|
authenticationResponse:
|
|
2641
|
+
title: AuthenticationResponse
|
|
2550
2642
|
type: string
|
|
2551
2643
|
enum:
|
|
2552
2644
|
- VERIFIED
|
|
2553
|
-
description:
|
|
2645
|
+
description: |-
|
|
2646
|
+
The AuthenticationResponse enumeration describes the result of authenticating verification request.
|
|
2647
|
+
Below are the allowed values for the enumeration AuthenticationResponse. - VERIFIED - The challenge was correctly signed.
|
|
2648
|
+
extensionList:
|
|
2649
|
+
$ref: '#/paths/~1consentRequests/post/requestBody/content/application~1json/schema/properties/extensionList'
|
|
2554
2650
|
required:
|
|
2555
2651
|
- authenticationResponse
|
|
2556
2652
|
example:
|