@mojaloop/api-snippets 17.2.5 → 17.3.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 +7 -0
- package/audit-ci.jsonc +1 -0
- package/docs/fspiop-rest-v1.0-openapi3-snippets.yaml +204 -805
- package/docs/fspiop-rest-v1.1-openapi3-snippets.yaml +2432 -2447
- package/docs/fspiop-rest-v2.0-openapi3-snippets.yaml +4841 -0
- package/docs/index.html +1 -0
- package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml +103 -345
- package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +150 -492
- package/docs/thirdparty-openapi3-snippets.yaml +296 -886
- package/fspiop/v1_1/openapi3/openapi.yaml +10 -2
- package/fspiop/v2_0/openapi3/components/headers/Content-Length.yaml +9 -0
- package/fspiop/v2_0/openapi3/components/headers/Content-Type.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/parameters/Accept.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/parameters/Content-Length.yaml +11 -0
- package/fspiop/v2_0/openapi3/components/parameters/Content-Type.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/parameters/Date.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-Destination.yaml +13 -0
- package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-Encryption.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +11 -0
- package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-Signature.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-Source.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-URI.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/parameters/ID.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/parameters/SourceCurrency.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/parameters/SubId.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/parameters/TargetCurrency.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/parameters/Type.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/parameters/X-Forwarded-For.yaml +15 -0
- package/fspiop/v2_0/openapi3/components/responses/200.yaml +1 -0
- package/fspiop/v2_0/openapi3/components/responses/202.yaml +1 -0
- package/fspiop/v2_0/openapi3/components/responses/400.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/responses/401.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/responses/403.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/responses/404.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/responses/405.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/responses/406.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/responses/501.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/responses/503.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/schemas/Amount.yaml +11 -0
- package/fspiop/v2_0/openapi3/components/schemas/AmountType.yaml +14 -0
- package/fspiop/v2_0/openapi3/components/schemas/AuthenticationInfo.yaml +11 -0
- package/fspiop/v2_0/openapi3/components/schemas/AuthenticationType.yaml +12 -0
- package/fspiop/v2_0/openapi3/components/schemas/AuthenticationValue.yaml +9 -0
- package/fspiop/v2_0/openapi3/components/schemas/AuthorizationResponse.yaml +12 -0
- package/fspiop/v2_0/openapi3/components/schemas/AuthorizationsIDPutResponse.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/schemas/BalanceOfPayments.yaml +9 -0
- package/fspiop/v2_0/openapi3/components/schemas/BinaryString.yaml +7 -0
- package/fspiop/v2_0/openapi3/components/schemas/BinaryString32.yaml +7 -0
- package/fspiop/v2_0/openapi3/components/schemas/BulkQuotesIDPutResponse.yaml +18 -0
- package/fspiop/v2_0/openapi3/components/schemas/BulkQuotesPostRequest.yaml +25 -0
- package/fspiop/v2_0/openapi3/components/schemas/BulkTransferState.yaml +18 -0
- package/fspiop/v2_0/openapi3/components/schemas/BulkTransfersIDPutResponse.yaml +18 -0
- package/fspiop/v2_0/openapi3/components/schemas/BulkTransfersPostRequest.yaml +30 -0
- package/fspiop/v2_0/openapi3/components/schemas/Code.yaml +5 -0
- package/fspiop/v2_0/openapi3/components/schemas/CorrelationId.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/schemas/Currency.yaml +174 -0
- package/fspiop/v2_0/openapi3/components/schemas/CurrencyConverter.yaml +9 -0
- package/fspiop/v2_0/openapi3/components/schemas/Date.yaml +9 -0
- package/fspiop/v2_0/openapi3/components/schemas/DateOfBirth.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/schemas/DateTime.yaml +14 -0
- package/fspiop/v2_0/openapi3/components/schemas/ErrorCode.yaml +11 -0
- package/fspiop/v2_0/openapi3/components/schemas/ErrorDescription.yaml +5 -0
- package/fspiop/v2_0/openapi3/components/schemas/ErrorInformation.yaml +13 -0
- package/fspiop/v2_0/openapi3/components/schemas/ErrorInformationObject.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/schemas/ErrorInformationResponse.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/schemas/Extension.yaml +11 -0
- package/fspiop/v2_0/openapi3/components/schemas/ExtensionKey.yaml +5 -0
- package/fspiop/v2_0/openapi3/components/schemas/ExtensionList.yaml +15 -0
- package/fspiop/v2_0/openapi3/components/schemas/ExtensionValue.yaml +5 -0
- package/fspiop/v2_0/openapi3/components/schemas/FirstName.yaml +9 -0
- package/fspiop/v2_0/openapi3/components/schemas/FspId.yaml +5 -0
- package/fspiop/v2_0/openapi3/components/schemas/FxCharge.yaml +19 -0
- package/fspiop/v2_0/openapi3/components/schemas/FxConversion.yaml +57 -0
- package/fspiop/v2_0/openapi3/components/schemas/FxMoney.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/schemas/FxQuotesIDPutResponse.yaml +15 -0
- package/fspiop/v2_0/openapi3/components/schemas/FxQuotesPostRequest.yaml +15 -0
- package/fspiop/v2_0/openapi3/components/schemas/FxRate.yaml +15 -0
- package/fspiop/v2_0/openapi3/components/schemas/FxTransfersIDPatchResponse.yaml +16 -0
- package/fspiop/v2_0/openapi3/components/schemas/FxTransfersIDPutResponse.yaml +20 -0
- package/fspiop/v2_0/openapi3/components/schemas/FxTransfersPostRequest.yaml +41 -0
- package/fspiop/v2_0/openapi3/components/schemas/GeoCode.yaml +13 -0
- package/fspiop/v2_0/openapi3/components/schemas/IlpCondition.yaml +5 -0
- package/fspiop/v2_0/openapi3/components/schemas/IlpFulfilment.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/schemas/IlpPacket.yaml +7 -0
- package/fspiop/v2_0/openapi3/components/schemas/IndividualQuote.yaml +29 -0
- package/fspiop/v2_0/openapi3/components/schemas/IndividualQuoteResult.yaml +26 -0
- package/fspiop/v2_0/openapi3/components/schemas/IndividualTransfer.yaml +19 -0
- package/fspiop/v2_0/openapi3/components/schemas/IndividualTransferResult.yaml +14 -0
- package/fspiop/v2_0/openapi3/components/schemas/Integer.yaml +7 -0
- package/fspiop/v2_0/openapi3/components/schemas/KYCInformation.yaml +33 -0
- package/fspiop/v2_0/openapi3/components/schemas/LastName.yaml +9 -0
- package/fspiop/v2_0/openapi3/components/schemas/Latitude.yaml +7 -0
- package/fspiop/v2_0/openapi3/components/schemas/Longitude.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/schemas/MerchantClassificationCode.yaml +7 -0
- package/fspiop/v2_0/openapi3/components/schemas/MiddleName.yaml +9 -0
- package/fspiop/v2_0/openapi3/components/schemas/Money.yaml +11 -0
- package/fspiop/v2_0/openapi3/components/schemas/Name.yaml +17 -0
- package/fspiop/v2_0/openapi3/components/schemas/Note.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/schemas/OtpValue.yaml +7 -0
- package/fspiop/v2_0/openapi3/components/schemas/ParticipantsIDPutResponse.yaml +17 -0
- package/fspiop/v2_0/openapi3/components/schemas/ParticipantsPostRequest.yaml +20 -0
- package/fspiop/v2_0/openapi3/components/schemas/ParticipantsTypeIDPutResponse.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/schemas/ParticipantsTypeIDSubIDPostRequest.yaml +15 -0
- package/fspiop/v2_0/openapi3/components/schemas/PartiesTypeIDPutResponse.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/schemas/Party.yaml +21 -0
- package/fspiop/v2_0/openapi3/components/schemas/PartyComplexName.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/schemas/PartyIdInfo.yaml +19 -0
- package/fspiop/v2_0/openapi3/components/schemas/PartyIdType.yaml +54 -0
- package/fspiop/v2_0/openapi3/components/schemas/PartyIdentifier.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/schemas/PartyName.yaml +5 -0
- package/fspiop/v2_0/openapi3/components/schemas/PartyPersonalInfo.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/schemas/PartyResult.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/schemas/PartySubIdOrType.yaml +7 -0
- package/fspiop/v2_0/openapi3/components/schemas/PersonalIdentifierType.yaml +51 -0
- package/fspiop/v2_0/openapi3/components/schemas/QRCODE.yaml +5 -0
- package/fspiop/v2_0/openapi3/components/schemas/QuotesIDPutResponse.yaml +27 -0
- package/fspiop/v2_0/openapi3/components/schemas/QuotesPostRequest.yaml +53 -0
- package/fspiop/v2_0/openapi3/components/schemas/Refund.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/schemas/RefundReason.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/schemas/ServicesFXPPutResponse.yaml +13 -0
- package/fspiop/v2_0/openapi3/components/schemas/ServicesFXPSourceCurrencyTargetCurrencyPutResponse.yaml +13 -0
- package/fspiop/v2_0/openapi3/components/schemas/TokenCode.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/schemas/Transaction.yaml +50 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionInitiator.yaml +16 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionInitiatorType.yaml +14 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionRequestState.yaml +14 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionRequestsIDPutResponse.yaml +12 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionRequestsPostRequest.yaml +30 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionScenario.yaml +32 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionState.yaml +14 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionSubScenario.yaml +5 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionType.yaml +20 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionsIDPutResponse.yaml +14 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransferState.yaml +19 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransfersIDPatchResponse.yaml +13 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransfersIDPutResponse.yaml +14 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransfersPostRequest.yaml +28 -0
- package/fspiop/v2_0/openapi3/components/schemas/U2FPIN.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/schemas/U2FPinValue.yaml +19 -0
- package/fspiop/v2_0/openapi3/components/schemas/UndefinedEnum.yaml +6 -0
- package/fspiop/v2_0/openapi3/openapi.yaml +136 -0
- package/fspiop/v2_0/openapi3/paths/authorizations_ID.yaml +110 -0
- package/fspiop/v2_0/openapi3/paths/authorizations_ID_error.yaml +48 -0
- package/fspiop/v2_0/openapi3/paths/bulkQuotes.yaml +46 -0
- package/fspiop/v2_0/openapi3/paths/bulkQuotes_ID.yaml +79 -0
- package/fspiop/v2_0/openapi3/paths/bulkQuotes_ID_error.yaml +49 -0
- package/fspiop/v2_0/openapi3/paths/bulkTransfers.yaml +46 -0
- package/fspiop/v2_0/openapi3/paths/bulkTransfers_ID.yaml +81 -0
- package/fspiop/v2_0/openapi3/paths/bulkTransfers_ID_error.yaml +49 -0
- package/fspiop/v2_0/openapi3/paths/fxQuotes.yaml +45 -0
- package/fspiop/v2_0/openapi3/paths/fxQuotes_ID.yaml +79 -0
- package/fspiop/v2_0/openapi3/paths/fxQuotes_ID_error.yaml +49 -0
- package/fspiop/v2_0/openapi3/paths/fxTransfers.yaml +45 -0
- package/fspiop/v2_0/openapi3/paths/fxTransfers_ID.yaml +118 -0
- package/fspiop/v2_0/openapi3/paths/fxTransfers_ID_error.yaml +49 -0
- package/fspiop/v2_0/openapi3/paths/participants.yaml +49 -0
- package/fspiop/v2_0/openapi3/paths/participants_ID.yaml +46 -0
- package/fspiop/v2_0/openapi3/paths/participants_ID_error.yaml +48 -0
- package/fspiop/v2_0/openapi3/paths/participants_Type_ID.yaml +167 -0
- package/fspiop/v2_0/openapi3/paths/participants_Type_ID_SubId.yaml +168 -0
- package/fspiop/v2_0/openapi3/paths/participants_Type_ID_SubId_error.yaml +50 -0
- package/fspiop/v2_0/openapi3/paths/participants_Type_ID_error.yaml +49 -0
- package/fspiop/v2_0/openapi3/paths/parties_Type_ID.yaml +81 -0
- package/fspiop/v2_0/openapi3/paths/parties_Type_ID_SubId.yaml +82 -0
- package/fspiop/v2_0/openapi3/paths/parties_Type_ID_SubId_error.yaml +50 -0
- package/fspiop/v2_0/openapi3/paths/parties_Type_ID_error.yaml +49 -0
- package/fspiop/v2_0/openapi3/paths/quotes.yaml +46 -0
- package/fspiop/v2_0/openapi3/paths/quotes_ID.yaml +79 -0
- package/fspiop/v2_0/openapi3/paths/quotes_ID_error.yaml +49 -0
- package/fspiop/v2_0/openapi3/paths/services_FXP.yaml +73 -0
- package/fspiop/v2_0/openapi3/paths/services_FXP_SourceCurrency_TargetCurrency.yaml +77 -0
- package/fspiop/v2_0/openapi3/paths/transactionRequests.yaml +47 -0
- package/fspiop/v2_0/openapi3/paths/transactionRequests_ID.yaml +81 -0
- package/fspiop/v2_0/openapi3/paths/transactionRequests_ID_error.yaml +50 -0
- package/fspiop/v2_0/openapi3/paths/transactions_ID.yaml +80 -0
- package/fspiop/v2_0/openapi3/paths/transactions_ID_error.yaml +48 -0
- package/fspiop/v2_0/openapi3/paths/transfers.yaml +46 -0
- package/fspiop/v2_0/openapi3/paths/transfers_ID.yaml +119 -0
- package/fspiop/v2_0/openapi3/paths/transfers_ID_error.yaml +49 -0
- package/lib/fspiop/v1_1/openapi.d.ts +524 -542
- package/lib/fspiop/v2_0/openapi.d.ts +3964 -0
- package/lib/fspiop/v2_0/openapi.js +7 -0
- package/lib/fspiop/v2_0/openapi.js.map +1 -0
- package/lib/scripts/json-schema-generator.js +4 -5
- package/lib/scripts/json-schema-generator.js.map +1 -1
- package/lib/scripts/openapi-refactor.d.ts +29 -0
- package/lib/scripts/openapi-refactor.js +70 -0
- package/lib/scripts/openapi-refactor.js.map +1 -0
- package/package.json +29 -21
- package/tsconfig.build.json +1 -1
@@ -19,10 +19,7 @@ servers:
|
|
19
19
|
paths:
|
20
20
|
/interface:
|
21
21
|
post:
|
22
|
-
description:
|
23
|
-
Essential path to include schema definitions that are not used so that
|
24
|
-
these definitions get included into the openapi-cli bundle api
|
25
|
-
definition so that they get converted into typescript definitions.
|
22
|
+
description: Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions.
|
26
23
|
operationId: test
|
27
24
|
requestBody:
|
28
25
|
content:
|
@@ -32,8 +29,7 @@ paths:
|
|
32
29
|
- $ref: '#/components/schemas/ParticipantsIDPutResponse'
|
33
30
|
- $ref: '#/components/schemas/PartiesTypeIDPutResponse'
|
34
31
|
- $ref: '#/components/schemas/QuotesIDPutResponse'
|
35
|
-
- $ref:
|
36
|
-
#/components/schemas/ThirdpartyRequestsTransactionsIDPatchResponse
|
32
|
+
- $ref: '#/components/schemas/ThirdpartyRequestsTransactionsIDPatchResponse'
|
37
33
|
- $ref: '#/components/schemas/AuthorizationResponseType'
|
38
34
|
- $ref: '#/components/schemas/ConsentStatusIssued'
|
39
35
|
- $ref: '#/components/schemas/IlpFulfilment'
|
@@ -62,9 +58,8 @@ paths:
|
|
62
58
|
get:
|
63
59
|
operationId: GetAccountsByUserId
|
64
60
|
summary: GetAccountsByUserId
|
65
|
-
description:
|
66
|
-
The HTTP request `GET /accounts/{ID}` is used to retrieve the list of
|
67
|
-
potential accounts available for linking.
|
61
|
+
description: |
|
62
|
+
The HTTP request `GET /accounts/{ID}` is used to retrieve the list of potential accounts available for linking.
|
68
63
|
tags:
|
69
64
|
- accounts
|
70
65
|
- sampled
|
@@ -90,9 +85,8 @@ paths:
|
|
90
85
|
'503':
|
91
86
|
$ref: '#/components/responses/503'
|
92
87
|
put:
|
93
|
-
description:
|
94
|
-
The HTTP request `PUT /accounts/{ID}` is used to return the list of
|
95
|
-
potential accounts available for linking
|
88
|
+
description: |
|
89
|
+
The HTTP request `PUT /accounts/{ID}` is used to return the list of potential accounts available for linking
|
96
90
|
operationId: UpdateAccountsByUserId
|
97
91
|
summary: UpdateAccountsByUserId
|
98
92
|
tags:
|
@@ -145,9 +139,8 @@ paths:
|
|
145
139
|
- $ref: '#/components/parameters/FSPIOP-URI'
|
146
140
|
- $ref: '#/components/parameters/FSPIOP-HTTP-Method'
|
147
141
|
put:
|
148
|
-
description:
|
149
|
-
The HTTP request `PUT /accounts/{ID}/error` is used to return error
|
150
|
-
information
|
142
|
+
description: |
|
143
|
+
The HTTP request `PUT /accounts/{ID}/error` is used to return error information
|
151
144
|
operationId: UpdateAccountsByUserIdError
|
152
145
|
summary: UpdateAccountsByUserIdError
|
153
146
|
tags:
|
@@ -206,9 +199,7 @@ paths:
|
|
206
199
|
$ref: '#/components/responses/503'
|
207
200
|
operationId: HealthGet
|
208
201
|
summary: Health check endpoint
|
209
|
-
description:
|
210
|
-
The HTTP request GET /health is used to return the current status of the
|
211
|
-
API.
|
202
|
+
description: The HTTP request GET /health is used to return the current status of the API.
|
212
203
|
/metrics:
|
213
204
|
get:
|
214
205
|
tags:
|
@@ -252,12 +243,9 @@ paths:
|
|
252
243
|
- sampled
|
253
244
|
operationId: CreateConsentRequest
|
254
245
|
summary: CreateConsentRequest
|
255
|
-
description:
|
256
|
-
The HTTP request **POST /consentRequests** is used to request a DFSP to
|
257
|
-
|
258
|
-
|
259
|
-
accounts owned by a customer of the DFSP for the PISP who sends the
|
260
|
-
request.
|
246
|
+
description: |
|
247
|
+
The HTTP request **POST /consentRequests** is used to request a DFSP to grant access to one or more
|
248
|
+
accounts owned by a customer of the DFSP for the PISP who sends the request.
|
261
249
|
parameters:
|
262
250
|
- $ref: '#/components/parameters/Accept'
|
263
251
|
- $ref: '#/components/parameters/Content-Length'
|
@@ -302,13 +290,9 @@ paths:
|
|
302
290
|
get:
|
303
291
|
operationId: GetConsentRequestsById
|
304
292
|
summary: GetConsentRequestsById
|
305
|
-
description:
|
306
|
-
The HTTP request `GET /consentRequests/{ID}` is used to get information
|
307
|
-
|
308
|
-
|
309
|
-
requested consent. The *{ID}* in the URI should contain the
|
310
|
-
consentRequestId that was assigned to the
|
311
|
-
|
293
|
+
description: |
|
294
|
+
The HTTP request `GET /consentRequests/{ID}` is used to get information about a previously
|
295
|
+
requested consent. The *{ID}* in the URI should contain the consentRequestId that was assigned to the
|
312
296
|
request by the PISP when the PISP originated the request.
|
313
297
|
tags:
|
314
298
|
- consentRequests
|
@@ -340,28 +324,15 @@ paths:
|
|
340
324
|
- sampled
|
341
325
|
operationId: UpdateConsentRequest
|
342
326
|
summary: UpdateConsentRequest
|
343
|
-
description:
|
344
|
-
A DFSP uses this callback to (1) inform the PISP that the consentRequest
|
345
|
-
|
346
|
-
|
347
|
-
and (2) communicate to the PISP which `authChannel` it should use to
|
348
|
-
authenticate their user
|
349
|
-
|
327
|
+
description: |
|
328
|
+
A DFSP uses this callback to (1) inform the PISP that the consentRequest has been accepted,
|
329
|
+
and (2) communicate to the PISP which `authChannel` it should use to authenticate their user
|
350
330
|
with.
|
351
331
|
|
352
|
-
|
353
|
-
|
354
|
-
|
355
|
-
|
356
|
-
the permissions requested may be granted by the DFSP. Conversely, the
|
357
|
-
out-of-band authorization
|
358
|
-
|
359
|
-
process may result in additional privileges being granted by the
|
360
|
-
account holder to the PISP. The
|
361
|
-
|
362
|
-
**PUT /consentRequests/**_{ID}_ resource returns the current state of
|
363
|
-
the permissions relating to a
|
364
|
-
|
332
|
+
When a PISP requests a series of permissions from a DFSP on behalf of a DFSP’s customer, not all
|
333
|
+
the permissions requested may be granted by the DFSP. Conversely, the out-of-band authorization
|
334
|
+
process may result in additional privileges being granted by the account holder to the PISP. The
|
335
|
+
**PUT /consentRequests/**_{ID}_ resource returns the current state of the permissions relating to a
|
365
336
|
particular authorization request.
|
366
337
|
parameters:
|
367
338
|
- $ref: '#/components/parameters/Content-Length'
|
@@ -398,10 +369,8 @@ paths:
|
|
398
369
|
- sampled
|
399
370
|
operationId: PatchConsentRequest
|
400
371
|
summary: PatchConsentRequest
|
401
|
-
description:
|
402
|
-
After the user completes an out-of-band authorization with the DFSP, the
|
403
|
-
PISP will receive a token which they can use to prove to the DFSP that
|
404
|
-
the user trusts this PISP.
|
372
|
+
description: |
|
373
|
+
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.
|
405
374
|
parameters:
|
406
375
|
- $ref: '#/components/parameters/Accept'
|
407
376
|
- $ref: '#/components/parameters/Content-Length'
|
@@ -448,9 +417,8 @@ paths:
|
|
448
417
|
- sampled
|
449
418
|
operationId: NotifyErrorConsentRequests
|
450
419
|
summary: NotifyErrorConsentRequests
|
451
|
-
description:
|
452
|
-
DFSP responds to the PISP if something went wrong with validating an OTP
|
453
|
-
or secret.
|
420
|
+
description: |
|
421
|
+
DFSP responds to the PISP if something went wrong with validating an OTP or secret.
|
454
422
|
parameters:
|
455
423
|
- $ref: '#/components/parameters/Content-Length'
|
456
424
|
requestBody:
|
@@ -496,10 +464,8 @@ paths:
|
|
496
464
|
- sampled
|
497
465
|
operationId: PostConsents
|
498
466
|
summary: PostConsents
|
499
|
-
description:
|
500
|
-
The **POST /consents** request is used to request the creation of a
|
501
|
-
consent for interactions between a PISP and the DFSP who owns the
|
502
|
-
account which a PISP’s customer wants to allow the PISP access to.
|
467
|
+
description: |
|
468
|
+
The **POST /consents** request is used to request the creation of a consent for interactions between a PISP and the DFSP who owns the account which a PISP’s customer wants to allow the PISP access to.
|
503
469
|
parameters:
|
504
470
|
- $ref: '#/components/parameters/Accept'
|
505
471
|
- $ref: '#/components/parameters/Content-Length'
|
@@ -543,11 +509,8 @@ paths:
|
|
543
509
|
- $ref: '#/components/parameters/FSPIOP-URI'
|
544
510
|
- $ref: '#/components/parameters/FSPIOP-HTTP-Method'
|
545
511
|
get:
|
546
|
-
description:
|
547
|
-
The **GET /consents/**_{ID}_ resource allows a party to enquire after
|
548
|
-
the status of a consent. The *{ID}* used in the URI of the request
|
549
|
-
should be the consent request ID which was used to identify the consent
|
550
|
-
when it was created.
|
512
|
+
description: |
|
513
|
+
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.
|
551
514
|
tags:
|
552
515
|
- consents
|
553
516
|
operationId: GetConsent
|
@@ -574,12 +537,10 @@ paths:
|
|
574
537
|
'503':
|
575
538
|
$ref: '#/components/responses/503'
|
576
539
|
patch:
|
577
|
-
description:
|
540
|
+
description: |
|
578
541
|
The HTTP request `PATCH /consents/{ID}` is used
|
579
542
|
|
580
|
-
|
581
|
-
- In account linking in the Credential Registration phase. Used by a
|
582
|
-
DFSP
|
543
|
+
- In account linking in the Credential Registration phase. Used by a DFSP
|
583
544
|
to notify a PISP a credential has been verified and registered with an
|
584
545
|
Auth service.
|
585
546
|
|
@@ -624,16 +585,11 @@ paths:
|
|
624
585
|
'503':
|
625
586
|
$ref: '#/components/responses/503'
|
626
587
|
put:
|
627
|
-
description:
|
628
|
-
The HTTP request `PUT /consents/{ID}` is used by the PISP and Auth
|
629
|
-
Service.
|
630
|
-
|
631
|
-
|
632
|
-
- Called by a `PISP` to after signing a challenge. Sent to an DFSP for
|
633
|
-
verification.
|
588
|
+
description: |
|
589
|
+
The HTTP request `PUT /consents/{ID}` is used by the PISP and Auth Service.
|
634
590
|
|
635
|
-
- Called by a `
|
636
|
-
verified and registered.
|
591
|
+
- Called by a `PISP` to after signing a challenge. Sent to an DFSP for verification.
|
592
|
+
- Called by a `auth-service` to notify a DFSP that a credential has been verified and registered.
|
637
593
|
tags:
|
638
594
|
- consents
|
639
595
|
- sampled
|
@@ -671,19 +627,12 @@ paths:
|
|
671
627
|
'503':
|
672
628
|
$ref: '#/components/responses/503'
|
673
629
|
delete:
|
674
|
-
description:
|
630
|
+
description: |
|
675
631
|
Used by PISP, DFSP
|
676
632
|
|
677
|
-
|
678
|
-
|
679
|
-
|
680
|
-
|
681
|
-
For tracing and auditing purposes, the switch should be sure not to
|
682
|
-
delete the consent physically;
|
683
|
-
|
684
|
-
instead, information relating to the consent should be marked as deleted
|
685
|
-
and requests relating to the
|
686
|
-
|
633
|
+
The **DELETE /consents/**_{ID}_ request is used to request the revocation of a previously agreed consent.
|
634
|
+
For tracing and auditing purposes, the switch should be sure not to delete the consent physically;
|
635
|
+
instead, information relating to the consent should be marked as deleted and requests relating to the
|
687
636
|
consent should not be honoured.
|
688
637
|
operationId: DeleteConsentByID
|
689
638
|
parameters:
|
@@ -727,9 +676,8 @@ paths:
|
|
727
676
|
- sampled
|
728
677
|
operationId: NotifyErrorConsents
|
729
678
|
summary: NotifyErrorConsents
|
730
|
-
description:
|
731
|
-
DFSP responds to the PISP if something went wrong with validating or
|
732
|
-
storing consent.
|
679
|
+
description: |
|
680
|
+
DFSP responds to the PISP if something went wrong with validating or storing consent.
|
733
681
|
parameters:
|
734
682
|
- $ref: '#/components/parameters/Content-Length'
|
735
683
|
requestBody:
|
@@ -770,12 +718,7 @@ paths:
|
|
770
718
|
- $ref: '#/components/parameters/FSPIOP-URI'
|
771
719
|
- $ref: '#/components/parameters/FSPIOP-HTTP-Method'
|
772
720
|
post:
|
773
|
-
description:
|
774
|
-
The HTTP request `POST /participants` is used to create information in
|
775
|
-
the server regarding the provided list of identities. This request
|
776
|
-
should be used for bulk creation of FSP information for more than one
|
777
|
-
Party. The optional currency parameter should indicate that each
|
778
|
-
provided Party supports the currency.
|
721
|
+
description: The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency.
|
779
722
|
summary: Create bulk participant information
|
780
723
|
tags:
|
781
724
|
- participants
|
@@ -823,9 +766,7 @@ paths:
|
|
823
766
|
- $ref: '#/components/parameters/FSPIOP-URI'
|
824
767
|
- $ref: '#/components/parameters/FSPIOP-HTTP-Method'
|
825
768
|
put:
|
826
|
-
description:
|
827
|
-
The callback `PUT /participants/{ID}` is used to inform the client of
|
828
|
-
the result of the creation of the provided list of identities.
|
769
|
+
description: The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
|
829
770
|
summary: Return bulk participant information
|
830
771
|
tags:
|
831
772
|
- participants
|
@@ -872,11 +813,7 @@ paths:
|
|
872
813
|
- $ref: '#/components/parameters/FSPIOP-URI'
|
873
814
|
- $ref: '#/components/parameters/FSPIOP-HTTP-Method'
|
874
815
|
put:
|
875
|
-
description:
|
876
|
-
If there is an error during FSP information creation in the server, the
|
877
|
-
error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the
|
878
|
-
URI should contain the requestId that was used for the creation of the
|
879
|
-
participant information.
|
816
|
+
description: If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information.
|
880
817
|
summary: Return bulk participant information error
|
881
818
|
tags:
|
882
819
|
- participants
|
@@ -924,13 +861,7 @@ paths:
|
|
924
861
|
- $ref: '#/components/parameters/FSPIOP-URI'
|
925
862
|
- $ref: '#/components/parameters/FSPIOP-HTTP-Method'
|
926
863
|
post:
|
927
|
-
description:
|
928
|
-
The HTTP request `POST /participants/{Type}/{ID}` (or `POST
|
929
|
-
/participants/{Type}/{ID}/{SubId}`) is used to create information in the
|
930
|
-
server regarding the provided identity, defined by `{Type}`, `{ID}`, and
|
931
|
-
optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789`
|
932
|
-
or `POST /participants/BUSINESS/shoecompany/employee1`). An
|
933
|
-
ExtensionList element has been added to this reqeust in version v1.1
|
864
|
+
description: The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1
|
934
865
|
summary: Create participant information
|
935
866
|
tags:
|
936
867
|
- participants
|
@@ -966,15 +897,7 @@ paths:
|
|
966
897
|
'503':
|
967
898
|
$ref: '#/components/responses/503'
|
968
899
|
get:
|
969
|
-
description:
|
970
|
-
The HTTP request `GET /participants/{Type}/{ID}` (or `GET
|
971
|
-
/participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the
|
972
|
-
requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`,
|
973
|
-
is located (for example, `GET /participants/MSISDN/123456789`, or `GET
|
974
|
-
/participants/BUSINESS/shoecompany/employee1`). This HTTP request should
|
975
|
-
support a query string for filtering of currency. To use filtering of
|
976
|
-
currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ`
|
977
|
-
should be used, where `XYZ` is the requested currency.
|
900
|
+
description: The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
|
978
901
|
summary: Look up participant information
|
979
902
|
tags:
|
980
903
|
- participants
|
@@ -1001,13 +924,7 @@ paths:
|
|
1001
924
|
'503':
|
1002
925
|
$ref: '#/components/responses/503'
|
1003
926
|
put:
|
1004
|
-
description:
|
1005
|
-
The callback `PUT /participants/{Type}/{ID}` (or `PUT
|
1006
|
-
/participants/{Type}/{ID}/{SubId}`) is used to inform the client of a
|
1007
|
-
successful result of the lookup, creation, or deletion of the FSP
|
1008
|
-
information related to the Party. If the FSP information is deleted, the
|
1009
|
-
fspId element should be empty; otherwise the element should include the
|
1010
|
-
FSP information for the Party.
|
927
|
+
description: The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party.
|
1011
928
|
summary: Return participant information
|
1012
929
|
tags:
|
1013
930
|
- participants
|
@@ -1041,20 +958,10 @@ paths:
|
|
1041
958
|
'503':
|
1042
959
|
$ref: '#/components/responses/503'
|
1043
960
|
delete:
|
1044
|
-
description:
|
1045
|
-
The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE
|
1046
|
-
/participants/{Type}/{ID}/{SubId}`) is used to delete information in the
|
1047
|
-
server regarding the provided identity, defined by `{Type}` and `{ID}`)
|
1048
|
-
(for example, `DELETE /participants/MSISDN/123456789`), and optionally
|
1049
|
-
`{SubId}`. This HTTP request should support a query string to delete FSP
|
1050
|
-
information regarding a specific currency only. To delete a specific
|
1051
|
-
currency only, the HTTP request `DELETE
|
1052
|
-
/participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is
|
1053
|
-
the requested currency.
|
1054
|
-
|
961
|
+
description: |-
|
962
|
+
The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
|
1055
963
|
|
1056
|
-
**Note:** The Account Lookup System should verify that it is the Party’s
|
1057
|
-
current FSP that is deleting the FSP information.
|
964
|
+
**Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
1058
965
|
summary: Delete participant information
|
1059
966
|
tags:
|
1060
967
|
- participants
|
@@ -1094,11 +1001,7 @@ paths:
|
|
1094
1001
|
- $ref: '#/components/parameters/FSPIOP-URI'
|
1095
1002
|
- $ref: '#/components/parameters/FSPIOP-HTTP-Method'
|
1096
1003
|
put:
|
1097
|
-
description:
|
1098
|
-
If the server is unable to find, create or delete the associated FSP of
|
1099
|
-
the provided identity, or another processing error occurred, the error
|
1100
|
-
callback `PUT /participants/{Type}/{ID}/error` (or `PUT
|
1101
|
-
/participants/{Type}/{ID}/{SubId}/error`) is used.
|
1004
|
+
description: If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used.
|
1102
1005
|
summary: Return participant information error
|
1103
1006
|
tags:
|
1104
1007
|
- participants
|
@@ -1147,10 +1050,8 @@ paths:
|
|
1147
1050
|
get:
|
1148
1051
|
operationId: GetServicesByServiceType
|
1149
1052
|
summary: GetServicesByServiceType
|
1150
|
-
description:
|
1151
|
-
The HTTP request `GET /services/{ServiceType}` is used to retrieve the
|
1152
|
-
list of participants
|
1153
|
-
|
1053
|
+
description: |
|
1054
|
+
The HTTP request `GET /services/{ServiceType}` is used to retrieve the list of participants
|
1154
1055
|
that support a specified service.
|
1155
1056
|
parameters:
|
1156
1057
|
- $ref: '#/components/parameters/Accept'
|
@@ -1177,10 +1078,8 @@ paths:
|
|
1177
1078
|
'503':
|
1178
1079
|
$ref: '#/components/responses/503'
|
1179
1080
|
put:
|
1180
|
-
description:
|
1181
|
-
The HTTP request `PUT /services/{ServiceType}` is used to return list of
|
1182
|
-
participants
|
1183
|
-
|
1081
|
+
description: |
|
1082
|
+
The HTTP request `PUT /services/{ServiceType}` is used to return list of participants
|
1184
1083
|
that support a specified service.
|
1185
1084
|
operationId: PutServicesByServiceType
|
1186
1085
|
summary: PutServicesByServiceType
|
@@ -1227,9 +1126,8 @@ paths:
|
|
1227
1126
|
- $ref: '#/components/parameters/FSPIOP-URI'
|
1228
1127
|
- $ref: '#/components/parameters/FSPIOP-HTTP-Method'
|
1229
1128
|
put:
|
1230
|
-
description:
|
1231
|
-
The HTTP request `PUT /services/{ServiceType}/error` is used to return
|
1232
|
-
error information
|
1129
|
+
description: |
|
1130
|
+
The HTTP request `PUT /services/{ServiceType}/error` is used to return error information
|
1233
1131
|
operationId: PutServicesByServiceTypeAndError
|
1234
1132
|
summary: PutServicesByServiceTypeAndError
|
1235
1133
|
tags:
|
@@ -1277,9 +1175,7 @@ paths:
|
|
1277
1175
|
post:
|
1278
1176
|
operationId: ThirdpartyRequestsTransactionsPost
|
1279
1177
|
summary: ThirdpartyRequestsTransactionsPost
|
1280
|
-
description:
|
1281
|
-
The HTTP request POST `/thirdpartyRequests/transactions` is used by a
|
1282
|
-
PISP to initiate a 3rd party Transaction request with a DFSP
|
1178
|
+
description: The HTTP request POST `/thirdpartyRequests/transactions` is used by a PISP to initiate a 3rd party Transaction request with a DFSP
|
1283
1179
|
tags:
|
1284
1180
|
- thirdpartyRequests
|
1285
1181
|
- sampled
|
@@ -1330,10 +1226,8 @@ paths:
|
|
1330
1226
|
- sampled
|
1331
1227
|
operationId: GetThirdpartyTransactionRequests
|
1332
1228
|
summary: GetThirdpartyTransactionRequests
|
1333
|
-
description:
|
1334
|
-
The HTTP request `GET /thirdpartyRequests/transactions/{ID}` is used to
|
1335
|
-
request the
|
1336
|
-
|
1229
|
+
description: |
|
1230
|
+
The HTTP request `GET /thirdpartyRequests/transactions/{ID}` is used to request the
|
1337
1231
|
retrieval of a third party transaction request.
|
1338
1232
|
parameters:
|
1339
1233
|
- $ref: '#/components/parameters/Accept'
|
@@ -1362,13 +1256,10 @@ paths:
|
|
1362
1256
|
- sampled
|
1363
1257
|
operationId: UpdateThirdPartyTransactionRequests
|
1364
1258
|
summary: UpdateThirdPartyTransactionRequests
|
1365
|
-
description:
|
1366
|
-
The HTTP request `PUT /thirdpartyRequests/transactions/{ID}` is used by
|
1367
|
-
the DFSP to inform the client about
|
1368
|
-
|
1259
|
+
description: |
|
1260
|
+
The HTTP request `PUT /thirdpartyRequests/transactions/{ID}` is used by the DFSP to inform the client about
|
1369
1261
|
the status of a previously requested thirdparty transaction request.
|
1370
1262
|
|
1371
|
-
|
1372
1263
|
Switch(Thirdparty API Adapter) -> PISP
|
1373
1264
|
parameters:
|
1374
1265
|
- $ref: '#/components/parameters/Content-Length'
|
@@ -1402,13 +1293,10 @@ paths:
|
|
1402
1293
|
patch:
|
1403
1294
|
operationId: NotifyThirdpartyTransactionRequests
|
1404
1295
|
summary: NotifyThirdpartyTransactionRequests
|
1405
|
-
description:
|
1406
|
-
The HTTP request `PATCH /thirdpartyRequests/transactions/{ID}` is used
|
1407
|
-
to
|
1408
|
-
|
1296
|
+
description: |
|
1297
|
+
The HTTP request `PATCH /thirdpartyRequests/transactions/{ID}` is used to
|
1409
1298
|
notify a thirdparty of the outcome of a transaction request.
|
1410
1299
|
|
1411
|
-
|
1412
1300
|
Switch(Thirdparty API Adapter) -> PISP
|
1413
1301
|
tags:
|
1414
1302
|
- thirdpartyRequests
|
@@ -1420,8 +1308,7 @@ paths:
|
|
1420
1308
|
content:
|
1421
1309
|
application/json:
|
1422
1310
|
schema:
|
1423
|
-
$ref:
|
1424
|
-
#/components/schemas/ThirdpartyRequestsTransactionsIDPatchResponse
|
1311
|
+
$ref: '#/components/schemas/ThirdpartyRequestsTransactionsIDPatchResponse'
|
1425
1312
|
example:
|
1426
1313
|
transactionRequestState: ACCEPTED
|
1427
1314
|
transactionState: COMMITTED
|
@@ -1462,16 +1349,10 @@ paths:
|
|
1462
1349
|
- sampled
|
1463
1350
|
operationId: ThirdpartyTransactionRequestsError
|
1464
1351
|
summary: ThirdpartyTransactionRequestsError
|
1465
|
-
description:
|
1466
|
-
If the server is unable to find the transaction request, or another
|
1467
|
-
|
1468
|
-
|
1469
|
-
the error callback `PUT /thirdpartyRequests/transactions/{ID}/error` is
|
1470
|
-
used.
|
1471
|
-
|
1472
|
-
The `{ID}` in the URI should contain the `transactionRequestId` that was
|
1473
|
-
used for the creation of
|
1474
|
-
|
1352
|
+
description: |
|
1353
|
+
If the server is unable to find the transaction request, or another processing error occurs,
|
1354
|
+
the error callback `PUT /thirdpartyRequests/transactions/{ID}/error` is used.
|
1355
|
+
The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of
|
1475
1356
|
the thirdparty transaction request.
|
1476
1357
|
parameters:
|
1477
1358
|
- $ref: '#/components/parameters/Content-Length'
|
@@ -1513,10 +1394,8 @@ paths:
|
|
1513
1394
|
- $ref: '#/components/parameters/FSPIOP-URI'
|
1514
1395
|
- $ref: '#/components/parameters/FSPIOP-HTTP-Method'
|
1515
1396
|
post:
|
1516
|
-
description:
|
1517
|
-
The HTTP request **POST /thirdpartyRequests/authorizations** is used to
|
1518
|
-
request the validation by a customer for the transfer described in the
|
1519
|
-
request.
|
1397
|
+
description: |
|
1398
|
+
The HTTP request **POST /thirdpartyRequests/authorizations** is used to request the validation by a customer for the transfer described in the request.
|
1520
1399
|
operationId: PostThirdpartyRequestsAuthorizations
|
1521
1400
|
summary: PostThirdpartyRequestsAuthorizations
|
1522
1401
|
tags:
|
@@ -1564,15 +1443,10 @@ paths:
|
|
1564
1443
|
- $ref: '#/components/parameters/FSPIOP-URI'
|
1565
1444
|
- $ref: '#/components/parameters/FSPIOP-HTTP-Method'
|
1566
1445
|
get:
|
1567
|
-
description:
|
1568
|
-
The HTTP request **GET /thirdpartyRequests/authorizations/**_{ID}_ is
|
1569
|
-
|
1570
|
-
|
1571
|
-
to a previously issued authorization request. The *{ID}* in the request
|
1572
|
-
should match the
|
1573
|
-
|
1574
|
-
`authorizationRequestId` which was given when the authorization request
|
1575
|
-
was created.
|
1446
|
+
description: |
|
1447
|
+
The HTTP request **GET /thirdpartyRequests/authorizations/**_{ID}_ is used to get information relating
|
1448
|
+
to a previously issued authorization request. The *{ID}* in the request should match the
|
1449
|
+
`authorizationRequestId` which was given when the authorization request was created.
|
1576
1450
|
operationId: GetThirdpartyRequestsAuthorizationsById
|
1577
1451
|
summary: GetThirdpartyRequestsAuthorizationsById
|
1578
1452
|
tags:
|
@@ -1600,18 +1474,12 @@ paths:
|
|
1600
1474
|
'503':
|
1601
1475
|
$ref: '#/components/responses/503'
|
1602
1476
|
put:
|
1603
|
-
description:
|
1604
|
-
After receiving the **POST /thirdpartyRequests/authorizations**, the
|
1605
|
-
|
1606
|
-
|
1607
|
-
transaction to their user, and request that the client sign the
|
1608
|
-
`challenge` field using the credential
|
1609
|
-
|
1477
|
+
description: |
|
1478
|
+
After receiving the **POST /thirdpartyRequests/authorizations**, the PISP will present the details of the
|
1479
|
+
transaction to their user, and request that the client sign the `challenge` field using the credential
|
1610
1480
|
they previously registered.
|
1611
1481
|
|
1612
|
-
|
1613
|
-
The signed challenge will be sent back by the PISP in **PUT
|
1614
|
-
/thirdpartyRequests/authorizations/**_{ID}_:
|
1482
|
+
The signed challenge will be sent back by the PISP in **PUT /thirdpartyRequests/authorizations/**_{ID}_:
|
1615
1483
|
operationId: PutThirdpartyRequestsAuthorizationsById
|
1616
1484
|
summary: PutThirdpartyRequestsAuthorizationsById
|
1617
1485
|
tags:
|
@@ -1625,12 +1493,9 @@ paths:
|
|
1625
1493
|
application/json:
|
1626
1494
|
schema:
|
1627
1495
|
oneOf:
|
1628
|
-
- $ref:
|
1629
|
-
|
1630
|
-
- $ref:
|
1631
|
-
#/components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseFIDO
|
1632
|
-
- $ref: >-
|
1633
|
-
#/components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseGeneric
|
1496
|
+
- $ref: '#/components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseRejected'
|
1497
|
+
- $ref: '#/components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseFIDO'
|
1498
|
+
- $ref: '#/components/schemas/ThirdpartyRequestsAuthorizationsIDPutResponseGeneric'
|
1634
1499
|
responses:
|
1635
1500
|
'200':
|
1636
1501
|
$ref: '#/components/responses/200'
|
@@ -1668,23 +1533,14 @@ paths:
|
|
1668
1533
|
- sampled
|
1669
1534
|
operationId: PutThirdpartyRequestsAuthorizationsByIdAndError
|
1670
1535
|
summary: PutThirdpartyRequestsAuthorizationsByIdAndError
|
1671
|
-
description:
|
1672
|
-
The HTTP request `PUT /thirdpartyRequests/authorizations/{ID}/error` is
|
1673
|
-
|
1674
|
-
|
1675
|
-
the other party that something went wrong with a Thirdparty Transaction
|
1676
|
-
Authorization Request.
|
1677
|
-
|
1678
|
-
|
1679
|
-
The PISP may use this to tell the DFSP that the Thirdparty Transaction
|
1680
|
-
Authorization Request is invalid or doesn't
|
1536
|
+
description: |
|
1537
|
+
The HTTP request `PUT /thirdpartyRequests/authorizations/{ID}/error` is used by the DFSP or PISP to inform
|
1538
|
+
the other party that something went wrong with a Thirdparty Transaction Authorization Request.
|
1681
1539
|
|
1540
|
+
The PISP may use this to tell the DFSP that the Thirdparty Transaction Authorization Request is invalid or doesn't
|
1682
1541
|
match a `transactionRequestId`.
|
1683
1542
|
|
1684
|
-
|
1685
|
-
The DFSP may use this to tell the PISP that the signed challenge
|
1686
|
-
returned in `PUT /thirdpartyRequest/authorizations/{ID}`
|
1687
|
-
|
1543
|
+
The DFSP may use this to tell the PISP that the signed challenge returned in `PUT /thirdpartyRequest/authorizations/{ID}`
|
1688
1544
|
was invalid.
|
1689
1545
|
parameters:
|
1690
1546
|
- $ref: '#/components/parameters/Content-Length'
|
@@ -1731,9 +1587,8 @@ paths:
|
|
1731
1587
|
- sampled
|
1732
1588
|
operationId: PostThirdpartyRequestsVerifications
|
1733
1589
|
summary: PostThirdpartyRequestsVerifications
|
1734
|
-
description:
|
1735
|
-
The HTTP request `POST /thirdpartyRequests/verifications` is used by the
|
1736
|
-
DFSP to verify a third party authorization.
|
1590
|
+
description: |
|
1591
|
+
The HTTP request `POST /thirdpartyRequests/verifications` is used by the DFSP to verify a third party authorization.
|
1737
1592
|
parameters:
|
1738
1593
|
- $ref: '#/components/parameters/Accept'
|
1739
1594
|
- $ref: '#/components/parameters/Content-Length'
|
@@ -1744,10 +1599,8 @@ paths:
|
|
1744
1599
|
application/json:
|
1745
1600
|
schema:
|
1746
1601
|
oneOf:
|
1747
|
-
- $ref:
|
1748
|
-
|
1749
|
-
- $ref: >-
|
1750
|
-
#/components/schemas/ThirdpartyRequestsVerificationsPostRequestGeneric
|
1602
|
+
- $ref: '#/components/schemas/ThirdpartyRequestsVerificationsPostRequestFIDO'
|
1603
|
+
- $ref: '#/components/schemas/ThirdpartyRequestsVerificationsPostRequestGeneric'
|
1751
1604
|
responses:
|
1752
1605
|
'202':
|
1753
1606
|
$ref: '#/components/responses/202'
|
@@ -1785,12 +1638,9 @@ paths:
|
|
1785
1638
|
- sampled
|
1786
1639
|
operationId: GetThirdpartyRequestsVerificationsById
|
1787
1640
|
summary: GetThirdpartyRequestsVerificationsById
|
1788
|
-
description:
|
1641
|
+
description: |
|
1789
1642
|
The HTTP request `/thirdpartyRequests/verifications/{ID}` is used to get
|
1790
|
-
|
1791
|
-
information regarding a previously created or requested authorization.
|
1792
|
-
The *{ID}*
|
1793
|
-
|
1643
|
+
information regarding a previously created or requested authorization. The *{ID}*
|
1794
1644
|
in the URI should contain the verification request ID
|
1795
1645
|
parameters:
|
1796
1646
|
- $ref: '#/components/parameters/Accept'
|
@@ -1819,17 +1669,10 @@ paths:
|
|
1819
1669
|
- sampled
|
1820
1670
|
operationId: PutThirdpartyRequestsVerificationsById
|
1821
1671
|
summary: PutThirdpartyRequestsVerificationsById
|
1822
|
-
description:
|
1823
|
-
The HTTP request `PUT /thirdpartyRequests/verifications/{ID}` is used by
|
1824
|
-
the
|
1825
|
-
the
|
1826
|
-
|
1827
|
-
If the validation fails, the auth-service will send back `PUT
|
1828
|
-
/thirdpartyRequests/verifications/{ID}` with `authenticationResponse:
|
1829
|
-
'REJECTED'`.
|
1830
|
-
|
1831
|
-
In unplanned error cases the Auth-Service MUST use `PUT
|
1832
|
-
/thirdpartyRequests/verifications/{ID}/error`.
|
1672
|
+
description: |-
|
1673
|
+
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.
|
1674
|
+
If the validation fails, the auth-service will send back `PUT /thirdpartyRequests/verifications/{ID}` with `authenticationResponse: 'REJECTED'`.
|
1675
|
+
In unplanned error cases the Auth-Service MUST use `PUT /thirdpartyRequests/verifications/{ID}/error`.
|
1833
1676
|
parameters:
|
1834
1677
|
- $ref: '#/components/parameters/Content-Length'
|
1835
1678
|
requestBody:
|
@@ -1838,8 +1681,7 @@ paths:
|
|
1838
1681
|
content:
|
1839
1682
|
application/json:
|
1840
1683
|
schema:
|
1841
|
-
$ref:
|
1842
|
-
#/components/schemas/ThirdpartyRequestsVerificationsIDPutResponse
|
1684
|
+
$ref: '#/components/schemas/ThirdpartyRequestsVerificationsIDPutResponse'
|
1843
1685
|
example:
|
1844
1686
|
authenticationResponse: VERIFIED
|
1845
1687
|
responses:
|
@@ -1879,12 +1721,9 @@ paths:
|
|
1879
1721
|
- sampled
|
1880
1722
|
operationId: PutThirdpartyRequestsVerificationsByIdAndError
|
1881
1723
|
summary: PutThirdpartyRequestsVerificationsByIdAndError
|
1882
|
-
description:
|
1883
|
-
The HTTP request `PUT /thirdpartyRequests/verifications/{ID}/error` is
|
1884
|
-
|
1885
|
-
|
1886
|
-
the DFSP of a failure in validating or looking up the verification of a
|
1887
|
-
Thirdparty Transaction Request.
|
1724
|
+
description: |
|
1725
|
+
The HTTP request `PUT /thirdpartyRequests/verifications/{ID}/error` is used by the Auth-Service to inform
|
1726
|
+
the DFSP of a failure in validating or looking up the verification of a Thirdparty Transaction Request.
|
1888
1727
|
parameters:
|
1889
1728
|
- $ref: '#/components/parameters/Content-Length'
|
1890
1729
|
requestBody:
|
@@ -1929,114 +1768,49 @@ components:
|
|
1929
1768
|
- ALIAS
|
1930
1769
|
- CONSENT
|
1931
1770
|
- THIRD_PARTY_LINK
|
1932
|
-
description:
|
1771
|
+
description: |
|
1933
1772
|
Below are the allowed values for the enumeration.
|
1934
|
-
|
1935
1773
|
- MSISDN - An MSISDN (Mobile Station International Subscriber Directory
|
1936
|
-
|
1937
|
-
Number, that is, the phone number) is used as reference to a
|
1938
|
-
participant.
|
1939
|
-
|
1774
|
+
Number, that is, the phone number) is used as reference to a participant.
|
1940
1775
|
The MSISDN identifier should be in international format according to the
|
1941
|
-
|
1942
1776
|
[ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en).
|
1943
|
-
|
1944
|
-
Optionally, the MSISDN may be prefixed by a single plus sign, indicating
|
1945
|
-
the
|
1946
|
-
|
1777
|
+
Optionally, the MSISDN may be prefixed by a single plus sign, indicating the
|
1947
1778
|
international prefix.
|
1948
|
-
|
1949
1779
|
- EMAIL - An email is used as reference to a
|
1950
|
-
|
1951
|
-
participant. The format of the email should be according to the
|
1952
|
-
informational
|
1953
|
-
|
1780
|
+
participant. The format of the email should be according to the informational
|
1954
1781
|
[RFC 3696](https://tools.ietf.org/html/rfc3696).
|
1955
|
-
|
1956
|
-
|
1957
|
-
|
1958
|
-
|
1959
|
-
Examples of personal identification are passport number, birth
|
1960
|
-
certificate
|
1961
|
-
|
1962
|
-
number, and national registration number. The identifier number is added
|
1963
|
-
in
|
1964
|
-
|
1965
|
-
the PartyIdentifier element. The personal identifier type is added in
|
1966
|
-
the
|
1967
|
-
|
1782
|
+
- PERSONAL_ID - A personal identifier is used as reference to a participant.
|
1783
|
+
Examples of personal identification are passport number, birth certificate
|
1784
|
+
number, and national registration number. The identifier number is added in
|
1785
|
+
the PartyIdentifier element. The personal identifier type is added in the
|
1968
1786
|
PartySubIdOrType element.
|
1969
|
-
|
1970
|
-
|
1971
|
-
|
1972
|
-
|
1973
|
-
is used as reference to a participant. The BUSINESS identifier can be in
|
1974
|
-
any
|
1975
|
-
|
1976
|
-
format. To make a transaction connected to a specific username or bill
|
1977
|
-
number
|
1978
|
-
|
1787
|
+
- BUSINESS - A specific Business (for example, an organization or a company)
|
1788
|
+
is used as reference to a participant. The BUSINESS identifier can be in any
|
1789
|
+
format. To make a transaction connected to a specific username or bill number
|
1979
1790
|
in a Business, the PartySubIdOrType element should be used.
|
1980
|
-
|
1981
|
-
- DEVICE - A specific device (for example, a POS or ATM) ID connected to
|
1982
|
-
a
|
1983
|
-
|
1791
|
+
- DEVICE - A specific device (for example, a POS or ATM) ID connected to a
|
1984
1792
|
specific business or organization is used as reference to a Party.
|
1985
|
-
|
1986
|
-
For referencing a specific device under a specific business or
|
1987
|
-
organization,
|
1988
|
-
|
1793
|
+
For referencing a specific device under a specific business or organization,
|
1989
1794
|
use the PartySubIdOrType element.
|
1990
|
-
|
1991
1795
|
- ACCOUNT_ID - A bank account number or FSP account ID should be used as
|
1992
|
-
|
1993
|
-
reference to a participant. The ACCOUNT_ID identifier can be in any
|
1994
|
-
format,
|
1995
|
-
|
1796
|
+
reference to a participant. The ACCOUNT_ID identifier can be in any format,
|
1996
1797
|
as formats can greatly differ depending on country and FSP.
|
1997
|
-
|
1998
|
-
- IBAN - A bank account number or FSP account ID is used as reference to
|
1999
|
-
a
|
2000
|
-
|
1798
|
+
- IBAN - A bank account number or FSP account ID is used as reference to a
|
2001
1799
|
participant. The IBAN identifier can consist of up to 34 alphanumeric
|
2002
|
-
|
2003
1800
|
characters and should be entered without whitespace.
|
2004
|
-
|
2005
|
-
- ALIAS An alias is used as reference to a participant. The alias should
|
2006
|
-
be
|
2007
|
-
|
1801
|
+
- ALIAS An alias is used as reference to a participant. The alias should be
|
2008
1802
|
created in the FSP as an alternative reference to an account owner.
|
2009
|
-
|
2010
1803
|
Another example of an alias is a username in the FSP system.
|
2011
|
-
|
2012
|
-
|
2013
|
-
the
|
2014
|
-
|
2015
|
-
PartySubIdOrType element for identifying an account under an Alias
|
2016
|
-
defined
|
2017
|
-
|
1804
|
+
The ALIAS identifier can be in any format. It is also possible to use the
|
1805
|
+
PartySubIdOrType element for identifying an account under an Alias defined
|
2018
1806
|
by the PartyIdentifier.
|
2019
|
-
|
2020
|
-
|
2021
|
-
|
2022
|
-
|
2023
|
-
a DFSP which allows the PISP permission to perform actions on behalf of
|
2024
|
-
the
|
2025
|
-
|
2026
|
-
customer. A Consent has an authoritative source: either the DFSP who
|
2027
|
-
issued
|
2028
|
-
|
1807
|
+
- CONSENT - A Consent represents an agreement between a PISP, a Customer and
|
1808
|
+
a DFSP which allows the PISP permission to perform actions on behalf of the
|
1809
|
+
customer. A Consent has an authoritative source: either the DFSP who issued
|
2029
1810
|
the Consent, or an Auth Service which administers the Consent.
|
2030
|
-
|
2031
|
-
|
2032
|
-
|
2033
|
-
|
2034
|
-
a DFSP, and a specific Customer's account at the DFSP. The content of
|
2035
|
-
the link
|
2036
|
-
|
2037
|
-
is created by the DFSP at the time when it gives permission to the PISP
|
2038
|
-
for
|
2039
|
-
|
1811
|
+
- THIRD_PARTY_LINK - A Third Party Link represents an agreement between a PISP,
|
1812
|
+
a DFSP, and a specific Customer's account at the DFSP. The content of the link
|
1813
|
+
is created by the DFSP at the time when it gives permission to the PISP for
|
2040
1814
|
specific access to a given account.
|
2041
1815
|
example: PERSONAL_ID
|
2042
1816
|
PartyIdentifier:
|
@@ -2051,9 +1825,7 @@ components:
|
|
2051
1825
|
type: string
|
2052
1826
|
minLength: 1
|
2053
1827
|
maxLength: 128
|
2054
|
-
description:
|
2055
|
-
Either a sub-identifier of a PartyIdentifier, or a sub-type of the
|
2056
|
-
PartyIdType, normally a PersonalIdentifierType.
|
1828
|
+
description: Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
|
2057
1829
|
FspId:
|
2058
1830
|
title: FspId
|
2059
1831
|
type: string
|
@@ -2087,9 +1859,7 @@ components:
|
|
2087
1859
|
ExtensionList:
|
2088
1860
|
title: ExtensionList
|
2089
1861
|
type: object
|
2090
|
-
description:
|
2091
|
-
Data model for the complex type ExtensionList. An optional list of
|
2092
|
-
extensions, specific to deployment.
|
1862
|
+
description: Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
|
2093
1863
|
properties:
|
2094
1864
|
extension:
|
2095
1865
|
type: array
|
@@ -2122,14 +1892,7 @@ components:
|
|
2122
1892
|
title: ErrorCode
|
2123
1893
|
type: string
|
2124
1894
|
pattern: ^[1-9]\d{3}$
|
2125
|
-
description:
|
2126
|
-
The API data type ErrorCode is a JSON String of four characters,
|
2127
|
-
consisting of digits only. Negative numbers are not allowed. A leading
|
2128
|
-
zero is not allowed. Each error code in the API is a four-digit number,
|
2129
|
-
for example, 1234, where the first number (1 in the example) represents
|
2130
|
-
the high-level error category, the second number (2 in the example)
|
2131
|
-
represents the low-level error category, and the last two numbers (34 in
|
2132
|
-
the example) represent the specific error.
|
1895
|
+
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.
|
2133
1896
|
example: '5100'
|
2134
1897
|
ErrorDescription:
|
2135
1898
|
title: ErrorDescription
|
@@ -2164,11 +1927,7 @@ components:
|
|
2164
1927
|
- partyId
|
2165
1928
|
Currency:
|
2166
1929
|
title: Currency
|
2167
|
-
description:
|
2168
|
-
The currency codes defined in [ISO
|
2169
|
-
4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter
|
2170
|
-
alphabetic codes are used as the standard naming representation for
|
2171
|
-
currencies.
|
1930
|
+
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.
|
2172
1931
|
type: string
|
2173
1932
|
minLength: 3
|
2174
1933
|
maxLength: 3
|
@@ -2348,9 +2107,7 @@ components:
|
|
2348
2107
|
$ref: '#/components/schemas/PartyResult'
|
2349
2108
|
minItems: 1
|
2350
2109
|
maxItems: 10000
|
2351
|
-
description:
|
2352
|
-
List of PartyResult elements that were either created or failed to
|
2353
|
-
be created.
|
2110
|
+
description: List of PartyResult elements that were either created or failed to be created.
|
2354
2111
|
currency:
|
2355
2112
|
$ref: '#/components/schemas/Currency'
|
2356
2113
|
required:
|
@@ -2359,10 +2116,7 @@ components:
|
|
2359
2116
|
title: MerchantClassificationCode
|
2360
2117
|
type: string
|
2361
2118
|
pattern: ^[\d]{1,4}$
|
2362
|
-
description:
|
2363
|
-
A limited set of pre-defined numbers. This list would be a limited set
|
2364
|
-
of numbers identifying a set of popular merchant types like School Fees,
|
2365
|
-
Pubs and Restaurants, Groceries, etc.
|
2119
|
+
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.
|
2366
2120
|
PartyName:
|
2367
2121
|
title: PartyName
|
2368
2122
|
type: string
|
@@ -2374,9 +2128,7 @@ components:
|
|
2374
2128
|
type: string
|
2375
2129
|
minLength: 1
|
2376
2130
|
maxLength: 128
|
2377
|
-
pattern:
|
2378
|
-
^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
|
2379
|
-
.,''-]{1,128}$
|
2131
|
+
pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
|
2380
2132
|
description: First name of the Party (Name Type).
|
2381
2133
|
example: Henrik
|
2382
2134
|
MiddleName:
|
@@ -2384,9 +2136,7 @@ components:
|
|
2384
2136
|
type: string
|
2385
2137
|
minLength: 1
|
2386
2138
|
maxLength: 128
|
2387
|
-
pattern:
|
2388
|
-
^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
|
2389
|
-
.,''-]{1,128}$
|
2139
|
+
pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
|
2390
2140
|
description: Middle name of the Party (Name Type).
|
2391
2141
|
example: Johannes
|
2392
2142
|
LastName:
|
@@ -2394,9 +2144,7 @@ components:
|
|
2394
2144
|
type: string
|
2395
2145
|
minLength: 1
|
2396
2146
|
maxLength: 128
|
2397
|
-
pattern:
|
2398
|
-
^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
|
2399
|
-
.,''-]{1,128}$
|
2147
|
+
pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
|
2400
2148
|
description: Last name of the Party (Name Type).
|
2401
2149
|
example: Karlsson
|
2402
2150
|
PartyComplexName:
|
@@ -2413,8 +2161,7 @@ components:
|
|
2413
2161
|
DateOfBirth:
|
2414
2162
|
title: DateofBirth (type Date)
|
2415
2163
|
type: string
|
2416
|
-
pattern:
|
2417
|
-
^(?:[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)$
|
2164
|
+
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)$
|
2418
2165
|
description: Date of Birth of the Party.
|
2419
2166
|
example: '1966-06-16'
|
2420
2167
|
PartyPersonalInfo:
|
@@ -2444,15 +2191,11 @@ components:
|
|
2444
2191
|
PartiesTypeIDPutResponse:
|
2445
2192
|
title: PartiesTypeIDPutResponse
|
2446
2193
|
type: object
|
2447
|
-
description:
|
2194
|
+
description: |
|
2448
2195
|
The object sent in the PUT /parties/{Type}/{ID} callback.
|
2449
2196
|
|
2450
|
-
|
2451
|
-
This is a variant based on FSPIOP `PartiesTypeIDPutResponse`
|
2452
|
-
specification.
|
2453
|
-
|
2197
|
+
This is a variant based on FSPIOP `PartiesTypeIDPutResponse` specification.
|
2454
2198
|
Main difference being that it returns a `Party` with the newly added
|
2455
|
-
|
2456
2199
|
`accounts` property.
|
2457
2200
|
properties:
|
2458
2201
|
party:
|
@@ -2463,13 +2206,7 @@ components:
|
|
2463
2206
|
title: Amount
|
2464
2207
|
type: string
|
2465
2208
|
pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
|
2466
|
-
description:
|
2467
|
-
The API data type Amount is a JSON String in a canonical format that is
|
2468
|
-
restricted by a regular expression for interoperability reasons. This
|
2469
|
-
pattern does not allow any trailing zeroes at all, but allows an amount
|
2470
|
-
without a minor currency unit. It also only allows four digits in the
|
2471
|
-
minor currency unit; a negative value is not allowed. Using more than 18
|
2472
|
-
digits in the major currency unit is not allowed.
|
2209
|
+
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.
|
2473
2210
|
example: '123.45'
|
2474
2211
|
Money:
|
2475
2212
|
title: Money
|
@@ -2486,42 +2223,25 @@ components:
|
|
2486
2223
|
DateTime:
|
2487
2224
|
title: DateTime
|
2488
2225
|
type: string
|
2489
|
-
pattern:
|
2490
|
-
|
2491
|
-
description: >-
|
2492
|
-
The API data type DateTime is a JSON String in a lexical format that is
|
2493
|
-
restricted by a regular expression for interoperability reasons. The
|
2494
|
-
format is according to [ISO
|
2495
|
-
8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed
|
2496
|
-
in a combined date, time and time zone format. A more readable version
|
2497
|
-
of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
|
2498
|
-
"2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z
|
2499
|
-
indicates Zulu time zone, same as UTC).
|
2226
|
+
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)$
|
2227
|
+
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).
|
2500
2228
|
example: '2016-05-24T08:38:08.699-04:00'
|
2501
2229
|
Latitude:
|
2502
2230
|
title: Latitude
|
2503
2231
|
type: string
|
2504
|
-
pattern:
|
2505
|
-
|
2506
|
-
description: >-
|
2507
|
-
The API data type Latitude is a JSON String in a lexical format that is
|
2508
|
-
restricted by a regular expression for interoperability reasons.
|
2232
|
+
pattern: ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
|
2233
|
+
description: The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
|
2509
2234
|
example: '+45.4215'
|
2510
2235
|
Longitude:
|
2511
2236
|
title: Longitude
|
2512
2237
|
type: string
|
2513
|
-
pattern:
|
2514
|
-
|
2515
|
-
description: >-
|
2516
|
-
The API data type Longitude is a JSON String in a lexical format that is
|
2517
|
-
restricted by a regular expression for interoperability reasons.
|
2238
|
+
pattern: ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
|
2239
|
+
description: The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
|
2518
2240
|
example: '+75.6972'
|
2519
2241
|
GeoCode:
|
2520
2242
|
title: GeoCode
|
2521
2243
|
type: object
|
2522
|
-
description:
|
2523
|
-
Data model for the complex type GeoCode. Indicates the geographic
|
2524
|
-
location from where the transaction was initiated.
|
2244
|
+
description: Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
|
2525
2245
|
properties:
|
2526
2246
|
latitude:
|
2527
2247
|
$ref: '#/components/schemas/Latitude'
|
@@ -2537,8 +2257,7 @@ components:
|
|
2537
2257
|
minLength: 1
|
2538
2258
|
maxLength: 32768
|
2539
2259
|
description: Information for recipient (transport layer information).
|
2540
|
-
example:
|
2541
|
-
AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
|
2260
|
+
example: AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
|
2542
2261
|
IlpCondition:
|
2543
2262
|
title: IlpCondition
|
2544
2263
|
type: string
|
@@ -2606,19 +2325,11 @@ components:
|
|
2606
2325
|
ThirdpartyRequestsTransactionsIDPatchResponse:
|
2607
2326
|
title: ThirdpartyRequestsTransactionsIDPatchResponse
|
2608
2327
|
type: object
|
2609
|
-
description:
|
2328
|
+
description: |-
|
2610
2329
|
Used by: DFSP
|
2611
|
-
|
2612
|
-
|
2613
|
-
which
|
2614
|
-
|
2615
|
-
This response will be given by a PATCH call on the
|
2616
|
-
/thirdpartyRequests/transactions/{ID} resource.
|
2617
|
-
|
2618
|
-
The {ID} given in the query string should be the transactionRequestId
|
2619
|
-
which was originally used by the PISP to identify the transaction
|
2620
|
-
request.
|
2621
|
-
|
2330
|
+
The issuing PISP will expect a response to their request for a transfer which describes the finalized state of the requested transfer.
|
2331
|
+
This response will be given by a PATCH call on the /thirdpartyRequests/transactions/{ID} resource.
|
2332
|
+
The {ID} given in the query string should be the transactionRequestId which was originally used by the PISP to identify the transaction request.
|
2622
2333
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
2623
2334
|
properties:
|
2624
2335
|
completedTimestamp:
|
@@ -2660,10 +2371,7 @@ components:
|
|
2660
2371
|
title: Integer
|
2661
2372
|
type: string
|
2662
2373
|
pattern: ^[1-9]\d*$
|
2663
|
-
description:
|
2664
|
-
The API data type Integer is a JSON String consisting of digits only.
|
2665
|
-
Negative numbers and leading zeroes are not allowed. The data type is
|
2666
|
-
always limited to a specific number of digits.
|
2374
|
+
description: The API data type Integer is a JSON String consisting of digits only. Negative numbers and leading zeroes are not allowed. The data type is always limited to a specific number of digits.
|
2667
2375
|
Note:
|
2668
2376
|
title: Note
|
2669
2377
|
type: string
|
@@ -2676,9 +2384,8 @@ components:
|
|
2676
2384
|
type: string
|
2677
2385
|
enum:
|
2678
2386
|
- THIRD_PARTY_LINK
|
2679
|
-
description:
|
2680
|
-
- THIRD_PARTY_LINK - is the DFSP's internal reference which allows DFSP
|
2681
|
-
to find out the corresponding consent
|
2387
|
+
description: |
|
2388
|
+
- THIRD_PARTY_LINK - is the DFSP's internal reference which allows DFSP to find out the corresponding consent
|
2682
2389
|
example: PERSONAL_ID
|
2683
2390
|
PartyIdInfoTPLink:
|
2684
2391
|
title: PartyIdInfo
|
@@ -2701,15 +2408,9 @@ components:
|
|
2701
2408
|
ServiceType:
|
2702
2409
|
title: ServiceType
|
2703
2410
|
type: string
|
2704
|
-
description:
|
2705
|
-
The ServiceType enumeration describes the types of role for which a DFSP
|
2706
|
-
|
2707
|
-
|
2708
|
-
Below are the allowed values for the enumeration ServiceType -
|
2709
|
-
THIRD_PARTY_DFSP - Enum used to query for DFSPs that have thirdparty
|
2710
|
-
features enabled. - PISP - Enum used to query for PISPs. - AUTH_SERVICE
|
2711
|
-
- Participants which provide Authentication Services.
|
2712
|
-
|
2411
|
+
description: |-
|
2412
|
+
The ServiceType enumeration describes the types of role for which a DFSP may query using the /services resource.
|
2413
|
+
Below are the allowed values for the enumeration ServiceType - THIRD_PARTY_DFSP - Enum used to query for DFSPs that have thirdparty features enabled. - PISP - Enum used to query for PISPs. - AUTH_SERVICE - Participants which provide Authentication Services.
|
2713
2414
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3229-servicetype
|
2714
2415
|
enum:
|
2715
2416
|
- THIRD_PARTY_DFSP
|
@@ -2718,15 +2419,8 @@ components:
|
|
2718
2419
|
CorrelationId:
|
2719
2420
|
title: CorrelationId
|
2720
2421
|
type: string
|
2721
|
-
pattern:
|
2722
|
-
|
2723
|
-
description: >-
|
2724
|
-
Identifier that correlates all messages of the same sequence. The API
|
2725
|
-
data type UUID (Universally Unique Identifier) is a JSON String in
|
2726
|
-
canonical format, conforming to [RFC
|
2727
|
-
4122](https://tools.ietf.org/html/rfc4122), that is restricted by a
|
2728
|
-
regular expression for interoperability reasons. A UUID is always 36
|
2729
|
-
characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
|
2422
|
+
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
2423
|
+
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 (‘-‘).
|
2730
2424
|
example: b51ec534-ee48-4575-b6a9-ead2955b8069
|
2731
2425
|
ParticipantsPostRequest:
|
2732
2426
|
title: ParticipantsPostRequest
|
@@ -2755,14 +2449,10 @@ components:
|
|
2755
2449
|
enum:
|
2756
2450
|
- SEND
|
2757
2451
|
- RECEIVE
|
2758
|
-
description:
|
2452
|
+
description: |-
|
2759
2453
|
Below are the allowed values for the enumeration AmountType.
|
2760
|
-
|
2761
|
-
-
|
2762
|
-
should be withdrawn from the Payer account including any fees.
|
2763
|
-
|
2764
|
-
- RECEIVE - Amount the Payer would like the Payee to receive, that is,
|
2765
|
-
the amount that should be sent to the receiver exclusive of any fees.
|
2454
|
+
- SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
|
2455
|
+
- 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.
|
2766
2456
|
example: RECEIVE
|
2767
2457
|
TransactionScenario:
|
2768
2458
|
title: TransactionScenario
|
@@ -2773,37 +2463,19 @@ components:
|
|
2773
2463
|
- TRANSFER
|
2774
2464
|
- PAYMENT
|
2775
2465
|
- REFUND
|
2776
|
-
description:
|
2466
|
+
description: |-
|
2777
2467
|
Below are the allowed values for the enumeration.
|
2778
|
-
|
2779
|
-
-
|
2780
|
-
|
2781
|
-
|
2782
|
-
Consumer to the Business User.
|
2783
|
-
|
2784
|
-
- WITHDRAWAL - Used for performing a Cash-Out (withdrawal) transaction.
|
2785
|
-
In a normal scenario, electronic funds are transferred from a Consumer’s
|
2786
|
-
account to a Business account, and physical cash is given from the
|
2787
|
-
Business User to the Consumer.
|
2788
|
-
|
2789
|
-
- TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to
|
2790
|
-
Consumer) transaction.
|
2791
|
-
|
2792
|
-
- PAYMENT - Usually used for performing a transaction from a Consumer to
|
2793
|
-
a Merchant or Organization, but could also be for a B2B (Business to
|
2794
|
-
Business) payment. The transaction could be online for a purchase in an
|
2795
|
-
Internet store, in a physical store where both the Consumer and Business
|
2796
|
-
User are present, a bill payment, a donation, and so on.
|
2797
|
-
|
2468
|
+
- DEPOSIT - Used for performing a Cash-In (deposit) transaction. In a normal scenario, electronic funds are transferred from a Business account to a Consumer account, and physical cash is given from the Consumer to the Business User.
|
2469
|
+
- WITHDRAWAL - Used for performing a Cash-Out (withdrawal) transaction. In a normal scenario, electronic funds are transferred from a Consumer’s account to a Business account, and physical cash is given from the Business User to the Consumer.
|
2470
|
+
- TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.
|
2471
|
+
- PAYMENT - Usually used for performing a transaction from a Consumer to a Merchant or Organization, but could also be for a B2B (Business to Business) payment. The transaction could be online for a purchase in an Internet store, in a physical store where both the Consumer and Business User are present, a bill payment, a donation, and so on.
|
2798
2472
|
- REFUND - Used for performing a refund of transaction.
|
2799
2473
|
example: DEPOSIT
|
2800
2474
|
TransactionSubScenario:
|
2801
2475
|
title: TransactionSubScenario
|
2802
2476
|
type: string
|
2803
2477
|
pattern: ^[A-Z_]{1,32}$
|
2804
|
-
description:
|
2805
|
-
Possible sub-scenario, defined locally within the scheme (UndefinedEnum
|
2806
|
-
Type).
|
2478
|
+
description: Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).
|
2807
2479
|
example: LOCALLY_DEFINED_SUBSCENARIO
|
2808
2480
|
TransactionInitiator:
|
2809
2481
|
title: TransactionInitiator
|
@@ -2811,17 +2483,10 @@ components:
|
|
2811
2483
|
enum:
|
2812
2484
|
- PAYER
|
2813
2485
|
- PAYEE
|
2814
|
-
description:
|
2486
|
+
description: |-
|
2815
2487
|
Below are the allowed values for the enumeration.
|
2816
|
-
|
2817
|
-
-
|
2818
|
-
send from is either owned by the Payer or is connected to the Payer in
|
2819
|
-
some way.
|
2820
|
-
|
2821
|
-
- PAYEE - Recipient of the funds is initiating the transaction by
|
2822
|
-
sending a transaction request. The Payer must approve the transaction,
|
2823
|
-
either automatically by a pre-generated OTP or by pre-approval of the
|
2824
|
-
Payee, or by manually approving in his or her own Device.
|
2488
|
+
- PAYER - Sender of funds is initiating the transaction. The account to send from is either owned by the Payer or is connected to the Payer in some way.
|
2489
|
+
- PAYEE - Recipient of the funds is initiating the transaction by sending a transaction request. The Payer must approve the transaction, either automatically by a pre-generated OTP or by pre-approval of the Payee, or by manually approving in his or her own Device.
|
2825
2490
|
example: PAYEE
|
2826
2491
|
TransactionInitiatorType:
|
2827
2492
|
title: TransactionInitiatorType
|
@@ -2860,11 +2525,7 @@ components:
|
|
2860
2525
|
title: BalanceOfPayments
|
2861
2526
|
type: string
|
2862
2527
|
pattern: ^[1-9]\d{2}$
|
2863
|
-
description:
|
2864
|
-
(BopCode) The API data type
|
2865
|
-
[BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String
|
2866
|
-
of 3 characters, consisting of digits only. Negative numbers are not
|
2867
|
-
allowed. A leading zero is not allowed.
|
2528
|
+
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.
|
2868
2529
|
example: '123'
|
2869
2530
|
TransactionType:
|
2870
2531
|
title: TransactionType
|
@@ -2894,20 +2555,11 @@ components:
|
|
2894
2555
|
properties:
|
2895
2556
|
quoteId:
|
2896
2557
|
$ref: '#/components/schemas/CorrelationId'
|
2897
|
-
description:
|
2898
|
-
Common ID between the FSPs for the quote object, decided by the
|
2899
|
-
Payer FSP. The ID should be reused for resends of the same quote for
|
2900
|
-
a transaction. A new ID should be generated for each new quote for a
|
2901
|
-
transaction.
|
2558
|
+
description: Common ID between the FSPs for the quote object, decided by the Payer FSP. The ID should be reused for resends of the same quote for a transaction. A new ID should be generated for each new quote for a transaction.
|
2902
2559
|
example: b51ec534-ee48-4575-b6a9-ead2955b8069
|
2903
2560
|
transactionId:
|
2904
2561
|
$ref: '#/components/schemas/CorrelationId'
|
2905
|
-
description:
|
2906
|
-
Common ID (decided by the Payer FSP) between the FSPs for the future
|
2907
|
-
transaction object. The actual transaction will be created as part
|
2908
|
-
of a successful transfer process. The ID should be reused for
|
2909
|
-
resends of the same quote for a transaction. A new ID should be
|
2910
|
-
generated for each new quote for a transaction.
|
2562
|
+
description: Common ID (decided by the Payer FSP) between the FSPs for the future transaction object. The actual transaction will be created as part of a successful transfer process. The ID should be reused for resends of the same quote for a transaction. A new ID should be generated for each new quote for a transaction.
|
2911
2563
|
example: a8323bc6-c228-4df2-ae82-e5a997baf899
|
2912
2564
|
transactionRequestId:
|
2913
2565
|
$ref: '#/components/schemas/CorrelationId'
|
@@ -2925,39 +2577,23 @@ components:
|
|
2925
2577
|
example: SEND
|
2926
2578
|
amount:
|
2927
2579
|
$ref: '#/components/schemas/Money'
|
2928
|
-
description:
|
2929
|
-
Depending on amountType - If SEND - The amount the Payer would like
|
2930
|
-
to send, that is, the amount that should be withdrawn from the Payer
|
2931
|
-
account including any fees. The amount is updated by each
|
2932
|
-
participating entity in the transaction. If RECEIVE - The amount the
|
2933
|
-
Payee should receive, that is, the amount that should be sent to the
|
2934
|
-
receiver exclusive any fees. The amount is not updated by any of the
|
2935
|
-
participating entities.
|
2580
|
+
description: Depending on amountType - If SEND - The amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees. The amount is updated by each participating entity in the transaction. If RECEIVE - The amount the Payee should receive, that is, the amount that should be sent to the receiver exclusive any fees. The amount is not updated by any of the participating entities.
|
2936
2581
|
fees:
|
2937
2582
|
$ref: '#/components/schemas/Money'
|
2938
|
-
description:
|
2939
|
-
The fees in the transaction. The fees element should be empty if
|
2940
|
-
fees should be non-disclosed. The fees element should be non-empty
|
2941
|
-
if fees should be disclosed.
|
2583
|
+
description: The fees in the transaction. The fees element should be empty if fees should be non-disclosed. The fees element should be non-empty if fees should be disclosed.
|
2942
2584
|
transactionType:
|
2943
2585
|
$ref: '#/components/schemas/TransactionType'
|
2944
2586
|
description: Type of transaction for which the quote is requested.
|
2945
2587
|
geoCode:
|
2946
2588
|
$ref: '#/components/schemas/GeoCode'
|
2947
|
-
description:
|
2948
|
-
Longitude and Latitude of the initiating Party. Can be used to
|
2949
|
-
detect fraud.
|
2589
|
+
description: Longitude and Latitude of the initiating Party. Can be used to detect fraud.
|
2950
2590
|
note:
|
2951
2591
|
$ref: '#/components/schemas/Note'
|
2952
2592
|
description: A memo that will be attached to the transaction.
|
2953
2593
|
example: Free-text memo.
|
2954
2594
|
expiration:
|
2955
2595
|
$ref: '#/components/schemas/DateTime'
|
2956
|
-
description:
|
2957
|
-
Expiration is optional. It can be set to get a quick failure in case
|
2958
|
-
the peer FSP takes too long to respond. Also, it may be beneficial
|
2959
|
-
for Consumer, Agent, and Merchant to know that their request has a
|
2960
|
-
time limit.
|
2596
|
+
description: Expiration is optional. It can be set to get a quick failure in case the peer FSP takes too long to respond. Also, it may be beneficial for Consumer, Agent, and Merchant to know that their request has a time limit.
|
2961
2597
|
example: '2016-05-24T08:38:08.699-04:00'
|
2962
2598
|
extensionList:
|
2963
2599
|
$ref: '#/components/schemas/ExtensionList'
|
@@ -2973,9 +2609,7 @@ components:
|
|
2973
2609
|
ErrorInformationResponse:
|
2974
2610
|
title: ErrorInformationResponse
|
2975
2611
|
type: object
|
2976
|
-
description:
|
2977
|
-
Data model for the complex type object that contains an optional element
|
2978
|
-
ErrorInformation used along with 4xx and 5xx responses.
|
2612
|
+
description: Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses.
|
2979
2613
|
properties:
|
2980
2614
|
errorInformation:
|
2981
2615
|
$ref: '#/components/schemas/ErrorInformation'
|
@@ -2983,44 +2617,21 @@ components:
|
|
2983
2617
|
title: Name
|
2984
2618
|
type: string
|
2985
2619
|
pattern: ^(?!\s*$)[\w .,'-]{1,128}$
|
2986
|
-
description:
|
2987
|
-
The API data type Name is a JSON String, restricted by a regular
|
2988
|
-
expression to avoid characters which are generally not used in a name.
|
2989
|
-
|
2990
|
-
|
2991
|
-
Regular Expression - The regular expression for restricting the Name
|
2992
|
-
type is "^(?!\s*$)[\w .,'-]{1,128}$". The restriction does not allow a
|
2993
|
-
string consisting of whitespace only, all Unicode characters are
|
2994
|
-
allowed, as well as the period (.) (apostrophe (‘), dash (-), comma (,)
|
2995
|
-
and space characters ( ).
|
2620
|
+
description: |-
|
2621
|
+
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.
|
2996
2622
|
|
2623
|
+
Regular Expression - The regular expression for restricting the Name type is "^(?!\s*$)[\w .,'-]{1,128}$". The restriction does not allow a string consisting of whitespace only, all Unicode characters are allowed, as well as the period (.) (apostrophe (‘), dash (-), comma (,) and space characters ( ).
|
2997
2624
|
|
2998
|
-
**Note:** In some programming languages, Unicode support must be
|
2999
|
-
specifically enabled. For example, if Java is used, the flag
|
3000
|
-
UNICODE_CHARACTER_CLASS must be enabled to allow Unicode characters.
|
2625
|
+
**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.
|
3001
2626
|
AccountAddress:
|
3002
2627
|
title: AccountAddress
|
3003
2628
|
type: string
|
3004
|
-
description:
|
3005
|
-
The AccountAddress data type is a variable length string with a maximum
|
3006
|
-
|
3007
|
-
|
3008
|
-
|
3009
|
-
|
3010
|
-
base64url.)
|
3011
|
-
|
3012
|
-
- Underscore (_) - Tilde (~) - Hyphen (-) - Period (.) Addresses MUST
|
3013
|
-
NOT end in a period (.) character
|
3014
|
-
|
3015
|
-
An entity providing accounts to parties (i.e. a participant) can provide
|
3016
|
-
any value for an AccountAddress that is meaningful to that entity. It
|
3017
|
-
does not need to provide an address that makes the account identifiable
|
3018
|
-
outside the entity's domain.
|
3019
|
-
|
3020
|
-
IMPORTANT: The policy for defining addresses and the life-cycle of these
|
3021
|
-
is at the discretion of the address space owner (the payer DFSP in this
|
3022
|
-
case).
|
3023
|
-
|
2629
|
+
description: |-
|
2630
|
+
The AccountAddress data type is a variable length string with a maximum size of 1023 characters and consists of:
|
2631
|
+
Alphanumeric characters, upper or lower case. (Addresses are case-sensitive so that they can contain data encoded in formats such as base64url.)
|
2632
|
+
- Underscore (_) - Tilde (~) - Hyphen (-) - Period (.) Addresses MUST NOT end in a period (.) character
|
2633
|
+
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.
|
2634
|
+
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).
|
3024
2635
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
|
3025
2636
|
pattern: ^([0-9A-Za-z_~\-\.]+[0-9A-Za-z_~\-])$
|
3026
2637
|
minLength: 1
|
@@ -3028,9 +2639,8 @@ components:
|
|
3028
2639
|
Account:
|
3029
2640
|
title: Account
|
3030
2641
|
type: object
|
3031
|
-
description:
|
2642
|
+
description: |-
|
3032
2643
|
Data model for the complex type Account.
|
3033
|
-
|
3034
2644
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account
|
3035
2645
|
properties:
|
3036
2646
|
accountNickname:
|
@@ -3046,10 +2656,8 @@ components:
|
|
3046
2656
|
AccountList:
|
3047
2657
|
title: AccountList
|
3048
2658
|
type: array
|
3049
|
-
description:
|
3050
|
-
The AccountList data model is used to hold information about the
|
3051
|
-
accounts that a party controls.
|
3052
|
-
|
2659
|
+
description: |-
|
2660
|
+
The AccountList data model is used to hold information about the accounts that a party controls.
|
3053
2661
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist
|
3054
2662
|
items:
|
3055
2663
|
$ref: '#/components/schemas/Account'
|
@@ -3058,16 +2666,10 @@ components:
|
|
3058
2666
|
AccountsIDPutResponse:
|
3059
2667
|
title: AccountsIDPutResponse
|
3060
2668
|
type: object
|
3061
|
-
description:
|
2669
|
+
description: |-
|
3062
2670
|
Callback and data model information for GET /accounts/{ID}:
|
3063
|
-
|
3064
|
-
|
3065
|
-
Data Model - Empty body
|
3066
|
-
|
3067
|
-
The PUT /accounts/{ID} response is used to inform the requester of the
|
3068
|
-
result of a request for accounts information. The identifier ID given in
|
3069
|
-
the call are the values given in the original request.
|
3070
|
-
|
2671
|
+
Callback - PUT /accounts/{ID} Error Callback - PUT /accounts/{ID}/error Data Model - Empty body
|
2672
|
+
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.
|
3071
2673
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
|
3072
2674
|
properties:
|
3073
2675
|
accounts:
|
@@ -3088,22 +2690,14 @@ components:
|
|
3088
2690
|
ScopeAction:
|
3089
2691
|
title: ScopeAction
|
3090
2692
|
type: string
|
3091
|
-
description:
|
2693
|
+
description: |
|
3092
2694
|
The ScopeAction element contains an access type which a PISP can request
|
3093
|
-
|
3094
2695
|
from a DFSP, or which a DFSP can grant to a PISP.
|
3095
|
-
|
3096
2696
|
It must be a member of the appropriate enumeration.
|
3097
2697
|
|
3098
|
-
|
3099
|
-
-
|
3100
|
-
account
|
3101
|
-
|
3102
|
-
- ACCOUNTS_TRANSFER: PISP can request a transfer of funds from the
|
3103
|
-
linked account in the DFSP
|
3104
|
-
|
3105
|
-
- ACCOUNTS_STATEMENT: PISP can request a statement of individual
|
3106
|
-
transactions on a user's account
|
2698
|
+
- ACCOUNTS_GET_BALANCE: PISP can request a balance for the linked account
|
2699
|
+
- ACCOUNTS_TRANSFER: PISP can request a transfer of funds from the linked account in the DFSP
|
2700
|
+
- ACCOUNTS_STATEMENT: PISP can request a statement of individual transactions on a user's account
|
3107
2701
|
enum:
|
3108
2702
|
- ACCOUNTS_GET_BALANCE
|
3109
2703
|
- ACCOUNTS_TRANSFER
|
@@ -3111,11 +2705,8 @@ components:
|
|
3111
2705
|
Scope:
|
3112
2706
|
title: Scope
|
3113
2707
|
type: object
|
3114
|
-
description:
|
3115
|
-
The Scope element contains an identifier defining, in the terms of a
|
3116
|
-
DFSP, an account on which access types can be requested or granted. It
|
3117
|
-
also defines the access types which are requested or granted.
|
3118
|
-
|
2708
|
+
description: |-
|
2709
|
+
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.
|
3119
2710
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope
|
3120
2711
|
properties:
|
3121
2712
|
address:
|
@@ -3145,33 +2736,23 @@ components:
|
|
3145
2736
|
pattern: ^(([^:/?#]+):)?(//([^/?#]*))?([^?#]*)(\?([^#]*))?(#(.*))?
|
3146
2737
|
minLength: 1
|
3147
2738
|
maxLength: 512
|
3148
|
-
description:
|
3149
|
-
The API data type Uri is a JSON string in a canonical format that is
|
3150
|
-
restricted by a regular expression for interoperability reasons.
|
2739
|
+
description: |
|
2740
|
+
The API data type Uri is a JSON string in a canonical format that is restricted by a regular expression for interoperability reasons.
|
3151
2741
|
ConsentRequestsPostRequest:
|
3152
2742
|
title: ConsentRequestsPostRequest
|
3153
2743
|
type: object
|
3154
|
-
description:
|
2744
|
+
description: |-
|
3155
2745
|
Used by: PISP
|
3156
|
-
|
3157
|
-
The HTTP request POST /consentRequests is used to request a DFSP to
|
3158
|
-
grant access to one or more accounts owned by a customer of the DFSP for
|
3159
|
-
the PISP who sends the request.
|
3160
|
-
|
2746
|
+
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.
|
3161
2747
|
Callback and data model for POST /consentRequests:
|
3162
|
-
|
3163
|
-
Callback: PUT /consentRequests/{ID} Error callback: PUT
|
3164
|
-
/consentRequests/{ID}/error Data model - see below url
|
3165
|
-
|
2748
|
+
Callback: PUT /consentRequests/{ID} Error callback: PUT /consentRequests/{ID}/error Data model - see below url
|
3166
2749
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests
|
3167
2750
|
properties:
|
3168
2751
|
consentRequestId:
|
3169
2752
|
$ref: '#/components/schemas/CorrelationId'
|
3170
2753
|
userId:
|
3171
2754
|
type: string
|
3172
|
-
description:
|
3173
|
-
The identifier used in the **GET /accounts/**_{ID}_. Used by the
|
3174
|
-
DFSP to correlate an account lookup to a `consentRequest`
|
2755
|
+
description: The identifier used in the **GET /accounts/**_{ID}_. Used by the DFSP to correlate an account lookup to a `consentRequest`
|
3175
2756
|
minLength: 1
|
3176
2757
|
maxLength: 128
|
3177
2758
|
scopes:
|
@@ -3206,17 +2787,12 @@ components:
|
|
3206
2787
|
ConsentRequestsIDPutResponseWeb:
|
3207
2788
|
title: ConsentRequestsIDPutResponseWeb
|
3208
2789
|
type: object
|
3209
|
-
description:
|
2790
|
+
description: |
|
3210
2791
|
The object sent in a `PUT /consentRequests/{ID}` request.
|
3211
2792
|
|
3212
|
-
|
3213
|
-
Schema used in the request consent phase of the account linking web
|
3214
|
-
flow,
|
3215
|
-
|
2793
|
+
Schema used in the request consent phase of the account linking web flow,
|
3216
2794
|
the result is the PISP being instructed on a specific URL where this
|
3217
|
-
|
3218
2795
|
supposed user should be redirected. This URL should be a place where
|
3219
|
-
|
3220
2796
|
the user can prove their identity (e.g., by logging in).
|
3221
2797
|
properties:
|
3222
2798
|
scopes:
|
@@ -3253,12 +2829,10 @@ components:
|
|
3253
2829
|
ConsentRequestsIDPutResponseOTP:
|
3254
2830
|
title: ConsentRequestsIDPutResponseOTP
|
3255
2831
|
type: object
|
3256
|
-
description:
|
2832
|
+
description: |
|
3257
2833
|
The object sent in a `PUT /consentRequests/{ID}` request.
|
3258
2834
|
|
3259
|
-
|
3260
|
-
Schema used in the request consent phase of the account linking OTP/SMS
|
3261
|
-
flow.
|
2835
|
+
Schema used in the request consent phase of the account linking OTP/SMS flow.
|
3262
2836
|
properties:
|
3263
2837
|
scopes:
|
3264
2838
|
type: array
|
@@ -3283,22 +2857,13 @@ components:
|
|
3283
2857
|
BinaryString:
|
3284
2858
|
type: string
|
3285
2859
|
pattern: ^[A-Za-z0-9-_]+[=]{0,2}$
|
3286
|
-
description:
|
3287
|
-
The API data type BinaryString is a JSON String. The string is a
|
3288
|
-
base64url encoding of a string of raw bytes, where padding (character
|
3289
|
-
‘=’) is added at the end of the data if needed to ensure that the string
|
3290
|
-
is a multiple of 4 characters. The length restriction indicates the
|
3291
|
-
allowed number of characters.
|
2860
|
+
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.
|
3292
2861
|
ConsentRequestsIDPatchRequest:
|
3293
2862
|
title: ConsentRequestsIDPatchRequest
|
3294
2863
|
type: object
|
3295
|
-
description:
|
2864
|
+
description: |-
|
3296
2865
|
Used by: PISP
|
3297
|
-
|
3298
|
-
After the user completes an out-of-band authorization with the DFSP, the
|
3299
|
-
PISP will receive a token which they can use to prove to the DFSP that
|
3300
|
-
the user trusts this PISP.
|
3301
|
-
|
2866
|
+
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.
|
3302
2867
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid
|
3303
2868
|
properties:
|
3304
2869
|
authToken:
|
@@ -3313,12 +2878,8 @@ components:
|
|
3313
2878
|
enum:
|
3314
2879
|
- FIDO
|
3315
2880
|
- GENERIC
|
3316
|
-
description:
|
3317
|
-
The type of the Credential. - "FIDO" - The credential is based on a FIDO
|
3318
|
-
challenge. Its payload is a FIDOPublicKeyCredentialAttestation object. -
|
3319
|
-
"GENERIC" - The credential is based on a simple public key validation.
|
3320
|
-
Its payload is a GenericCredential object.
|
3321
|
-
|
2881
|
+
description: |-
|
2882
|
+
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.
|
3322
2883
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype
|
3323
2884
|
CredentialStatusPending:
|
3324
2885
|
title: CredentialStatusPending
|
@@ -3331,9 +2892,8 @@ components:
|
|
3331
2892
|
GenericCredential:
|
3332
2893
|
title: GenericCredential
|
3333
2894
|
type: object
|
3334
|
-
description:
|
3335
|
-
A publicKey + signature of a challenge for a generic public/private
|
3336
|
-
keypair.
|
2895
|
+
description: |
|
2896
|
+
A publicKey + signature of a challenge for a generic public/private keypair.
|
3337
2897
|
properties:
|
3338
2898
|
publicKey:
|
3339
2899
|
$ref: '#/components/schemas/BinaryString'
|
@@ -3346,18 +2906,12 @@ components:
|
|
3346
2906
|
FIDOPublicKeyCredentialAttestation:
|
3347
2907
|
title: FIDOPublicKeyCredentialAttestation
|
3348
2908
|
type: object
|
3349
|
-
description:
|
2909
|
+
description: |
|
3350
2910
|
A data model representing a FIDO Attestation result. Derived from
|
3351
|
-
|
3352
|
-
[`PublicKeyCredential`
|
3353
|
-
Interface](https://w3c.github.io/webauthn/#iface-pkcredential).
|
3354
|
-
|
2911
|
+
[`PublicKeyCredential` Interface](https://w3c.github.io/webauthn/#iface-pkcredential).
|
3355
2912
|
|
3356
2913
|
The `PublicKeyCredential` interface represents the below fields with
|
3357
|
-
|
3358
|
-
a Type of Javascript
|
3359
|
-
[ArrayBuffer](https://heycam.github.io/webidl/#idl-ArrayBuffer).
|
3360
|
-
|
2914
|
+
a Type of Javascript [ArrayBuffer](https://heycam.github.io/webidl/#idl-ArrayBuffer).
|
3361
2915
|
For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
|
3362
2916
|
properties:
|
3363
2917
|
id:
|
@@ -3407,18 +2961,12 @@ components:
|
|
3407
2961
|
SignedCredential:
|
3408
2962
|
title: SignedCredential
|
3409
2963
|
type: object
|
3410
|
-
description:
|
2964
|
+
description: |
|
3411
2965
|
A credential used to allow a user to prove their identity and access
|
3412
|
-
|
3413
2966
|
to an account with a DFSP.
|
3414
2967
|
|
3415
|
-
|
3416
|
-
|
3417
|
-
to be
|
3418
|
-
|
3419
|
-
more explicit about the `status` field - it should only ever be PENDING
|
3420
|
-
when
|
3421
|
-
|
2968
|
+
SignedCredential is a special formatting of the credential to allow us to be
|
2969
|
+
more explicit about the `status` field - it should only ever be PENDING when
|
3422
2970
|
updating a credential.
|
3423
2971
|
properties:
|
3424
2972
|
credentialType:
|
@@ -3486,20 +3034,15 @@ components:
|
|
3486
3034
|
consentId:
|
3487
3035
|
allOf:
|
3488
3036
|
- $ref: '#/components/schemas/CorrelationId'
|
3489
|
-
description:
|
3490
|
-
Common ID between the PISP and the Payer DFSP for the consent
|
3491
|
-
|
3492
|
-
|
3493
|
-
should be reused for re-sends of the same consent. A new ID should
|
3494
|
-
be generated
|
3495
|
-
|
3037
|
+
description: |
|
3038
|
+
Common ID between the PISP and the Payer DFSP for the consent object. The ID
|
3039
|
+
should be reused for re-sends of the same consent. A new ID should be generated
|
3496
3040
|
for each new consent.
|
3497
3041
|
consentRequestId:
|
3498
3042
|
allOf:
|
3499
3043
|
- $ref: '#/components/schemas/CorrelationId'
|
3500
|
-
description:
|
3501
|
-
The ID given to the original consent request on which this consent
|
3502
|
-
is based.
|
3044
|
+
description: |
|
3045
|
+
The ID given to the original consent request on which this consent is based.
|
3503
3046
|
scopes:
|
3504
3047
|
type: array
|
3505
3048
|
minLength: 1
|
@@ -3518,12 +3061,9 @@ components:
|
|
3518
3061
|
ConsentsIDPutResponseSigned:
|
3519
3062
|
title: ConsentsIDPutResponseSigned
|
3520
3063
|
type: object
|
3521
|
-
description:
|
3522
|
-
The HTTP request `PUT /consents/{ID}` is used by the PISP to update a
|
3523
|
-
|
3524
|
-
|
3525
|
-
Called by a `PISP` to after signing a challenge. Sent to a DFSP for
|
3526
|
-
verification.
|
3064
|
+
description: |
|
3065
|
+
The HTTP request `PUT /consents/{ID}` is used by the PISP to update a Consent with a signed challenge and register a credential.
|
3066
|
+
Called by a `PISP` to after signing a challenge. Sent to a DFSP for verification.
|
3527
3067
|
properties:
|
3528
3068
|
status:
|
3529
3069
|
$ref: '#/components/schemas/ConsentStatusIssued'
|
@@ -3550,18 +3090,12 @@ components:
|
|
3550
3090
|
VerifiedCredential:
|
3551
3091
|
title: VerifiedCredential
|
3552
3092
|
type: object
|
3553
|
-
description:
|
3093
|
+
description: |
|
3554
3094
|
A credential used to allow a user to prove their identity and access
|
3555
|
-
|
3556
3095
|
to an account with a DFSP.
|
3557
3096
|
|
3558
|
-
|
3559
|
-
|
3560
|
-
be
|
3561
|
-
|
3562
|
-
more explicit about the `status` field - it should only ever be VERIFIED
|
3563
|
-
when
|
3564
|
-
|
3097
|
+
VerifiedCredential is a special formatting of Credential to allow us to be
|
3098
|
+
more explicit about the `status` field - it should only ever be VERIFIED when
|
3565
3099
|
updating a credential.
|
3566
3100
|
properties:
|
3567
3101
|
credentialType:
|
@@ -3579,12 +3113,9 @@ components:
|
|
3579
3113
|
ConsentsIDPutResponseVerified:
|
3580
3114
|
title: ConsentsIDPutResponseVerified
|
3581
3115
|
type: object
|
3582
|
-
description:
|
3583
|
-
The HTTP request `PUT /consents/{ID}` is used by the DFSP or
|
3584
|
-
|
3585
|
-
|
3586
|
-
Called by a `auth-service` to notify a DFSP that a credential has been
|
3587
|
-
verified and registered.
|
3116
|
+
description: |
|
3117
|
+
The HTTP request `PUT /consents/{ID}` is used by the DFSP or Auth-Service to update a Consent object once it has been Verified.
|
3118
|
+
Called by a `auth-service` to notify a DFSP that a credential has been verified and registered.
|
3588
3119
|
properties:
|
3589
3120
|
status:
|
3590
3121
|
$ref: '#/components/schemas/ConsentStatusIssued'
|
@@ -3649,19 +3180,14 @@ components:
|
|
3649
3180
|
ParticipantsTypeIDPutResponse:
|
3650
3181
|
title: ParticipantsTypeIDPutResponse
|
3651
3182
|
type: object
|
3652
|
-
description:
|
3653
|
-
The object sent in the PUT /participants/{Type}/{ID}/{SubId} and
|
3654
|
-
/participants/{Type}/{ID} callbacks.
|
3183
|
+
description: The object sent in the PUT /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} callbacks.
|
3655
3184
|
properties:
|
3656
3185
|
fspId:
|
3657
3186
|
$ref: '#/components/schemas/FspId'
|
3658
3187
|
ParticipantsTypeIDSubIDPostRequest:
|
3659
3188
|
title: ParticipantsTypeIDSubIDPostRequest
|
3660
3189
|
type: object
|
3661
|
-
description:
|
3662
|
-
The object sent in the POST /participants/{Type}/{ID}/{SubId} and
|
3663
|
-
/participants/{Type}/{ID} requests. An additional optional ExtensionList
|
3664
|
-
element has been added as part of v1.1 changes.
|
3190
|
+
description: The object sent in the POST /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} requests. An additional optional ExtensionList element has been added as part of v1.1 changes.
|
3665
3191
|
properties:
|
3666
3192
|
fspId:
|
3667
3193
|
$ref: '#/components/schemas/FspId'
|
@@ -3674,17 +3200,11 @@ components:
|
|
3674
3200
|
ServicesServiceTypePutResponse:
|
3675
3201
|
title: ServicesServiceTypePutResponse
|
3676
3202
|
type: object
|
3677
|
-
description:
|
3203
|
+
description: |-
|
3678
3204
|
Used by: Switch
|
3679
|
-
|
3680
|
-
The callback PUT /services/{ServiceType} is used to inform the client of
|
3681
|
-
a successful result of the service information lookup.
|
3682
|
-
|
3205
|
+
The callback PUT /services/{ServiceType} is used to inform the client of a successful result of the service information lookup.
|
3683
3206
|
Callback and data model information for GET /services/{ServiceType}:
|
3684
|
-
|
3685
|
-
Callback - PUT /services/{ServiceType} Error Callback - PUT
|
3686
|
-
/services/{ServiceType}/error Data Model - Empty body
|
3687
|
-
|
3207
|
+
Callback - PUT /services/{ServiceType} Error Callback - PUT /services/{ServiceType}/error Data Model - Empty body
|
3688
3208
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31531-put-servicesservicetype
|
3689
3209
|
properties:
|
3690
3210
|
providers:
|
@@ -3700,30 +3220,18 @@ components:
|
|
3700
3220
|
ThirdpartyRequestsTransactionsPostRequest:
|
3701
3221
|
title: ThirdpartyRequestsTransactionsPostRequest
|
3702
3222
|
type: object
|
3703
|
-
description:
|
3223
|
+
description: |-
|
3704
3224
|
Used by: PISP
|
3705
|
-
|
3706
|
-
|
3707
|
-
|
3708
|
-
transfer described in the request.
|
3709
|
-
|
3710
|
-
Callback and data model information for POST
|
3711
|
-
/thirdpartyRequests/transactions:
|
3712
|
-
|
3713
|
-
Callback - PUT /thirdpartyRequests/transactions/{ID} Error Callback -
|
3714
|
-
PUT /thirdpartyRequests/transactions/{ID}/error Data Model - See link
|
3715
|
-
below
|
3716
|
-
|
3225
|
+
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.
|
3226
|
+
Callback and data model information for POST /thirdpartyRequests/transactions:
|
3227
|
+
Callback - PUT /thirdpartyRequests/transactions/{ID} Error Callback - PUT /thirdpartyRequests/transactions/{ID}/error Data Model - See link below
|
3717
3228
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions
|
3718
3229
|
properties:
|
3719
3230
|
transactionRequestId:
|
3720
3231
|
allOf:
|
3721
3232
|
- $ref: '#/components/schemas/CorrelationId'
|
3722
|
-
description:
|
3723
|
-
Common ID between the PISP and the Payer DFSP for the transaction
|
3724
|
-
request object. The ID should be reused for resends of the same
|
3725
|
-
transaction request. A new ID should be generated for each new
|
3726
|
-
transaction request.
|
3233
|
+
description: |
|
3234
|
+
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.
|
3727
3235
|
payee:
|
3728
3236
|
allOf:
|
3729
3237
|
- $ref: '#/components/schemas/Party'
|
@@ -3751,10 +3259,8 @@ components:
|
|
3751
3259
|
description: A memo that will be attached to the transaction.
|
3752
3260
|
expiration:
|
3753
3261
|
type: string
|
3754
|
-
description:
|
3755
|
-
Date and time until when the transaction request is valid. It can be
|
3756
|
-
set to get a quick failure in case the peer FSP takes too long to
|
3757
|
-
respond.
|
3262
|
+
description: |
|
3263
|
+
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.
|
3758
3264
|
example: '2016-05-24T08:38:08.699-04:00'
|
3759
3265
|
extensionList:
|
3760
3266
|
$ref: '#/components/schemas/ExtensionList'
|
@@ -3769,15 +3275,9 @@ components:
|
|
3769
3275
|
ThirdpartyRequestsTransactionsIDPutResponse:
|
3770
3276
|
title: ThirdpartyRequestsTransactionsIDPutResponse
|
3771
3277
|
type: object
|
3772
|
-
description:
|
3278
|
+
description: |-
|
3773
3279
|
Used by: DFSP
|
3774
|
-
|
3775
|
-
After a PISP requests the creation of a Third Party Transaction request
|
3776
|
-
(POST /thirdpartyRequests/transactions) or the status of a previously
|
3777
|
-
created Third Party Transaction request (GET
|
3778
|
-
/thirdpartyRequests/transactions/{ID}), the DFSP will send this
|
3779
|
-
callback.
|
3780
|
-
|
3280
|
+
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.
|
3781
3281
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
|
3782
3282
|
properties:
|
3783
3283
|
transactionId:
|
@@ -3790,20 +3290,11 @@ components:
|
|
3790
3290
|
- transactionRequestState
|
3791
3291
|
ThirdpartyRequestsAuthorizationsPostRequest:
|
3792
3292
|
title: ThirdpartyRequestsAuthorizationsPostRequest
|
3793
|
-
description:
|
3293
|
+
description: |-
|
3794
3294
|
Used by: DFSP
|
3795
|
-
|
3796
|
-
|
3797
|
-
|
3798
|
-
request.
|
3799
|
-
|
3800
|
-
Callback and data model information for POST
|
3801
|
-
/thirdpartyRequests/authorizations:
|
3802
|
-
|
3803
|
-
Callback - PUT /thirdpartyRequests/authorizations/{ID} Error Callback -
|
3804
|
-
PUT /thirdpartyRequests/authorizations/{ID}/error Data Model - See below
|
3805
|
-
url
|
3806
|
-
|
3295
|
+
The HTTP request POST /thirdpartyRequests/authorizations is used to request the validation by a customer for the transfer described in the request.
|
3296
|
+
Callback and data model information for POST /thirdpartyRequests/authorizations:
|
3297
|
+
Callback - PUT /thirdpartyRequests/authorizations/{ID} Error Callback - PUT /thirdpartyRequests/authorizations/{ID}/error Data Model - See below url
|
3807
3298
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
3808
3299
|
type: object
|
3809
3300
|
properties:
|
@@ -3817,27 +3308,19 @@ components:
|
|
3817
3308
|
transferAmount:
|
3818
3309
|
allOf:
|
3819
3310
|
- $ref: '#/components/schemas/Money'
|
3820
|
-
description:
|
3821
|
-
The amount that will be debited from the sending customer's account
|
3822
|
-
as a consequence of the transaction.
|
3311
|
+
description: The amount that will be debited from the sending customer's account as a consequence of the transaction.
|
3823
3312
|
payeeReceiveAmount:
|
3824
3313
|
allOf:
|
3825
3314
|
- $ref: '#/components/schemas/Money'
|
3826
|
-
description:
|
3827
|
-
The amount that will be credited to the receiving customer's account
|
3828
|
-
as a consequence of the transaction.
|
3315
|
+
description: The amount that will be credited to the receiving customer's account as a consequence of the transaction.
|
3829
3316
|
fees:
|
3830
3317
|
allOf:
|
3831
3318
|
- $ref: '#/components/schemas/Money'
|
3832
|
-
description:
|
3833
|
-
The amount of fees that the paying customer will be charged as part
|
3834
|
-
of the transaction.
|
3319
|
+
description: The amount of fees that the paying customer will be charged as part of the transaction.
|
3835
3320
|
payer:
|
3836
3321
|
allOf:
|
3837
3322
|
- $ref: '#/components/schemas/PartyIdInfo'
|
3838
|
-
description:
|
3839
|
-
Information about the Payer type, id, sub-type/id, FSP Id in the
|
3840
|
-
proposed financial transaction.
|
3323
|
+
description: Information about the Payer type, id, sub-type/id, FSP Id in the proposed financial transaction.
|
3841
3324
|
payee:
|
3842
3325
|
allOf:
|
3843
3326
|
- $ref: '#/components/schemas/Party'
|
@@ -3847,9 +3330,7 @@ components:
|
|
3847
3330
|
expiration:
|
3848
3331
|
allOf:
|
3849
3332
|
- $ref: '#/components/schemas/DateTime'
|
3850
|
-
description:
|
3851
|
-
The time by which the transfer must be completed, set by the payee
|
3852
|
-
DFSP.
|
3333
|
+
description: The time by which the transfer must be completed, set by the payee DFSP.
|
3853
3334
|
extensionList:
|
3854
3335
|
$ref: '#/components/schemas/ExtensionList'
|
3855
3336
|
required:
|
@@ -3874,9 +3355,7 @@ components:
|
|
3874
3355
|
ThirdpartyRequestsAuthorizationsIDPutResponseRejected:
|
3875
3356
|
title: ThirdpartyRequestsAuthorizationsIDPutResponseRejected
|
3876
3357
|
type: object
|
3877
|
-
description:
|
3878
|
-
The object sent in the PUT /thirdpartyRequests/authorizations/{ID}
|
3879
|
-
callback.
|
3358
|
+
description: The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback.
|
3880
3359
|
properties:
|
3881
3360
|
responseType:
|
3882
3361
|
$ref: '#/components/schemas/AuthorizationResponseTypeRejected'
|
@@ -3900,20 +3379,14 @@ components:
|
|
3900
3379
|
FIDOPublicKeyCredentialAssertion:
|
3901
3380
|
title: FIDOPublicKeyCredentialAssertion
|
3902
3381
|
type: object
|
3903
|
-
description:
|
3382
|
+
description: |
|
3904
3383
|
A data model representing a FIDO Assertion result.
|
3905
|
-
|
3906
3384
|
Derived from PublicKeyCredential Interface in WebAuthN.
|
3907
3385
|
|
3908
|
-
|
3909
|
-
The PublicKeyCredential interface represents the below fields with a
|
3910
|
-
Type of
|
3911
|
-
|
3386
|
+
The PublicKeyCredential interface represents the below fields with a Type of
|
3912
3387
|
Javascript ArrayBuffer.
|
3913
|
-
|
3914
3388
|
For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
|
3915
3389
|
|
3916
|
-
|
3917
3390
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
|
3918
3391
|
properties:
|
3919
3392
|
id:
|
@@ -3948,9 +3421,8 @@ components:
|
|
3948
3421
|
maxLength: 512
|
3949
3422
|
signature:
|
3950
3423
|
type: string
|
3951
|
-
description:
|
3952
|
-
The signature generated by the private key associated with this
|
3953
|
-
credential.
|
3424
|
+
description: |
|
3425
|
+
The signature generated by the private key associated with this credential.
|
3954
3426
|
minLength: 59
|
3955
3427
|
maxLength: 256
|
3956
3428
|
userHandle:
|
@@ -3991,9 +3463,7 @@ components:
|
|
3991
3463
|
ThirdpartyRequestsAuthorizationsIDPutResponseFIDO:
|
3992
3464
|
title: ThirdpartyRequestsAuthorizationsIDPutResponseFIDO
|
3993
3465
|
type: object
|
3994
|
-
description:
|
3995
|
-
The object sent in the PUT /thirdpartyRequests/authorizations/{ID}
|
3996
|
-
callback.
|
3466
|
+
description: The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback.
|
3997
3467
|
properties:
|
3998
3468
|
responseType:
|
3999
3469
|
$ref: '#/components/schemas/AuthorizationResponseTypeAccepted'
|
@@ -4026,9 +3496,7 @@ components:
|
|
4026
3496
|
ThirdpartyRequestsAuthorizationsIDPutResponseGeneric:
|
4027
3497
|
title: ThirdpartyRequestsAuthorizationsIDPutResponseGeneric
|
4028
3498
|
type: object
|
4029
|
-
description:
|
4030
|
-
The object sent in the PUT /thirdpartyRequests/authorizations/{ID}
|
4031
|
-
callback.
|
3499
|
+
description: The object sent in the PUT /thirdpartyRequests/authorizations/{ID} callback.
|
4032
3500
|
properties:
|
4033
3501
|
responseType:
|
4034
3502
|
$ref: '#/components/schemas/AuthorizationResponseTypeAccepted'
|
@@ -4054,10 +3522,8 @@ components:
|
|
4054
3522
|
consentId:
|
4055
3523
|
allOf:
|
4056
3524
|
- $ref: '#/components/schemas/CorrelationId'
|
4057
|
-
description:
|
4058
|
-
The id of the stored consent object that contains the credential
|
4059
|
-
with which to verify
|
4060
|
-
|
3525
|
+
description: |
|
3526
|
+
The id of the stored consent object that contains the credential with which to verify
|
4061
3527
|
the signed challenge against.
|
4062
3528
|
signedPayloadType:
|
4063
3529
|
$ref: '#/components/schemas/SignedPayloadTypeFIDO'
|
@@ -4085,10 +3551,8 @@ components:
|
|
4085
3551
|
consentId:
|
4086
3552
|
allOf:
|
4087
3553
|
- $ref: '#/components/schemas/CorrelationId'
|
4088
|
-
description:
|
4089
|
-
The id of the stored consent object that contains the credential
|
4090
|
-
with which to verify
|
4091
|
-
|
3554
|
+
description: |
|
3555
|
+
The id of the stored consent object that contains the credential with which to verify
|
4092
3556
|
the signed challenge against.
|
4093
3557
|
signedPayloadType:
|
4094
3558
|
$ref: '#/components/schemas/SignedPayloadTypeGeneric'
|
@@ -4107,24 +3571,15 @@ components:
|
|
4107
3571
|
type: string
|
4108
3572
|
enum:
|
4109
3573
|
- VERIFIED
|
4110
|
-
description:
|
4111
|
-
The AuthenticationResponse enumeration describes the result of
|
4112
|
-
|
4113
|
-
|
4114
|
-
Below are the allowed values for the enumeration AuthenticationResponse.
|
4115
|
-
- VERIFIED - The challenge was correctly signed.
|
3574
|
+
description: |-
|
3575
|
+
The AuthenticationResponse enumeration describes the result of authenticating verification request.
|
3576
|
+
Below are the allowed values for the enumeration AuthenticationResponse. - VERIFIED - The challenge was correctly signed.
|
4116
3577
|
ThirdpartyRequestsVerificationsIDPutResponse:
|
4117
3578
|
title: ThirdpartyRequestsVerificationsIDPutResponse
|
4118
3579
|
type: object
|
4119
|
-
description:
|
3580
|
+
description: |-
|
4120
3581
|
Used by: Auth Service
|
4121
|
-
|
4122
|
-
The callback PUT /thirdpartyRequests/verifications/{ID} is used to
|
4123
|
-
inform the client of the result of an authorization check. The {ID} in
|
4124
|
-
the URI should contain the authorizationRequestId which was used to
|
4125
|
-
request the check, or the {ID} that was used in the GET
|
4126
|
-
/thirdpartyRequests/verifications/{ID}.
|
4127
|
-
|
3582
|
+
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}.
|
4128
3583
|
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31821-put-thirdpartyrequestsverificationsid
|
4129
3584
|
properties:
|
4130
3585
|
authenticationResponse:
|
@@ -4147,9 +3602,7 @@ components:
|
|
4147
3602
|
schema:
|
4148
3603
|
type: string
|
4149
3604
|
required: true
|
4150
|
-
description:
|
4151
|
-
The `Content-Type` header indicates the specific version of the API used
|
4152
|
-
to send the payload body.
|
3605
|
+
description: The `Content-Type` header indicates the specific version of the API used to send the payload body.
|
4153
3606
|
Date:
|
4154
3607
|
name: Date
|
4155
3608
|
in: header
|
@@ -4163,107 +3616,69 @@ components:
|
|
4163
3616
|
schema:
|
4164
3617
|
type: string
|
4165
3618
|
required: false
|
4166
|
-
description:
|
4167
|
-
The `X-Forwarded-For` header field is an unofficially accepted standard
|
4168
|
-
used for informational purposes of the originating client IP address, as
|
4169
|
-
a request might pass multiple proxies, firewalls, and so on. Multiple
|
4170
|
-
`X-Forwarded-For` values should be expected and supported by
|
4171
|
-
implementers of the API.
|
4172
|
-
|
3619
|
+
description: |-
|
3620
|
+
The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
4173
3621
|
|
4174
|
-
**Note:** An alternative to `X-Forwarded-For` is defined in [RFC
|
4175
|
-
7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC
|
4176
|
-
7239 is less-used and supported than `X-Forwarded-For`.
|
3622
|
+
**Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
4177
3623
|
FSPIOP-Source:
|
4178
3624
|
name: FSPIOP-Source
|
4179
3625
|
in: header
|
4180
3626
|
schema:
|
4181
3627
|
type: string
|
4182
3628
|
required: true
|
4183
|
-
description:
|
4184
|
-
The `FSPIOP-Source` header field is a non-HTTP standard field used by
|
4185
|
-
the API for identifying the sender of the HTTP request. The field should
|
4186
|
-
be set by the original sender of the request. Required for routing and
|
4187
|
-
signature verification (see header field `FSPIOP-Signature`).
|
3629
|
+
description: The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`).
|
4188
3630
|
FSPIOP-Destination:
|
4189
3631
|
name: FSPIOP-Destination
|
4190
3632
|
in: header
|
4191
3633
|
schema:
|
4192
3634
|
type: string
|
4193
3635
|
required: false
|
4194
|
-
description:
|
4195
|
-
The `FSPIOP-Destination` header field is a non-HTTP standard field used
|
4196
|
-
by the API for HTTP header based routing of requests and responses to
|
4197
|
-
the destination. The field must be set by the original sender of the
|
4198
|
-
request if the destination is known (valid for all services except GET
|
4199
|
-
/parties) so that any entities between the client and the server do not
|
4200
|
-
need to parse the payload for routing purposes. If the destination is
|
4201
|
-
not known (valid for service GET /parties), the field should be left
|
4202
|
-
empty.
|
3636
|
+
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.
|
4203
3637
|
FSPIOP-Encryption:
|
4204
3638
|
name: FSPIOP-Encryption
|
4205
3639
|
in: header
|
4206
3640
|
schema:
|
4207
3641
|
type: string
|
4208
3642
|
required: false
|
4209
|
-
description:
|
4210
|
-
The `FSPIOP-Encryption` header field is a non-HTTP standard field used
|
4211
|
-
by the API for applying end-to-end encryption of the request.
|
3643
|
+
description: The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request.
|
4212
3644
|
FSPIOP-Signature:
|
4213
3645
|
name: FSPIOP-Signature
|
4214
3646
|
in: header
|
4215
3647
|
schema:
|
4216
3648
|
type: string
|
4217
3649
|
required: false
|
4218
|
-
description:
|
4219
|
-
The `FSPIOP-Signature` header field is a non-HTTP standard field used by
|
4220
|
-
the API for applying an end-to-end request signature.
|
3650
|
+
description: The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature.
|
4221
3651
|
FSPIOP-URI:
|
4222
3652
|
name: FSPIOP-URI
|
4223
3653
|
in: header
|
4224
3654
|
schema:
|
4225
3655
|
type: string
|
4226
3656
|
required: false
|
4227
|
-
description:
|
4228
|
-
The `FSPIOP-URI` header field is a non-HTTP standard field used by the
|
4229
|
-
API for signature verification, should contain the service URI. Required
|
4230
|
-
if signature verification is used, for more information, see [the API
|
4231
|
-
Signature
|
4232
|
-
document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
3657
|
+
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).
|
4233
3658
|
FSPIOP-HTTP-Method:
|
4234
3659
|
name: FSPIOP-HTTP-Method
|
4235
3660
|
in: header
|
4236
3661
|
schema:
|
4237
3662
|
type: string
|
4238
3663
|
required: false
|
4239
|
-
description:
|
4240
|
-
The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used
|
4241
|
-
by the API for signature verification, should contain the service HTTP
|
4242
|
-
method. Required if signature verification is used, for more
|
4243
|
-
information, see [the API Signature
|
4244
|
-
document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
3664
|
+
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).
|
4245
3665
|
Accept:
|
4246
3666
|
name: Accept
|
4247
3667
|
in: header
|
4248
3668
|
required: true
|
4249
3669
|
schema:
|
4250
3670
|
type: string
|
4251
|
-
description:
|
4252
|
-
The `Accept` header field indicates the version of the API the client
|
4253
|
-
would like the server to use.
|
3671
|
+
description: The `Accept` header field indicates the version of the API the client would like the server to use.
|
4254
3672
|
Content-Length:
|
4255
3673
|
name: Content-Length
|
4256
3674
|
in: header
|
4257
3675
|
required: false
|
4258
3676
|
schema:
|
4259
3677
|
type: integer
|
4260
|
-
description:
|
4261
|
-
The `Content-Length` header field indicates the anticipated size of the
|
4262
|
-
payload body. Only sent if there is a body.
|
4263
|
-
|
3678
|
+
description: |-
|
3679
|
+
The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4264
3680
|
|
4265
|
-
**Note:** The API supports a maximum size of 5242880 bytes (5
|
4266
|
-
Megabytes).
|
3681
|
+
**Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
4267
3682
|
Type:
|
4268
3683
|
name: Type
|
4269
3684
|
in: path
|
@@ -4376,17 +3791,12 @@ components:
|
|
4376
3791
|
required: false
|
4377
3792
|
schema:
|
4378
3793
|
type: integer
|
4379
|
-
description:
|
4380
|
-
The `Content-Length` header field indicates the anticipated size of the
|
4381
|
-
payload body. Only sent if there is a body.
|
4382
|
-
|
3794
|
+
description: |-
|
3795
|
+
The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
4383
3796
|
|
4384
|
-
**Note:** The API supports a maximum size of 5242880 bytes (5
|
4385
|
-
Megabytes).
|
3797
|
+
**Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
4386
3798
|
Content-Type:
|
4387
3799
|
schema:
|
4388
3800
|
type: string
|
4389
3801
|
required: true
|
4390
|
-
description:
|
4391
|
-
The `Content-Type` header indicates the specific version of the API used
|
4392
|
-
to send the payload body.
|
3802
|
+
description: The `Content-Type` header indicates the specific version of the API used to send the payload body.
|