@mojaloop/api-snippets 17.3.0-snapshot.0 → 17.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +14 -0
- package/audit-ci.jsonc +1 -1
- 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 +3149 -3163
- package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml +103 -346
- package/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml +131 -449
- package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +144 -478
- package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +179 -606
- package/docs/thirdparty-openapi3-snippets.yaml +296 -886
- package/fspiop/v1_1/openapi3/openapi.yaml +10 -2
- package/fspiop/v2_0/openapi3/openapi.yaml +11 -1
- package/lib/fspiop/v1_1/openapi.d.ts +524 -542
- package/lib/fspiop/v2_0/openapi.d.ts +685 -703
- 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 +14 -9
@@ -1,24 +1,16 @@
|
|
1
1
|
openapi: 3.0.1
|
2
2
|
info:
|
3
3
|
title: Mojaloop SDK Backend API
|
4
|
-
description:
|
4
|
+
description: |
|
5
5
|
API specification for the SDK Backend API.
|
6
6
|
|
7
|
+
To be implemented by the Digital Financial Service Provider (DFSP) to work in tandem with the Mojaloop SDK (`mojaloop/sdk-scheme-adapter`).
|
7
8
|
|
8
|
-
|
9
|
-
in tandem with the Mojaloop SDK (`mojaloop/sdk-scheme-adapter`).
|
9
|
+
This API is not to be confused with the Mojaloop SDK's Inbound or Outbound API.
|
10
10
|
|
11
|
+
TODO: More explanation and links about the SDK adapter's Inbound and Outbound API.
|
11
12
|
|
12
|
-
|
13
|
-
API.
|
14
|
-
|
15
|
-
|
16
|
-
TODO: More explanation and links about the SDK adapter's Inbound and
|
17
|
-
Outbound API.
|
18
|
-
|
19
|
-
|
20
|
-
**Note on terminology:** The term "Switch" is equal to the term "Hub", and
|
21
|
-
the term "FSP" is equal to the term "DFSP".
|
13
|
+
**Note on terminology:** The term "Switch" is equal to the term "Hub", and the term "FSP" is equal to the term "DFSP".
|
22
14
|
license:
|
23
15
|
name: Apache License Version 2.0, January 2004
|
24
16
|
url: http://www.apache.org/licenses/
|
@@ -72,20 +64,12 @@ paths:
|
|
72
64
|
$ref: '#/components/responses/404'
|
73
65
|
'500':
|
74
66
|
$ref: '#/components/responses/500'
|
75
|
-
summary:
|
76
|
-
Requests information relating to a bulk quote identified by the
|
77
|
-
specified identifier value.
|
67
|
+
summary: Requests information relating to a bulk quote identified by the specified identifier value.
|
78
68
|
tags:
|
79
69
|
- BulkQuotes
|
80
70
|
/bulkTransactions/{bulkTransactionId}:
|
81
71
|
put:
|
82
|
-
description:
|
83
|
-
The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to
|
84
|
-
amend information regarding a bulk transaction, i.e. when
|
85
|
-
autoAcceptParty or autoAcceptQuote is false then the payer need to
|
86
|
-
provide confirmation to proceed with further processing of the request.
|
87
|
-
The `{bulkTransactionId}` in the URI should contain the
|
88
|
-
`bulkTransactionId` that was used for the creation of the bulk transfer.
|
72
|
+
description: The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to amend information regarding a bulk transaction, i.e. when autoAcceptParty or autoAcceptQuote is false then the payer need to provide confirmation to proceed with further processing of the request. The `{bulkTransactionId}` in the URI should contain the `bulkTransactionId` that was used for the creation of the bulk transfer.
|
89
73
|
operationId: BackendBulkTransactionsPut
|
90
74
|
parameters:
|
91
75
|
- $ref: '#/components/parameters/bulkTransactionId'
|
@@ -106,9 +90,7 @@ paths:
|
|
106
90
|
- BulkTransactionsPut
|
107
91
|
/requestToPay/{transactionRequestId}:
|
108
92
|
put:
|
109
|
-
description:
|
110
|
-
It is used to notify the DFSP backend about the status of the
|
111
|
-
requestToPayTransfer.
|
93
|
+
description: It is used to notify the DFSP backend about the status of the requestToPayTransfer.
|
112
94
|
operationId: RequestToPayPut
|
113
95
|
parameters:
|
114
96
|
- $ref: '#/components/parameters/transactionRequestId'
|
@@ -147,9 +129,7 @@ paths:
|
|
147
129
|
$ref: '#/components/responses/400'
|
148
130
|
'500':
|
149
131
|
$ref: '#/components/responses/500'
|
150
|
-
summary:
|
151
|
-
Execute bulk transfer of funds from an external account to internal
|
152
|
-
accounts.
|
132
|
+
summary: Execute bulk transfer of funds from an external account to internal accounts.
|
153
133
|
tags:
|
154
134
|
- BulkTransfers
|
155
135
|
/bulkTransfers/{idValue}:
|
@@ -170,9 +150,7 @@ paths:
|
|
170
150
|
$ref: '#/components/responses/404'
|
171
151
|
'500':
|
172
152
|
$ref: '#/components/responses/500'
|
173
|
-
summary:
|
174
|
-
Requests information relating to a bulk transfer identified by the
|
175
|
-
specified identifier value.
|
153
|
+
summary: Requests information relating to a bulk transfer identified by the specified identifier value.
|
176
154
|
tags:
|
177
155
|
- BulkTransfers
|
178
156
|
/otp/{transactionRequestId}:
|
@@ -198,10 +176,7 @@ paths:
|
|
198
176
|
- OTP
|
199
177
|
/participants/{idType}/{idValue}:
|
200
178
|
get:
|
201
|
-
description:
|
202
|
-
The HTTP request `GET /participants/{idType}/{idValue}` is used to find
|
203
|
-
out in which FSP the requested party, defined by `{idType}` and
|
204
|
-
`{idValue}`, is located.
|
179
|
+
description: The HTTP request `GET /participants/{idType}/{idValue}` is used to find out in which FSP the requested party, defined by `{idType}` and `{idValue}`, is located.
|
205
180
|
operationId: BackendParticipantsGetByTypeAndID
|
206
181
|
parameters:
|
207
182
|
- $ref: '#/components/parameters/idType'
|
@@ -219,17 +194,12 @@ paths:
|
|
219
194
|
$ref: '#/components/responses/404'
|
220
195
|
'500':
|
221
196
|
$ref: '#/components/responses/500'
|
222
|
-
summary:
|
223
|
-
Asks for the identifier (fspId) of the scheme participant (FSP) that can
|
224
|
-
handle transfers for the specified identifier type and value.
|
197
|
+
summary: Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value.
|
225
198
|
tags:
|
226
199
|
- Participants
|
227
200
|
/participants/{idType}/{idValue}/{idSubValue}:
|
228
201
|
get:
|
229
|
-
description:
|
230
|
-
The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is
|
231
|
-
used to find out in which FSP the requested party, defined by
|
232
|
-
`{idType}`, `{idValue}` and `{idSubValue}` is located.
|
202
|
+
description: The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is used to find out in which FSP the requested party, defined by `{idType}`, `{idValue}` and `{idSubValue}` is located.
|
233
203
|
operationId: BackendParticipantsGetByTypeIDAndSubId
|
234
204
|
parameters:
|
235
205
|
- $ref: '#/components/parameters/idType'
|
@@ -248,17 +218,12 @@ paths:
|
|
248
218
|
$ref: '#/components/responses/404'
|
249
219
|
'500':
|
250
220
|
$ref: '#/components/responses/500'
|
251
|
-
summary:
|
252
|
-
Asks for the identifier (fspId) of the scheme participant (FSP) that can
|
253
|
-
handle transfers for the specified identifier type and value.
|
221
|
+
summary: Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value.
|
254
222
|
tags:
|
255
223
|
- Participants
|
256
224
|
/parties/{idType}/{idValue}:
|
257
225
|
get:
|
258
|
-
description:
|
259
|
-
The HTTP request `GET /parties/{idType}/{idValue}` is used to look up
|
260
|
-
information regarding the requested transfer party, identified by
|
261
|
-
`{idType}` and `{idValue}`.
|
226
|
+
description: The HTTP request `GET /parties/{idType}/{idValue}` is used to look up information regarding the requested transfer party, identified by `{idType}` and `{idValue}`.
|
262
227
|
operationId: BackendPartiesGetByTypeAndID
|
263
228
|
parameters:
|
264
229
|
- $ref: '#/components/parameters/idType'
|
@@ -276,17 +241,12 @@ paths:
|
|
276
241
|
$ref: '#/components/responses/404'
|
277
242
|
'500':
|
278
243
|
$ref: '#/components/responses/500'
|
279
|
-
summary:
|
280
|
-
Requests information relating to a transfer party identified by the
|
281
|
-
specified identifier type and value.
|
244
|
+
summary: Requests information relating to a transfer party identified by the specified identifier type and value.
|
282
245
|
tags:
|
283
246
|
- Parties
|
284
247
|
/parties/{idType}/{idValue}/{idSubValue}:
|
285
248
|
get:
|
286
|
-
description:
|
287
|
-
The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used
|
288
|
-
to look up information regarding the requested transfer party,
|
289
|
-
identified by `{idType}`, `{idValue}` and `{idSubValue}`.
|
249
|
+
description: The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used to look up information regarding the requested transfer party, identified by `{idType}`, `{idValue}` and `{idSubValue}`.
|
290
250
|
operationId: BackendPartiesGetByTypeIdAndSubId
|
291
251
|
parameters:
|
292
252
|
- $ref: '#/components/parameters/idType'
|
@@ -305,16 +265,12 @@ paths:
|
|
305
265
|
$ref: '#/components/responses/404'
|
306
266
|
'500':
|
307
267
|
$ref: '#/components/responses/500'
|
308
|
-
summary:
|
309
|
-
Requests information relating to a transfer party identified by the
|
310
|
-
specified identifier type, value and subId value.
|
268
|
+
summary: Requests information relating to a transfer party identified by the specified identifier type, value and subId value.
|
311
269
|
tags:
|
312
270
|
- Parties
|
313
271
|
/quoterequests:
|
314
272
|
post:
|
315
|
-
description:
|
316
|
-
The HTTP request `POST /quoterequests` is used to request the creation
|
317
|
-
of a quote for the provided financial transaction.
|
273
|
+
description: The HTTP request `POST /quoterequests` is used to request the creation of a quote for the provided financial transaction.
|
318
274
|
operationId: BackendQuoteRequest
|
319
275
|
requestBody:
|
320
276
|
content:
|
@@ -361,9 +317,7 @@ paths:
|
|
361
317
|
- TransactionRequest
|
362
318
|
/transfers:
|
363
319
|
post:
|
364
|
-
description:
|
365
|
-
The HTTP request `POST /transfers` is used to request the creation of a
|
366
|
-
transfer for the transfer party.
|
320
|
+
description: The HTTP request `POST /transfers` is used to request the creation of a transfer for the transfer party.
|
367
321
|
operationId: BackendTransfersPost
|
368
322
|
requestBody:
|
369
323
|
content:
|
@@ -387,11 +341,7 @@ paths:
|
|
387
341
|
- Transfers
|
388
342
|
/transfers/{transferId}:
|
389
343
|
get:
|
390
|
-
description:
|
391
|
-
The HTTP request `GET /transfers/{transferId}` is used to get
|
392
|
-
information regarding a transfer created or requested earlier. The
|
393
|
-
`{transferId}` in the URI should contain the `transferId` that was used
|
394
|
-
for the creation of the transfer.
|
344
|
+
description: The HTTP request `GET /transfers/{transferId}` is used to get information regarding a transfer created or requested earlier. The `{transferId}` in the URI should contain the `transferId` that was used for the creation of the transfer.
|
395
345
|
operationId: BackendTransfersGet
|
396
346
|
parameters:
|
397
347
|
- $ref: '#/components/parameters/transferId'
|
@@ -408,9 +358,7 @@ paths:
|
|
408
358
|
tags:
|
409
359
|
- Transfers
|
410
360
|
put:
|
411
|
-
description:
|
412
|
-
The HTTP request `PUT /transfers/{transferId}` is used to receive
|
413
|
-
notification for transfer being fulfiled when the FSP is a Payee.
|
361
|
+
description: The HTTP request `PUT /transfers/{transferId}` is used to receive notification for transfer being fulfiled when the FSP is a Payee.
|
414
362
|
operationId: BackendTransfersPut
|
415
363
|
parameters:
|
416
364
|
- $ref: '#/components/parameters/transferId'
|
@@ -430,9 +378,7 @@ paths:
|
|
430
378
|
- Transfers
|
431
379
|
/fxQuotes:
|
432
380
|
post:
|
433
|
-
description:
|
434
|
-
The HTTP request `POST /fxQuotes` is used to ask an FXP backend to
|
435
|
-
provide a quotation for a currency conversion.
|
381
|
+
description: The HTTP request `POST /fxQuotes` is used to ask an FXP backend to provide a quotation for a currency conversion.
|
436
382
|
summary: Calculate FX quote
|
437
383
|
tags:
|
438
384
|
- Fx
|
@@ -457,9 +403,7 @@ paths:
|
|
457
403
|
$ref: '#/components/responses/500'
|
458
404
|
/fxTransfers:
|
459
405
|
post:
|
460
|
-
description:
|
461
|
-
The HTTP request `POST /fxTransfers` is used to ask an FXP backend to
|
462
|
-
confirm the execution of an agreed currency conversion.
|
406
|
+
description: The HTTP request `POST /fxTransfers` is used to ask an FXP backend to confirm the execution of an agreed currency conversion.
|
463
407
|
summary: Perform FX transfer
|
464
408
|
tags:
|
465
409
|
- Fx
|
@@ -484,9 +428,7 @@ paths:
|
|
484
428
|
$ref: '#/components/responses/500'
|
485
429
|
/fxTransfers/{commitRequestId}:
|
486
430
|
put:
|
487
|
-
description:
|
488
|
-
The HTTP request `PUT /fxTransfers/{commitRequestId}` is used to notify
|
489
|
-
an FXP backend about the status of currency conversion.
|
431
|
+
description: The HTTP request `PUT /fxTransfers/{commitRequestId}` is used to notify an FXP backend about the status of currency conversion.
|
490
432
|
summary: FX Commit Notification
|
491
433
|
tags:
|
492
434
|
- Fx
|
@@ -508,9 +450,7 @@ paths:
|
|
508
450
|
components:
|
509
451
|
parameters:
|
510
452
|
idSubValue:
|
511
|
-
description:
|
512
|
-
A sub-identifier of the party identifier, or a sub-type of the party
|
513
|
-
identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
|
453
|
+
description: A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`.
|
514
454
|
in: path
|
515
455
|
name: idSubValue
|
516
456
|
required: true
|
@@ -548,15 +488,12 @@ components:
|
|
548
488
|
required: true
|
549
489
|
schema:
|
550
490
|
$ref: '#/components/schemas/CorrelationId'
|
551
|
-
description:
|
552
|
-
Identifier of the bulk transaction to continue as returned in the
|
553
|
-
response to a `POST /bulkTransaction` request.
|
491
|
+
description: Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request.
|
554
492
|
schemas:
|
555
493
|
DateOfBirth:
|
556
494
|
title: DateofBirth (type Date)
|
557
495
|
type: string
|
558
|
-
pattern:
|
559
|
-
^(?:[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)$
|
496
|
+
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)$
|
560
497
|
description: Date of Birth of the Party.
|
561
498
|
example: '1966-06-16'
|
562
499
|
FirstName:
|
@@ -564,9 +501,7 @@ components:
|
|
564
501
|
type: string
|
565
502
|
minLength: 1
|
566
503
|
maxLength: 128
|
567
|
-
pattern:
|
568
|
-
^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
|
569
|
-
.,''-]{1,128}$
|
504
|
+
pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
|
570
505
|
description: First name of the Party (Name Type).
|
571
506
|
example: Henrik
|
572
507
|
FspId:
|
@@ -705,27 +640,20 @@ components:
|
|
705
640
|
type: string
|
706
641
|
minLength: 1
|
707
642
|
maxLength: 128
|
708
|
-
pattern:
|
709
|
-
^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
|
710
|
-
.,''-]{1,128}$
|
643
|
+
pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
|
711
644
|
description: Last name of the Party (Name Type).
|
712
645
|
example: Karlsson
|
713
646
|
MerchantClassificationCode:
|
714
647
|
title: MerchantClassificationCode
|
715
648
|
type: string
|
716
649
|
pattern: ^[\d]{1,4}$
|
717
|
-
description:
|
718
|
-
A limited set of pre-defined numbers. This list would be a limited set
|
719
|
-
of numbers identifying a set of popular merchant types like School Fees,
|
720
|
-
Pubs and Restaurants, Groceries, etc.
|
650
|
+
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.
|
721
651
|
MiddleName:
|
722
652
|
title: MiddleName
|
723
653
|
type: string
|
724
654
|
minLength: 1
|
725
655
|
maxLength: 128
|
726
|
-
pattern:
|
727
|
-
^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control}
|
728
|
-
.,''-]{1,128}$
|
656
|
+
pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
|
729
657
|
description: Middle name of the Party (Name Type).
|
730
658
|
example: Johannes
|
731
659
|
amountCurrency:
|
@@ -746,8 +674,7 @@ components:
|
|
746
674
|
type: string
|
747
675
|
bulkQuoteId:
|
748
676
|
description: A Mojaloop API bulk quote identifier (UUID).
|
749
|
-
pattern:
|
750
|
-
^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
677
|
+
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
751
678
|
type: string
|
752
679
|
bulkQuoteRequest:
|
753
680
|
description: A request for a bulk quote.
|
@@ -779,9 +706,7 @@ components:
|
|
779
706
|
expiration:
|
780
707
|
$ref: '#/components/schemas/timestamp'
|
781
708
|
individualQuoteResults:
|
782
|
-
description:
|
783
|
-
Fees for each individual transaction, if any of them are charged per
|
784
|
-
transaction.
|
709
|
+
description: Fees for each individual transaction, if any of them are charged per transaction.
|
785
710
|
items:
|
786
711
|
oneOf:
|
787
712
|
- $ref: '#/components/schemas/IndividualQuoteResultSuccess'
|
@@ -795,8 +720,7 @@ components:
|
|
795
720
|
type: object
|
796
721
|
bulkTransferId:
|
797
722
|
description: A Mojaloop API transfer identifier (UUID).
|
798
|
-
pattern:
|
799
|
-
^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
723
|
+
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
800
724
|
type: string
|
801
725
|
bulkTransferRequest:
|
802
726
|
properties:
|
@@ -821,9 +745,7 @@ components:
|
|
821
745
|
bulkTransferId:
|
822
746
|
$ref: '#/components/schemas/bulkTransferId'
|
823
747
|
homeTransactionId:
|
824
|
-
description:
|
825
|
-
Transaction ID from the DFSP backend, used to reconcile transactions
|
826
|
-
between the switch and DFSP backend systems.
|
748
|
+
description: Transaction ID from the DFSP backend, used to reconcile transactions between the switch and DFSP backend systems.
|
827
749
|
type: string
|
828
750
|
individualTransferResults:
|
829
751
|
items:
|
@@ -1005,18 +927,11 @@ components:
|
|
1005
927
|
type: string
|
1006
928
|
dateOfBirth:
|
1007
929
|
description: Date of birth in the form YYYY-MM-DD.
|
1008
|
-
pattern:
|
1009
|
-
^(?:[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)$
|
930
|
+
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)$
|
1010
931
|
type: string
|
1011
932
|
errorCode:
|
1012
|
-
description:
|
1013
|
-
The API data type errorCode is a JSON String of four characters,
|
1014
|
-
consisting of digits only. Negative numbers are not allowed. A leading
|
1015
|
-
zero is not allowed. Each error code in the API is a four-digit number,
|
1016
|
-
for example, 1234, where the first number (1 in the example) represents
|
1017
|
-
the high-level error category, the second number (2 in the example)
|
1018
|
-
represents the low-level error category, and the last two numbers (34 in
|
1019
|
-
the example) represents the specific error.
|
933
|
+
description: |
|
934
|
+
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) represents the specific error.
|
1020
935
|
pattern: ^[1-9]\d{3}$
|
1021
936
|
title: ErrorCode
|
1022
937
|
type: string
|
@@ -1146,14 +1061,10 @@ components:
|
|
1146
1061
|
title: TransfersIDPatchResponse
|
1147
1062
|
type: object
|
1148
1063
|
generalError:
|
1149
|
-
description:
|
1150
|
-
This object may represent a number of different error object types and
|
1151
|
-
so its properties may vary significantly.
|
1064
|
+
description: This object may represent a number of different error object types and so its properties may vary significantly.
|
1152
1065
|
type: object
|
1153
1066
|
geoCode:
|
1154
|
-
description:
|
1155
|
-
Indicates the geographic location from where the transaction was
|
1156
|
-
initiated.
|
1067
|
+
description: Indicates the geographic location from where the transaction was initiated.
|
1157
1068
|
properties:
|
1158
1069
|
latitude:
|
1159
1070
|
$ref: '#/components/schemas/latitude'
|
@@ -1220,18 +1131,12 @@ components:
|
|
1220
1131
|
- DEVICE
|
1221
1132
|
type: string
|
1222
1133
|
latitude:
|
1223
|
-
description:
|
1224
|
-
|
1225
|
-
restricted by a regular expression for interoperability reasons.
|
1226
|
-
pattern: >-
|
1227
|
-
^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
|
1134
|
+
description: The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
|
1135
|
+
pattern: ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
|
1228
1136
|
type: string
|
1229
1137
|
longitude:
|
1230
|
-
description:
|
1231
|
-
|
1232
|
-
restricted by a regular expression for interoperability reasons.
|
1233
|
-
pattern: >-
|
1234
|
-
^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
|
1138
|
+
description: The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
|
1139
|
+
pattern: ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
|
1235
1140
|
type: string
|
1236
1141
|
money:
|
1237
1142
|
pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
|
@@ -1258,17 +1163,14 @@ components:
|
|
1258
1163
|
type: string
|
1259
1164
|
quoteId:
|
1260
1165
|
description: A Mojaloop API quote identifier (UUID).
|
1261
|
-
pattern:
|
1262
|
-
^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
1166
|
+
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
1263
1167
|
type: string
|
1264
1168
|
quoteRequest:
|
1265
1169
|
description: A request for a quote for transfer from the DFSP backend.
|
1266
1170
|
properties:
|
1267
1171
|
homeR2PTransactionId:
|
1268
1172
|
type: string
|
1269
|
-
description:
|
1270
|
-
Linked homeR2PTransactionId which was generated as part of POST
|
1271
|
-
/requestToPay to SDK incase of requestToPay transfer.
|
1173
|
+
description: Linked homeR2PTransactionId which was generated as part of POST /requestToPay to SDK incase of requestToPay transfer.
|
1272
1174
|
amount:
|
1273
1175
|
$ref: '#/components/schemas/money'
|
1274
1176
|
amountType:
|
@@ -1311,23 +1213,11 @@ components:
|
|
1311
1213
|
converter:
|
1312
1214
|
allOf:
|
1313
1215
|
- $ref: '#/components/schemas/CurrencyConverter'
|
1314
|
-
- description:
|
1315
|
-
An optional field which will allow the payer DFSP to specify
|
1316
|
-
which DFSP it wants to undertake currency conversion. This is
|
1317
|
-
useful incase of if the sender wants the recipient to receive a
|
1318
|
-
specified amount of the target currency, but the payer DFSP does
|
1319
|
-
not want to undertake the currency conversion. In this case, the
|
1320
|
-
amount of the transfer would be expressed in the target currency
|
1321
|
-
and the amountType would be set to RECEIVE.
|
1216
|
+
- description: An optional field which will allow the payer DFSP to specify which DFSP it wants to undertake currency conversion. This is useful incase of if the sender wants the recipient to receive a specified amount of the target currency, but the payer DFSP does not want to undertake the currency conversion. In this case, the amount of the transfer would be expressed in the target currency and the amountType would be set to RECEIVE.
|
1322
1217
|
currencyConversion:
|
1323
1218
|
allOf:
|
1324
1219
|
- $ref: '#/components/schemas/FxRate'
|
1325
|
-
- description:
|
1326
|
-
Used by the debtor party if it wants to share information about
|
1327
|
-
the currency conversion it proposes to make; or if it is
|
1328
|
-
required by scheme rules to share this information. This object
|
1329
|
-
contains the amount of the transfer in the source and target
|
1330
|
-
currencies, but does not identify the FXP being used.
|
1220
|
+
- description: Used by the debtor party if it wants to share information about the currency conversion it proposes to make; or if it is required by scheme rules to share this information. This object contains the amount of the transfer in the source and target currencies, but does not identify the FXP being used.
|
1331
1221
|
required:
|
1332
1222
|
- quoteId
|
1333
1223
|
- transactionId
|
@@ -1381,15 +1271,11 @@ components:
|
|
1381
1271
|
type: string
|
1382
1272
|
timestamp:
|
1383
1273
|
description: An ISO-8601 formatted timestamp.
|
1384
|
-
pattern:
|
1385
|
-
^(?:[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)$
|
1274
|
+
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)$
|
1386
1275
|
type: string
|
1387
1276
|
transactionId:
|
1388
|
-
description:
|
1389
|
-
|
1390
|
-
creation of the quote.
|
1391
|
-
pattern: >-
|
1392
|
-
^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
1277
|
+
description: ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote.
|
1278
|
+
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
1393
1279
|
type: string
|
1394
1280
|
transactionRequest:
|
1395
1281
|
description: A request for a pull based transfer.
|
@@ -1435,17 +1321,14 @@ components:
|
|
1435
1321
|
type: object
|
1436
1322
|
transactionRequestId:
|
1437
1323
|
description: A Mojaloop API transaction request identifier (UUID).
|
1438
|
-
pattern:
|
1439
|
-
^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
1324
|
+
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
1440
1325
|
type: string
|
1441
1326
|
transactionRequestResponse:
|
1442
1327
|
description: A response to a request for a quote.
|
1443
1328
|
properties:
|
1444
1329
|
homeR2PTransactionId:
|
1445
1330
|
type: string
|
1446
|
-
description:
|
1447
|
-
Transaction ID from the DFSP backend, used to reconcile transactions
|
1448
|
-
between the Switch and DFSP backend systems.
|
1331
|
+
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
|
1449
1332
|
transactionId:
|
1450
1333
|
$ref: '#/components/schemas/transactionId'
|
1451
1334
|
transactionRequestState:
|
@@ -1462,9 +1345,7 @@ components:
|
|
1462
1345
|
- REJECTED
|
1463
1346
|
type: string
|
1464
1347
|
transactionSubScenario:
|
1465
|
-
description:
|
1466
|
-
Possible sub-scenario, defined locally within the scheme (UndefinedEnum
|
1467
|
-
Type). Based on FSPIOP TransactionSubScenario.
|
1348
|
+
description: Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
|
1468
1349
|
example: LOCALLY_DEFINED_SUBSCENARIO
|
1469
1350
|
pattern: ^[A-Z_]{1,32}$
|
1470
1351
|
title: transactionSubScenario
|
@@ -1504,9 +1385,7 @@ components:
|
|
1504
1385
|
from:
|
1505
1386
|
$ref: '#/components/schemas/transferParty'
|
1506
1387
|
homeTransactionId:
|
1507
|
-
description:
|
1508
|
-
Transaction ID from the DFSP backend, used to reconcile transactions
|
1509
|
-
between the Switch and DFSP backend systems.
|
1388
|
+
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
|
1510
1389
|
type: string
|
1511
1390
|
note:
|
1512
1391
|
maxLength: 128
|
@@ -1534,8 +1413,7 @@ components:
|
|
1534
1413
|
type: object
|
1535
1414
|
transferId:
|
1536
1415
|
description: A Mojaloop API transfer identifier (UUID).
|
1537
|
-
pattern:
|
1538
|
-
^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
1416
|
+
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
1539
1417
|
type: string
|
1540
1418
|
transferParty:
|
1541
1419
|
properties:
|
@@ -1563,9 +1441,7 @@ components:
|
|
1563
1441
|
description: Party last name.
|
1564
1442
|
type: string
|
1565
1443
|
merchantClassificationCode:
|
1566
|
-
description:
|
1567
|
-
Up to 4 digits specifying the sender's merchant classification, if
|
1568
|
-
known and applicable.
|
1444
|
+
description: Up to 4 digits specifying the sender's merchant classification, if known and applicable.
|
1569
1445
|
type: string
|
1570
1446
|
middleName:
|
1571
1447
|
description: Party middle name.
|
@@ -1589,9 +1465,7 @@ components:
|
|
1589
1465
|
properties:
|
1590
1466
|
homeR2PTransactionId:
|
1591
1467
|
type: string
|
1592
|
-
description:
|
1593
|
-
Linked homeR2PTransactionId which was generated as part of POST
|
1594
|
-
/requestToPay to SDK incase of requestToPay transfer.
|
1468
|
+
description: Linked homeR2PTransactionId which was generated as part of POST /requestToPay to SDK incase of requestToPay transfer.
|
1595
1469
|
amount:
|
1596
1470
|
$ref: '#/components/schemas/money'
|
1597
1471
|
amountType:
|
@@ -1642,9 +1516,7 @@ components:
|
|
1642
1516
|
fulfilment:
|
1643
1517
|
$ref: '#/components/schemas/IlpFulfilment'
|
1644
1518
|
homeTransactionId:
|
1645
|
-
description:
|
1646
|
-
Transaction ID from the DFSP backend, used to reconcile transactions
|
1647
|
-
between the Switch and DFSP backend systems.
|
1519
|
+
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
|
1648
1520
|
type: string
|
1649
1521
|
transferState:
|
1650
1522
|
$ref: '#/components/schemas/transferState'
|
@@ -1652,12 +1524,8 @@ components:
|
|
1652
1524
|
- homeTransactionId
|
1653
1525
|
type: object
|
1654
1526
|
transferState:
|
1655
|
-
description:
|
1656
|
-
Below are the allowed values for the enumeration - RECEIVED DFSP has
|
1657
|
-
received the transfer. - RESERVED DFSP has reserved the transfer. -
|
1658
|
-
COMMITTED DFSP has successfully performed the transfer. - ABORTED DFSP
|
1659
|
-
has aborted the transfer due a rejection or failure to perform the
|
1660
|
-
transfer.
|
1527
|
+
description: |
|
1528
|
+
Below are the allowed values for the enumeration - RECEIVED DFSP has received the transfer. - RESERVED DFSP has reserved the transfer. - COMMITTED DFSP has successfully performed the transfer. - ABORTED DFSP has aborted the transfer due a rejection or failure to perform the transfer.
|
1661
1529
|
enum:
|
1662
1530
|
- RECEIVED
|
1663
1531
|
- RESERVED
|
@@ -1676,9 +1544,7 @@ components:
|
|
1676
1544
|
properties:
|
1677
1545
|
homeR2PTransactionId:
|
1678
1546
|
type: string
|
1679
|
-
description:
|
1680
|
-
Transaction ID from the DFSP backend, used to reconcile transactions
|
1681
|
-
between the Switch and DFSP backend systems.
|
1547
|
+
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
|
1682
1548
|
transactionRequestState:
|
1683
1549
|
$ref: '#/components/schemas/transactionRequestState'
|
1684
1550
|
required:
|
@@ -1688,9 +1554,7 @@ components:
|
|
1688
1554
|
type: string
|
1689
1555
|
minLength: 1
|
1690
1556
|
maxLength: 2048
|
1691
|
-
description:
|
1692
|
-
KYC information for the party in a form mandated by an individual
|
1693
|
-
scheme.
|
1557
|
+
description: KYC information for the party in a form mandated by an individual scheme.
|
1694
1558
|
example: |-
|
1695
1559
|
{
|
1696
1560
|
"metadata": {
|
@@ -1723,37 +1587,24 @@ components:
|
|
1723
1587
|
title: TransactionSubScenario
|
1724
1588
|
type: string
|
1725
1589
|
pattern: ^[A-Z_]{1,32}$
|
1726
|
-
description:
|
1727
|
-
Possible sub-scenario, defined locally within the scheme (UndefinedEnum
|
1728
|
-
Type).
|
1590
|
+
description: Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).
|
1729
1591
|
example: LOCALLY_DEFINED_SUBSCENARIO
|
1730
1592
|
errorResponse:
|
1731
1593
|
type: object
|
1732
1594
|
properties:
|
1733
1595
|
statusCode:
|
1734
1596
|
type: string
|
1735
|
-
description:
|
1736
|
-
Backend error code from FSP. Ideally, statusCode is FSPIOP
|
1737
|
-
|
1738
|
-
with the same code.
|
1739
|
-
|
1740
|
-
Otherwise, a suitable generic FSPIOP will be used with the
|
1741
|
-
errorResponse in the FSPIOP error message.
|
1597
|
+
description: |
|
1598
|
+
Backend error code from FSP. Ideally, statusCode is FSPIOP conforming. SDK will use status code to retrieve an FSPIOP error with the same code.
|
1599
|
+
Otherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message.
|
1742
1600
|
message:
|
1743
1601
|
type: string
|
1744
1602
|
description: Error message text.
|
1745
1603
|
CorrelationId:
|
1746
1604
|
title: CorrelationId
|
1747
1605
|
type: string
|
1748
|
-
pattern:
|
1749
|
-
|
1750
|
-
description: >-
|
1751
|
-
Identifier that correlates all messages of the same sequence. The API
|
1752
|
-
data type UUID (Universally Unique Identifier) is a JSON String in
|
1753
|
-
canonical format, conforming to [RFC
|
1754
|
-
4122](https://tools.ietf.org/html/rfc4122), that is restricted by a
|
1755
|
-
regular expression for interoperability reasons. A UUID is always 36
|
1756
|
-
characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).
|
1606
|
+
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
|
1607
|
+
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 (‘-‘).
|
1757
1608
|
example: b51ec534-ee48-4575-b6a9-ead2955b8069
|
1758
1609
|
bulkTransactionStatus:
|
1759
1610
|
type: string
|
@@ -1774,11 +1625,7 @@ components:
|
|
1774
1625
|
- true
|
1775
1626
|
Currency:
|
1776
1627
|
title: Currency
|
1777
|
-
description:
|
1778
|
-
The currency codes defined in [ISO
|
1779
|
-
4217](https://www.iso.org/iso-4217-currency-codes.html) as three-letter
|
1780
|
-
alphabetic codes are used as the standard naming representation for
|
1781
|
-
currencies.
|
1628
|
+
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.
|
1782
1629
|
type: string
|
1783
1630
|
minLength: 3
|
1784
1631
|
maxLength: 3
|
@@ -1951,13 +1798,7 @@ components:
|
|
1951
1798
|
title: Amount
|
1952
1799
|
type: string
|
1953
1800
|
pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
|
1954
|
-
description:
|
1955
|
-
The API data type Amount is a JSON String in a canonical format that is
|
1956
|
-
restricted by a regular expression for interoperability reasons. This
|
1957
|
-
pattern does not allow any trailing zeroes at all, but allows an amount
|
1958
|
-
without a minor currency unit. It also only allows four digits in the
|
1959
|
-
minor currency unit; a negative value is not allowed. Using more than 18
|
1960
|
-
digits in the major currency unit is not allowed.
|
1801
|
+
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.
|
1961
1802
|
example: '123.45'
|
1962
1803
|
bulkPerTransferFeeLimit:
|
1963
1804
|
type: object
|
@@ -1987,17 +1828,8 @@ components:
|
|
1987
1828
|
DateTime:
|
1988
1829
|
title: DateTime
|
1989
1830
|
type: string
|
1990
|
-
pattern:
|
1991
|
-
|
1992
|
-
description: >-
|
1993
|
-
The API data type DateTime is a JSON String in a lexical format that is
|
1994
|
-
restricted by a regular expression for interoperability reasons. The
|
1995
|
-
format is according to [ISO
|
1996
|
-
8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed
|
1997
|
-
in a combined date, time and time zone format. A more readable version
|
1998
|
-
of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are
|
1999
|
-
"2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z
|
2000
|
-
indicates Zulu time zone, same as UTC).
|
1831
|
+
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)$
|
1832
|
+
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).
|
2001
1833
|
example: '2016-05-24T08:38:08.699-04:00'
|
2002
1834
|
bulkTransactionOptions:
|
2003
1835
|
type: object
|
@@ -2007,33 +1839,20 @@ components:
|
|
2007
1839
|
- bulkExpiration
|
2008
1840
|
properties:
|
2009
1841
|
onlyValidateParty:
|
2010
|
-
description:
|
2011
|
-
Set to true if only party validation is required. This means the
|
2012
|
-
quotes and transfers will not run. This is useful for only party
|
2013
|
-
resolution.
|
1842
|
+
description: Set to true if only party validation is required. This means the quotes and transfers will not run. This is useful for only party resolution.
|
2014
1843
|
type: boolean
|
2015
1844
|
autoAcceptParty:
|
2016
1845
|
$ref: '#/components/schemas/autoAcceptPartyOption'
|
2017
1846
|
autoAcceptQuote:
|
2018
|
-
description:
|
2019
|
-
Set to true if the quote response is accepted without confirmation
|
2020
|
-
from the payer. The fees applied by the payee will be acceptable to
|
2021
|
-
the payer abiding by the limits set by optional
|
2022
|
-
'perTransferFeeLimits' array.
|
1847
|
+
description: Set to true if the quote response is accepted without confirmation from the payer. The fees applied by the payee will be acceptable to the payer abiding by the limits set by optional 'perTransferFeeLimits' array.
|
2023
1848
|
type: object
|
2024
1849
|
oneOf:
|
2025
1850
|
- $ref: '#/components/schemas/autoAcceptQuote'
|
2026
1851
|
skipPartyLookup:
|
2027
|
-
description:
|
2028
|
-
Set to true if supplying an FSPID for the payee party and no party
|
2029
|
-
resolution is needed. This may be useful if a previous party
|
2030
|
-
resolution has been performed.
|
1852
|
+
description: Set to true if supplying an FSPID for the payee party and no party resolution is needed. This may be useful if a previous party resolution has been performed.
|
2031
1853
|
type: boolean
|
2032
1854
|
synchronous:
|
2033
|
-
description:
|
2034
|
-
Set to true if the bulkTransfer requests need be handled
|
2035
|
-
synchronous. Otherwise the requests will be handled asynchronously,
|
2036
|
-
meaning there will be callbacks whenever the processing is done
|
1855
|
+
description: Set to true if the bulkTransfer requests need be handled synchronous. Otherwise the requests will be handled asynchronously, meaning there will be callbacks whenever the processing is done
|
2037
1856
|
type: boolean
|
2038
1857
|
bulkExpiration:
|
2039
1858
|
$ref: '#/components/schemas/DateTime'
|
@@ -2049,52 +1868,16 @@ components:
|
|
2049
1868
|
- ACCOUNT_ID
|
2050
1869
|
- IBAN
|
2051
1870
|
- ALIAS
|
2052
|
-
description:
|
1871
|
+
description: |-
|
2053
1872
|
Below are the allowed values for the enumeration.
|
2054
|
-
|
2055
|
-
-
|
2056
|
-
|
2057
|
-
participant. The
|
2058
|
-
|
2059
|
-
|
2060
|
-
|
2061
|
-
|
2062
|
-
|
2063
|
-
- EMAIL - An email is used as reference to a participant. The format of
|
2064
|
-
the email should be according to the informational [RFC
|
2065
|
-
3696](https://tools.ietf.org/html/rfc3696).
|
2066
|
-
|
2067
|
-
- PERSONAL_ID - A personal identifier is used as reference to a
|
2068
|
-
participant. Examples of personal identification are passport number,
|
2069
|
-
birth certificate number, and national registration number. The
|
2070
|
-
identifier number is added in the PartyIdentifier element. The personal
|
2071
|
-
identifier type is added in the PartySubIdOrType element.
|
2072
|
-
|
2073
|
-
- BUSINESS - A specific Business (for example, an organization or a
|
2074
|
-
company) is used as reference to a participant. The BUSINESS identifier
|
2075
|
-
can be in any format. To make a transaction connected to a specific
|
2076
|
-
username or bill number in a Business, the PartySubIdOrType element
|
2077
|
-
should be used.
|
2078
|
-
|
2079
|
-
- DEVICE - A specific device (for example, a POS or ATM) ID connected to
|
2080
|
-
a specific business or organization is used as reference to a Party. For
|
2081
|
-
referencing a specific device under a specific business or organization,
|
2082
|
-
use the PartySubIdOrType element.
|
2083
|
-
|
2084
|
-
- ACCOUNT_ID - A bank account number or FSP account ID should be used as
|
2085
|
-
reference to a participant. The ACCOUNT_ID identifier can be in any
|
2086
|
-
format, as formats can greatly differ depending on country and FSP.
|
2087
|
-
|
2088
|
-
- IBAN - A bank account number or FSP account ID is used as reference to
|
2089
|
-
a participant. The IBAN identifier can consist of up to 34 alphanumeric
|
2090
|
-
characters and should be entered without whitespace.
|
2091
|
-
|
2092
|
-
- ALIAS An alias is used as reference to a participant. The alias should
|
2093
|
-
be created in the FSP as an alternative reference to an account owner.
|
2094
|
-
Another example of an alias is a username in the FSP system. The ALIAS
|
2095
|
-
identifier can be in any format. It is also possible to use the
|
2096
|
-
PartySubIdOrType element for identifying an account under an Alias
|
2097
|
-
defined by the PartyIdentifier.
|
1873
|
+
- MSISDN - An MSISDN (Mobile Station International Subscriber Directory Number, that is, the phone number) is used as reference to a participant. The MSISDN identifier should be in international format according to the [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en). Optionally, the MSISDN may be prefixed by a single plus sign, indicating the international prefix.
|
1874
|
+
- EMAIL - An email is used as reference to a participant. The format of the email should be according to the informational [RFC 3696](https://tools.ietf.org/html/rfc3696).
|
1875
|
+
- PERSONAL_ID - A personal identifier is used as reference to a participant. Examples of personal identification are passport number, birth certificate number, and national registration number. The identifier number is added in the PartyIdentifier element. The personal identifier type is added in the PartySubIdOrType element.
|
1876
|
+
- BUSINESS - A specific Business (for example, an organization or a company) is used as reference to a participant. The BUSINESS identifier can be in any format. To make a transaction connected to a specific username or bill number in a Business, the PartySubIdOrType element should be used.
|
1877
|
+
- DEVICE - A specific device (for example, a POS or ATM) ID connected to a specific business or organization is used as reference to a Party. For referencing a specific device under a specific business or organization, use the PartySubIdOrType element.
|
1878
|
+
- ACCOUNT_ID - A bank account number or FSP account ID should be used as reference to a participant. The ACCOUNT_ID identifier can be in any format, as formats can greatly differ depending on country and FSP.
|
1879
|
+
- IBAN - A bank account number or FSP account ID is used as reference to a participant. The IBAN identifier can consist of up to 34 alphanumeric characters and should be entered without whitespace.
|
1880
|
+
- ALIAS An alias is used as reference to a participant. The alias should be created in the FSP as an alternative reference to an account owner. Another example of an alias is a username in the FSP system. The ALIAS identifier can be in any format. It is also possible to use the PartySubIdOrType element for identifying an account under an Alias defined by the PartyIdentifier.
|
2098
1881
|
PartyIdentifier:
|
2099
1882
|
title: PartyIdentifier
|
2100
1883
|
type: string
|
@@ -2107,9 +1890,7 @@ components:
|
|
2107
1890
|
type: string
|
2108
1891
|
minLength: 1
|
2109
1892
|
maxLength: 128
|
2110
|
-
description:
|
2111
|
-
Either a sub-identifier of a PartyIdentifier, or a sub-type of the
|
2112
|
-
PartyIdType, normally a PersonalIdentifierType.
|
1893
|
+
description: Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
|
2113
1894
|
ExtensionKey:
|
2114
1895
|
title: ExtensionKey
|
2115
1896
|
type: string
|
@@ -2137,9 +1918,7 @@ components:
|
|
2137
1918
|
ExtensionList:
|
2138
1919
|
title: ExtensionList
|
2139
1920
|
type: object
|
2140
|
-
description:
|
2141
|
-
Data model for the complex type ExtensionList. An optional list of
|
2142
|
-
extensions, specific to deployment.
|
1921
|
+
description: Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
|
2143
1922
|
properties:
|
2144
1923
|
extension:
|
2145
1924
|
type: array
|
@@ -2153,9 +1932,7 @@ components:
|
|
2153
1932
|
PartyIdInfo:
|
2154
1933
|
title: PartyIdInfo
|
2155
1934
|
type: object
|
2156
|
-
description:
|
2157
|
-
Data model for the complex type PartyIdInfo. An ExtensionList element
|
2158
|
-
has been added to this reqeust in version v1.1
|
1935
|
+
description: Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
|
2159
1936
|
properties:
|
2160
1937
|
partyIdType:
|
2161
1938
|
$ref: '#/components/schemas/PartyIdType'
|
@@ -2226,14 +2003,10 @@ components:
|
|
2226
2003
|
enum:
|
2227
2004
|
- SEND
|
2228
2005
|
- RECEIVE
|
2229
|
-
description:
|
2006
|
+
description: |-
|
2230
2007
|
Below are the allowed values for the enumeration AmountType.
|
2231
|
-
|
2232
|
-
-
|
2233
|
-
should be withdrawn from the Payer account including any fees.
|
2234
|
-
|
2235
|
-
- RECEIVE - Amount the Payer would like the Payee to receive, that is,
|
2236
|
-
the amount that should be sent to the receiver exclusive of any fees.
|
2008
|
+
- SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
|
2009
|
+
- 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.
|
2237
2010
|
example: RECEIVE
|
2238
2011
|
Note:
|
2239
2012
|
title: Note
|
@@ -2257,27 +2030,19 @@ components:
|
|
2257
2030
|
Latitude:
|
2258
2031
|
title: Latitude
|
2259
2032
|
type: string
|
2260
|
-
pattern:
|
2261
|
-
|
2262
|
-
description: >-
|
2263
|
-
The API data type Latitude is a JSON String in a lexical format that is
|
2264
|
-
restricted by a regular expression for interoperability reasons.
|
2033
|
+
pattern: ^(\+|-)?(?:90(?:(?:\.0{1,6})?)|(?:[0-9]|[1-8][0-9])(?:(?:\.[0-9]{1,6})?))$
|
2034
|
+
description: The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
|
2265
2035
|
example: '+45.4215'
|
2266
2036
|
Longitude:
|
2267
2037
|
title: Longitude
|
2268
2038
|
type: string
|
2269
|
-
pattern:
|
2270
|
-
|
2271
|
-
description: >-
|
2272
|
-
The API data type Longitude is a JSON String in a lexical format that is
|
2273
|
-
restricted by a regular expression for interoperability reasons.
|
2039
|
+
pattern: ^(\+|-)?(?:180(?:(?:\.0{1,6})?)|(?:[0-9]|[1-9][0-9]|1[0-7][0-9])(?:(?:\.[0-9]{1,6})?))$
|
2040
|
+
description: The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
|
2274
2041
|
example: '+75.6972'
|
2275
2042
|
GeoCode:
|
2276
2043
|
title: GeoCode
|
2277
2044
|
type: object
|
2278
|
-
description:
|
2279
|
-
Data model for the complex type GeoCode. Indicates the geographic
|
2280
|
-
location from where the transaction was initiated.
|
2045
|
+
description: Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
|
2281
2046
|
properties:
|
2282
2047
|
latitude:
|
2283
2048
|
$ref: '#/components/schemas/Latitude'
|
@@ -2293,8 +2058,7 @@ components:
|
|
2293
2058
|
minLength: 1
|
2294
2059
|
maxLength: 32768
|
2295
2060
|
description: Information for recipient (transport layer information).
|
2296
|
-
example:
|
2297
|
-
AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
|
2061
|
+
example: AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
|
2298
2062
|
IlpCondition:
|
2299
2063
|
title: IlpCondition
|
2300
2064
|
type: string
|
@@ -2305,14 +2069,7 @@ components:
|
|
2305
2069
|
title: ErrorCode
|
2306
2070
|
type: string
|
2307
2071
|
pattern: ^[1-9]\d{3}$
|
2308
|
-
description:
|
2309
|
-
The API data type ErrorCode is a JSON String of four characters,
|
2310
|
-
consisting of digits only. Negative numbers are not allowed. A leading
|
2311
|
-
zero is not allowed. Each error code in the API is a four-digit number,
|
2312
|
-
for example, 1234, where the first number (1 in the example) represents
|
2313
|
-
the high-level error category, the second number (2 in the example)
|
2314
|
-
represents the low-level error category, and the last two numbers (34 in
|
2315
|
-
the example) represent the specific error.
|
2072
|
+
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.
|
2316
2073
|
example: '5100'
|
2317
2074
|
ErrorDescription:
|
2318
2075
|
title: ErrorDescription
|
@@ -2341,15 +2098,11 @@ components:
|
|
2341
2098
|
$ref: '#/components/schemas/ErrorInformation'
|
2342
2099
|
quoteError:
|
2343
2100
|
type: object
|
2344
|
-
description:
|
2345
|
-
This object represents a Mojaloop API error received at any time during
|
2346
|
-
the quote process
|
2101
|
+
description: This object represents a Mojaloop API error received at any time during the quote process
|
2347
2102
|
properties:
|
2348
2103
|
httpStatusCode:
|
2349
2104
|
type: integer
|
2350
|
-
description:
|
2351
|
-
The HTTP status code returned to the caller. This is the same as the
|
2352
|
-
actual HTTP status code returned with the response.
|
2105
|
+
description: The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response.
|
2353
2106
|
mojaloopError:
|
2354
2107
|
$ref: '#/components/schemas/mojaloopError'
|
2355
2108
|
individualQuoteResult:
|
@@ -2392,29 +2145,20 @@ components:
|
|
2392
2145
|
- RESERVED
|
2393
2146
|
- COMMITTED
|
2394
2147
|
- ABORTED
|
2395
|
-
description:
|
2148
|
+
description: |-
|
2396
2149
|
Below are the allowed values for the enumeration.
|
2397
|
-
|
2398
2150
|
- RECEIVED - Next ledger has received the transfer.
|
2399
|
-
|
2400
2151
|
- RESERVED - Next ledger has reserved the transfer.
|
2401
|
-
|
2402
2152
|
- COMMITTED - Next ledger has successfully performed the transfer.
|
2403
|
-
|
2404
|
-
- ABORTED - Next ledger has aborted the transfer due to a rejection or
|
2405
|
-
failure to perform the transfer.
|
2153
|
+
- ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
|
2406
2154
|
example: RESERVED
|
2407
2155
|
transferError:
|
2408
2156
|
type: object
|
2409
|
-
description:
|
2410
|
-
This object represents a Mojaloop API error received at any time during
|
2411
|
-
the transfer process
|
2157
|
+
description: This object represents a Mojaloop API error received at any time during the transfer process
|
2412
2158
|
properties:
|
2413
2159
|
httpStatusCode:
|
2414
2160
|
type: integer
|
2415
|
-
description:
|
2416
|
-
The HTTP status code returned to the caller. This is the same as the
|
2417
|
-
actual HTTP status code returned with the response.
|
2161
|
+
description: The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response.
|
2418
2162
|
mojaloopError:
|
2419
2163
|
$ref: '#/components/schemas/mojaloopError'
|
2420
2164
|
individualTransferResult:
|
@@ -2441,9 +2185,7 @@ components:
|
|
2441
2185
|
$ref: '#/components/schemas/CorrelationId'
|
2442
2186
|
homeTransactionId:
|
2443
2187
|
type: string
|
2444
|
-
description:
|
2445
|
-
Transaction ID from the DFSP backend, used to reconcile transactions
|
2446
|
-
between the Switch and DFSP backend systems.
|
2188
|
+
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
|
2447
2189
|
transactionId:
|
2448
2190
|
$ref: '#/components/schemas/CorrelationId'
|
2449
2191
|
to:
|
@@ -2482,9 +2224,7 @@ components:
|
|
2482
2224
|
properties:
|
2483
2225
|
bulkHomeTransactionID:
|
2484
2226
|
type: string
|
2485
|
-
description:
|
2486
|
-
Transaction ID from the DFSP backend, used to reconcile transactions
|
2487
|
-
between the Switch and DFSP backend systems.
|
2227
|
+
description: Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems.
|
2488
2228
|
bulkTransactionId:
|
2489
2229
|
$ref: '#/components/schemas/CorrelationId'
|
2490
2230
|
currentState:
|
@@ -2505,18 +2245,11 @@ components:
|
|
2505
2245
|
enum:
|
2506
2246
|
- PAYER
|
2507
2247
|
- PAYEE
|
2508
|
-
description:
|
2509
|
-
Below are the allowed values for the enumeration CurrencyConverter. -
|
2510
|
-
PAYER - Currency conversion should be performed by the payer. - PAYEE -
|
2511
|
-
Currency conversion should be performed by the payee.
|
2248
|
+
description: Below are the allowed values for the enumeration CurrencyConverter. - PAYER - Currency conversion should be performed by the payer. - PAYEE - Currency conversion should be performed by the payee.
|
2512
2249
|
FxRate:
|
2513
2250
|
title: FxRate
|
2514
2251
|
type: object
|
2515
|
-
description:
|
2516
|
-
The FxRate object contains information about a currency conversion in
|
2517
|
-
the transfer. It can be used by parties to the transfer to exchange
|
2518
|
-
information with each other about the exchange rate for the transfer, to
|
2519
|
-
ensure that the best rate can be agreed on.
|
2252
|
+
description: The FxRate object contains information about a currency conversion in the transfer. It can be used by parties to the transfer to exchange information with each other about the exchange rate for the transfer, to ensure that the best rate can be agreed on.
|
2520
2253
|
properties:
|
2521
2254
|
sourceAmount:
|
2522
2255
|
allOf:
|
@@ -2545,9 +2278,7 @@ components:
|
|
2545
2278
|
FxMoney:
|
2546
2279
|
title: FxMoney
|
2547
2280
|
type: object
|
2548
|
-
description:
|
2549
|
-
Data model for the complex type FxMoney; This is based on the type Money
|
2550
|
-
but allows the amount to be optional to support FX quotations.
|
2281
|
+
description: Data model for the complex type FxMoney; This is based on the type Money but allows the amount to be optional to support FX quotations.
|
2551
2282
|
properties:
|
2552
2283
|
currency:
|
2553
2284
|
$ref: '#/components/schemas/Currency'
|
@@ -2558,9 +2289,7 @@ components:
|
|
2558
2289
|
FxCharge:
|
2559
2290
|
title: FxCharge
|
2560
2291
|
type: object
|
2561
|
-
description:
|
2562
|
-
An FXP will be able to specify a charge which it proposes to levy on the
|
2563
|
-
currency conversion operation using a FxCharge object.
|
2292
|
+
description: An FXP will be able to specify a charge which it proposes to levy on the currency conversion operation using a FxCharge object.
|
2564
2293
|
properties:
|
2565
2294
|
chargeType:
|
2566
2295
|
type: string
|
@@ -2570,24 +2299,17 @@ components:
|
|
2570
2299
|
sourceAmount:
|
2571
2300
|
allOf:
|
2572
2301
|
- $ref: '#/components/schemas/Money'
|
2573
|
-
- description:
|
2574
|
-
The amount of the charge which is being levied, expressed in the
|
2575
|
-
source currency.
|
2302
|
+
- description: The amount of the charge which is being levied, expressed in the source currency.
|
2576
2303
|
targetAmount:
|
2577
2304
|
allOf:
|
2578
2305
|
- $ref: '#/components/schemas/Money'
|
2579
|
-
- description:
|
2580
|
-
The amount of the charge which is being levied, expressed in the
|
2581
|
-
target currency.
|
2306
|
+
- description: The amount of the charge which is being levied, expressed in the target currency.
|
2582
2307
|
required:
|
2583
2308
|
- chargeType
|
2584
2309
|
FxConversion:
|
2585
2310
|
title: FxConversion
|
2586
2311
|
type: object
|
2587
|
-
description:
|
2588
|
-
A DFSP will be able to request a currency conversion, and an FX provider
|
2589
|
-
will be able to describe its involvement in a proposed transfer, using a
|
2590
|
-
FxConversion object.
|
2312
|
+
description: A DFSP will be able to request a currency conversion, and an FX provider will be able to describe its involvement in a proposed transfer, using a FxConversion object.
|
2591
2313
|
properties:
|
2592
2314
|
conversionId:
|
2593
2315
|
allOf:
|
@@ -2596,15 +2318,11 @@ components:
|
|
2596
2318
|
determiningTransferId:
|
2597
2319
|
allOf:
|
2598
2320
|
- $ref: '#/components/schemas/CorrelationId'
|
2599
|
-
- description:
|
2600
|
-
The transaction ID of the transfer on whose success this
|
2601
|
-
currency conversion depends.
|
2321
|
+
- description: The transaction ID of the transfer on whose success this currency conversion depends.
|
2602
2322
|
initiatingFsp:
|
2603
2323
|
allOf:
|
2604
2324
|
- $ref: '#/components/schemas/FspId'
|
2605
|
-
- description:
|
2606
|
-
The id of the participant who is requesting a currency
|
2607
|
-
conversion.
|
2325
|
+
- description: The id of the participant who is requesting a currency conversion.
|
2608
2326
|
counterPartyFsp:
|
2609
2327
|
allOf:
|
2610
2328
|
- $ref: '#/components/schemas/FspId'
|
@@ -2612,13 +2330,7 @@ components:
|
|
2612
2330
|
amountType:
|
2613
2331
|
allOf:
|
2614
2332
|
- $ref: '#/components/schemas/AmountType'
|
2615
|
-
- description:
|
2616
|
-
This is the AmountType for the base transaction - If SEND - then
|
2617
|
-
any charges levied by the FXP as part of the transaction will be
|
2618
|
-
deducted by the FXP from the amount shown for the target party
|
2619
|
-
in the conversion. If RECEIVE - then any charges levied by the
|
2620
|
-
FXP as part of the transaction will be added by the FXP to the
|
2621
|
-
amount shown for the source party in the conversion.
|
2333
|
+
- description: This is the AmountType for the base transaction - If SEND - then any charges levied by the FXP as part of the transaction will be deducted by the FXP from the amount shown for the target party in the conversion. If RECEIVE - then any charges levied by the FXP as part of the transaction will be added by the FXP to the amount shown for the source party in the conversion.
|
2622
2334
|
sourceAmount:
|
2623
2335
|
allOf:
|
2624
2336
|
- $ref: '#/components/schemas/FxMoney'
|
@@ -2630,15 +2342,10 @@ components:
|
|
2630
2342
|
expiration:
|
2631
2343
|
allOf:
|
2632
2344
|
- $ref: '#/components/schemas/DateTime'
|
2633
|
-
- description:
|
2634
|
-
The end of the period for which the currency conversion is
|
2635
|
-
required to remain valid.
|
2345
|
+
- description: The end of the period for which the currency conversion is required to remain valid.
|
2636
2346
|
charges:
|
2637
2347
|
type: array
|
2638
|
-
description:
|
2639
|
-
One or more charges which the FXP intends to levy as part of the
|
2640
|
-
currency conversion, or which the payee DFSP intends to add to the
|
2641
|
-
amount transferred.
|
2348
|
+
description: One or more charges which the FXP intends to levy as part of the currency conversion, or which the payee DFSP intends to add to the amount transferred.
|
2642
2349
|
items:
|
2643
2350
|
$ref: '#/components/schemas/FxCharge'
|
2644
2351
|
minItems: 0
|
@@ -2667,31 +2374,22 @@ components:
|
|
2667
2374
|
conversionTerms:
|
2668
2375
|
allOf:
|
2669
2376
|
- $ref: '#/components/schemas/FxConversion'
|
2670
|
-
- description:
|
2671
|
-
The terms of the currency conversion for which a quotation is
|
2672
|
-
sought.
|
2377
|
+
- description: The terms of the currency conversion for which a quotation is sought.
|
2673
2378
|
required:
|
2674
2379
|
- conversionRequestId
|
2675
2380
|
- conversionTerms
|
2676
2381
|
FxQuotesPostBackendResponse:
|
2677
2382
|
title: FxQuotesPostBackendResponse
|
2678
2383
|
type: object
|
2679
|
-
description:
|
2680
|
-
The object sent as a response for the POST /fxQuotes request. The terms
|
2681
|
-
under which the FXP will undertake the currency conversion proposed by
|
2682
|
-
the requester.
|
2384
|
+
description: The object sent as a response for the POST /fxQuotes request. The terms under which the FXP will undertake the currency conversion proposed by the requester.
|
2683
2385
|
properties:
|
2684
2386
|
homeTransactionId:
|
2685
|
-
description:
|
2686
|
-
Transaction ID for the FXP backend, used to reconcile transactions
|
2687
|
-
between the Switch and FXP backend systems.
|
2387
|
+
description: Transaction ID for the FXP backend, used to reconcile transactions between the Switch and FXP backend systems.
|
2688
2388
|
type: string
|
2689
2389
|
conversionTerms:
|
2690
2390
|
allOf:
|
2691
2391
|
- $ref: '#/components/schemas/FxConversion'
|
2692
|
-
- description:
|
2693
|
-
The terms under which the FXP will undertake the currency
|
2694
|
-
conversion proposed by the requester.
|
2392
|
+
- description: The terms under which the FXP will undertake the currency conversion proposed by the requester.
|
2695
2393
|
required:
|
2696
2394
|
- conversionTerms
|
2697
2395
|
commitRequestId:
|
@@ -2701,10 +2399,7 @@ components:
|
|
2701
2399
|
determiningTransferId:
|
2702
2400
|
allOf:
|
2703
2401
|
- $ref: '#/components/schemas/CorrelationId'
|
2704
|
-
- description:
|
2705
|
-
The transaction ID of the transfer to which this currency conversion
|
2706
|
-
relates, if the conversion is part of a transfer. If the conversion
|
2707
|
-
is a bulk currency purchase, this field should be omitted.
|
2402
|
+
- description: The transaction ID of the transfer to which this currency conversion relates, if the conversion is part of a transfer. If the conversion is a bulk currency purchase, this field should be omitted.
|
2708
2403
|
initiatingFsp:
|
2709
2404
|
allOf:
|
2710
2405
|
- $ref: '#/components/schemas/FspId'
|
@@ -2720,24 +2415,18 @@ components:
|
|
2720
2415
|
targetAmount:
|
2721
2416
|
allOf:
|
2722
2417
|
- $ref: '#/components/schemas/Money'
|
2723
|
-
- description:
|
2724
|
-
The amount which the FXP is to credit to the requesting FSP in the
|
2725
|
-
target currency.
|
2418
|
+
- description: The amount which the FXP is to credit to the requesting FSP in the target currency.
|
2726
2419
|
condition:
|
2727
2420
|
allOf:
|
2728
2421
|
- $ref: '#/components/schemas/IlpCondition'
|
2729
|
-
- description:
|
2730
|
-
ILP condition received by the requesting FSP when the quote was
|
2731
|
-
approved.
|
2422
|
+
- description: ILP condition received by the requesting FSP when the quote was approved.
|
2732
2423
|
FxTransfersPostBackendRequest:
|
2733
2424
|
title: FxTransfersPostBackendRequest
|
2734
2425
|
type: object
|
2735
2426
|
description: The object sent in the POST /fxTransfers request.
|
2736
2427
|
properties:
|
2737
2428
|
homeTransactionId:
|
2738
|
-
description:
|
2739
|
-
Transaction ID for the FXP backend, used to reconcile transactions
|
2740
|
-
between the Switch and FXP backend systems.
|
2429
|
+
description: Transaction ID for the FXP backend, used to reconcile transactions between the Switch and FXP backend systems.
|
2741
2430
|
type: string
|
2742
2431
|
commitRequestId:
|
2743
2432
|
$ref: '#/components/schemas/commitRequestId'
|
@@ -2762,10 +2451,7 @@ components:
|
|
2762
2451
|
fulfilment:
|
2763
2452
|
allOf:
|
2764
2453
|
- $ref: '#/components/schemas/IlpFulfilment'
|
2765
|
-
- description:
|
2766
|
-
The fulfilment of the condition specified for the currency
|
2767
|
-
conversion. Mandatory if the conversion has been executed
|
2768
|
-
successfully.
|
2454
|
+
- description: The fulfilment of the condition specified for the currency conversion. Mandatory if the conversion has been executed successfully.
|
2769
2455
|
completedTimestamp:
|
2770
2456
|
allOf:
|
2771
2457
|
- $ref: '#/components/schemas/DateTime'
|
@@ -2780,9 +2466,7 @@ components:
|
|
2780
2466
|
description: The object sent as a response for the POST /fxTransfers request.
|
2781
2467
|
properties:
|
2782
2468
|
homeTransactionId:
|
2783
|
-
description:
|
2784
|
-
Transaction ID for the FXP backend, used to reconcile transactions
|
2785
|
-
between the Switch and FXP backend systems.
|
2469
|
+
description: Transaction ID for the FXP backend, used to reconcile transactions between the Switch and FXP backend systems.
|
2786
2470
|
type: string
|
2787
2471
|
fulfilment:
|
2788
2472
|
$ref: '#/components/schemas/fulfilment'
|
@@ -2800,9 +2484,7 @@ components:
|
|
2800
2484
|
description: PUT /fxTransfers/{commitRequestId} object
|
2801
2485
|
properties:
|
2802
2486
|
homeTransactionId:
|
2803
|
-
description:
|
2804
|
-
Transaction ID for the FXP backend, used to reconcile transactions
|
2805
|
-
between the Switch and FXP backend systems.
|
2487
|
+
description: Transaction ID for the FXP backend, used to reconcile transactions between the Switch and FXP backend systems.
|
2806
2488
|
type: string
|
2807
2489
|
fulfilment:
|
2808
2490
|
$ref: '#/components/schemas/fulfilment'
|