-
Notifications
You must be signed in to change notification settings - Fork 1
/
sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml
3024 lines (3003 loc) · 111 KB
/
sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: Mojaloop SDK Outbound Scheme Adapter API
description: |
Specification for the Mojaloop SDK Scheme Adapter Outbound Transfers API
This API can be used by DFSP backends to simplify the process of sending funds to other parties within a Mojaloop scheme.
Please see other documentation on https://github.com/mojaloop/sdk-scheme-adapter for more information.
**Note on terminology:** The term "Switch" is equal to the term "Hub", and the term "FSP" is equal to the term "DFSP".
license:
name: Apache License Version 2.0, January 2004
url: https://github.com/mojaloop/documentation/blob/main/LICENSE.md
version: 2.1.0
paths:
/:
get:
summary: Health check endpoint
description: This endpoint allows a user of the SDK scheme adapter to check the outbound transfers service is listening.
tags:
- Health
responses:
'200':
description: Returns empty body if the scheme adapter outbound transfers service is running.
/accounts:
post:
summary: Create accounts on the Account Lookup Service
description: |-
The HTTP request `POST /accounts` is used to create account information on the Account Lookup Service (ALS) regarding the provided list of identities.
Caller DFSP is used as the account source FSP information
tags:
- Accounts
requestBody:
description: Identities list request body
content:
application/json:
schema:
$ref: '#/components/schemas/accountsRequest'
required: true
responses:
'200':
$ref: '#/components/responses/accountsCreationCompleted'
'400':
$ref: '#/components/responses/accountsCreationError'
'500':
$ref: '#/components/responses/accountsCreationError'
'504':
$ref: '#/components/responses/accountsCreationTimeout'
/bulkQuotes:
post:
summary: Request bulk quotes for the provided financial transactions
description: |
The HTTP request `POST /bulkQuotes` is used to request a bulk quote to fascilitate funds transfer from payer DFSP to payees' DFSP.
tags:
- BulkQuotes
requestBody:
description: Bulk quote request body
content:
application/json:
schema:
$ref: '#/components/schemas/bulkQuoteRequest'
required: true
responses:
'200':
$ref: '#/components/responses/bulkQuoteSuccess'
'400':
$ref: '#/components/responses/bulkQuoteBadRequest'
'500':
$ref: '#/components/responses/bulkQuoteServerError'
'504':
$ref: '#/components/responses/bulkQuoteTimeout'
/bulkQuotes/{bulkQuoteId}:
get:
summary: Retrieves information for a specific bulk quote
description: The HTTP request `GET /bulkQuotes/{bulktQuoteId}` is used to get information regarding a bulk quote created or requested earlier. The `{bulkQuoteId}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote.
tags:
- BulkQuotes
parameters:
- $ref: '#/components/parameters/bulkQuoteId'
responses:
'200':
description: Bulk quote information successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/bulkQuoteStatusResponse'
'500':
description: An error occurred processing the bulk quote
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
/bulkTransactions:
post:
summary: Sends money from one account to multiple accounts
description: |
The HTTP request `POST /bulkTransactions` is used to request the movement of funds from payer DFSP to payees' DFSP.
tags:
- BulkTransactions
requestBody:
description: Bulk transfer request body
content:
application/json:
schema:
$ref: '#/components/schemas/bulkTransactionRequest'
required: true
responses:
'202':
$ref: '#/components/responses/bulkTransactionAccepted'
'400':
$ref: '#/components/responses/bulkTransferBadRequest'
'500':
$ref: '#/components/responses/errorResponse'
/bulkTransactions/{bulkTransactionId}:
put:
summary: Amends the bulk transaction request
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.
tags:
- BulkTransactions
parameters:
- $ref: '#/components/parameters/bulkTransactionId'
requestBody:
description: Bulk transaction request body
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/bulkTransactionContinuationAcceptParty'
- $ref: '#/components/schemas/bulkTransactionContinuationAcceptQuote'
required: true
responses:
'202':
description: Bulk transaction information successfully amended
'400':
$ref: '#/components/responses/bulkTransactionPutBadRequest'
'500':
description: An error occurred processing the bulk transaction
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
/bulkTransfers:
post:
summary: Sends money from one account to multiple accounts
description: |
The HTTP request `POST /bulkTransfers` is used to request the movement of funds from payer DFSP to payees' DFSP.
tags:
- BulkTransfers
requestBody:
description: Bulk transfer request body
content:
application/json:
schema:
$ref: '#/components/schemas/bulkTransferRequest'
required: true
responses:
'200':
$ref: '#/components/responses/bulkTransferSuccess'
'400':
$ref: '#/components/responses/bulkTransferBadRequest'
'500':
$ref: '#/components/responses/errorResponse'
/bulkTransfers/{bulkTransferId}:
get:
summary: Retrieves information for a specific bulk transfer
description: The HTTP request `GET /bulkTransfers/{bulkTransferId}` is used to get information regarding a bulk transfer created or requested earlier. The `{bulkTransferId}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer.
tags:
- BulkTransfers
parameters:
- $ref: '#/components/parameters/bulkTransferId'
responses:
'200':
description: Bulk transfer information successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/bulkTransferStatusResponse'
'500':
description: An error occurred processing the bulk transfer
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
/parties/{Type}/{ID}:
parameters:
- $ref: '#/components/parameters/Type'
- $ref: '#/components/parameters/ID'
get:
description: The HTTP request GET /parties// (or GET /parties///) is used to lookup information regarding the requested Party, defined by , and optionally (for example, GET /parties/MSISDN/123456789, or GET /parties/BUSINESS/shoecompany/employee1).
summary: PartiesByTypeAndID
tags:
- parties
operationId: PartiesByTypeAndID
responses:
'200':
$ref: '#/components/responses/partiesByIdSuccess'
'404':
$ref: '#/components/responses/partiesByIdError404'
/parties/{Type}/{ID}/{SubId}:
parameters:
- $ref: '#/components/parameters/Type'
- $ref: '#/components/parameters/ID'
- $ref: '#/components/parameters/SubId'
get:
description: The HTTP request GET /parties// (or GET /parties///) is used to lookup information regarding the requested Party, defined by , and optionally (for example, GET /parties/MSISDN/123456789, or GET /parties/BUSINESS/shoecompany/employee1).
summary: PartiesSubIdByTypeAndID
tags:
- parties
operationId: PartiesSubIdByTypeAndID
responses:
'200':
$ref: '#/components/responses/partiesByIdSuccess'
'404':
$ref: '#/components/responses/partiesByIdError404'
/quotes:
post:
summary: Quotes endpoint
description: is used to request quotes from other DFSP
tags:
- quotes
operationId: QuotesPost
requestBody:
description: Quotes request payload
content:
application/json:
schema:
$ref: '#/components/schemas/simpleQuotesPostRequest'
required: true
responses:
'200':
$ref: '#/components/responses/quotesPostSuccess'
'500':
$ref: '#/components/responses/quotesServerError'
/requestToPay:
post:
summary: Receiver requesting funds from Sender
description: |
The HTTP request `POST /requestToPay` is used to support Pull Funds pattern where in a receiver can request for funds from the Sender.
The underlying API has two stages:
1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement.
2. Transaction Request. This request enables a Payee to request Payer to send electronic funds to the Payee.
tags:
- RequestToPay
requestBody:
description: RequestToPay request body
content:
application/json:
schema:
$ref: '#/components/schemas/requestToPayRequest'
required: true
responses:
'200':
$ref: '#/components/responses/requestToPaySuccess'
/requestToPay/{transactionRequestId}:
put:
summary: Continues a request funds from sender that has paused at the party resolution stage in order to accept or reject party information
description: |
The HTTP request `PUT /requestToPay/{transactionRequestId}` is used to continue a transfer initiated via the `POST /requestToPay` method that has halted after party lookup stage.
The request body should contain the "acceptParty" property set to `true` as required to continue the transfer.
See the description of the `POST /requestToPay` HTTP method for more information on modes of transfer.
tags:
- RequestToPay
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/transferContinuationAcceptParty'
parameters:
- $ref: '#/components/parameters/transactionRequestId'
responses:
'200':
$ref: '#/components/responses/requestToPaySuccess'
'500':
$ref: '#/components/responses/transferServerError'
'504':
$ref: '#/components/responses/transferTimeout'
/requestToPayTransfer:
post:
summary: Used to trigger funds from customer fsp account to merchant fsp account. This is a follow-up request to requestToPay.
description: |
The HTTP request `POST /requestToPayTransfer` is used to request the movement of funds from payer DFSP to payee DFSP.
The underlying Mojaloop API has three stages for money transfer:
1. Quotation. This facilitates the exchange of fee information and the construction of a cryptographic "contract" between payee and payer DFSPs before funds are transferred.
2. Authorization. This facilitates getting OTP from payee DFSP.
3. Transfer. The enactment of the previously agreed "contract"
This method has several modes of operation.
- If the configuration variable `AUTO_ACCEPT_QUOTES` is set to `"false"` this method will terminate and return the quotation when it has been received from the payee DFSP.
If the payee wished to proceed with the otp, then a subsequent `PUT /transfers/{transferId}` request (accepting the quote) is required to continue the operation.
The scheme adapter will then proceed with the transfer state.
- If the configuration variable `AUTO_ACCEPT_OTP` is set to `"false"` this method will terminate and return the otp when it has been received from the payee DFSP.
If the payer wished to proceed with the transfer, then a subsequent `PUT /transfers/{transferId}` request (accepting the quote) is required to continue the operation.
The scheme adapter will then proceed with the transfer state.
If the configuration variables `AUTO_ACCEPT_PARTIES` and `AUTO_ACCEPT_QUOTES` are both set to `"true"` this method will block until all three transfer stages are complete. Upon completion it will return the entire set of transfer details received during the operation.
Combinations of settings for `AUTO_ACCEPT...` configuration variables allow the scheme adapter user to decide which mode of operation best suits their use cases. i.e. the scheme adapter can be configured to "break" the three stage transfer at these points in order to execute backend logic such as party verification, quoted fees assessments etc...
tags:
- RequestToPayTransfer
requestBody:
description: Request To Pay Transfer request body
content:
application/json:
schema:
$ref: '#/components/schemas/requestToPayTransferRequest'
required: true
responses:
'200':
$ref: '#/components/responses/requestToPayTransferSuccess'
'400':
$ref: '#/components/responses/requestToPayTransferBadRequest'
'500':
$ref: '#/components/responses/transferServerError'
'504':
$ref: '#/components/responses/transferTimeout'
/requestToPayTransfer/{transactionRequestId}:
put:
summary: Continues a transfer that has paused at the otp stage in order to accept or reject quote
description: |
This request is used to continue a requestToPayTransfer initiated via the `POST /requestToPayTransfer` method that has halted after quotation stage and/or otp stage.
The request body should contain either the "acceptOTP" or "acceptQuote" property set to `true` as required to continue the transfer.
See the description of the `POST /requestToPayTransfer` HTTP method for more information on modes of transfer.
tags:
- RequestToPayTransferID
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/transferContinuationAcceptQuote'
- $ref: '#/components/schemas/transferContinuationAcceptOTP'
parameters:
- $ref: '#/components/parameters/transactionRequestId'
responses:
'200':
$ref: '#/components/responses/transferSuccess'
'500':
$ref: '#/components/responses/transferServerError'
'504':
$ref: '#/components/responses/transferTimeout'
/simpleTransfers:
post:
summary: Simple Transfers endpoint
description: is used to request a transfer
tags:
- transfers
operationId: SimpleTransfersPost
requestBody:
description: Simple Transfer request payload
content:
application/json:
schema:
$ref: '#/components/schemas/simpleTransfersPostRequest'
required: true
responses:
'200':
$ref: '#/components/responses/simpleTransfersPostSuccess'
'500':
$ref: '#/components/responses/simpleTransfersServerError'
/transfers:
post:
summary: Sends money from one account to another
description: |
The HTTP request `POST /transfers` is used to request the movement of funds from payer DFSP to payee DFSP.
The underlying Mojaloop API has three stages for money transfer:
1. Party lookup. This facilitates a check by the sending party that the destination party is correct before proceeding with a money movement.
2. Quotation. This facilitates the exchange of fee information and the construction of a cryptographic "contract" between payee and payer DFSPs before funds are transferred.
3. Transfer. The enactment of the previously agreed "contract"
This method has several modes of operation.
- If the configuration variables `AUTO_ACCEPT_PARTIES` is set to `"false"` this method will terminate when the payee party has been resolved and return the payee party details.
If the payee wishes to proceed with the transfer, then a subsequent `PUT /transfers/{transferId}` request (accepting the payee party) is required to continue the operation.
The scheme adapter will then proceed with quotation stage...
- If the configuration variable `AUTO_ACCEPT_QUOTES` is set to `"false"` this method will terminate and return the quotation when it has been received from the payee DFSP.
If the payee wished to proceed with the transfer, then a subsequent `PUT /transfers/{transferId}` request (accepting the quote) is required to continue the operation.
The scheme adapter will then proceed with the transfer state.
If the configuration variables `AUTO_ACCEPT_PARTIES` and `AUTO_ACCEPT_QUOTES` are both set to `"true"` this method will block until all three transfer stages are complete. Upon completion it will return the entire set of transfer details received during the operation.
Combinations of settings for `AUTO_ACCEPT...` configuration variables allow the scheme adapter user to decide which mode of operation best suits their use cases. i.e. the scheme adapter can be configured to "break" the three stage transfer at these points in order to execute backend logic such as party verification, quoted fees assessments etc...
tags:
- Transfers
requestBody:
description: Transfer request body
content:
application/json:
schema:
$ref: '#/components/schemas/transferRequest'
required: true
responses:
'200':
$ref: '#/components/responses/transferSuccess'
'400':
$ref: '#/components/responses/transferBadRequest'
'500':
$ref: '#/components/responses/transferServerError'
'504':
$ref: '#/components/responses/transferTimeout'
/transfers/{transferId}:
put:
summary: Continues a transfer that has paused at the quote stage in order to accept or reject payee party and/or quote and/or conversion
description: |
The HTTP request `PUT /transfers/{transferId}` is used to continue a transfer initiated via the `POST /transfers` method that has halted after party lookup and/or quotation stage and/or currency conversion stage.
The request body should contain either the "acceptParty" or "acceptQuote" or "acceptConversion" property set to `true` as required to continue the transfer.
See the description of the `POST /transfers` HTTP method for more information on modes of transfer.
tags:
- Transfers
requestBody:
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/transferContinuationAcceptParty'
- $ref: '#/components/schemas/transferContinuationAcceptQuote'
- $ref: '#/components/schemas/transferContinuationAcceptConversion'
parameters:
- $ref: '#/components/parameters/transferId'
responses:
'200':
$ref: '#/components/responses/transferSuccess'
'500':
$ref: '#/components/responses/transferServerError'
'504':
$ref: '#/components/responses/transferTimeout'
get:
summary: Retrieves information for a specific transfer
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.
tags:
- Transfers
parameters:
- $ref: '#/components/parameters/transferId'
responses:
'200':
description: Transfer information successfully retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/transferStatusResponse'
'500':
description: An error occurred processing the transfer
content:
application/json:
schema:
$ref: '#/components/schemas/errorResponse'
/services/FXP:
get:
description: The HTTP request `GET /services/FXP` is used to request information about the participants in a scheme who offer currency conversion services.
summary: Obtain a list of the DFSPs in the scheme who provide FXP service
tags:
- servicesFXP
operationId: ServicesFXPGet
responses:
'200':
$ref: '#/components/responses/servicesFXPSucess'
'400':
$ref: '#/components/responses/400'
'500':
$ref: '#/components/responses/500'
/services/FXP/{SourceCurrency}/{TargetCurrency}:
get:
description: The HTTP request `GET /services/FXP/{SourceCurrency}/{TargetCurrency}` is used to request information about the participants in a scheme who offer currency conversion services in a particular currency corridor. The required corridor is specified by giving the ISO 4217 currency code for the SourceCurrency and the TargetCurrency.
summary: Obtain a list of the DFSPs in the scheme who provide FXP service
tags:
- servicesFXP
operationId: ServicesFXPSourceCurrencyTargetCurrencyGet
parameters:
- $ref: '#/components/parameters/SourceCurrency'
- $ref: '#/components/parameters/TargetCurrency'
responses:
'200':
$ref: '#/components/responses/servicesFXPSucess'
'400':
$ref: '#/components/responses/400'
'500':
$ref: '#/components/responses/500'
/fxQuotes:
post:
description: The HTTP request `POST /fxQuotes` is used to ask to provide a quotation for a currency conversion.
summary: Calculate FX quote
tags:
- Fx
operationId: FxQuotesPost
requestBody:
description: Details of the FX quote request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FxQuotesPostOutboundRequest'
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/FxQuotesPostOutboundResponse'
'400':
$ref: '#/components/responses/400'
'500':
$ref: '#/components/responses/500'
/fxTransfers:
post:
description: The HTTP request `POST /fxTransfers` is used to ask to confirm the execution of an agreed currency conversion.
summary: Perform FX transfer
tags:
- Fx
operationId: FxTransfersPost
requestBody:
description: Details of the FX transfer request.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FxTransfersPostOutboundRequest'
responses:
'200':
description: Successful response.
content:
application/json:
schema:
$ref: '#/components/schemas/FxTransfersPostOutboundResponse'
'400':
$ref: '#/components/responses/400'
'500':
$ref: '#/components/responses/500'
components:
schemas:
PartyIdType:
title: PartyIdType
type: string
enum:
- MSISDN
- EMAIL
- PERSONAL_ID
- BUSINESS
- DEVICE
- ACCOUNT_ID
- IBAN
- ALIAS
description: |-
Below are the allowed values for the enumeration.
- 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.
- 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).
- 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.
- 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.
- 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.
- 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.
- 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.
- 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.
PartyIdentifier:
title: PartyIdentifier
type: string
minLength: 1
maxLength: 128
description: Identifier of the Party.
example: '16135551212'
PartySubIdOrType:
title: PartySubIdOrType
type: string
minLength: 1
maxLength: 128
description: Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
Currency:
title: Currency
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.
type: string
minLength: 3
maxLength: 3
enum:
- AED
- AFN
- ALL
- AMD
- ANG
- AOA
- ARS
- AUD
- AWG
- AZN
- BAM
- BBD
- BDT
- BGN
- BHD
- BIF
- BMD
- BND
- BOB
- BRL
- BSD
- BTN
- BWP
- BYN
- BZD
- CAD
- CDF
- CHF
- CLP
- CNY
- COP
- CRC
- CUC
- CUP
- CVE
- CZK
- DJF
- DKK
- DOP
- DZD
- EGP
- ERN
- ETB
- EUR
- FJD
- FKP
- GBP
- GEL
- GGP
- GHS
- GIP
- GMD
- GNF
- GTQ
- GYD
- HKD
- HNL
- HRK
- HTG
- HUF
- IDR
- ILS
- IMP
- INR
- IQD
- IRR
- ISK
- JEP
- JMD
- JOD
- JPY
- KES
- KGS
- KHR
- KMF
- KPW
- KRW
- KWD
- KYD
- KZT
- LAK
- LBP
- LKR
- LRD
- LSL
- LYD
- MAD
- MDL
- MGA
- MKD
- MMK
- MNT
- MOP
- MRO
- MUR
- MVR
- MWK
- MXN
- MYR
- MZN
- NAD
- NGN
- NIO
- NOK
- NPR
- NZD
- OMR
- PAB
- PEN
- PGK
- PHP
- PKR
- PLN
- PYG
- QAR
- RON
- RSD
- RUB
- RWF
- SAR
- SBD
- SCR
- SDG
- SEK
- SGD
- SHP
- SLL
- SOS
- SPL
- SRD
- STD
- SVC
- SYP
- SZL
- THB
- TJS
- TMT
- TND
- TOP
- TRY
- TTD
- TVD
- TWD
- TZS
- UAH
- UGX
- USD
- UYU
- UZS
- VEF
- VND
- VUV
- WST
- XAF
- XCD
- XDR
- XOF
- XPF
- XTS
- XXX
- YER
- ZAR
- ZMW
- ZWD
accountsRequest:
type: array
items:
type: object
required:
- idType
- idValue
- currency
properties:
idType:
$ref: '#/components/schemas/PartyIdType'
idValue:
$ref: '#/components/schemas/PartyIdentifier'
idSubValue:
$ref: '#/components/schemas/PartySubIdOrType'
currency:
$ref: '#/components/schemas/Currency'
CorrelationId:
title: CorrelationId
type: string
pattern: ^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$
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 (‘-‘).
example: b51ec534-ee48-4575-b6a9-ead2955b8069
errorResponse:
type: object
properties:
statusCode:
type: string
description: |
Backend error code from FSP. Ideally, statusCode is FSPIOP conforming. SDK will use status code to retrieve an FSPIOP error with the same code.
Otherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message.
message:
type: string
description: Error message text.
accountCreationStatus:
type: array
items:
type: object
required:
- idType
- idValue
properties:
idType:
$ref: '#/components/schemas/PartyIdType'
idValue:
$ref: '#/components/schemas/PartyIdentifier'
idSubValue:
$ref: '#/components/schemas/PartySubIdOrType'
error:
$ref: '#/components/schemas/errorResponse'
accountsCreationState:
type: string
enum:
- ERROR_OCCURRED
- COMPLETED
ErrorCode:
title: ErrorCode
type: string
pattern: ^[1-9]\d{3}$
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.
example: '5100'
ErrorDescription:
title: ErrorDescription
type: string
minLength: 1
maxLength: 128
description: Error description string.
ExtensionKey:
title: ExtensionKey
type: string
minLength: 1
maxLength: 32
description: Extension key.
ExtensionValue:
title: ExtensionValue
type: string
minLength: 1
maxLength: 128
description: Extension value.
Extension:
title: Extension
type: object
description: Data model for the complex type Extension.
properties:
key:
$ref: '#/components/schemas/ExtensionKey'
value:
$ref: '#/components/schemas/ExtensionValue'
required:
- key
- value
ExtensionList:
title: ExtensionList
type: object
description: Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
properties:
extension:
type: array
items:
$ref: '#/components/schemas/Extension'
minItems: 1
maxItems: 16
description: Number of Extension elements.
required:
- extension
ErrorInformation:
title: ErrorInformation
type: object
description: Data model for the complex type ErrorInformation.
properties:
errorCode:
$ref: '#/components/schemas/ErrorCode'
errorDescription:
$ref: '#/components/schemas/ErrorDescription'
extensionList:
$ref: '#/components/schemas/ExtensionList'
required:
- errorCode
- errorDescription
mojaloopError:
type: object
properties:
errorInformation:
$ref: '#/components/schemas/ErrorInformation'
transferError:
type: object
description: This object represents a Mojaloop API error received at any time during the transfer process
properties:
httpStatusCode:
type: integer
description: The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response.
mojaloopError:
$ref: '#/components/schemas/mojaloopError'
accountsResponse:
type: object
required:
- accounts
properties:
modelId:
$ref: '#/components/schemas/CorrelationId'
accounts:
$ref: '#/components/schemas/accountsRequest'
response:
$ref: '#/components/schemas/accountCreationStatus'
currentState:
$ref: '#/components/schemas/accountsCreationState'
lastError:
$ref: '#/components/schemas/transferError'
postAccountsResponse:
type: object
required:
- body
properties:
body:
type: object
headers:
type: object
errorAccountsResponse:
allOf:
- $ref: '#/components/schemas/errorResponse'
- type: object
required:
- executionState
properties:
executionState:
$ref: '#/components/schemas/accountsResponse'
TransactionInitiatorType:
title: TransactionInitiatorType
type: string
enum:
- CONSUMER
- AGENT
- BUSINESS
- DEVICE
description: |-
Below are the allowed values for the enumeration.
- CONSUMER - Consumer is the initiator of the transaction.
- AGENT - Agent is the initiator of the transaction.
- BUSINESS - Business is the initiator of the transaction.
- DEVICE - Device is the initiator of the transaction.
example: CONSUMER
Name:
title: Name
type: string
pattern: ^(?!\s*$)[\w .,'-]{1,128}$
description: |-
The API data type Name is a JSON String, restricted by a regular expression to avoid characters which are generally not used in a name.
Regular Expression - The regular expression for restricting the Name type is "^(?!\s*$)[\w .,'-]{1,128}$". The restriction does not allow a string consisting of whitespace only, all Unicode characters are allowed, as well as the period (.) (apostrophe (‘), dash (-), comma (,) and space characters ( ).
**Note:** In some programming languages, Unicode support must be specifically enabled. For example, if Java is used, the flag UNICODE_CHARACTER_CLASS must be enabled to allow Unicode characters.
FirstName:
title: FirstName
type: string
minLength: 1
maxLength: 128
pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
description: First name of the Party (Name Type).
example: Henrik
MiddleName:
title: MiddleName
type: string
minLength: 1
maxLength: 128
pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
description: Middle name of the Party (Name Type).
example: Johannes
LastName:
title: LastName
type: string
minLength: 1
maxLength: 128
pattern: ^(?!\s*$)[\p{L}\p{gc=Mark}\p{digit}\p{gc=Connector_Punctuation}\p{Join_Control} .,''-]{1,128}$
description: Last name of the Party (Name Type).
example: Karlsson
DateOfBirth:
title: DateofBirth (type Date)
type: string
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)$
description: Date of Birth of the Party.
example: '1966-06-16'
MerchantClassificationCode:
title: MerchantClassificationCode
type: string
pattern: ^[\d]{1,4}$
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.
FspId:
title: FspId
type: string
minLength: 1
maxLength: 32
description: FSP identifier.
KYCInformation:
title: KYCInformation
type: string
minLength: 1
maxLength: 2048
description: KYC information for the party in a form mandated by an individual scheme.
example: |-
{
"metadata": {
"format": "JSON",
"version": "1.0",
"description": "Data containing KYC Information"
},
"data": {
"name": "John Doe",
"dob": "1980-05-15",
"gender": "Male",
"address": "123 Main Street, Anytown, USA",
"email": "[email protected]",
"phone": "+1 555-123-4567",
"nationality": "US",
"passport_number": "AB1234567",
"issue_date": "2010-02-20",
"expiry_date": "2025-02-20",