@mojaloop/api-snippets 13.0.11 → 14.0.0-snapshot.1

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.
@@ -13,9 +13,9 @@ info:
13
13
  name: >-
14
14
  Open API for FSP Interoperability (FSPIOP) (Implementation Friendly
15
15
  Version)
16
- url: 'https://github.com/mojaloop/mojaloop-specification/blob/develop/LICENSE.md'
16
+ url: https://github.com/mojaloop/mojaloop-specification/blob/develop/LICENSE.md
17
17
  servers:
18
- - url: 'protocol://hostname:<port>/switch/'
18
+ - url: protocol://hostname:<port>/switch/
19
19
  variables:
20
20
  protocol:
21
21
  enum:
@@ -90,7 +90,7 @@ paths:
90
90
  responses:
91
91
  '200':
92
92
  description: Ok
93
- '/participants/{Type}/{ID}':
93
+ /participants/{Type}/{ID}:
94
94
  parameters:
95
95
  - $ref: '#/components/parameters/Type'
96
96
  - $ref: '#/components/parameters/ID'
@@ -258,7 +258,7 @@ paths:
258
258
  $ref: '#/components/responses/501'
259
259
  '503':
260
260
  $ref: '#/components/responses/503'
261
- '/participants/{Type}/{ID}/error':
261
+ /participants/{Type}/{ID}/error:
262
262
  put:
263
263
  description: >-
264
264
  If the server is unable to find, create or delete the associated FSP of
@@ -308,7 +308,7 @@ paths:
308
308
  $ref: '#/components/responses/501'
309
309
  '503':
310
310
  $ref: '#/components/responses/503'
311
- '/participants/{Type}/{ID}/{SubId}':
311
+ /participants/{Type}/{ID}/{SubId}:
312
312
  parameters:
313
313
  - $ref: '#/components/parameters/Type'
314
314
  - $ref: '#/components/parameters/ID'
@@ -477,7 +477,7 @@ paths:
477
477
  $ref: '#/components/responses/501'
478
478
  '503':
479
479
  $ref: '#/components/responses/503'
480
- '/participants/{Type}/{ID}/{SubId}/error':
480
+ /participants/{Type}/{ID}/{SubId}/error:
481
481
  put:
482
482
  description: >-
483
483
  If the server is unable to find, create or delete the associated FSP of
@@ -578,7 +578,7 @@ paths:
578
578
  $ref: '#/components/responses/501'
579
579
  '503':
580
580
  $ref: '#/components/responses/503'
581
- '/participants/{ID}':
581
+ /participants/{ID}:
582
582
  put:
583
583
  description: >-
584
584
  The callback `PUT /participants/{ID}` is used to inform the client of
@@ -625,7 +625,7 @@ paths:
625
625
  $ref: '#/components/responses/501'
626
626
  '503':
627
627
  $ref: '#/components/responses/503'
628
- '/participants/{ID}/error':
628
+ /participants/{ID}/error:
629
629
  put:
630
630
  description: >-
631
631
  If there is an error during FSP information creation in the server, the
@@ -674,7 +674,7 @@ paths:
674
674
  $ref: '#/components/responses/501'
675
675
  '503':
676
676
  $ref: '#/components/responses/503'
677
- '/parties/{Type}/{ID}':
677
+ /parties/{Type}/{ID}:
678
678
  parameters:
679
679
  - $ref: '#/components/parameters/Type'
680
680
  - $ref: '#/components/parameters/ID'
@@ -756,7 +756,7 @@ paths:
756
756
  $ref: '#/components/responses/501'
757
757
  '503':
758
758
  $ref: '#/components/responses/503'
759
- '/parties/{Type}/{ID}/error':
759
+ /parties/{Type}/{ID}/error:
760
760
  put:
761
761
  description: >-
762
762
  If the server is unable to find Party information of the provided
@@ -806,7 +806,7 @@ paths:
806
806
  $ref: '#/components/responses/501'
807
807
  '503':
808
808
  $ref: '#/components/responses/503'
809
- '/parties/{Type}/{ID}/{SubId}':
809
+ /parties/{Type}/{ID}/{SubId}:
810
810
  parameters:
811
811
  - $ref: '#/components/parameters/Type'
812
812
  - $ref: '#/components/parameters/ID'
@@ -889,7 +889,7 @@ paths:
889
889
  $ref: '#/components/responses/501'
890
890
  '503':
891
891
  $ref: '#/components/responses/503'
892
- '/parties/{Type}/{ID}/{SubId}/error':
892
+ /parties/{Type}/{ID}/{SubId}/error:
893
893
  put:
