@mojaloop/api-snippets 17.2.4 → 17.2.5
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/README.md +1 -1
- package/docs/dist/openapi.yaml +2 -2
- package/docs/fspiop-rest-v1.0-openapi3-snippets.yaml +2 -2
- package/docs/fspiop-rest-v1.1-openapi3-snippets.yaml +4 -4
- package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +1 -1
- package/docs/thirdparty-openapi3-snippets.yaml +19 -19
- package/fspiop/v1_0/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +1 -1
- package/fspiop/v1_0/openapi3/components/parameters/FSPIOP-URI.yaml +1 -1
- package/fspiop/v1_1/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +1 -1
- package/fspiop/v1_1/openapi3/components/parameters/FSPIOP-URI.yaml +1 -1
- package/fspiop/v1_1/openapi3/openapi.yaml +2 -2
- package/lib/fspiop/v1_0/openapi.d.ts +2 -2
- package/lib/fspiop/v1_1/openapi.d.ts +2 -2
- package/lib/thirdparty/openapi.d.ts +18 -18
- package/package.json +11 -10
- package/sdk-bulk.yaml +1 -1
- package/sdk-outbound-old.yaml +1 -1
- package/sdk-scheme-adapter/v2_0_0/outbound/openapi.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/Account.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/AccountAddress.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/AccountList.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/AccountsIDPutResponse.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/AuthenticatorAssertionResponse.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/AuthenticatorAttestationResponse.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/ConsentRequestsIDPatchRequest.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/ConsentRequestsPostRequest.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/CredentialType.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/FIDOPublicKeyCredentialAssertion.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/Scope.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/ServiceType.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/ServicesServiceTypePutResponse.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsAuthorizationsPostRequest.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsTransactionsIDPatchResponse.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsTransactionsIDPutResponse.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsTransactionsPostRequest.yaml +1 -1
- package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsVerificationsIDPutResponse.yaml +1 -1
- package/thirdparty/v1_0/openapi3/openapi.yaml +1 -1
- package/thirdparty/v1_0/openapi3/thirdparty-dfsp-api.template.yaml +1 -1
- package/thirdparty/v1_0/openapi3/thirdparty-dfsp-api.yaml +17 -17
- package/thirdparty/v1_0/openapi3/thirdparty-pisp-api.template.yaml +1 -1
- package/thirdparty/v1_0/openapi3/thirdparty-pisp-api.yaml +17 -17
package/CHANGELOG.md
CHANGED
@@ -1,4 +1,11 @@
|
|
1
1
|
# Changelog: [mojaloop/api-snippets](https://github.com/mojaloop/api-snippets)
|
2
|
+
### [17.2.5](https://github.com/mojaloop/api-snippets/compare/v17.2.4...v17.2.5) (2023-09-20)
|
3
|
+
|
4
|
+
|
5
|
+
### Maintenance
|
6
|
+
|
7
|
+
* master to main migration ([#168](https://github.com/mojaloop/api-snippets/issues/168)) ([0e20935](https://github.com/mojaloop/api-snippets/commit/0e20935a3c4acb0aff4627bbfef5139f823dc471))
|
8
|
+
|
2
9
|
### [17.2.4](https://github.com/mojaloop/api-snippets/compare/v17.2.3...v17.2.4) (2023-08-23)
|
3
10
|
|
4
11
|
|
package/README.md
CHANGED
@@ -42,7 +42,7 @@ Validate the result file.
|
|
42
42
|
## Swagger-UI
|
43
43
|
|
44
44
|
The snippets specification is previewable using swagger-ui. Swagger-UI files
|
45
|
-
are found in `docs/dist/`. Github pages uses the
|
45
|
+
are found in `docs/dist/`. Github pages uses the main branch `docs/` folder
|
46
46
|
to build the page found at https://docs.mojaloop.io/api-snippets/
|
47
47
|
|
48
48
|
## Dev Tools
|
package/docs/dist/openapi.yaml
CHANGED
@@ -1356,7 +1356,7 @@ components:
|
|
1356
1356
|
schema:
|
1357
1357
|
type: string
|
1358
1358
|
required: false
|
1359
|
-
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/
|
1359
|
+
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).'
|
1360
1360
|
FSPIOP-Signature:
|
1361
1361
|
name: FSPIOP-Signature
|
1362
1362
|
in: header
|
@@ -1377,7 +1377,7 @@ components:
|
|
1377
1377
|
schema:
|
1378
1378
|
type: string
|
1379
1379
|
required: false
|
1380
|
-
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/
|
1380
|
+
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).'
|
1381
1381
|
ID:
|
1382
1382
|
name: ID
|
1383
1383
|
in: path
|
@@ -4177,7 +4177,7 @@ components:
|
|
4177
4177
|
API for signature verification, should contain the service URI. Required
|
4178
4178
|
if signature verification is used, for more information, see [the API
|
4179
4179
|
Signature
|
4180
|
-
document](https://github.com/mojaloop/docs/tree/
|
4180
|
+
document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
4181
4181
|
FSPIOP-HTTP-Method:
|
4182
4182
|
name: FSPIOP-HTTP-Method
|
4183
4183
|
in: header
|
@@ -4189,7 +4189,7 @@ components:
|
|
4189
4189
|
by the API for signature verification, should contain the service HTTP
|
4190
4190
|
method. Required if signature verification is used, for more
|
4191
4191
|
information, see [the API Signature
|
4192
|
-
document](https://github.com/mojaloop/docs/tree/
|
4192
|
+
document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
4193
4193
|
Accept:
|
4194
4194
|
name: Accept
|
4195
4195
|
in: header
|
@@ -4,14 +4,14 @@ info:
|
|
4
4
|
title: Open API for FSP Interoperability (FSPIOP)
|
5
5
|
description: >-
|
6
6
|
Based on [API Definition updated on 2020-05-19 Version
|
7
|
-
1.1](https://github.com/mojaloop/mojaloop-specification/blob/
|
7
|
+
1.1](https://github.com/mojaloop/mojaloop-specification/blob/main/documents/v1.1-document-set/API%20Definition_v1.1.pdf).
|
8
8
|
|
9
9
|
|
10
10
|
**Note:** The API supports a maximum size of 65536 bytes (64 Kilobytes) in
|
11
11
|
the HTTP header.
|
12
12
|
license:
|
13
13
|
name: CC BY-ND 4.0
|
14
|
-
url: https://github.com/mojaloop/mojaloop-specification/blob/
|
14
|
+
url: https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md
|
15
15
|
contact:
|
16
16
|
name: Sam Kummary
|
17
17
|
url: https://github.com/mojaloop/mojaloop-specification/issues
|
@@ -3730,7 +3730,7 @@ components:
|
|
3730
3730
|
API for signature verification, should contain the service URI. Required
|
3731
3731
|
if signature verification is used, for more information, see [the API
|
3732
3732
|
Signature
|
3733
|
-
document](https://github.com/mojaloop/docs/tree/
|
3733
|
+
document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
3734
3734
|
FSPIOP-HTTP-Method:
|
3735
3735
|
name: FSPIOP-HTTP-Method
|
3736
3736
|
in: header
|
@@ -3742,7 +3742,7 @@ components:
|
|
3742
3742
|
by the API for signature verification, should contain the service HTTP
|
3743
3743
|
method. Required if signature verification is used, for more
|
3744
3744
|
information, see [the API Signature
|
3745
|
-
document](https://github.com/mojaloop/docs/tree/
|
3745
|
+
document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
3746
3746
|
Accept:
|
3747
3747
|
name: Accept
|
3748
3748
|
in: header
|
@@ -17,7 +17,7 @@ info:
|
|
17
17
|
the term "FSP" is equal to the term "DFSP".
|
18
18
|
license:
|
19
19
|
name: Apache License Version 2.0, January 2004
|
20
|
-
url: https://github.com/mojaloop/documentation/blob/
|
20
|
+
url: https://github.com/mojaloop/documentation/blob/main/LICENSE.md
|
21
21
|
version: 1.0.0
|
22
22
|
paths:
|
23
23
|
/:
|
@@ -4,7 +4,7 @@ info:
|
|
4
4
|
title: Thirdparty Snippets
|
5
5
|
description: |
|
6
6
|
Based on sequence diagrams
|
7
|
-
(https://github.com/mojaloop/pisp/tree/
|
7
|
+
(https://github.com/mojaloop/pisp/tree/main/docs/out).
|
8
8
|
This is a work in progress.
|
9
9
|
license:
|
10
10
|
name: TBD
|
@@ -2619,7 +2619,7 @@ components:
|
|
2619
2619
|
which was originally used by the PISP to identify the transaction
|
2620
2620
|
request.
|
2621
2621
|
|
2622
|
-
https://github.com/mojaloop/documentation/blob/
|
2622
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
2623
2623
|
properties:
|
2624
2624
|
completedTimestamp:
|
2625
2625
|
$ref: '#/components/schemas/DateTime'
|
@@ -2710,7 +2710,7 @@ components:
|
|
2710
2710
|
features enabled. - PISP - Enum used to query for PISPs. - AUTH_SERVICE
|
2711
2711
|
- Participants which provide Authentication Services.
|
2712
2712
|
|
2713
|
-
https://github.com/mojaloop/documentation/blob/
|
2713
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3229-servicetype
|
2714
2714
|
enum:
|
2715
2715
|
- THIRD_PARTY_DFSP
|
2716
2716
|
- PISP
|
@@ -3021,7 +3021,7 @@ components:
|
|
3021
3021
|
is at the discretion of the address space owner (the payer DFSP in this
|
3022
3022
|
case).
|
3023
3023
|
|
3024
|
-
https://github.com/mojaloop/documentation/blob/
|
3024
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
|
3025
3025
|
pattern: ^([0-9A-Za-z_~\-\.]+[0-9A-Za-z_~\-])$
|
3026
3026
|
minLength: 1
|
3027
3027
|
maxLength: 1023
|
@@ -3031,7 +3031,7 @@ components:
|
|
3031
3031
|
description: >-
|
3032
3032
|
Data model for the complex type Account.
|
3033
3033
|
|
3034
|
-
https://github.com/mojaloop/documentation/blob/
|
3034
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account
|
3035
3035
|
properties:
|
3036
3036
|
accountNickname:
|
3037
3037
|
$ref: '#/components/schemas/Name'
|
@@ -3050,7 +3050,7 @@ components:
|
|
3050
3050
|
The AccountList data model is used to hold information about the
|
3051
3051
|
accounts that a party controls.
|
3052
3052
|
|
3053
|
-
https://github.com/mojaloop/documentation/blob/
|
3053
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist
|
3054
3054
|
items:
|
3055
3055
|
$ref: '#/components/schemas/Account'
|
3056
3056
|
minItems: 1
|
@@ -3068,7 +3068,7 @@ components:
|
|
3068
3068
|
result of a request for accounts information. The identifier ID given in
|
3069
3069
|
the call are the values given in the original request.
|
3070
3070
|
|
3071
|
-
https://github.com/mojaloop/documentation/blob/
|
3071
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
|
3072
3072
|
properties:
|
3073
3073
|
accounts:
|
3074
3074
|
$ref: '#/components/schemas/AccountList'
|
@@ -3116,7 +3116,7 @@ components:
|
|
3116
3116
|
DFSP, an account on which access types can be requested or granted. It
|
3117
3117
|
also defines the access types which are requested or granted.
|
3118
3118
|
|
3119
|
-
https://github.com/mojaloop/documentation/blob/
|
3119
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope
|
3120
3120
|
properties:
|
3121
3121
|
address:
|
3122
3122
|
$ref: '#/components/schemas/AccountAddress'
|
@@ -3163,7 +3163,7 @@ components:
|
|
3163
3163
|
Callback: PUT /consentRequests/{ID} Error callback: PUT
|
3164
3164
|
/consentRequests/{ID}/error Data model - see below url
|
3165
3165
|
|
3166
|
-
https://github.com/mojaloop/documentation/blob/
|
3166
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests
|
3167
3167
|
properties:
|
3168
3168
|
consentRequestId:
|
3169
3169
|
$ref: '#/components/schemas/CorrelationId'
|
@@ -3299,7 +3299,7 @@ components:
|
|
3299
3299
|
PISP will receive a token which they can use to prove to the DFSP that
|
3300
3300
|
the user trusts this PISP.
|
3301
3301
|
|
3302
|
-
https://github.com/mojaloop/documentation/blob/
|
3302
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid
|
3303
3303
|
properties:
|
3304
3304
|
authToken:
|
3305
3305
|
$ref: '#/components/schemas/BinaryString'
|
@@ -3319,7 +3319,7 @@ components:
|
|
3319
3319
|
"GENERIC" - The credential is based on a simple public key validation.
|
3320
3320
|
Its payload is a GenericCredential object.
|
3321
3321
|
|
3322
|
-
https://github.com/mojaloop/documentation/blob/
|
3322
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype
|
3323
3323
|
CredentialStatusPending:
|
3324
3324
|
title: CredentialStatusPending
|
3325
3325
|
type: string
|
@@ -3685,7 +3685,7 @@ components:
|
|
3685
3685
|
Callback - PUT /services/{ServiceType} Error Callback - PUT
|
3686
3686
|
/services/{ServiceType}/error Data Model - Empty body
|
3687
3687
|
|
3688
|
-
https://github.com/mojaloop/documentation/blob/
|
3688
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31531-put-servicesservicetype
|
3689
3689
|
properties:
|
3690
3690
|
providers:
|
3691
3691
|
type: array
|
@@ -3714,7 +3714,7 @@ components:
|
|
3714
3714
|
PUT /thirdpartyRequests/transactions/{ID}/error Data Model - See link
|
3715
3715
|
below
|
3716
3716
|
|
3717
|
-
https://github.com/mojaloop/documentation/blob/
|
3717
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions
|
3718
3718
|
properties:
|
3719
3719
|
transactionRequestId:
|
3720
3720
|
allOf:
|
@@ -3778,7 +3778,7 @@ components:
|
|
3778
3778
|
/thirdpartyRequests/transactions/{ID}), the DFSP will send this
|
3779
3779
|
callback.
|
3780
3780
|
|
3781
|
-
https://github.com/mojaloop/documentation/blob/
|
3781
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
|
3782
3782
|
properties:
|
3783
3783
|
transactionId:
|
3784
3784
|
$ref: '#/components/schemas/CorrelationId'
|
@@ -3804,7 +3804,7 @@ components:
|
|
3804
3804
|
PUT /thirdpartyRequests/authorizations/{ID}/error Data Model - See below
|
3805
3805
|
url
|
3806
3806
|
|
3807
|
-
https://github.com/mojaloop/documentation/blob/
|
3807
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
3808
3808
|
type: object
|
3809
3809
|
properties:
|
3810
3810
|
authorizationRequestId:
|
@@ -3914,7 +3914,7 @@ components:
|
|
3914
3914
|
For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
|
3915
3915
|
|
3916
3916
|
|
3917
|
-
https://github.com/mojaloop/documentation/blob/
|
3917
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
|
3918
3918
|
properties:
|
3919
3919
|
id:
|
3920
3920
|
type: string
|
@@ -4125,7 +4125,7 @@ components:
|
|
4125
4125
|
request the check, or the {ID} that was used in the GET
|
4126
4126
|
/thirdpartyRequests/verifications/{ID}.
|
4127
4127
|
|
4128
|
-
https://github.com/mojaloop/documentation/blob/
|
4128
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31821-put-thirdpartyrequestsverificationsid
|
4129
4129
|
properties:
|
4130
4130
|
authenticationResponse:
|
4131
4131
|
$ref: '#/components/schemas/AuthenticationResponse'
|
@@ -4229,7 +4229,7 @@ components:
|
|
4229
4229
|
API for signature verification, should contain the service URI. Required
|
4230
4230
|
if signature verification is used, for more information, see [the API
|
4231
4231
|
Signature
|
4232
|
-
document](https://github.com/mojaloop/docs/tree/
|
4232
|
+
document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
4233
4233
|
FSPIOP-HTTP-Method:
|
4234
4234
|
name: FSPIOP-HTTP-Method
|
4235
4235
|
in: header
|
@@ -4241,7 +4241,7 @@ components:
|
|
4241
4241
|
by the API for signature verification, should contain the service HTTP
|
4242
4242
|
method. Required if signature verification is used, for more
|
4243
4243
|
information, see [the API Signature
|
4244
|
-
document](https://github.com/mojaloop/docs/tree/
|
4244
|
+
document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
4245
4245
|
Accept:
|
4246
4246
|
name: Accept
|
4247
4247
|
in: header
|
@@ -8,4 +8,4 @@ description: >-
|
|
8
8
|
API for signature verification, should contain the service HTTP method.
|
9
9
|
Required if signature verification is used, for more information, see [the API
|
10
10
|
Signature
|
11
|
-
document](https://github.com/mojaloop/docs/tree/
|
11
|
+
document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
@@ -7,4 +7,4 @@ description: >-
|
|
7
7
|
The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for
|
8
8
|
signature verification, should contain the service URI. Required if signature
|
9
9
|
verification is used, for more information, see [the API Signature
|
10
|
-
document](https://github.com/mojaloop/docs/tree/
|
10
|
+
document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
@@ -8,4 +8,4 @@ description: >-
|
|
8
8
|
API for signature verification, should contain the service HTTP method.
|
9
9
|
Required if signature verification is used, for more information, see [the API
|
10
10
|
Signature
|
11
|
-
document](https://github.com/mojaloop/docs/tree/
|
11
|
+
document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
@@ -7,4 +7,4 @@ description: >-
|
|
7
7
|
The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for
|
8
8
|
signature verification, should contain the service URI. Required if signature
|
9
9
|
verification is used, for more information, see [the API Signature
|
10
|
-
document](https://github.com/mojaloop/docs/tree/
|
10
|
+
document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).
|
@@ -4,14 +4,14 @@ info:
|
|
4
4
|
title: Open API for FSP Interoperability (FSPIOP)
|
5
5
|
description: >-
|
6
6
|
Based on [API Definition updated on 2020-05-19 Version
|
7
|
-
1.1](https://github.com/mojaloop/mojaloop-specification/blob/
|
7
|
+
1.1](https://github.com/mojaloop/mojaloop-specification/blob/main/documents/v1.1-document-set/API%20Definition_v1.1.pdf).
|
8
8
|
|
9
9
|
|
10
10
|
**Note:** The API supports a maximum size of 65536 bytes (64 Kilobytes) in
|
11
11
|
the HTTP header.
|
12
12
|
license:
|
13
13
|
name: CC BY-ND 4.0
|
14
|
-
url: 'https://github.com/mojaloop/mojaloop-specification/blob/
|
14
|
+
url: 'https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md'
|
15
15
|
contact:
|
16
16
|
name: Sam Kummary
|
17
17
|
url: 'https://github.com/mojaloop/mojaloop-specification/issues'
|
@@ -1948,9 +1948,9 @@ export interface components {
|
|
1948
1948
|
"FSPIOP-Encryption"?: string;
|
1949
1949
|
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1950
1950
|
"FSPIOP-Signature"?: string;
|
1951
|
-
/** @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/
|
1951
|
+
/** @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). */
|
1952
1952
|
"FSPIOP-URI"?: string;
|
1953
|
-
/** @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/
|
1953
|
+
/** @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). */
|
1954
1954
|
"FSPIOP-HTTP-Method"?: string;
|
1955
1955
|
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1956
1956
|
Accept: string;
|
@@ -1365,9 +1365,9 @@ export interface components {
|
|
1365
1365
|
"FSPIOP-Encryption"?: string;
|
1366
1366
|
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1367
1367
|
"FSPIOP-Signature"?: string;
|
1368
|
-
/** @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/
|
1368
|
+
/** @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). */
|
1369
1369
|
"FSPIOP-URI"?: string;
|
1370
|
-
/** @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/
|
1370
|
+
/** @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). */
|
1371
1371
|
"FSPIOP-HTTP-Method"?: string;
|
1372
1372
|
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1373
1373
|
Accept: string;
|
@@ -1003,7 +1003,7 @@ export interface components {
|
|
1003
1003
|
* The issuing PISP will expect a response to their request for a transfer which describes the finalized state of the requested transfer.
|
1004
1004
|
* This response will be given by a PATCH call on the /thirdpartyRequests/transactions/{ID} resource.
|
1005
1005
|
* The {ID} given in the query string should be the transactionRequestId which was originally used by the PISP to identify the transaction request.
|
1006
|
-
* https://github.com/mojaloop/documentation/blob/
|
1006
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
1007
1007
|
*/
|
1008
1008
|
ThirdpartyRequestsTransactionsIDPatchResponse: {
|
1009
1009
|
completedTimestamp?: components["schemas"]["DateTime"];
|
@@ -1066,7 +1066,7 @@ export interface components {
|
|
1066
1066
|
* ServiceType
|
1067
1067
|
* @description The ServiceType enumeration describes the types of role for which a DFSP may query using the /services resource.
|
1068
1068
|
* 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.
|
1069
|
-
* https://github.com/mojaloop/documentation/blob/
|
1069
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3229-servicetype
|
1070
1070
|
* @enum {string}
|
1071
1071
|
*/
|
1072
1072
|
ServiceType: "THIRD_PARTY_DFSP" | "PISP" | "AUTH_SERVICE";
|
@@ -1241,13 +1241,13 @@ export interface components {
|
|
1241
1241
|
* - Underscore (_) - Tilde (~) - Hyphen (-) - Period (.) Addresses MUST NOT end in a period (.) character
|
1242
1242
|
* 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.
|
1243
1243
|
* 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).
|
1244
|
-
* https://github.com/mojaloop/documentation/blob/
|
1244
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
|
1245
1245
|
*/
|
1246
1246
|
AccountAddress: string;
|
1247
1247
|
/**
|
1248
1248
|
* Account
|
1249
1249
|
* @description Data model for the complex type Account.
|
1250
|
-
* https://github.com/mojaloop/documentation/blob/
|
1250
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account
|
1251
1251
|
*/
|
1252
1252
|
Account: {
|
1253
1253
|
accountNickname: components["schemas"]["Name"];
|
@@ -1257,7 +1257,7 @@ export interface components {
|
|
1257
1257
|
/**
|
1258
1258
|
* AccountList
|
1259
1259
|
* @description The AccountList data model is used to hold information about the accounts that a party controls.
|
1260
|
-
* https://github.com/mojaloop/documentation/blob/
|
1260
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist
|
1261
1261
|
*/
|
1262
1262
|
AccountList: components["schemas"]["Account"][];
|
1263
1263
|
/**
|
@@ -1265,7 +1265,7 @@ export interface components {
|
|
1265
1265
|
* @description Callback and data model information for GET /accounts/{ID}:
|
1266
1266
|
* Callback - PUT /accounts/{ID} Error Callback - PUT /accounts/{ID}/error Data Model - Empty body
|
1267
1267
|
* 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.
|
1268
|
-
* https://github.com/mojaloop/documentation/blob/
|
1268
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
|
1269
1269
|
*/
|
1270
1270
|
AccountsIDPutResponse: {
|
1271
1271
|
accounts: components["schemas"]["AccountList"];
|
@@ -1294,7 +1294,7 @@ export interface components {
|
|
1294
1294
|
/**
|
1295
1295
|
* Scope
|
1296
1296
|
* @description 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.
|
1297
|
-
* https://github.com/mojaloop/documentation/blob/
|
1297
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope
|
1298
1298
|
*/
|
1299
1299
|
Scope: {
|
1300
1300
|
address: components["schemas"]["AccountAddress"];
|
@@ -1320,7 +1320,7 @@ export interface components {
|
|
1320
1320
|
* 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.
|
1321
1321
|
* Callback and data model for POST /consentRequests:
|
1322
1322
|
* Callback: PUT /consentRequests/{ID} Error callback: PUT /consentRequests/{ID}/error Data model - see below url
|
1323
|
-
* https://github.com/mojaloop/documentation/blob/
|
1323
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests
|
1324
1324
|
*/
|
1325
1325
|
ConsentRequestsPostRequest: {
|
1326
1326
|
consentRequestId: components["schemas"]["CorrelationId"];
|
@@ -1379,7 +1379,7 @@ export interface components {
|
|
1379
1379
|
* ConsentRequestsIDPatchRequest
|
1380
1380
|
* @description Used by: PISP
|
1381
1381
|
* 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.
|
1382
|
-
* https://github.com/mojaloop/documentation/blob/
|
1382
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid
|
1383
1383
|
*/
|
1384
1384
|
ConsentRequestsIDPatchRequest: {
|
1385
1385
|
authToken: components["schemas"]["BinaryString"];
|
@@ -1388,7 +1388,7 @@ export interface components {
|
|
1388
1388
|
/**
|
1389
1389
|
* CredentialType
|
1390
1390
|
* @description 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.
|
1391
|
-
* https://github.com/mojaloop/documentation/blob/
|
1391
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype
|
1392
1392
|
* @enum {string}
|
1393
1393
|
*/
|
1394
1394
|
CredentialType: "FIDO" | "GENERIC";
|
@@ -1594,7 +1594,7 @@ export interface components {
|
|
1594
1594
|
* The callback PUT /services/{ServiceType} is used to inform the client of a successful result of the service information lookup.
|
1595
1595
|
* Callback and data model information for GET /services/{ServiceType}:
|
1596
1596
|
* Callback - PUT /services/{ServiceType} Error Callback - PUT /services/{ServiceType}/error Data Model - Empty body
|
1597
|
-
* https://github.com/mojaloop/documentation/blob/
|
1597
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31531-put-servicesservicetype
|
1598
1598
|
*/
|
1599
1599
|
ServicesServiceTypePutResponse: {
|
1600
1600
|
providers: components["schemas"]["FspId"][];
|
@@ -1606,7 +1606,7 @@ export interface components {
|
|
1606
1606
|
* 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.
|
1607
1607
|
* Callback and data model information for POST /thirdpartyRequests/transactions:
|
1608
1608
|
* Callback - PUT /thirdpartyRequests/transactions/{ID} Error Callback - PUT /thirdpartyRequests/transactions/{ID}/error Data Model - See link below
|
1609
|
-
* https://github.com/mojaloop/documentation/blob/
|
1609
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions
|
1610
1610
|
*/
|
1611
1611
|
ThirdpartyRequestsTransactionsPostRequest: {
|
1612
1612
|
/** @description 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. */
|
@@ -1635,7 +1635,7 @@ export interface components {
|
|
1635
1635
|
* ThirdpartyRequestsTransactionsIDPutResponse
|
1636
1636
|
* @description Used by: DFSP
|
1637
1637
|
* 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.
|
1638
|
-
* https://github.com/mojaloop/documentation/blob/
|
1638
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
|
1639
1639
|
*/
|
1640
1640
|
ThirdpartyRequestsTransactionsIDPutResponse: {
|
1641
1641
|
transactionId?: components["schemas"]["CorrelationId"];
|
@@ -1648,7 +1648,7 @@ export interface components {
|
|
1648
1648
|
* The HTTP request POST /thirdpartyRequests/authorizations is used to request the validation by a customer for the transfer described in the request.
|
1649
1649
|
* Callback and data model information for POST /thirdpartyRequests/authorizations:
|
1650
1650
|
* Callback - PUT /thirdpartyRequests/authorizations/{ID} Error Callback - PUT /thirdpartyRequests/authorizations/{ID}/error Data Model - See below url
|
1651
|
-
* https://github.com/mojaloop/documentation/blob/
|
1651
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
1652
1652
|
*/
|
1653
1653
|
ThirdpartyRequestsAuthorizationsPostRequest: {
|
1654
1654
|
authorizationRequestId: components["schemas"]["CorrelationId"];
|
@@ -1707,7 +1707,7 @@ export interface components {
|
|
1707
1707
|
* Javascript ArrayBuffer.
|
1708
1708
|
* For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
|
1709
1709
|
*
|
1710
|
-
* https://github.com/mojaloop/documentation/blob/
|
1710
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
|
1711
1711
|
*/
|
1712
1712
|
FIDOPublicKeyCredentialAssertion: {
|
1713
1713
|
/**
|
@@ -1816,7 +1816,7 @@ export interface components {
|
|
1816
1816
|
* ThirdpartyRequestsVerificationsIDPutResponse
|
1817
1817
|
* @description Used by: Auth Service
|
1818
1818
|
* 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}.
|
1819
|
-
* https://github.com/mojaloop/documentation/blob/
|
1819
|
+
* https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31821-put-thirdpartyrequestsverificationsid
|
1820
1820
|
*/
|
1821
1821
|
ThirdpartyRequestsVerificationsIDPutResponse: {
|
1822
1822
|
authenticationResponse: components["schemas"]["AuthenticationResponse"];
|
@@ -1934,9 +1934,9 @@ export interface components {
|
|
1934
1934
|
"FSPIOP-Encryption"?: string;
|
1935
1935
|
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1936
1936
|
"FSPIOP-Signature"?: string;
|
1937
|
-
/** @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/
|
1937
|
+
/** @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). */
|
1938
1938
|
"FSPIOP-URI"?: string;
|
1939
|
-
/** @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/
|
1939
|
+
/** @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). */
|
1940
1940
|
"FSPIOP-HTTP-Method"?: string;
|
1941
1941
|
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1942
1942
|
Accept: string;
|
package/package.json
CHANGED
@@ -1,6 +1,6 @@
|
|
1
1
|
{
|
2
2
|
"name": "@mojaloop/api-snippets",
|
3
|
-
"version": "17.2.
|
3
|
+
"version": "17.2.5",
|
4
4
|
"description": "Mojaloop API specification reusable snippets",
|
5
5
|
"main": "lib/index.js",
|
6
6
|
"types": "lib/index.d.ts",
|
@@ -28,11 +28,12 @@
|
|
28
28
|
"build:schemas:sdk-scheme-adapter:outbound": "npx ts-node --transpile-only src/scripts/json-schema-generator.ts docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml src/sdk-scheme-adapter/v2_0_0/outbound",
|
29
29
|
"lint": "eslint --ext ts --ext js test src",
|
30
30
|
"lint:fix": "eslint --fix --ext ts --ext js test src",
|
31
|
-
"prepare": "npm run build",
|
31
|
+
"prepare": "husky install && npm run build",
|
32
32
|
"dep:check": "ncu -e 2",
|
33
33
|
"dep:update": "ncu -u",
|
34
34
|
"release": "standard-version --releaseCommitMessageFormat 'chore(release): {{currentTag}} [skip ci]'",
|
35
35
|
"snapshot": "standard-version --no-verify --skip.changelog --prerelease snapshot --releaseCommitMessageFormat 'chore(snapshot): {{currentTag}}'",
|
36
|
+
"test": "npm run test:unit",
|
36
37
|
"test:unit": "jest --testMatch '**/test/dto/*.(test|spec).ts'"
|
37
38
|
},
|
38
39
|
"lint-staged": {
|
@@ -63,7 +64,7 @@
|
|
63
64
|
"js-yaml": "^4.1.0",
|
64
65
|
"json-refs": "^3.0.15",
|
65
66
|
"openapi-types": "^12.1.3",
|
66
|
-
"openapi-typescript": "^6.
|
67
|
+
"openapi-typescript": "^6.6.1",
|
67
68
|
"ts-auto-mock": "^3.7.1"
|
68
69
|
},
|
69
70
|
"overrides": {
|
@@ -75,11 +76,11 @@
|
|
75
76
|
"@commitlint/config-conventional": "^17.7.0",
|
76
77
|
"@redocly/openapi-cli": "^1.0.0-beta.94",
|
77
78
|
"@types/jest": "^29.5.4",
|
78
|
-
"@typescript-eslint/eslint-plugin": "^6.
|
79
|
-
"@typescript-eslint/parser": "^6.
|
79
|
+
"@typescript-eslint/eslint-plugin": "^6.7.0",
|
80
|
+
"@typescript-eslint/parser": "^6.7.0",
|
80
81
|
"audit-ci": "^6.6.1",
|
81
82
|
"diff": "^5.1.0",
|
82
|
-
"eslint": "^8.
|
83
|
+
"eslint": "^8.49.0",
|
83
84
|
"eslint-config-prettier": "^9.0.0",
|
84
85
|
"eslint-config-standard": "^17.1.0",
|
85
86
|
"eslint-import-resolver-typescript": "^3.6.0",
|
@@ -90,18 +91,18 @@
|
|
90
91
|
"eslint-plugin-promise": "^6.1.1",
|
91
92
|
"eslint-plugin-standard": "^5.0.0",
|
92
93
|
"husky": "8.0.3",
|
93
|
-
"jest": "^29.
|
94
|
+
"jest": "^29.7.0",
|
94
95
|
"jest-junit": "^16.0.0",
|
95
96
|
"lint-staged": "^14.0.1",
|
96
|
-
"npm-check-updates": "^16.
|
97
|
-
"prettier": "^3.0.
|
97
|
+
"npm-check-updates": "^16.14.2",
|
98
|
+
"prettier": "^3.0.3",
|
98
99
|
"standard-version": "^9.5.0",
|
99
100
|
"swagger-cli": "^4.0.4",
|
100
101
|
"ts-jest": "^29.1.1",
|
101
102
|
"ts-node": "^10.9.1",
|
102
103
|
"ts-patch": "^3.0.2",
|
103
104
|
"tslib": "^2.6.2",
|
104
|
-
"typescript": "^5.
|
105
|
+
"typescript": "^5.2.2"
|
105
106
|
},
|
106
107
|
"publishConfig": {
|
107
108
|
"registry": "https://registry.npmjs.org/"
|
package/sdk-bulk.yaml
CHANGED
@@ -17,7 +17,7 @@ info:
|
|
17
17
|
the term "FSP" is equal to the term "DFSP".
|
18
18
|
license:
|
19
19
|
name: Apache License Version 2.0, January 2004
|
20
|
-
url: https://github.com/mojaloop/documentation/blob/
|
20
|
+
url: https://github.com/mojaloop/documentation/blob/main/LICENSE.md
|
21
21
|
version: 1.0.0
|
22
22
|
paths:
|
23
23
|
/:
|
package/sdk-outbound-old.yaml
CHANGED
@@ -17,7 +17,7 @@ info:
|
|
17
17
|
the term "FSP" is equal to the term "DFSP".
|
18
18
|
license:
|
19
19
|
name: 'Apache License Version 2.0, January 2004'
|
20
|
-
url: 'https://github.com/mojaloop/documentation/blob/
|
20
|
+
url: 'https://github.com/mojaloop/documentation/blob/main/LICENSE.md'
|
21
21
|
version: 2.0.0
|
22
22
|
paths:
|
23
23
|
/:
|
@@ -17,7 +17,7 @@ info:
|
|
17
17
|
the term "FSP" is equal to the term "DFSP".
|
18
18
|
license:
|
19
19
|
name: Apache License Version 2.0, January 2004
|
20
|
-
url: https://github.com/mojaloop/documentation/blob/
|
20
|
+
url: https://github.com/mojaloop/documentation/blob/main/LICENSE.md
|
21
21
|
version: 1.0.0
|
22
22
|
paths:
|
23
23
|
/:
|
@@ -3,7 +3,7 @@ type: object
|
|
3
3
|
description: >-
|
4
4
|
Data model for the complex type Account.
|
5
5
|
|
6
|
-
https://github.com/mojaloop/documentation/blob/
|
6
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account
|
7
7
|
properties:
|
8
8
|
accountNickname:
|
9
9
|
$ref: ./Name.yaml
|
@@ -19,7 +19,7 @@ description: >-
|
|
19
19
|
|
20
20
|
IMPORTANT: The policy for defining addresses and the life-cycle of these is at the discretion of the address space owner (the payer DFSP in this case).
|
21
21
|
|
22
|
-
https://github.com/mojaloop/documentation/blob/
|
22
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
|
23
23
|
pattern: '^([0-9A-Za-z_~\-\.]+[0-9A-Za-z_~\-])$'
|
24
24
|
minLength: 1
|
25
25
|
maxLength: 1023
|
@@ -4,7 +4,7 @@ description: >-
|
|
4
4
|
The AccountList data model is used to hold information about the accounts
|
5
5
|
that a party controls.
|
6
6
|
|
7
|
-
https://github.com/mojaloop/documentation/blob/
|
7
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist
|
8
8
|
items:
|
9
9
|
$ref: ./Account.yaml
|
10
10
|
minItems: 1
|
@@ -11,7 +11,7 @@ description: >-
|
|
11
11
|
of a request for accounts information. The identifier ID given in the call
|
12
12
|
are the values given in the original request.
|
13
13
|
|
14
|
-
https://github.com/mojaloop/documentation/blob/
|
14
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
|
15
15
|
properties:
|
16
16
|
accounts:
|
17
17
|
$ref: ./AccountList.yaml
|
@@ -3,7 +3,7 @@ type: object
|
|
3
3
|
description: >-
|
4
4
|
A data model representing an AssertionStatement from WebAuthN.
|
5
5
|
|
6
|
-
https://github.com/mojaloop/documentation/blob/
|
6
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32130-authenticatorassertionresponse
|
7
7
|
properties:
|
8
8
|
authenticatorData:
|
9
9
|
type: string
|
@@ -3,7 +3,7 @@ type: object
|
|
3
3
|
description: |
|
4
4
|
A data model representing an AttestationStatement from WebAuthN.
|
5
5
|
|
6
|
-
https://github.com/mojaloop/documentation/blob/
|
6
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32129-authenticatorattestationresponse
|
7
7
|
properties:
|
8
8
|
clientDataJSON:
|
9
9
|
type: string
|
@@ -7,7 +7,7 @@ description: >-
|
|
7
7
|
the PISP will receive a token which they can use to prove to the DFSP
|
8
8
|
that the user trusts this PISP.
|
9
9
|
|
10
|
-
https://github.com/mojaloop/documentation/blob/
|
10
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid
|
11
11
|
properties:
|
12
12
|
authToken:
|
13
13
|
$ref: ./BinaryString.yaml
|
@@ -13,7 +13,7 @@ description: >-
|
|
13
13
|
Error callback: PUT /consentRequests/{ID}/error
|
14
14
|
Data model - see below url
|
15
15
|
|
16
|
-
https://github.com/mojaloop/documentation/blob/
|
16
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests
|
17
17
|
properties:
|
18
18
|
consentRequestId:
|
19
19
|
$ref: ./CorrelationId.yaml
|
@@ -8,4 +8,4 @@ description: >-
|
|
8
8
|
- "FIDO" - The credential is based on a FIDO challenge. Its payload is a FIDOPublicKeyCredentialAttestation object.
|
9
9
|
- "GENERIC" - The credential is based on a simple public key validation. Its payload is a GenericCredential object.
|
10
10
|
|
11
|
-
https://github.com/mojaloop/documentation/blob/
|
11
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype
|
@@ -8,7 +8,7 @@ description: |
|
|
8
8
|
Javascript ArrayBuffer.
|
9
9
|
For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
|
10
10
|
|
11
|
-
https://github.com/mojaloop/documentation/blob/
|
11
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
|
12
12
|
properties:
|
13
13
|
id:
|
14
14
|
type: string
|
@@ -5,7 +5,7 @@ description: >-
|
|
5
5
|
an account on which access types can be requested or granted.
|
6
6
|
It also defines the access types which are requested or granted.
|
7
7
|
|
8
|
-
https://github.com/mojaloop/documentation/blob/
|
8
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope
|
9
9
|
properties:
|
10
10
|
address:
|
11
11
|
$ref: ./AccountAddress.yaml
|
@@ -8,7 +8,7 @@ description: >-
|
|
8
8
|
- PISP - Enum used to query for PISPs.
|
9
9
|
- AUTH_SERVICE - Participants which provide Authentication Services.
|
10
10
|
|
11
|
-
https://github.com/mojaloop/documentation/blob/
|
11
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3229-servicetype
|
12
12
|
enum:
|
13
13
|
- THIRD_PARTY_DFSP
|
14
14
|
- PISP
|
@@ -12,7 +12,7 @@ description: >-
|
|
12
12
|
Error Callback - PUT /services/{ServiceType}/error
|
13
13
|
Data Model - Empty body
|
14
14
|
|
15
|
-
https://github.com/mojaloop/documentation/blob/
|
15
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31531-put-servicesservicetype
|
16
16
|
properties:
|
17
17
|
providers:
|
18
18
|
type: array
|
package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsAuthorizationsPostRequest.yaml
CHANGED
@@ -11,7 +11,7 @@ description: >-
|
|
11
11
|
Error Callback - PUT /thirdpartyRequests/authorizations/{ID}/error
|
12
12
|
Data Model - See below url
|
13
13
|
|
14
|
-
https://github.com/mojaloop/documentation/blob/
|
14
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
15
15
|
type: object
|
16
16
|
properties:
|
17
17
|
authorizationRequestId:
|
@@ -12,7 +12,7 @@ description: >-
|
|
12
12
|
The {ID} given in the query string should be the transactionRequestId which
|
13
13
|
was originally used by the PISP to identify the transaction request.
|
14
14
|
|
15
|
-
https://github.com/mojaloop/documentation/blob/
|
15
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
16
16
|
properties:
|
17
17
|
completedTimestamp:
|
18
18
|
$ref: ./DateTime.yaml
|
package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsTransactionsIDPutResponse.yaml
CHANGED
@@ -8,7 +8,7 @@ description: >-
|
|
8
8
|
Third Party Transaction request (GET /thirdpartyRequests/transactions/{ID}),
|
9
9
|
the DFSP will send this callback.
|
10
10
|
|
11
|
-
https://github.com/mojaloop/documentation/blob/
|
11
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
|
12
12
|
properties:
|
13
13
|
transactionId:
|
14
14
|
$ref: ./CorrelationId.yaml
|
package/thirdparty/v1_0/openapi3/components/schemas/ThirdpartyRequestsTransactionsPostRequest.yaml
CHANGED
@@ -11,7 +11,7 @@ description: >-
|
|
11
11
|
Error Callback - PUT /thirdpartyRequests/transactions/{ID}/error
|
12
12
|
Data Model - See link below
|
13
13
|
|
14
|
-
https://github.com/mojaloop/documentation/blob/
|
14
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions
|
15
15
|
properties:
|
16
16
|
transactionRequestId:
|
17
17
|
allOf:
|
@@ -9,7 +9,7 @@ description: >-
|
|
9
9
|
which was used to request the check, or the {ID} that was used in the
|
10
10
|
GET /thirdpartyRequests/verifications/{ID}.
|
11
11
|
|
12
|
-
https://github.com/mojaloop/documentation/blob/
|
12
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31821-put-thirdpartyrequestsverificationsid
|
13
13
|
properties:
|
14
14
|
authenticationResponse:
|
15
15
|
$ref: ./AuthenticationResponse.yaml
|
@@ -13,7 +13,7 @@ info:
|
|
13
13
|
Party API (PISP) instead.
|
14
14
|
license:
|
15
15
|
name: Open API for FSP Interoperability (FSPIOP) (Implementation Friendly Version)
|
16
|
-
url: https://github.com/mojaloop/mojaloop-specification/blob/
|
16
|
+
url: https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md
|
17
17
|
servers:
|
18
18
|
- url: /
|
19
19
|
paths:
|
@@ -8,7 +8,7 @@ info:
|
|
8
8
|
PISPs should implement the accompanying API - Mojaloop Third Party API (PISP) instead.
|
9
9
|
license:
|
10
10
|
name: Open API for FSP Interoperability (FSPIOP) (Implementation Friendly Version)
|
11
|
-
url: 'https://github.com/mojaloop/mojaloop-specification/blob/
|
11
|
+
url: 'https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md'
|
12
12
|
servers:
|
13
13
|
- url: /
|
14
14
|
paths:
|
@@ -79,20 +79,20 @@ paths:
|
|
79
79
|
Callback and data model information for GET /accounts/{ID}:
|
80
80
|
Callback - PUT /accounts/{ID} Error Callback - PUT /accounts/{ID}/error Data Model - Empty body
|
81
81
|
The PUT /accounts/{ID} response is used to inform the requester of the result of a request for accounts information. The identifier ID given in the call are the values given in the original request.
|
82
|
-
https://github.com/mojaloop/documentation/blob/
|
82
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
|
83
83
|
properties:
|
84
84
|
accountList:
|
85
85
|
title: AccountList
|
86
86
|
type: array
|
87
87
|
description: |-
|
88
88
|
The AccountList data model is used to hold information about the accounts that a party controls.
|
89
|
-
https://github.com/mojaloop/documentation/blob/
|
89
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist
|
90
90
|
items:
|
91
91
|
title: Account
|
92
92
|
type: object
|
93
93
|
description: |-
|
94
94
|
Data model for the complex type Account.
|
95
|
-
https://github.com/mojaloop/documentation/blob/
|
95
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account
|
96
96
|
properties:
|
97
97
|
accountNickname:
|
98
98
|
title: Name
|
@@ -255,7 +255,7 @@ paths:
|
|
255
255
|
The HTTP request POST /consentRequests is used to request a DFSP to grant access to one or more accounts owned by a customer of the DFSP for the PISP who sends the request.
|
256
256
|
Callback and data model for POST /consentRequests:
|
257
257
|
Callback: PUT /consentRequests/{ID} Error callback: PUT /consentRequests/{ID}/error Data model - see below url
|
258
|
-
https://github.com/mojaloop/documentation/blob/
|
258
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests
|
259
259
|
properties:
|
260
260
|
consentRequestId:
|
261
261
|
title: CorrelationId
|
@@ -277,7 +277,7 @@ paths:
|
|
277
277
|
type: object
|
278
278
|
description: |-
|
279
279
|
The Scope element contains an identifier defining, in the terms of a DFSP, an account on which access types can be requested or granted. It also defines the access types which are requested or granted.
|
280
|
-
https://github.com/mojaloop/documentation/blob/
|
280
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope
|
281
281
|
properties:
|
282
282
|
address:
|
283
283
|
title: AccountAddress
|
@@ -288,7 +288,7 @@ paths:
|
|
288
288
|
- Underscore (_) - Tilde (~) - Hyphen (-) - Period (.) Addresses MUST NOT end in a period (.) character
|
289
289
|
An entity providing accounts to parties (i.e. a participant) can provide any value for an AccountAddress that is meaningful to that entity. It does not need to provide an address that makes the account identifiable outside the entity's domain.
|
290
290
|
IMPORTANT: The policy for defining addresses and the life-cycle of these is at the discretion of the address space owner (the payer DFSP in this case).
|
291
|
-
https://github.com/mojaloop/documentation/blob/
|
291
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
|
292
292
|
pattern: '^([0-9A-Za-z_~\-\.]+[0-9A-Za-z_~\-])$'
|
293
293
|
minLength: 1
|
294
294
|
maxLength: 1023
|
@@ -571,7 +571,7 @@ paths:
|
|
571
571
|
description: |-
|
572
572
|
Used by: PISP
|
573
573
|
After the user completes an out-of-band authorization with the DFSP, the PISP will receive a token which they can use to prove to the DFSP that the user trusts this PISP.
|
574
|
-
https://github.com/mojaloop/documentation/blob/
|
574
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid
|
575
575
|
properties:
|
576
576
|
authToken:
|
577
577
|
type: string
|
@@ -699,13 +699,13 @@ paths:
|
|
699
699
|
schema:
|
700
700
|
type: string
|
701
701
|
required: false
|
702
|
-
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/
|
702
|
+
description: 'The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).'
|
703
703
|
- name: FSPIOP-HTTP-Method
|
704
704
|
in: header
|
705
705
|
schema:
|
706
706
|
type: string
|
707
707
|
required: false
|
708
|
-
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/
|
708
|
+
description: 'The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set).'
|
709
709
|
post:
|
710
710
|
tags:
|
711
711
|
- consents
|
@@ -1102,7 +1102,7 @@ paths:
|
|
1102
1102
|
- GENERIC
|
1103
1103
|
description: |-
|
1104
1104
|
The type of the Credential. - "FIDO" - The credential is based on a FIDO challenge. Its payload is a FIDOPublicKeyCredentialAttestation object. - "GENERIC" - The credential is based on a simple public key validation. Its payload is a GenericCredential object.
|
1105
|
-
https://github.com/mojaloop/documentation/blob/
|
1105
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype
|
1106
1106
|
status:
|
1107
1107
|
title: CredentialStatusPending
|
1108
1108
|
type: string
|
@@ -1366,7 +1366,7 @@ paths:
|
|
1366
1366
|
The HTTP request POST /thirdpartyRequests/authorizations is used to request the validation by a customer for the transfer described in the request.
|
1367
1367
|
Callback and data model information for POST /thirdpartyRequests/authorizations:
|
1368
1368
|
Callback - PUT /thirdpartyRequests/authorizations/{ID} Error Callback - PUT /thirdpartyRequests/authorizations/{ID}/error Data Model - See below url
|
1369
|
-
https://github.com/mojaloop/documentation/blob/
|
1369
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
1370
1370
|
type: object
|
1371
1371
|
properties:
|
1372
1372
|
authorizationRequestId:
|
@@ -1750,7 +1750,7 @@ paths:
|
|
1750
1750
|
The HTTP request POST /thirdpartyRequests/transactions is used to request the creation of a transaction request on the server for the transfer described in the request.
|
1751
1751
|
Callback and data model information for POST /thirdpartyRequests/transactions:
|
1752
1752
|
Callback - PUT /thirdpartyRequests/transactions/{ID} Error Callback - PUT /thirdpartyRequests/transactions/{ID}/error Data Model - See link below
|
1753
|
-
https://github.com/mojaloop/documentation/blob/
|
1753
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions
|
1754
1754
|
properties:
|
1755
1755
|
transactionRequestId:
|
1756
1756
|
allOf:
|
@@ -2217,7 +2217,7 @@ paths:
|
|
2217
2217
|
description: |-
|
2218
2218
|
Used by: DFSP
|
2219
2219
|
After a PISP requests the creation of a Third Party Transaction request (POST /thirdpartyRequests/transactions) or the status of a previously created Third Party Transaction request (GET /thirdpartyRequests/transactions/{ID}), the DFSP will send this callback.
|
2220
|
-
https://github.com/mojaloop/documentation/blob/
|
2220
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
|
2221
2221
|
properties:
|
2222
2222
|
transactionRequestState:
|
2223
2223
|
title: TransactionRequestState
|
@@ -2284,7 +2284,7 @@ paths:
|
|
2284
2284
|
The issuing PISP will expect a response to their request for a transfer which describes the finalized state of the requested transfer.
|
2285
2285
|
This response will be given by a PATCH call on the /thirdpartyRequests/transactions/{ID} resource.
|
2286
2286
|
The {ID} given in the query string should be the transactionRequestId which was originally used by the PISP to identify the transaction request.
|
2287
|
-
https://github.com/mojaloop/documentation/blob/
|
2287
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
2288
2288
|
properties:
|
2289
2289
|
completedTimestamp:
|
2290
2290
|
title: DateTime
|
@@ -2449,7 +2449,7 @@ paths:
|
|
2449
2449
|
Javascript ArrayBuffer.
|
2450
2450
|
For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
|
2451
2451
|
|
2452
|
-
https://github.com/mojaloop/documentation/blob/
|
2452
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
|
2453
2453
|
properties:
|
2454
2454
|
id:
|
2455
2455
|
type: string
|
@@ -2635,7 +2635,7 @@ paths:
|
|
2635
2635
|
description: |-
|
2636
2636
|
Used by: Auth Service
|
2637
2637
|
The callback PUT /thirdpartyRequests/verifications/{ID} is used to inform the client of the result of an authorization check. The {ID} in the URI should contain the authorizationRequestId which was used to request the check, or the {ID} that was used in the GET /thirdpartyRequests/verifications/{ID}.
|
2638
|
-
https://github.com/mojaloop/documentation/blob/
|
2638
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31821-put-thirdpartyrequestsverificationsid
|
2639
2639
|
properties:
|
2640
2640
|
authenticationResponse:
|
2641
2641
|
title: AuthenticationResponse
|
@@ -11,7 +11,7 @@ info:
|
|
11
11
|
Party API (DFSP) instead.
|
12
12
|
license:
|
13
13
|
name: Open API for FSP Interoperability (FSPIOP) (Implementation Friendly Version)
|
14
|
-
url: https://github.com/mojaloop/mojaloop-specification/blob/
|
14
|
+
url: https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md
|
15
15
|
servers:
|
16
16
|
- url: /
|
17
17
|
paths:
|
@@ -7,7 +7,7 @@ info:
|
|
7
7
|
DFSPs who want to enable Payment Initiation Service Providers (PISPs) should implement the accompanying API - Mojaloop Third Party API (DFSP) instead.
|
8
8
|
license:
|
9
9
|
name: Open API for FSP Interoperability (FSPIOP) (Implementation Friendly Version)
|
10
|
-
url: 'https://github.com/mojaloop/mojaloop-specification/blob/
|
10
|
+
url: 'https://github.com/mojaloop/mojaloop-specification/blob/main/LICENSE.md'
|
11
11
|
servers:
|
12
12
|
- url: /
|
13
13
|
paths:
|
@@ -73,20 +73,20 @@ paths:
|
|
73
73
|
Callback and data model information for GET /accounts/{ID}:
|
74
74
|
Callback - PUT /accounts/{ID} Error Callback - PUT /accounts/{ID}/error Data Model - Empty body
|
75
75
|
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.
|
76
|
-
https://github.com/mojaloop/documentation/blob/
|
76
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31121--put-accountsid
|
77
77
|
properties:
|
78
78
|
accountList:
|
79
79
|
title: AccountList
|
80
80
|
type: array
|
81
81
|
description: |-
|
82
82
|
The AccountList data model is used to hold information about the accounts that a party controls.
|
83
|
-
https://github.com/mojaloop/documentation/blob/
|
83
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3213-accountlist
|
84
84
|
items:
|
85
85
|
title: Account
|
86
86
|
type: object
|
87
87
|
description: |-
|
88
88
|
Data model for the complex type Account.
|
89
|
-
https://github.com/mojaloop/documentation/blob/
|
89
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3211-account
|
90
90
|
properties:
|
91
91
|
accountNickname:
|
92
92
|
title: Name
|
@@ -249,7 +249,7 @@ paths:
|
|
249
249
|
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.
|
250
250
|
Callback and data model for POST /consentRequests:
|
251
251
|
Callback: PUT /consentRequests/{ID} Error callback: PUT /consentRequests/{ID}/error Data model - see below url
|
252
|
-
https://github.com/mojaloop/documentation/blob/
|
252
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31212-post-consentrequests
|
253
253
|
properties:
|
254
254
|
consentRequestId:
|
255
255
|
title: CorrelationId
|
@@ -271,7 +271,7 @@ paths:
|
|
271
271
|
type: object
|
272
272
|
description: |-
|
273
273
|
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.
|
274
|
-
https://github.com/mojaloop/documentation/blob/
|
274
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32121-scope
|
275
275
|
properties:
|
276
276
|
address:
|
277
277
|
title: AccountAddress
|
@@ -282,7 +282,7 @@ paths:
|
|
282
282
|
- Underscore (_) - Tilde (~) - Hyphen (-) - Period (.) Addresses MUST NOT end in a period (.) character
|
283
283
|
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.
|
284
284
|
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).
|
285
|
-
https://github.com/mojaloop/documentation/blob/
|
285
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3212-accountaddress
|
286
286
|
pattern: '^([0-9A-Za-z_~\-\.]+[0-9A-Za-z_~\-])$'
|
287
287
|
minLength: 1
|
288
288
|
maxLength: 1023
|
@@ -565,7 +565,7 @@ paths:
|
|
565
565
|
description: |-
|
566
566
|
Used by: PISP
|
567
567
|
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.
|
568
|
-
https://github.com/mojaloop/documentation/blob/
|
568
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31222-patch-consentrequestsid
|
569
569
|
properties:
|
570
570
|
authToken:
|
571
571
|
type: string
|
@@ -949,7 +949,7 @@ paths:
|
|
949
949
|
- GENERIC
|
950
950
|
description: |-
|
951
951
|
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.
|
952
|
-
https://github.com/mojaloop/documentation/blob/
|
952
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#3226-credentialtype
|
953
953
|
status:
|
954
954
|
title: CredentialStatusPending
|
955
955
|
type: string
|
@@ -1213,7 +1213,7 @@ paths:
|
|
1213
1213
|
The HTTP request POST /thirdpartyRequests/authorizations is used to request the validation by a customer for the transfer described in the request.
|
1214
1214
|
Callback and data model information for POST /thirdpartyRequests/authorizations:
|
1215
1215
|
Callback - PUT /thirdpartyRequests/authorizations/{ID} Error Callback - PUT /thirdpartyRequests/authorizations/{ID}/error Data Model - See below url
|
1216
|
-
https://github.com/mojaloop/documentation/blob/
|
1216
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
1217
1217
|
type: object
|
1218
1218
|
properties:
|
1219
1219
|
authorizationRequestId:
|
@@ -1469,7 +1469,7 @@ paths:
|
|
1469
1469
|
Javascript ArrayBuffer.
|
1470
1470
|
For this API, we represent ArrayBuffers as base64 encoded utf-8 strings.
|
1471
1471
|
|
1472
|
-
https://github.com/mojaloop/documentation/blob/
|
1472
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#32128-fidopublickeycredentialassertion
|
1473
1473
|
properties:
|
1474
1474
|
id:
|
1475
1475
|
type: string
|
@@ -1675,7 +1675,7 @@ paths:
|
|
1675
1675
|
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.
|
1676
1676
|
Callback and data model information for POST /thirdpartyRequests/transactions:
|
1677
1677
|
Callback - PUT /thirdpartyRequests/transactions/{ID} Error Callback - PUT /thirdpartyRequests/transactions/{ID}/error Data Model - See link below
|
1678
|
-
https://github.com/mojaloop/documentation/blob/
|
1678
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31712-post-thirdpartyrequeststransactions
|
1679
1679
|
properties:
|
1680
1680
|
transactionRequestId:
|
1681
1681
|
allOf:
|
@@ -2093,7 +2093,7 @@ paths:
|
|
2093
2093
|
description: |-
|
2094
2094
|
Used by: DFSP
|
2095
2095
|
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.
|
2096
|
-
https://github.com/mojaloop/documentation/blob/
|
2096
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31721-put-thirdpartyrequeststransactionsid
|
2097
2097
|
properties:
|
2098
2098
|
transactionRequestState:
|
2099
2099
|
title: TransactionRequestState
|
@@ -2160,7 +2160,7 @@ paths:
|
|
2160
2160
|
The issuing PISP will expect a response to their request for a transfer which describes the finalized state of the requested transfer.
|
2161
2161
|
This response will be given by a PATCH call on the /thirdpartyRequests/transactions/{ID} resource.
|
2162
2162
|
The {ID} given in the query string should be the transactionRequestId which was originally used by the PISP to identify the transaction request.
|
2163
|
-
https://github.com/mojaloop/documentation/blob/
|
2163
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31612-post-thirdpartyrequestsauthorizations
|
2164
2164
|
properties:
|
2165
2165
|
completedTimestamp:
|
2166
2166
|
title: DateTime
|
@@ -2327,13 +2327,13 @@ paths:
|
|
2327
2327
|
schema:
|
2328
2328
|
type: string
|
2329
2329
|
required: false
|
2330
|
-
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/
|
2330
|
+
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).'
|
2331
2331
|
- name: FSPIOP-HTTP-Method
|
2332
2332
|
in: header
|
2333
2333
|
schema:
|
2334
2334
|
type: string
|
2335
2335
|
required: false
|
2336
|
-
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/
|
2336
|
+
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).'
|
2337
2337
|
get:
|
2338
2338
|
description: 'The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).'
|
2339
2339
|
summary: Look up party information
|
@@ -2838,7 +2838,7 @@ paths:
|
|
2838
2838
|
The callback PUT /services/{ServiceType} is used to inform the client of a successful result of the service information lookup.
|
2839
2839
|
Callback and data model information for GET /services/{ServiceType}:
|
2840
2840
|
Callback - PUT /services/{ServiceType} Error Callback - PUT /services/{ServiceType}/error Data Model - Empty body
|
2841
|
-
https://github.com/mojaloop/documentation/blob/
|
2841
|
+
https://github.com/mojaloop/documentation/blob/main/website/versioned_docs/v1.0.1/api/thirdparty/data-models.md#31531-put-servicesservicetype
|
2842
2842
|
properties:
|
2843
2843
|
providers:
|
2844
2844
|
type: array
|