894
894
  description: >-
895
895
  If the server is unable to find Party information of the provided
@@ -988,7 +988,7 @@ paths:
988
988
  $ref: '#/components/responses/501'
989
989
  '503':
990
990
  $ref: '#/components/responses/503'
991
- '/transactionRequests/{ID}':
991
+ /transactionRequests/{ID}:
992
992
  parameters:
993
993
  - $ref: '#/components/parameters/ID'
994
994
  - $ref: '#/components/parameters/Content-Type'
@@ -1070,7 +1070,7 @@ paths:
1070
1070
  $ref: '#/components/responses/501'
1071
1071
  '503':
1072
1072
  $ref: '#/components/responses/503'
1073
- '/transactionRequests/{ID}/error':
1073
+ /transactionRequests/{ID}/error:
1074
1074
  put:
1075
1075
  description: >-
1076
1076
  If the server is unable to find or create a transaction request, or
@@ -1168,7 +1168,7 @@ paths:
1168
1168
  $ref: '#/components/responses/501'
1169
1169
  '503':
1170
1170
  $ref: '#/components/responses/503'
1171
- '/quotes/{ID}':
1171
+ /quotes/{ID}:
1172
1172
  parameters:
1173
1173
  - $ref: '#/components/parameters/ID'
1174
1174
  - $ref: '#/components/parameters/Content-Type'
@@ -1248,7 +1248,7 @@ paths:
1248
1248
  $ref: '#/components/responses/501'
1249
1249
  '503':
1250
1250
  $ref: '#/components/responses/503'
1251
- '/quotes/{ID}/error':
1251
+ /quotes/{ID}/error:
1252
1252
  put:
1253
1253
  description: >-
1254
1254
  If the server is unable to find or create a quote, or some other
@@ -1298,7 +1298,7 @@ paths:
1298
1298
  $ref: '#/components/responses/501'
1299
1299
  '503':
1300
1300
  $ref: '#/components/responses/503'
1301
- '/authorizations/{ID}':
1301
+ /authorizations/{ID}:
1302
1302
  parameters:
1303
1303
  - $ref: '#/components/parameters/ID'
1304
1304
  - $ref: '#/components/parameters/Content-Type'
@@ -1411,7 +1411,7 @@ paths:
1411
1411
  $ref: '#/components/responses/501'
1412
1412
  '503':
1413
1413
  $ref: '#/components/responses/503'
1414
- '/authorizations/{ID}/error':
1414
+ /authorizations/{ID}/error:
1415
1415
  put:
1416
1416
  description: >-
1417
1417
  If the server is unable to find the transaction request, or another
@@ -1508,7 +1508,7 @@ paths:
1508
1508
  $ref: '#/components/responses/501'
1509
1509
  '503':
1510
1510
  $ref: '#/components/responses/503'
1511
- '/transfers/{ID}':
1511
+ /transfers/{ID}:
1512
1512
  parameters:
1513
1513
  - $ref: '#/components/parameters/ID'
1514
1514
  - $ref: '#/components/parameters/Content-Type'
@@ -1589,7 +1589,7 @@ paths:
1589
1589
  $ref: '#/components/responses/501'
1590
1590
  '503':
1591
1591
  $ref: '#/components/responses/503'
1592
- '/transfers/{ID}/error':
1592
+ /transfers/{ID}/error:
1593
1593
  put:
1594
1594
  description: >-
1595
1595
  If the server is unable to find or create a transfer, or another
@@ -1639,7 +1639,7 @@ paths:
1639
1639
  $ref: '#/components/responses/501'
1640
1640
  '503':
1641
1641
  $ref: '#/components/responses/503'
1642
- '/transactions/{ID}':
1642
+ /transactions/{ID}:
1643
1643
  parameters:
1644
1644
  - $ref: '#/components/parameters/ID'
1645
1645
  - $ref: '#/components/parameters/Content-Type'
@@ -1720,7 +1720,7 @@ paths:
1720
1720
  $ref: '#/components/responses/501'
1721
1721
  '503':
1722
1722
  $ref: '#/components/responses/503'
1723
- '/transactions/{ID}/error':
1723
+ /transactions/{ID}/error:
1724
1724
  put:
1725
1725
  description: >-
1726
1726
  If the server is unable to find or create a transaction, or another
@@ -1816,7 +1816,7 @@ paths:
1816
1816
  $ref: '#/components/responses/501'
1817
1817
  '503':
1818
1818
  $ref: '#/components/responses/503'
1819
- '/bulkQuotes/{ID}':
1819
+ /bulkQuotes/{ID}:
1820
1820
  parameters:
1821
1821
  - $ref: '#/components/parameters/ID'
1822
1822
  - $ref: '#/components/parameters/Content-Type'
@@ -1897,7 +1897,7 @@ paths:
1897
1897
  $ref: '#/components/responses/501'
1898
1898
  '503':
1899
1899
  $ref: '#/components/responses/503'
1900
- '/bulkQuotes/{ID}/error':
1900
+ /bulkQuotes/{ID}/error:
1901
1901
  put:
1902
1902
  description: >-
1903
1903
  If the server is unable to find or create a bulk quote, or another
@@ -1994,7 +1994,7 @@ paths:
1994
1994
  $ref: '#/components/responses/501'
1995
1995
  '503':
1996
1996
  $ref: '#/components/responses/503'
1997
- '/bulkTransfers/{ID}':
1997
+ /bulkTransfers/{ID}:
1998
1998
  parameters:
1999
1999
  - $ref: '#/components/parameters/ID'
2000
2000
  - $ref: '#/components/parameters/Content-Type'
@@ -2076,7 +2076,7 @@ paths:
2076
2076
  $ref: '#/components/responses/501'
2077
2077
  '503':
2078
2078
  $ref: '#/components/responses/503'
2079
- '/bulkTransfers/{ID}/error':
2079
+ /bulkTransfers/{ID}/error:
2080
2080
  put:
2081
2081
  description: >-
2082
2082
  If the server is unable to find or create a bulk transfer, or another
@@ -2132,7 +2132,7 @@ components:
2132
2132
  Amount:
2133
2133
  title: Amount
2134
2134
  type: string
2135
- pattern: '^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$'
2135
+ pattern: ^([0]|([1-9][0-9]{0,17}))([.][0-9]{0,3}[1-9])?$
2136
2136
  description: >-
2137
2137
  The API data type Amount is a JSON String in a canonical format that is
2138
2138
  restricted by a regular expression for interoperability reasons. This
@@ -2183,7 +2183,7 @@ components:
2183
2183
  OtpValue:
2184
2184
  title: OtpValue
2185
2185
  type: string
2186
- pattern: '^\d{3,10}$'
2186
+ pattern: ^\d{3,10}$
2187
2187
  description: >-
2188
2188
  The API data type OtpValue is a JSON String of 3 to 10 characters,
2189
2189
  consisting of digits only. Negative numbers are not allowed. One or more
@@ -2199,7 +2199,7 @@ components:
2199
2199
  oneOf:
2200
2200
  - $ref: '#/components/schemas/OtpValue'
2201
2201
  - $ref: '#/components/schemas/QRCODE'
2202
- pattern: '^\d{3,10}$|^\S{1,64}$'
2202
+ pattern: ^\d{3,10}$|^\S{1,64}$
2203
2203
  description: >-
2204
2204
  Contains the authentication value. The format depends on the
2205
2205
  authentication type used in the AuthenticationInfo complex type.
@@ -2218,7 +2218,7 @@ components:
2218
2218
  BalanceOfPayments:
2219
2219
  title: BalanceOfPayments
2220
2220
  type: string
2221
- pattern: '^[1-9]\d{2}$'
2221
+ pattern: ^[1-9]\d{2}$
2222
2222
  description: >-
2223
2223
  (BopCode) The API data type
2224
2224
  [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String
@@ -2226,7 +2226,7 @@ components:
2226
2226
  allowed. A leading zero is not allowed.
2227
2227
  BinaryString:
2228
2228
  type: string
2229
- pattern: '^[A-Za-z0-9-_]+[=]{0,2}$'
2229
+ pattern: ^[A-Za-z0-9-_]+[=]{0,2}$
2230
2230
  description: >-
2231
2231
  The API data type BinaryString is a JSON String. The string is a
2232
2232
  base64url encoding of a string of raw bytes, where padding (character
@@ -2235,7 +2235,7 @@ components:
2235
2235
  allowed number of characters.
2236
2236
  BinaryString32:
2237
2237
  type: string
2238
- pattern: '^[A-Za-z0-9-_]{43}$'
2238
+ pattern: ^[A-Za-z0-9-_]{43}$
2239
2239
  description: >-
2240
2240
  The API data type BinaryString32 is a fixed size version of the API data
2241
2241
  type BinaryString, where the raw underlying data is always of 32 bytes.
@@ -2269,7 +2269,7 @@ components:
2269
2269
  Code:
2270
2270
  title: Code
2271
2271
  type: string
2272
- pattern: '^[0-9a-zA-Z]{4,32}$'
2272
+ pattern: ^[0-9a-zA-Z]{4,32}$
2273
2273
  description: Any code/token returned by the Payee FSP (TokenCode Type).
2274
2274
  CorrelationId:
2275
2275
  title: CorrelationId
@@ -2492,7 +2492,7 @@ components:
2492
2492
  ErrorCode:
2493
2493
  title: ErrorCode
2494
2494
  type: string
2495
- pattern: '^[1-9]\d{3}$'
2495
+ pattern: ^[1-9]\d{3}$
2496
2496
  description: >-
2497
2497
  The API data type ErrorCode is a JSON String of four characters,
2498
2498
  consisting of digits only. Negative numbers are not allowed. A leading
@@ -2537,19 +2537,19 @@ components:
2537
2537
  IlpCondition:
2538
2538
  title: IlpCondition
2539
2539
  type: string
2540
- pattern: '^[A-Za-z0-9-_]{43}$'
2540
+ pattern: ^[A-Za-z0-9-_]{43}$
2541
2541
  maxLength: 48
2542
2542
  description: Condition that must be attached to the transfer by the Payer.
2543
2543
  IlpFulfilment:
2544
2544
  title: IlpFulfilment
2545
2545
  type: string
2546
- pattern: '^[A-Za-z0-9-_]{43}$'
2546
+ pattern: ^[A-Za-z0-9-_]{43}$
2547
2547
  maxLength: 48
2548
2548
  description: Fulfilment that must be attached to the transfer by the Payee.
2549
2549
  IlpPacket:
2550
2550
  title: IlpPacket
2551
2551
  type: string
2552
- pattern: '^[A-Za-z0-9-_]+[=]{0,2}$'
2552
+ pattern: ^[A-Za-z0-9-_]+[=]{0,2}$
2553
2553
  minLength: 1
2554
2554
  maxLength: 32768
2555
2555
  description: Information for recipient (transport layer information).
@@ -2601,7 +2601,7 @@ components:
2601
2601
  properties:
2602
2602
  complexName:
2603
2603
  $ref: '#/components/schemas/PartyComplexName'
2604
- description: 'First, middle and last name for the Party.'
2604
+ description: First, middle and last name for the Party.
2605
2605
  dateOfBirth:
2606
2606
  type: string
2607
2607
  description: Date of birth for the Party.
@@ -2613,7 +2613,7 @@ components:
2613
2613
  properties:
2614
2614
  partyIdInfo:
2615
2615
  $ref: '#/components/schemas/PartyIdInfo'
2616
- description: 'Party Id type, id, sub ID or type, and FSP Id.'
2616
+ description: Party Id type, id, sub ID or type, and FSP Id.
2617
2617
  merchantClassificationCode:
2618
2618
  type: string
2619
2619
  description: >-
@@ -2622,7 +2622,7 @@ components:
2622
2622
  example: 4321
2623
2623
  name:
2624
2624
  type: string
2625
- description: 'Display name of the Party, could be a real name or a nick name.'
2625
+ description: Display name of the Party, could be a real name or a nick name.
2626
2626
  example: Henrik Karlsson
2627
2627
  personalInfo:
2628
2628
  $ref: '#/components/schemas/PartyPersonalInfo'
@@ -2655,11 +2655,11 @@ components:
2655
2655
  properties:
2656
2656
  scenario:
2657
2657
  type: string
2658
- description: 'Deposit, withdrawal, refund, …'
2658
+ description: Deposit, withdrawal, refund, …
2659
2659
  example: DEPOSIT
2660
2660
  subScenario:
2661
2661
  type: string
2662
- description: 'Possible sub-scenario, defined locally within the scheme.'
2662
+ description: Possible sub-scenario, defined locally within the scheme.
2663
2663
  example: Locally defined sub-scenario.
2664
2664
  initiator:
2665
2665
  type: string
@@ -2667,7 +2667,7 @@ components:
2667
2667
  example: PAYEE
2668
2668
  initiatorType:
2669
2669
  type: string
2670
- description: 'Consumer, agent, business, …'
2670
+ description: Consumer, agent, business, …
2671
2671
  example: CONSUMER
2672
2672
  refundInfo:
2673
2673
  $ref: '#/components/schemas/Refund'
@@ -2730,7 +2730,7 @@ components:
2730
2730
  description: Information about the Payee in the proposed financial transaction.
2731
2731
  amountType:
2732
2732
  type: string
2733
- description: 'SEND for sendAmount, RECEIVE for receiveAmount.'
2733
+ description: SEND for sendAmount, RECEIVE for receiveAmount.
2734
2734
  example: RECEIVE
2735
2735
  amount:
2736
2736
  properties:
@@ -2761,7 +2761,7 @@ components:
2761
2761
  example: Note sent to Payee.
2762
2762
  extensionList:
2763
2763
  $ref: '#/components/schemas/ExtensionList'
2764
- description: 'Optional extension, specific to deployment.'
2764
+ description: Optional extension, specific to deployment.
2765
2765
  required:
2766
2766
  - quoteId
2767
2767
  - transactionId
@@ -2772,7 +2772,7 @@ components:
2772
2772
  Integer:
2773
2773
  title: Integer
2774
2774
  type: string
2775
- pattern: '^[1-9]\d*$'
2775
+ pattern: ^[1-9]\d*$
2776
2776
  description: >-
2777
2777
  The API data type Integer is a JSON String consisting of digits only.
2778
2778
  Negative numbers and leading zeroes are not allowed. The data type is
@@ -2805,7 +2805,7 @@ components:
2805
2805
  MerchantClassificationCode:
2806
2806
  title: MerchantClassificationCode
2807
2807
  type: string
2808
- pattern: '^[\d]{1,4}$'
2808
+ pattern: ^[\d]{1,4}$
2809
2809
  description: >-
2810
2810
  A limited set of pre-defined numbers. This list would be a limited set
2811
2811
  of numbers identifying a set of popular merchant types like School Fees,
@@ -2822,7 +2822,7 @@ components:
2822
2822
  Name:
2823
2823
  title: Name
2824
2824
  type: string
2825
- pattern: '^(?!\s*$)[\w .,''-]{1,128}$'
2825
+ pattern: ^(?!\s*$)[\w .,'-]{1,128}$
2826
2826
  description: >-
2827
2827
  The API data type Name is a JSON String, restricted by a regular
2828
2828
  expression to avoid characters which are generally not used in a name.
@@ -2986,7 +2986,7 @@ components:
2986
2986
  TokenCode:
2987
2987
  title: TokenCode
2988
2988
  type: string
2989
- pattern: '^[0-9a-zA-Z]{4,32}$'
2989
+ pattern: ^[0-9a-zA-Z]{4,32}$
2990
2990
  description: >-
2991
2991
  The API data type TokenCode is a JSON String between 4 and 32
2992
2992
  characters, consisting of digits or upper- or lowercase characters from
@@ -3040,10 +3040,10 @@ components:
3040
3040
  description: Type of the transaction.
3041
3041
  note:
3042
3042
  type: string
3043
- description: 'Memo associated to the transaction, intended to the Payee.'
3043
+ description: Memo associated to the transaction, intended to the Payee.
3044
3044
  extensionList:
3045
3045
  $ref: '#/components/schemas/ExtensionList'
3046
- description: 'Optional extension, specific to deployment.'
3046
+ description: Optional extension, specific to deployment.
3047
3047
  required:
3048
3048
  - transactionId
3049
3049
  - quoteId
@@ -3145,7 +3145,7 @@ components:
3145
3145
  TransactionSubScenario:
3146
3146
  title: TransactionSubScenario
3147
3147
  type: string
3148
- pattern: '^[A-Z_]{1,32}$'
3148
+ pattern: ^[A-Z_]{1,32}$
3149
3149
  description: >-
3150
3150
  Possible sub-scenario, defined locally within the scheme (UndefinedEnum
3151
3151
  Type).
@@ -3171,7 +3171,7 @@ components:
3171
3171
  UndefinedEnum:
3172
3172
  title: UndefinedEnum
3173
3173
  type: string
3174
- pattern: '^[A-Z_]{1,32}$'
3174
+ pattern: ^[A-Z_]{1,32}$
3175
3175
  description: >-
3176
3176
  The API data type UndefinedEnum is a JSON String consisting of 1 to 32
3177
3177
  uppercase characters including an underscore character (_).
@@ -3275,7 +3275,7 @@ components:
3275
3275
  properties:
3276
3276
  partyId:
3277
3277
  $ref: '#/components/schemas/PartyIdInfo'
3278
- description: 'Party Id type, id, sub ID or type, and FSP Id.'
3278
+ description: Party Id type, id, sub ID or type, and FSP Id.
3279
3279
  errorInformation:
3280
3280
  $ref: '#/components/schemas/ErrorInformation'
3281
3281
  description: >-
@@ -3287,7 +3287,7 @@ components:
3287
3287
  ParticipantsIDPutResponse:
3288
3288
  title: ParticipantsIDPutResponse
3289
3289
  type: object
3290
- description: 'The object sent in the PUT /participants/{ID} callback.'
3290
+ description: The object sent in the PUT /participants/{ID} callback.
3291
3291
  properties:
3292
3292
  partyList:
3293
3293
  type: array
@@ -3309,7 +3309,7 @@ components:
3309
3309
  PartiesTypeIDPutResponse:
3310
3310
  title: PartiesTypeIDPutResponse
3311
3311
  type: object
3312
- description: 'The object sent in the PUT /parties/{Type}/{ID} callback.'
3312
+ description: The object sent in the PUT /parties/{Type}/{ID} callback.
3313
3313
  properties:
3314
3314
  party:
3315
3315
  $ref: '#/components/schemas/Party'
@@ -3363,7 +3363,7 @@ components:
3363
3363
  description: Type of transaction.
3364
3364
  note:
3365
3365
  type: string
3366
- description: 'Reason for the transaction request, intended to the Payer.'
3366
+ description: Reason for the transaction request, intended to the Payer.
3367
3367
  example: Free-text memo.
3368
3368
  geoCode:
3369
3369
  $ref: '#/components/schemas/GeoCode'
@@ -3372,7 +3372,7 @@ components:
3372
3372
  detect fraud.
3373
3373
  authenticationType:
3374
3374
  type: string
3375
- description: 'OTP or QR Code, otherwise empty.'
3375
+ description: OTP or QR Code, otherwise empty.
3376
3376
  example: OTP
3377
3377
  expiration:
3378
3378
  type: string
@@ -3383,7 +3383,7 @@ components:
3383
3383
  example: '2016-05-24T08:38:08.699-04:00'
3384
3384
  extensionList:
3385
3385
  $ref: '#/components/schemas/ExtensionList'
3386
- description: 'Optional extension, specific to deployment.'
3386
+ description: Optional extension, specific to deployment.
3387
3387
  required:
3388
3388
  - transactionRequestId
3389
3389
  - payee
@@ -3393,7 +3393,7 @@ components:
3393
3393
  TransactionRequestsIDPutResponse:
3394
3394
  title: TransactionRequestsIDPutResponse
3395
3395
  type: object
3396
- description: 'The object sent in the PUT /transactionRequests/{ID} callback.'
3396
+ description: The object sent in the PUT /transactionRequests/{ID} callback.
3397
3397
  properties:
3398
3398
  transactionId:
3399
3399
  type: string
@@ -3407,7 +3407,7 @@ components:
3407
3407
  example: RECEIVED
3408
3408
  extensionList:
3409
3409
  $ref: '#/components/schemas/ExtensionList'
3410
- description: 'Optional extension, specific to deployment.'
3410
+ description: Optional extension, specific to deployment.
3411
3411
  required:
3412
3412
  - transactionRequestState
3413
3413
  QuotesPostRequest:
@@ -3473,7 +3473,7 @@ components:
3473
3473
  example: 1234
3474
3474
  name:
3475
3475
  type: string
3476
- description: 'Display name of the Party, could be a real name or a nick name.'
3476
+ description: Display name of the Party, could be a real name or a nick name.
3477
3477
  example: Lars Bergqvist
3478
3478
  personalInfo:
3479
3479
  properties:
@@ -3497,7 +3497,7 @@ components:
3497
3497
  example: '1977-07-17'
3498
3498
  amountType:
3499
3499
  type: string
3500
- description: 'SEND for send amount, RECEIVE for receive amount.'
3500
+ description: SEND for send amount, RECEIVE for receive amount.
3501
3501
  example: SEND
3502
3502
  amount:
3503
3503
  properties:
@@ -3541,7 +3541,7 @@ components:
3541
3541
  example: '2016-05-24T08:38:08.699-04:00'
3542
3542
  extensionList:
3543
3543
  $ref: '#/components/schemas/ExtensionList'
3544
- description: 'Optional extension, specific to deployment.'
3544
+ description: Optional extension, specific to deployment.
3545
3545
  required:
3546
3546
  - quoteId
3547
3547
  - transactionId
@@ -3553,7 +3553,7 @@ components:
3553
3553
  QuotesIDPutResponse:
3554
3554
  title: QuotesIDPutResponse
3555
3555
  type: object
3556
- description: 'The object sent in the PUT /quotes/{ID} callback.'
3556
+ description: The object sent in the PUT /quotes/{ID} callback.
3557
3557
  properties:
3558
3558
  transferAmount:
3559
3559
  properties:
@@ -3615,7 +3615,7 @@ components:
3615
3615
  example: f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA
3616
3616
  extensionList:
3617
3617
  $ref: '#/components/schemas/ExtensionList'
3618
- description: 'Optional extension, specific to deployment.'
3618
+ description: Optional extension, specific to deployment.
3619
3619
  required:
3620
3620
  - transferAmount
3621
3621
  - expiration
@@ -3624,11 +3624,11 @@ components:
3624
3624
  AuthorizationsIDPutResponse:
3625
3625
  title: AuthorizationsIDPutResponse
3626
3626
  type: object
3627
- description: 'The object sent in the PUT /authorizations/{ID} callback.'
3627
+ description: The object sent in the PUT /authorizations/{ID} callback.
3628
3628
  properties:
3629
3629
  authenticationInfo:
3630
3630
  type: string
3631
- description: 'OTP or QR Code if entered, otherwise empty.'
3631
+ description: OTP or QR Code if entered, otherwise empty.
3632
3632
  example: OTP
3633
3633
  responseType:
3634
3634
  type: string
@@ -3683,7 +3683,7 @@ components:
3683
3683
  example: '2016-05-24T08:38:08.699-04:00'
3684
3684
  extensionList:
3685
3685
  $ref: '#/components/schemas/ExtensionList'
3686
- description: 'Optional extension, specific to deployment.'
3686
+ description: Optional extension, specific to deployment.
3687
3687
  required:
3688
3688
  - transferId
3689
3689
  - payeeFsp
@@ -3695,7 +3695,7 @@ components:
3695
3695
  TransfersIDPutResponse:
3696
3696
  title: TransfersIDPutResponse
3697
3697
  type: object
3698
- description: 'The object sent in the PUT /transfers/{ID} callback.'
3698
+ description: The object sent in the PUT /transfers/{ID} callback.
3699
3699
  properties:
3700
3700
  fulfilment:
3701
3701
  type: string
@@ -3713,13 +3713,13 @@ components:
3713
3713
  example: RESERVED
3714
3714
  extensionList:
3715
3715
  $ref: '#/components/schemas/ExtensionList'
3716
- description: 'Optional extension, specific to deployment.'
3716
+ description: Optional extension, specific to deployment.
3717
3717
  required:
3718
3718
  - transferState
3719
3719
  TransactionsIDPutResponse:
3720
3720
  title: TransactionsIDPutResponse
3721
3721
  type: object
3722
- description: 'The object sent in the PUT /transactions/{ID} callback.'
3722
+ description: The object sent in the PUT /transactions/{ID} callback.
3723
3723
  properties:
3724
3724
  completedTimestamp:
3725
3725
  type: string
@@ -3737,7 +3737,7 @@ components:
3737
3737
  example: Test-Code
3738
3738
  extensionList:
3739
3739
  $ref: '#/components/schemas/ExtensionList'
3740
- description: 'Optional extension, specific to deployment.'
3740
+ description: Optional extension, specific to deployment.
3741
3741
  required:
3742
3742
  - transactionState
3743
3743
  BulkQuotesPostRequest:
@@ -3756,7 +3756,7 @@ components:
3756
3756
  properties:
3757
3757
  partyIdInfo:
3758
3758
  $ref: '#/components/schemas/PartyIdInfo'
3759
- description: 'Party Id type, id, sub ID or type, and FSP Id.'
3759
+ description: Party Id type, id, sub ID or type, and FSP Id.
3760
3760
  merchantClassificationCode:
3761
3761
  type: string
3762
3762
  description: >-
@@ -3765,7 +3765,7 @@ components:
3765
3765
  example: 1234
3766
3766
  name:
3767
3767
  type: string
3768
- description: 'Display name of the Party, could be a real name or a nick name.'
3768
+ description: Display name of the Party, could be a real name or a nick name.
3769
3769
  example: Henrik Karlsson
3770
3770
  personalInfo:
3771
3771
  $ref: '#/components/schemas/PartyPersonalInfo'
@@ -3797,7 +3797,7 @@ components:
3797
3797
  properties:
3798
3798
  partyIdInfo:
3799
3799
  $ref: '#/components/schemas/PartyIdInfo'
3800
- description: 'Party Id type, id, sub ID or type, and FSP Id.'
3800
+ description: Party Id type, id, sub ID or type, and FSP Id.
3801
3801
  merchantClassificationCode:
3802
3802
  type: string
3803
3803
  description: >-
@@ -3817,7 +3817,7 @@ components:
3817
3817
  as first, middle, last name and date of birth.
3818
3818
  amountType:
3819
3819
  type: string
3820
- description: 'SEND for sendAmount, RECEIVE for receiveAmount.'
3820
+ description: SEND for sendAmount, RECEIVE for receiveAmount.
3821
3821
  example: RECEIVE
3822
3822
  amount:
3823
3823
  properties:
@@ -3848,7 +3848,7 @@ components:
3848
3848
  example: Note sent to Payee.
3849
3849
  extensionList:
3850
3850
  $ref: '#/components/schemas/ExtensionList'
3851
- description: 'Optional extension, specific to deployment.'
3851
+ description: Optional extension, specific to deployment.
3852
3852
  required:
3853
3853
  - bulkQuoteId
3854
3854
  - payer
@@ -3922,13 +3922,13 @@ components:
3922
3922
  should not be set if errorInformation is set.
3923
3923
  extensionList:
3924
3924
  $ref: '#/components/schemas/ExtensionList'
3925
- description: 'Optional extension, specific to deployment.'
3925
+ description: Optional extension, specific to deployment.
3926
3926
  required:
3927
3927
  - quoteId
3928
3928
  BulkQuotesIDPutResponse:
3929
3929
  title: BulkQuotesIDPutResponse
3930
3930
  type: object
3931
- description: 'The object sent in the PUT /bulkQuotes/{ID} callback.'
3931
+ description: The object sent in the PUT /bulkQuotes/{ID} callback.
3932
3932
  properties:
3933
3933
  individualQuoteResults:
3934
3934
  type: array
@@ -3946,7 +3946,7 @@ components:
3946
3946
  example: '2016-05-24T08:38:08.699-04:00'
3947
3947
  extensionList:
3948
3948
  $ref: '#/components/schemas/ExtensionList'
3949
- description: 'Optional extension, specific to deployment.'
3949
+ description: Optional extension, specific to deployment.
3950
3950
  required:
3951
3951
  - expiration
3952
3952
  IndividualTransfer:
@@ -3974,7 +3974,7 @@ components:
3974
3974
  example: f5sqb7tBTWPd5Y8BDFdMm9BJR_MNI4isf8p8n4D5pHA
3975
3975
  extensionList:
3976
3976
  $ref: '#/components/schemas/ExtensionList'
3977
- description: 'Optional extension, specific to deployment.'
3977
+ description: Optional extension, specific to deployment.
3978
3978
  required:
3979
3979
  - transferId
3980
3980
  - transferAmount
@@ -4018,7 +4018,7 @@ components:
4018
4018
  example: '2016-05-24T08:38:08.699-04:00'
4019
4019
  extensionList:
4020
4020
  $ref: '#/components/schemas/ExtensionList'
4021
- description: 'Optional extension, specific to deployment.'
4021
+ description: Optional extension, specific to deployment.
4022
4022
  required:
4023
4023
  - bulkTransferId
4024
4024
  - bulkQuoteId
@@ -4050,13 +4050,13 @@ components:
4050
4050
  both.
4051
4051
  extensionList:
4052
4052
  $ref: '#/components/schemas/ExtensionList'
4053
- description: 'Optional extension, specific to deployment.'
4053
+ description: Optional extension, specific to deployment.
4054
4054
  required:
4055
4055
  - transferId
4056
4056
  BulkTransfersIDPutResponse:
4057
4057
  title: BulkTransfersIDPutResponse
4058
4058
  type: object
4059
- description: 'The object sent in the PUT /bulkTransfers/{ID} callback.'
4059
+ description: The object sent in the PUT /bulkTransfers/{ID} callback.
4060
4060
  properties:
4061
4061
  completedTimestamp:
4062
4062
  type: string
@@ -4074,7 +4074,7 @@ components:
4074
4074
  example: RECEIVED
4075
4075
  extensionList:
4076
4076
  $ref: '#/components/schemas/ExtensionList'
4077
- description: 'Optional extension, specific to deployment.'
4077
+ description: Optional extension, specific to deployment.
4078
4078
  required:
4079
4079
  - bulkTransferState
4080
4080
  parameters:
@@ -4084,7 +4084,7 @@ components:
4084
4084
  required: true
4085
4085
  schema:
4086
4086
  type: string
4087
- description: 'The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`.'
4087
+ description: The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`.
4088
4088
  ID:
4089
4089
  name: ID
4090
4090
  in: path