@mojaloop/api-snippets 17.0.2-snapshot.0 → 17.0.2-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.
@@ -67,51 +67,6 @@ export interface components {
67
67
  * @example 1966-06-16
68
68
  */
69
69
  DateOfBirth: string;
70
- /**
71
- * Extension
72
- * @description Data model for the complex type Extension
73
- */
74
- Extension: {
75
- /**
76
- * ExtensionKey
77
- * @description Extension key.
78
- */
79
- key: string;
80
- /**
81
- * ExtensionValue
82
- * @description Extension value.
83
- */
84
- value: string;
85
- };
86
- /**
87
- * ExtensionKey
88
- * @description Extension key.
89
- */
90
- ExtensionKey: string;
91
- /**
92
- * ExtensionList
93
- * @description Data model for the complex type ExtensionList
94
- */
95
- ExtensionList: {
96
- /** @description Number of Extension elements */
97
- extension: {
98
- /**
99
- * ExtensionKey
100
- * @description Extension key.
101
- */
102
- key: string;
103
- /**
104
- * ExtensionValue
105
- * @description Extension value.
106
- */
107
- value: string;
108
- }[];
109
- };
110
- /**
111
- * ExtensionValue
112
- * @description Extension value.
113
- */
114
- ExtensionValue: string;
115
70
  /**
116
71
  * FirstName
117
72
  * @description First name of the Party (Name Type).
@@ -299,492 +254,111 @@ export interface components {
299
254
  * @example Johannes
300
255
  */
301
256
  MiddleName: string;
302
- /**
303
- * Party
304
- * @description Data model for the complex type Party.
305
- */
306
- Party: {
307
- /**
308
- * MerchantClassificationCode
309
- * @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.
310
- */
311
- merchantClassificationCode?: string;
312
- /**
313
- * PartyName
314
- * @description Name of the Party. Could be a real name or a nickname.
315
- */
316
- name?: string;
317
- /**
318
- * PartyIdInfo
319
- * @description Data model for the complex type PartyIdInfo.
320
- */
321
- partyIdInfo: {
322
- /**
323
- * ExtensionList
324
- * @description Data model for the complex type ExtensionList
325
- */
257
+ /** @description Object containing Amount and Currency of the transfer. */
258
+ amountCurrency: {
259
+ amount: string;
260
+ /** @enum {string} */
261
+ currency: "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";
262
+ };
263
+ /** @enum {string} */
264
+ amountType: "SEND" | "RECEIVE";
265
+ /** @description A Mojaloop API bulk quote identifier (UUID). */
266
+ bulkQuoteId: string;
267
+ /** @description A request for a bulk quote. */
268
+ bulkQuoteRequest: {
269
+ /** @description A Mojaloop API bulk quote identifier (UUID). */
270
+ bulkQuoteId: string;
271
+ /** @description An ISO-8601 formatted timestamp. */
272
+ expiration?: string;
273
+ from: {
274
+ /** @description Date of birth in the form YYYY-MM-DD. */
275
+ dateOfBirth?: string;
276
+ /** @description Display name of the sender, if known. */
277
+ displayName?: string;
326
278
  extensionList?: {
327
- /** @description Number of Extension elements */
328
- extension: {
329
- /**
330
- * ExtensionKey
331
- * @description Extension key.
332
- */
333
- key: string;
334
- /**
335
- * ExtensionValue
336
- * @description Extension value.
337
- */
338
- value: string;
339
- }[];
340
- };
341
- /**
342
- * FspId
343
- * @description FSP identifier.
344
- */
279
+ key?: string;
280
+ value?: string;
281
+ }[];
282
+ /** @description Party first name. */
283
+ firstName?: string;
284
+ /** @description Mojaloop scheme FSPID of the DFSP which owns the party account. */
345
285
  fspId?: string;
346
- /**
347
- * PartyIdType
348
- * @description This is a variant based on FSPIOP `PartyIdType` specification.
349
- * Main difference being the CONSENT and THIRD_PARTY_LINK enums.
350
- *
351
- * Below are the allowed values for the enumeration.
352
- * - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
353
- * Number, that is, the phone number) is used as reference to a participant.
354
- * The MSISDN identifier should be in international format according to the
355
- * [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en).
356
- * Optionally, the MSISDN may be prefixed by a single plus sign, indicating the
357
- * international prefix.
358
- * - EMAIL - An email is used as reference to a
359
- * participant. The format of the email should be according to the informational
360
- * [RFC 3696](https://tools.ietf.org/html/rfc3696).
361
- * - PERSONAL_ID - A personal identifier is used as reference to a participant.
362
- * Examples of personal identification are passport number, birth certificate
363
- * number, and national registration number. The identifier number is added in
364
- * the PartyIdentifier element. The personal identifier type is added in the
365
- * PartySubIdOrType element.
366
- * - BUSINESS - A specific Business (for example, an organization or a company)
367
- * is used as reference to a participant. The BUSINESS identifier can be in any
368
- * format. To make a transaction connected to a specific username or bill number
369
- * in a Business, the PartySubIdOrType element should be used.
370
- * - DEVICE - A specific device (for example, a POS or ATM) ID connected to a
371
- * specific business or organization is used as reference to a Party.
372
- * For referencing a specific device under a specific business or organization,
373
- * use the PartySubIdOrType element.
374
- * - ACCOUNT_ID - A bank account number or FSP account ID should be used as
375
- * reference to a participant. The ACCOUNT_ID identifier can be in any format,
376
- * as formats can greatly differ depending on country and FSP.
377
- * - IBAN - A bank account number or FSP account ID is used as reference to a
378
- * participant. The IBAN identifier can consist of up to 34 alphanumeric
379
- * characters and should be entered without whitespace.
380
- * - ALIAS An alias is used as reference to a participant. The alias should be
381
- * created in the FSP as an alternative reference to an account owner.
382
- * Another example of an alias is a username in the FSP system.
383
- * The ALIAS identifier can be in any format. It is also possible to use the
384
- * PartySubIdOrType element for identifying an account under an Alias defined
385
- * by the PartyIdentifier.
386
- * - CONSENT - TBD
387
- * - THIRD_PARTY_LINK - TBD
388
- *
389
- * @example PERSONAL_ID
390
- * @enum {string}
391
- */
392
- partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS" | "CONSENT" | "THIRD_PARTY_LINK";
393
- /**
394
- * PartyIdentifier
395
- * @description Identifier of the Party.
396
- * @example 16135551212
397
- */
398
- partyIdentifier: string;
399
- /**
400
- * PartySubIdOrType
401
- * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
402
- */
403
- partySubIdOrType?: string;
286
+ idSubValue?: string;
287
+ /** @enum {string} */
288
+ idType: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
289
+ /** @description The identifier string used to identify the sender. */
290
+ idValue: string;
291
+ /** @description Party last name. */
292
+ lastName?: string;
293
+ /** @description Up to 4 digits specifying the sender's merchant classification, if known and applicable. */
294
+ merchantClassificationCode?: string;
295
+ /** @description Party middle name. */
296
+ middleName?: string;
297
+ /** @enum {string} */
298
+ type?: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
404
299
  };
405
- /**
406
- * PartyPersonalInfo
407
- * @description Data model for the complex type PartyPersonalInfo.
408
- */
409
- personalInfo?: {
300
+ /** @description Indicates the geographic location from where the transaction was initiated. */
301
+ geoCode?: {
302
+ /** @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. */
303
+ latitude: string;
304
+ /** @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. */
305
+ longitude: string;
306
+ };
307
+ individualQuotes: {
308
+ amount: string;
309
+ /** @enum {string} */
310
+ amountType: "SEND" | "RECEIVE";
311
+ /** @enum {string} */
312
+ currency: "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";
313
+ feesAmount?: string;
314
+ /** @enum {string} */
315
+ feesCurrency?: "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";
316
+ /** @enum {string} */
317
+ initiator: "PAYER" | "PAYEE";
318
+ /** @enum {string} */
319
+ initiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
320
+ /** @description An optional note associated with the quote. */
321
+ note?: string;
322
+ /** @description A Mojaloop API quote identifier (UUID). */
323
+ quoteId: string;
410
324
  /**
411
- * PartyComplexName
412
- * @description Data model for the complex type PartyComplexName.
325
+ * transactionSubScenario
326
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
327
+ * @example LOCALLY_DEFINED_SUBSCENARIO
413
328
  */
414
- complexName?: {
415
- /** @description Display name of the sender if known */
329
+ subScenario?: string;
330
+ to: {
331
+ /** @description Date of birth in the form YYYY-MM-DD. */
332
+ dateOfBirth?: string;
333
+ /** @description Display name of the sender, if known. */
416
334
  displayName?: string;
417
- /**
418
- * FirstName
419
- * @description First name of the Party (Name Type).
420
- * @example Henrik
421
- */
335
+ extensionList?: {
336
+ key?: string;
337
+ value?: string;
338
+ }[];
339
+ /** @description Party first name. */
422
340
  firstName?: string;
423
- /** @description The sub identifier string used to identify the sender */
341
+ /** @description Mojaloop scheme FSPID of the DFSP which owns the party account. */
342
+ fspId?: string;
424
343
  idSubValue?: string;
425
344
  /** @enum {string} */
426
- idType?: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
427
- /** @description The identifier string used to identify the sender */
428
- idValue?: string;
429
- /**
430
- * LastName
431
- * @description Last name of the Party (Name Type).
432
- * @example Karlsson
433
- */
345
+ idType: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
346
+ /** @description The identifier string used to identify the sender. */
347
+ idValue: string;
348
+ /** @description Party last name. */
434
349
  lastName?: string;
435
- /**
436
- * MiddleName
437
- * @description Middle name of the Party (Name Type).
438
- * @example Johannes
439
- */
350
+ /** @description Up to 4 digits specifying the sender's merchant classification, if known and applicable. */
351
+ merchantClassificationCode?: string;
352
+ /** @description Party middle name. */
440
353
  middleName?: string;
441
354
  /** @enum {string} */
442
355
  type?: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
443
356
  };
444
- /**
445
- * DateofBirth (type Date)
446
- * @description Date of Birth of the Party.
447
- * @example 1966-06-16
448
- */
449
- dateOfBirth?: string;
450
- };
451
- };
452
- /**
453
- * PartyComplexName
454
- * @description Data model for the complex type PartyComplexName.
455
- */
456
- PartyComplexName: {
457
- /** @description Display name of the sender if known */
458
- displayName?: string;
459
- /**
460
- * FirstName
461
- * @description First name of the Party (Name Type).
462
- * @example Henrik
463
- */
464
- firstName?: string;
465
- /** @description The sub identifier string used to identify the sender */
466
- idSubValue?: string;
467
- /** @enum {string} */
468
- idType?: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
469
- /** @description The identifier string used to identify the sender */
470
- idValue?: string;
471
- /**
472
- * LastName
473
- * @description Last name of the Party (Name Type).
474
- * @example Karlsson
475
- */
476
- lastName?: string;
477
- /**
478
- * MiddleName
479
- * @description Middle name of the Party (Name Type).
480
- * @example Johannes
481
- */
482
- middleName?: string;
483
- /** @enum {string} */
484
- type?: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
485
- };
486
- /**
487
- * PartyIdInfo
488
- * @description Data model for the complex type PartyIdInfo.
489
- */
490
- PartyIdInfo: {
491
- /**
492
- * ExtensionList
493
- * @description Data model for the complex type ExtensionList
494
- */
495
- extensionList?: {
496
- /** @description Number of Extension elements */
497
- extension: {
498
- /**
499
- * ExtensionKey
500
- * @description Extension key.
501
- */
502
- key: string;
503
- /**
504
- * ExtensionValue
505
- * @description Extension value.
506
- */
507
- value: string;
508
- }[];
509
- };
510
- /**
511
- * FspId
512
- * @description FSP identifier.
513
- */
514
- fspId?: string;
515
- /**
516
- * PartyIdType
517
- * @description This is a variant based on FSPIOP `PartyIdType` specification.
518
- * Main difference being the CONSENT and THIRD_PARTY_LINK enums.
519
- *
520
- * Below are the allowed values for the enumeration.
521
- * - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
522
- * Number, that is, the phone number) is used as reference to a participant.
523
- * The MSISDN identifier should be in international format according to the
524
- * [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en).
525
- * Optionally, the MSISDN may be prefixed by a single plus sign, indicating the
526
- * international prefix.
527
- * - EMAIL - An email is used as reference to a
528
- * participant. The format of the email should be according to the informational
529
- * [RFC 3696](https://tools.ietf.org/html/rfc3696).
530
- * - PERSONAL_ID - A personal identifier is used as reference to a participant.
531
- * Examples of personal identification are passport number, birth certificate
532
- * number, and national registration number. The identifier number is added in
533
- * the PartyIdentifier element. The personal identifier type is added in the
534
- * PartySubIdOrType element.
535
- * - BUSINESS - A specific Business (for example, an organization or a company)
536
- * is used as reference to a participant. The BUSINESS identifier can be in any
537
- * format. To make a transaction connected to a specific username or bill number
538
- * in a Business, the PartySubIdOrType element should be used.
539
- * - DEVICE - A specific device (for example, a POS or ATM) ID connected to a
540
- * specific business or organization is used as reference to a Party.
541
- * For referencing a specific device under a specific business or organization,
542
- * use the PartySubIdOrType element.
543
- * - ACCOUNT_ID - A bank account number or FSP account ID should be used as
544
- * reference to a participant. The ACCOUNT_ID identifier can be in any format,
545
- * as formats can greatly differ depending on country and FSP.
546
- * - IBAN - A bank account number or FSP account ID is used as reference to a
547
- * participant. The IBAN identifier can consist of up to 34 alphanumeric
548
- * characters and should be entered without whitespace.
549
- * - ALIAS An alias is used as reference to a participant. The alias should be
550
- * created in the FSP as an alternative reference to an account owner.
551
- * Another example of an alias is a username in the FSP system.
552
- * The ALIAS identifier can be in any format. It is also possible to use the
553
- * PartySubIdOrType element for identifying an account under an Alias defined
554
- * by the PartyIdentifier.
555
- * - CONSENT - TBD
556
- * - THIRD_PARTY_LINK - TBD
557
- *
558
- * @example PERSONAL_ID
559
- * @enum {string}
560
- */
561
- partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS" | "CONSENT" | "THIRD_PARTY_LINK";
562
- /**
563
- * PartyIdentifier
564
- * @description Identifier of the Party.
565
- * @example 16135551212
566
- */
567
- partyIdentifier: string;
568
- /**
569
- * PartySubIdOrType
570
- * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
571
- */
572
- partySubIdOrType?: string;
573
- };
574
- /**
575
- * PartyIdType
576
- * @description This is a variant based on FSPIOP `PartyIdType` specification.
577
- * Main difference being the CONSENT and THIRD_PARTY_LINK enums.
578
- *
579
- * Below are the allowed values for the enumeration.
580
- * - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
581
- * Number, that is, the phone number) is used as reference to a participant.
582
- * The MSISDN identifier should be in international format according to the
583
- * [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en).
584
- * Optionally, the MSISDN may be prefixed by a single plus sign, indicating the
585
- * international prefix.
586
- * - EMAIL - An email is used as reference to a
587
- * participant. The format of the email should be according to the informational
588
- * [RFC 3696](https://tools.ietf.org/html/rfc3696).
589
- * - PERSONAL_ID - A personal identifier is used as reference to a participant.
590
- * Examples of personal identification are passport number, birth certificate
591
- * number, and national registration number. The identifier number is added in
592
- * the PartyIdentifier element. The personal identifier type is added in the
593
- * PartySubIdOrType element.
594
- * - BUSINESS - A specific Business (for example, an organization or a company)
595
- * is used as reference to a participant. The BUSINESS identifier can be in any
596
- * format. To make a transaction connected to a specific username or bill number
597
- * in a Business, the PartySubIdOrType element should be used.
598
- * - DEVICE - A specific device (for example, a POS or ATM) ID connected to a
599
- * specific business or organization is used as reference to a Party.
600
- * For referencing a specific device under a specific business or organization,
601
- * use the PartySubIdOrType element.
602
- * - ACCOUNT_ID - A bank account number or FSP account ID should be used as
603
- * reference to a participant. The ACCOUNT_ID identifier can be in any format,
604
- * as formats can greatly differ depending on country and FSP.
605
- * - IBAN - A bank account number or FSP account ID is used as reference to a
606
- * participant. The IBAN identifier can consist of up to 34 alphanumeric
607
- * characters and should be entered without whitespace.
608
- * - ALIAS An alias is used as reference to a participant. The alias should be
609
- * created in the FSP as an alternative reference to an account owner.
610
- * Another example of an alias is a username in the FSP system.
611
- * The ALIAS identifier can be in any format. It is also possible to use the
612
- * PartySubIdOrType element for identifying an account under an Alias defined
613
- * by the PartyIdentifier.
614
- * - CONSENT - TBD
615
- * - THIRD_PARTY_LINK - TBD
616
- *
617
- * @example PERSONAL_ID
618
- * @enum {string}
619
- */
620
- PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS" | "CONSENT" | "THIRD_PARTY_LINK";
621
- /**
622
- * PartyIdentifier
623
- * @description Identifier of the Party.
624
- * @example 16135551212
625
- */
626
- PartyIdentifier: string;
627
- /**
628
- * PartyName
629
- * @description Name of the Party. Could be a real name or a nickname.
630
- */
631
- PartyName: string;
632
- /**
633
- * PartyPersonalInfo
634
- * @description Data model for the complex type PartyPersonalInfo.
635
- */
636
- PartyPersonalInfo: {
637
- /**
638
- * PartyComplexName
639
- * @description Data model for the complex type PartyComplexName.
640
- */
641
- complexName?: {
642
- /** @description Display name of the sender if known */
643
- displayName?: string;
644
- /**
645
- * FirstName
646
- * @description First name of the Party (Name Type).
647
- * @example Henrik
648
- */
649
- firstName?: string;
650
- /** @description The sub identifier string used to identify the sender */
651
- idSubValue?: string;
652
- /** @enum {string} */
653
- idType?: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
654
- /** @description The identifier string used to identify the sender */
655
- idValue?: string;
656
- /**
657
- * LastName
658
- * @description Last name of the Party (Name Type).
659
- * @example Karlsson
660
- */
661
- lastName?: string;
662
- /**
663
- * MiddleName
664
- * @description Middle name of the Party (Name Type).
665
- * @example Johannes
666
- */
667
- middleName?: string;
668
- /** @enum {string} */
669
- type?: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
670
- };
671
- /**
672
- * DateofBirth (type Date)
673
- * @description Date of Birth of the Party.
674
- * @example 1966-06-16
675
- */
676
- dateOfBirth?: string;
677
- };
678
- /**
679
- * PartySubIdOrType
680
- * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
681
- */
682
- PartySubIdOrType: string;
683
- /** @description Object containing Amount and Currency of the transfer. */
684
- amountCurrency: {
685
- amount: string;
686
- /** @enum {string} */
687
- currency: "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";
688
- };
689
- /** @enum {string} */
690
- amountType: "SEND" | "RECEIVE";
691
- /** @description A Mojaloop API bulk quote identifier (UUID). */
692
- bulkQuoteId: string;
693
- /** @description A request for a bulk quote. */
694
- bulkQuoteRequest: {
695
- /** @description A Mojaloop API bulk quote identifier (UUID). */
696
- bulkQuoteId: string;
697
- /** @description An ISO-8601 formatted timestamp. */
698
- expiration?: string;
699
- from: {
700
- /** @description Date of birth in the form YYYY-MM-DD. */
701
- dateOfBirth?: string;
702
- /** @description Display name of the sender, if known. */
703
- displayName?: string;
704
- extensionList?: {
705
- key?: string;
706
- value?: string;
707
- }[];
708
- /** @description Party first name. */
709
- firstName?: string;
710
- /** @description Mojaloop scheme FSPID of the DFSP which owns the party account. */
711
- fspId?: string;
712
- idSubValue?: string;
713
- /** @enum {string} */
714
- idType: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
715
- /** @description The identifier string used to identify the sender. */
716
- idValue: string;
717
- /** @description Party last name. */
718
- lastName?: string;
719
- /** @description Up to 4 digits specifying the sender's merchant classification, if known and applicable. */
720
- merchantClassificationCode?: string;
721
- /** @description Party middle name. */
722
- middleName?: string;
723
- /** @enum {string} */
724
- type?: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
725
- };
726
- /** @description Indicates the geographic location from where the transaction was initiated. */
727
- geoCode?: {
728
- /** @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. */
729
- latitude: string;
730
- /** @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. */
731
- longitude: string;
732
- };
733
- individualQuotes: {
734
- amount: string;
735
- /** @enum {string} */
736
- amountType: "SEND" | "RECEIVE";
737
- /** @enum {string} */
738
- currency: "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";
739
- feesAmount?: string;
740
- /** @enum {string} */
741
- feesCurrency?: "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";
742
- /** @enum {string} */
743
- initiator: "PAYER" | "PAYEE";
744
- /** @enum {string} */
745
- initiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
746
- /** @description An optional note associated with the quote. */
747
- note?: string;
748
- /** @description A Mojaloop API quote identifier (UUID). */
749
- quoteId: string;
750
- /**
751
- * transactionSubScenario
752
- * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
753
- * @example LOCALLY_DEFINED_SUBSCENARIO
754
- */
755
- subScenario?: string;
756
- to: {
757
- /** @description Date of birth in the form YYYY-MM-DD. */
758
- dateOfBirth?: string;
759
- /** @description Display name of the sender, if known. */
760
- displayName?: string;
761
- extensionList?: {
762
- key?: string;
763
- value?: string;
764
- }[];
765
- /** @description Party first name. */
766
- firstName?: string;
767
- /** @description Mojaloop scheme FSPID of the DFSP which owns the party account. */
768
- fspId?: string;
769
- idSubValue?: string;
770
- /** @enum {string} */
771
- idType: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
772
- /** @description The identifier string used to identify the sender. */
773
- idValue: string;
774
- /** @description Party last name. */
775
- lastName?: string;
776
- /** @description Up to 4 digits specifying the sender's merchant classification, if known and applicable. */
777
- merchantClassificationCode?: string;
778
- /** @description Party middle name. */
779
- middleName?: string;
780
- /** @enum {string} */
781
- type?: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
782
- };
783
- /** @description ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote. */
784
- transactionId: string;
785
- /** @enum {string} */
786
- transactionType: "TRANSFER" | "DEPOSIT" | "PAYMENT";
787
- }[];
357
+ /** @description ID of the transaction, the ID is decided by the Payer FSP during the creation of the quote. */
358
+ transactionId: string;
359
+ /** @enum {string} */
360
+ transactionType: "TRANSFER" | "DEPOSIT" | "PAYMENT";
361
+ }[];
788
362
  };
789
363
  /** @description A response to a request for a bulk quote. */
790
364
  bulkQuoteResponse: {
@@ -1070,7 +644,7 @@ export interface components {
1070
644
  };
1071
645
  /** @description An ISO-8601 formatted timestamp. */
1072
646
  initiatedTimestamp?: string;
1073
- /** @description This object represents a Mojaloop API error received at any time during the transfer process. */
647
+ /** @description This object represents a Mojaloop API error received at any time during the transfer process */
1074
648
  lastError?: {
1075
649
  /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
1076
650
  httpStatusCode?: number;
@@ -1078,12 +652,13 @@ export interface components {
1078
652
  mojaloopError?: {
1079
653
  /**
1080
654
  * ErrorInformation
1081
- * @description A Mojaloop API error information construct.
655
+ * @description Data model for the complex type ErrorInformation.
1082
656
  */
1083
657
  errorInformation?: {
1084
658
  /**
1085
659
  * ErrorCode
1086
- * @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) represents the specific error.
660
+ * @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.
661
+ * @example 5100
1087
662
  */
1088
663
  errorCode: string;
1089
664
  /**
@@ -1091,12 +666,23 @@ export interface components {
1091
666
  * @description Error description string.
1092
667
  */
1093
668
  errorDescription: string;
1094
- /** @description Data model for the complex type ExtensionList. */
669
+ /**
670
+ * ExtensionList
671
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
672
+ */
1095
673
  extensionList?: {
1096
674
  /** @description Number of Extension elements. */
1097
675
  extension: {
1098
- key?: string;
1099
- value?: string;
676
+ /**
677
+ * ExtensionKey
678
+ * @description Extension key.
679
+ */
680
+ key: string;
681
+ /**
682
+ * ExtensionValue
683
+ * @description Extension value.
684
+ */
685
+ value: string;
1100
686
  }[];
1101
687
  };
1102
688
  };
@@ -1160,12 +746,6 @@ export interface components {
1160
746
  idType: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
1161
747
  /** @description Identifier of the party. */
1162
748
  idValue: string;
1163
- /**
1164
- * ilpFulfilment
1165
- * @description Fulfilment that must be attached to the transfer by the Payee.
1166
- * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
1167
- */
1168
- ilpFulfilment: string;
1169
749
  /** @description Object containing transfer object. */
1170
750
  ilpPacketData: {
1171
751
  /** @description Object containing Amount and Currency of the transfer. */
@@ -1179,27 +759,47 @@ export interface components {
1179
759
  * @description Data model for the complex type Party.
1180
760
  */
1181
761
  payee: {
1182
- /**
1183
- * MerchantClassificationCode
1184
- * @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.
1185
- */
1186
- merchantClassificationCode?: string;
1187
- /**
1188
- * PartyName
1189
- * @description Name of the Party. Could be a real name or a nickname.
1190
- */
1191
- name?: string;
1192
762
  /**
1193
763
  * PartyIdInfo
1194
- * @description Data model for the complex type PartyIdInfo.
764
+ * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
1195
765
  */
1196
766
  partyIdInfo: {
767
+ /**
768
+ * PartyIdType
769
+ * @description Below are the allowed values for the enumeration.
770
+ * - 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.
771
+ * - 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).
772
+ * - 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.
773
+ * - 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.
774
+ * - 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.
775
+ * - 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.
776
+ * - 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.
777
+ * - 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.
778
+ * @enum {string}
779
+ */
780
+ partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
781
+ /**
782
+ * PartyIdentifier
783
+ * @description Identifier of the Party.
784
+ * @example 16135551212
785
+ */
786
+ partyIdentifier: string;
787
+ /**
788
+ * PartySubIdOrType
789
+ * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
790
+ */
791
+ partySubIdOrType?: string;
792
+ /**
793
+ * FspId
794
+ * @description FSP identifier.
795
+ */
796
+ fspId?: string;
1197
797
  /**
1198
798
  * ExtensionList
1199
- * @description Data model for the complex type ExtensionList
799
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
1200
800
  */
1201
801
  extensionList?: {
1202
- /** @description Number of Extension elements */
802
+ /** @description Number of Extension elements. */
1203
803
  extension: {
1204
804
  /**
1205
805
  * ExtensionKey
@@ -1213,70 +813,17 @@ export interface components {
1213
813
  value: string;
1214
814
  }[];
1215
815
  };
1216
- /**
1217
- * FspId
1218
- * @description FSP identifier.
1219
- */
1220
- fspId?: string;
1221
- /**
1222
- * PartyIdType
1223
- * @description This is a variant based on FSPIOP `PartyIdType` specification.
1224
- * Main difference being the CONSENT and THIRD_PARTY_LINK enums.
1225
- *
1226
- * Below are the allowed values for the enumeration.
1227
- * - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
1228
- * Number, that is, the phone number) is used as reference to a participant.
1229
- * The MSISDN identifier should be in international format according to the
1230
- * [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en).
1231
- * Optionally, the MSISDN may be prefixed by a single plus sign, indicating the
1232
- * international prefix.
1233
- * - EMAIL - An email is used as reference to a
1234
- * participant. The format of the email should be according to the informational
1235
- * [RFC 3696](https://tools.ietf.org/html/rfc3696).
1236
- * - PERSONAL_ID - A personal identifier is used as reference to a participant.
1237
- * Examples of personal identification are passport number, birth certificate
1238
- * number, and national registration number. The identifier number is added in
1239
- * the PartyIdentifier element. The personal identifier type is added in the
1240
- * PartySubIdOrType element.
1241
- * - BUSINESS - A specific Business (for example, an organization or a company)
1242
- * is used as reference to a participant. The BUSINESS identifier can be in any
1243
- * format. To make a transaction connected to a specific username or bill number
1244
- * in a Business, the PartySubIdOrType element should be used.
1245
- * - DEVICE - A specific device (for example, a POS or ATM) ID connected to a
1246
- * specific business or organization is used as reference to a Party.
1247
- * For referencing a specific device under a specific business or organization,
1248
- * use the PartySubIdOrType element.
1249
- * - ACCOUNT_ID - A bank account number or FSP account ID should be used as
1250
- * reference to a participant. The ACCOUNT_ID identifier can be in any format,
1251
- * as formats can greatly differ depending on country and FSP.
1252
- * - IBAN - A bank account number or FSP account ID is used as reference to a
1253
- * participant. The IBAN identifier can consist of up to 34 alphanumeric
1254
- * characters and should be entered without whitespace.
1255
- * - ALIAS An alias is used as reference to a participant. The alias should be
1256
- * created in the FSP as an alternative reference to an account owner.
1257
- * Another example of an alias is a username in the FSP system.
1258
- * The ALIAS identifier can be in any format. It is also possible to use the
1259
- * PartySubIdOrType element for identifying an account under an Alias defined
1260
- * by the PartyIdentifier.
1261
- * - CONSENT - TBD
1262
- * - THIRD_PARTY_LINK - TBD
1263
- *
1264
- * @example PERSONAL_ID
1265
- * @enum {string}
1266
- */
1267
- partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS" | "CONSENT" | "THIRD_PARTY_LINK";
1268
- /**
1269
- * PartyIdentifier
1270
- * @description Identifier of the Party.
1271
- * @example 16135551212
1272
- */
1273
- partyIdentifier: string;
1274
- /**
1275
- * PartySubIdOrType
1276
- * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
1277
- */
1278
- partySubIdOrType?: string;
1279
816
  };
817
+ /**
818
+ * MerchantClassificationCode
819
+ * @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.
820
+ */
821
+ merchantClassificationCode?: string;
822
+ /**
823
+ * PartyName
824
+ * @description Name of the Party. Could be a real name or a nickname.
825
+ */
826
+ name?: string;
1280
827
  /**
1281
828
  * PartyPersonalInfo
1282
829
  * @description Data model for the complex type PartyPersonalInfo.
@@ -1287,34 +834,24 @@ export interface components {
1287
834
  * @description Data model for the complex type PartyComplexName.
1288
835
  */
1289
836
  complexName?: {
1290
- /** @description Display name of the sender if known */
1291
- displayName?: string;
1292
837
  /**
1293
838
  * FirstName
1294
839
  * @description First name of the Party (Name Type).
1295
840
  * @example Henrik
1296
841
  */
1297
842
  firstName?: string;
1298
- /** @description The sub identifier string used to identify the sender */
1299
- idSubValue?: string;
1300
- /** @enum {string} */
1301
- idType?: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
1302
- /** @description The identifier string used to identify the sender */
1303
- idValue?: string;
1304
- /**
1305
- * LastName
1306
- * @description Last name of the Party (Name Type).
1307
- * @example Karlsson
1308
- */
1309
- lastName?: string;
1310
843
  /**
1311
844
  * MiddleName
1312
845
  * @description Middle name of the Party (Name Type).
1313
846
  * @example Johannes
1314
847
  */
1315
848
  middleName?: string;
1316
- /** @enum {string} */
1317
- type?: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
849
+ /**
850
+ * LastName
851
+ * @description Last name of the Party (Name Type).
852
+ * @example Karlsson
853
+ */
854
+ lastName?: string;
1318
855
  };
1319
856
  /**
1320
857
  * DateofBirth (type Date)
@@ -1329,27 +866,47 @@ export interface components {
1329
866
  * @description Data model for the complex type Party.
1330
867
  */
1331
868
  payer: {
1332
- /**
1333
- * MerchantClassificationCode
1334
- * @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.
1335
- */
1336
- merchantClassificationCode?: string;
1337
- /**
1338
- * PartyName
1339
- * @description Name of the Party. Could be a real name or a nickname.
1340
- */
1341
- name?: string;
1342
869
  /**
1343
870
  * PartyIdInfo
1344
- * @description Data model for the complex type PartyIdInfo.
871
+ * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
1345
872
  */
1346
873
  partyIdInfo: {
874
+ /**
875
+ * PartyIdType
876
+ * @description Below are the allowed values for the enumeration.
877
+ * - 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.
878
+ * - 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).
879
+ * - 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.
880
+ * - 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.
881
+ * - 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.
882
+ * - 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.
883
+ * - 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.
884
+ * - 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.
885
+ * @enum {string}
886
+ */
887
+ partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
888
+ /**
889
+ * PartyIdentifier
890
+ * @description Identifier of the Party.
891
+ * @example 16135551212
892
+ */
893
+ partyIdentifier: string;
894
+ /**
895
+ * PartySubIdOrType
896
+ * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
897
+ */
898
+ partySubIdOrType?: string;
899
+ /**
900
+ * FspId
901
+ * @description FSP identifier.
902
+ */
903
+ fspId?: string;
1347
904
  /**
1348
905
  * ExtensionList
1349
- * @description Data model for the complex type ExtensionList
906
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
1350
907
  */
1351
908
  extensionList?: {
1352
- /** @description Number of Extension elements */
909
+ /** @description Number of Extension elements. */
1353
910
  extension: {
1354
911
  /**
1355
912
  * ExtensionKey
@@ -1363,70 +920,17 @@ export interface components {
1363
920
  value: string;
1364
921
  }[];
1365
922
  };
1366
- /**
1367
- * FspId
1368
- * @description FSP identifier.
1369
- */
1370
- fspId?: string;
1371
- /**
1372
- * PartyIdType
1373
- * @description This is a variant based on FSPIOP `PartyIdType` specification.
1374
- * Main difference being the CONSENT and THIRD_PARTY_LINK enums.
1375
- *
1376
- * Below are the allowed values for the enumeration.
1377
- * - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
1378
- * Number, that is, the phone number) is used as reference to a participant.
1379
- * The MSISDN identifier should be in international format according to the
1380
- * [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en).
1381
- * Optionally, the MSISDN may be prefixed by a single plus sign, indicating the
1382
- * international prefix.
1383
- * - EMAIL - An email is used as reference to a
1384
- * participant. The format of the email should be according to the informational
1385
- * [RFC 3696](https://tools.ietf.org/html/rfc3696).
1386
- * - PERSONAL_ID - A personal identifier is used as reference to a participant.
1387
- * Examples of personal identification are passport number, birth certificate
1388
- * number, and national registration number. The identifier number is added in
1389
- * the PartyIdentifier element. The personal identifier type is added in the
1390
- * PartySubIdOrType element.
1391
- * - BUSINESS - A specific Business (for example, an organization or a company)
1392
- * is used as reference to a participant. The BUSINESS identifier can be in any
1393
- * format. To make a transaction connected to a specific username or bill number
1394
- * in a Business, the PartySubIdOrType element should be used.
1395
- * - DEVICE - A specific device (for example, a POS or ATM) ID connected to a
1396
- * specific business or organization is used as reference to a Party.
1397
- * For referencing a specific device under a specific business or organization,
1398
- * use the PartySubIdOrType element.
1399
- * - ACCOUNT_ID - A bank account number or FSP account ID should be used as
1400
- * reference to a participant. The ACCOUNT_ID identifier can be in any format,
1401
- * as formats can greatly differ depending on country and FSP.
1402
- * - IBAN - A bank account number or FSP account ID is used as reference to a
1403
- * participant. The IBAN identifier can consist of up to 34 alphanumeric
1404
- * characters and should be entered without whitespace.
1405
- * - ALIAS An alias is used as reference to a participant. The alias should be
1406
- * created in the FSP as an alternative reference to an account owner.
1407
- * Another example of an alias is a username in the FSP system.
1408
- * The ALIAS identifier can be in any format. It is also possible to use the
1409
- * PartySubIdOrType element for identifying an account under an Alias defined
1410
- * by the PartyIdentifier.
1411
- * - CONSENT - TBD
1412
- * - THIRD_PARTY_LINK - TBD
1413
- *
1414
- * @example PERSONAL_ID
1415
- * @enum {string}
1416
- */
1417
- partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS" | "CONSENT" | "THIRD_PARTY_LINK";
1418
- /**
1419
- * PartyIdentifier
1420
- * @description Identifier of the Party.
1421
- * @example 16135551212
1422
- */
1423
- partyIdentifier: string;
1424
- /**
1425
- * PartySubIdOrType
1426
- * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
1427
- */
1428
- partySubIdOrType?: string;
1429
923
  };
924
+ /**
925
+ * MerchantClassificationCode
926
+ * @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.
927
+ */
928
+ merchantClassificationCode?: string;
929
+ /**
930
+ * PartyName
931
+ * @description Name of the Party. Could be a real name or a nickname.
932
+ */
933
+ name?: string;
1430
934
  /**
1431
935
  * PartyPersonalInfo
1432
936
  * @description Data model for the complex type PartyPersonalInfo.
@@ -1437,34 +941,24 @@ export interface components {
1437
941
  * @description Data model for the complex type PartyComplexName.
1438
942
  */
1439
943
  complexName?: {
1440
- /** @description Display name of the sender if known */
1441
- displayName?: string;
1442
944
  /**
1443
945
  * FirstName
1444
946
  * @description First name of the Party (Name Type).
1445
947
  * @example Henrik
1446
948
  */
1447
949
  firstName?: string;
1448
- /** @description The sub identifier string used to identify the sender */
1449
- idSubValue?: string;
1450
- /** @enum {string} */
1451
- idType?: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
1452
- /** @description The identifier string used to identify the sender */
1453
- idValue?: string;
1454
- /**
1455
- * LastName
1456
- * @description Last name of the Party (Name Type).
1457
- * @example Karlsson
1458
- */
1459
- lastName?: string;
1460
950
  /**
1461
951
  * MiddleName
1462
952
  * @description Middle name of the Party (Name Type).
1463
953
  * @example Johannes
1464
954
  */
1465
955
  middleName?: string;
1466
- /** @enum {string} */
1467
- type?: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
956
+ /**
957
+ * LastName
958
+ * @description Last name of the Party (Name Type).
959
+ * @example Karlsson
960
+ */
961
+ lastName?: string;
1468
962
  };
1469
963
  /**
1470
964
  * DateofBirth (type Date)
@@ -1505,32 +999,6 @@ export interface components {
1505
999
  latitude: string;
1506
1000
  /** @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. */
1507
1001
  longitude: string;
1508
- mojaloopError: {
1509
- /**
1510
- * ErrorInformation
1511
- * @description A Mojaloop API error information construct.
1512
- */
1513
- errorInformation?: {
1514
- /**
1515
- * ErrorCode
1516
- * @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) represents the specific error.
1517
- */
1518
- errorCode: string;
1519
- /**
1520
- * ErrorDescription
1521
- * @description Error description string.
1522
- */
1523
- errorDescription: string;
1524
- /** @description Data model for the complex type ExtensionList. */
1525
- extensionList?: {
1526
- /** @description Number of Extension elements. */
1527
- extension: {
1528
- key?: string;
1529
- value?: string;
1530
- }[];
1531
- };
1532
- };
1533
- };
1534
1002
  money: string;
1535
1003
  otpDetails: {
1536
1004
  /** @description OTP value. */
@@ -1918,38 +1386,6 @@ export interface components {
1918
1386
  */
1919
1387
  transferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
1920
1388
  };
1921
- /** @description This object represents a Mojaloop API error received at any time during the transfer process. */
1922
- transferError: {
1923
- /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
1924
- httpStatusCode?: number;
1925
- /** @description If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object. */
1926
- mojaloopError?: {
1927
- /**
1928
- * ErrorInformation
1929
- * @description A Mojaloop API error information construct.
1930
- */
1931
- errorInformation?: {
1932
- /**
1933
- * ErrorCode
1934
- * @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) represents the specific error.
1935
- */
1936
- errorCode: string;
1937
- /**
1938
- * ErrorDescription
1939
- * @description Error description string.
1940
- */
1941
- errorDescription: string;
1942
- /** @description Data model for the complex type ExtensionList. */
1943
- extensionList?: {
1944
- /** @description Number of Extension elements. */
1945
- extension: {
1946
- key?: string;
1947
- value?: string;
1948
- }[];
1949
- };
1950
- };
1951
- };
1952
- };
1953
1389
  /** @description A Mojaloop API transfer identifier (UUID). */
1954
1390
  transferId: string;
1955
1391
  transferParty: {
@@ -2026,27 +1462,47 @@ export interface components {
2026
1462
  * @description Data model for the complex type Party.
2027
1463
  */
2028
1464
  payee: {
2029
- /**
2030
- * MerchantClassificationCode
2031
- * @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.
2032
- */
2033
- merchantClassificationCode?: string;
2034
- /**
2035
- * PartyName
2036
- * @description Name of the Party. Could be a real name or a nickname.
2037
- */
2038
- name?: string;
2039
1465
  /**
2040
1466
  * PartyIdInfo
2041
- * @description Data model for the complex type PartyIdInfo.
1467
+ * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
2042
1468
  */
2043
1469
  partyIdInfo: {
1470
+ /**
1471
+ * PartyIdType
1472
+ * @description Below are the allowed values for the enumeration.
1473
+ * - 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.
1474
+ * - 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).
1475
+ * - 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.
1476
+ * - 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.
1477
+ * - 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.
1478
+ * - 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.
1479
+ * - 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.
1480
+ * - 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.
1481
+ * @enum {string}
1482
+ */
1483
+ partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
1484
+ /**
1485
+ * PartyIdentifier
1486
+ * @description Identifier of the Party.
1487
+ * @example 16135551212
1488
+ */
1489
+ partyIdentifier: string;
1490
+ /**
1491
+ * PartySubIdOrType
1492
+ * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
1493
+ */
1494
+ partySubIdOrType?: string;
1495
+ /**
1496
+ * FspId
1497
+ * @description FSP identifier.
1498
+ */
1499
+ fspId?: string;
2044
1500
  /**
2045
1501
  * ExtensionList
2046
- * @description Data model for the complex type ExtensionList
1502
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
2047
1503
  */
2048
1504
  extensionList?: {
2049
- /** @description Number of Extension elements */
1505
+ /** @description Number of Extension elements. */
2050
1506
  extension: {
2051
1507
  /**
2052
1508
  * ExtensionKey
@@ -2060,70 +1516,17 @@ export interface components {
2060
1516
  value: string;
2061
1517
  }[];
2062
1518
  };
2063
- /**
2064
- * FspId
2065
- * @description FSP identifier.
2066
- */
2067
- fspId?: string;
2068
- /**
2069
- * PartyIdType
2070
- * @description This is a variant based on FSPIOP `PartyIdType` specification.
2071
- * Main difference being the CONSENT and THIRD_PARTY_LINK enums.
2072
- *
2073
- * Below are the allowed values for the enumeration.
2074
- * - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
2075
- * Number, that is, the phone number) is used as reference to a participant.
2076
- * The MSISDN identifier should be in international format according to the
2077
- * [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en).
2078
- * Optionally, the MSISDN may be prefixed by a single plus sign, indicating the
2079
- * international prefix.
2080
- * - EMAIL - An email is used as reference to a
2081
- * participant. The format of the email should be according to the informational
2082
- * [RFC 3696](https://tools.ietf.org/html/rfc3696).
2083
- * - PERSONAL_ID - A personal identifier is used as reference to a participant.
2084
- * Examples of personal identification are passport number, birth certificate
2085
- * number, and national registration number. The identifier number is added in
2086
- * the PartyIdentifier element. The personal identifier type is added in the
2087
- * PartySubIdOrType element.
2088
- * - BUSINESS - A specific Business (for example, an organization or a company)
2089
- * is used as reference to a participant. The BUSINESS identifier can be in any
2090
- * format. To make a transaction connected to a specific username or bill number
2091
- * in a Business, the PartySubIdOrType element should be used.
2092
- * - DEVICE - A specific device (for example, a POS or ATM) ID connected to a
2093
- * specific business or organization is used as reference to a Party.
2094
- * For referencing a specific device under a specific business or organization,
2095
- * use the PartySubIdOrType element.
2096
- * - ACCOUNT_ID - A bank account number or FSP account ID should be used as
2097
- * reference to a participant. The ACCOUNT_ID identifier can be in any format,
2098
- * as formats can greatly differ depending on country and FSP.
2099
- * - IBAN - A bank account number or FSP account ID is used as reference to a
2100
- * participant. The IBAN identifier can consist of up to 34 alphanumeric
2101
- * characters and should be entered without whitespace.
2102
- * - ALIAS An alias is used as reference to a participant. The alias should be
2103
- * created in the FSP as an alternative reference to an account owner.
2104
- * Another example of an alias is a username in the FSP system.
2105
- * The ALIAS identifier can be in any format. It is also possible to use the
2106
- * PartySubIdOrType element for identifying an account under an Alias defined
2107
- * by the PartyIdentifier.
2108
- * - CONSENT - TBD
2109
- * - THIRD_PARTY_LINK - TBD
2110
- *
2111
- * @example PERSONAL_ID
2112
- * @enum {string}
2113
- */
2114
- partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS" | "CONSENT" | "THIRD_PARTY_LINK";
2115
- /**
2116
- * PartyIdentifier
2117
- * @description Identifier of the Party.
2118
- * @example 16135551212
2119
- */
2120
- partyIdentifier: string;
2121
- /**
2122
- * PartySubIdOrType
2123
- * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
2124
- */
2125
- partySubIdOrType?: string;
2126
1519
  };
1520
+ /**
1521
+ * MerchantClassificationCode
1522
+ * @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.
1523
+ */
1524
+ merchantClassificationCode?: string;
1525
+ /**
1526
+ * PartyName
1527
+ * @description Name of the Party. Could be a real name or a nickname.
1528
+ */
1529
+ name?: string;
2127
1530
  /**
2128
1531
  * PartyPersonalInfo
2129
1532
  * @description Data model for the complex type PartyPersonalInfo.
@@ -2134,34 +1537,24 @@ export interface components {
2134
1537
  * @description Data model for the complex type PartyComplexName.
2135
1538
  */
2136
1539
  complexName?: {
2137
- /** @description Display name of the sender if known */
2138
- displayName?: string;
2139
1540
  /**
2140
1541
  * FirstName
2141
1542
  * @description First name of the Party (Name Type).
2142
1543
  * @example Henrik
2143
1544
  */
2144
1545
  firstName?: string;
2145
- /** @description The sub identifier string used to identify the sender */
2146
- idSubValue?: string;
2147
- /** @enum {string} */
2148
- idType?: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
2149
- /** @description The identifier string used to identify the sender */
2150
- idValue?: string;
2151
- /**
2152
- * LastName
2153
- * @description Last name of the Party (Name Type).
2154
- * @example Karlsson
2155
- */
2156
- lastName?: string;
2157
1546
  /**
2158
1547
  * MiddleName
2159
1548
  * @description Middle name of the Party (Name Type).
2160
1549
  * @example Johannes
2161
1550
  */
2162
1551
  middleName?: string;
2163
- /** @enum {string} */
2164
- type?: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
1552
+ /**
1553
+ * LastName
1554
+ * @description Last name of the Party (Name Type).
1555
+ * @example Karlsson
1556
+ */
1557
+ lastName?: string;
2165
1558
  };
2166
1559
  /**
2167
1560
  * DateofBirth (type Date)
@@ -2176,27 +1569,47 @@ export interface components {
2176
1569
  * @description Data model for the complex type Party.
2177
1570
  */
2178
1571
  payer: {
2179
- /**
2180
- * MerchantClassificationCode
2181
- * @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.
2182
- */
2183
- merchantClassificationCode?: string;
2184
- /**
2185
- * PartyName
2186
- * @description Name of the Party. Could be a real name or a nickname.
2187
- */
2188
- name?: string;
2189
1572
  /**
2190
1573
  * PartyIdInfo
2191
- * @description Data model for the complex type PartyIdInfo.
1574
+ * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
2192
1575
  */
2193
1576
  partyIdInfo: {
2194
1577
  /**
2195
- * ExtensionList
2196
- * @description Data model for the complex type ExtensionList
1578
+ * PartyIdType
1579
+ * @description Below are the allowed values for the enumeration.
1580
+ * - 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.
1581
+ * - 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).
1582
+ * - 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.
1583
+ * - 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.
1584
+ * - 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.
1585
+ * - 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.
1586
+ * - 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.
1587
+ * - 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.
1588
+ * @enum {string}
2197
1589
  */
2198
- extensionList?: {
2199
- /** @description Number of Extension elements */
1590
+ partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
1591
+ /**
1592
+ * PartyIdentifier
1593
+ * @description Identifier of the Party.
1594
+ * @example 16135551212
1595
+ */
1596
+ partyIdentifier: string;
1597
+ /**
1598
+ * PartySubIdOrType
1599
+ * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
1600
+ */
1601
+ partySubIdOrType?: string;
1602
+ /**
1603
+ * FspId
1604
+ * @description FSP identifier.
1605
+ */
1606
+ fspId?: string;
1607
+ /**
1608
+ * ExtensionList
1609
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
1610
+ */
1611
+ extensionList?: {
1612
+ /** @description Number of Extension elements. */
2200
1613
  extension: {
2201
1614
  /**
2202
1615
  * ExtensionKey
@@ -2210,70 +1623,17 @@ export interface components {
2210
1623
  value: string;
2211
1624
  }[];
2212
1625
  };
2213
- /**
2214
- * FspId
2215
- * @description FSP identifier.
2216
- */
2217
- fspId?: string;
2218
- /**
2219
- * PartyIdType
2220
- * @description This is a variant based on FSPIOP `PartyIdType` specification.
2221
- * Main difference being the CONSENT and THIRD_PARTY_LINK enums.
2222
- *
2223
- * Below are the allowed values for the enumeration.
2224
- * - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
2225
- * Number, that is, the phone number) is used as reference to a participant.
2226
- * The MSISDN identifier should be in international format according to the
2227
- * [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en).
2228
- * Optionally, the MSISDN may be prefixed by a single plus sign, indicating the
2229
- * international prefix.
2230
- * - EMAIL - An email is used as reference to a
2231
- * participant. The format of the email should be according to the informational
2232
- * [RFC 3696](https://tools.ietf.org/html/rfc3696).
2233
- * - PERSONAL_ID - A personal identifier is used as reference to a participant.
2234
- * Examples of personal identification are passport number, birth certificate
2235
- * number, and national registration number. The identifier number is added in
2236
- * the PartyIdentifier element. The personal identifier type is added in the
2237
- * PartySubIdOrType element.
2238
- * - BUSINESS - A specific Business (for example, an organization or a company)
2239
- * is used as reference to a participant. The BUSINESS identifier can be in any
2240
- * format. To make a transaction connected to a specific username or bill number
2241
- * in a Business, the PartySubIdOrType element should be used.
2242
- * - DEVICE - A specific device (for example, a POS or ATM) ID connected to a
2243
- * specific business or organization is used as reference to a Party.
2244
- * For referencing a specific device under a specific business or organization,
2245
- * use the PartySubIdOrType element.
2246
- * - ACCOUNT_ID - A bank account number or FSP account ID should be used as
2247
- * reference to a participant. The ACCOUNT_ID identifier can be in any format,
2248
- * as formats can greatly differ depending on country and FSP.
2249
- * - IBAN - A bank account number or FSP account ID is used as reference to a
2250
- * participant. The IBAN identifier can consist of up to 34 alphanumeric
2251
- * characters and should be entered without whitespace.
2252
- * - ALIAS An alias is used as reference to a participant. The alias should be
2253
- * created in the FSP as an alternative reference to an account owner.
2254
- * Another example of an alias is a username in the FSP system.
2255
- * The ALIAS identifier can be in any format. It is also possible to use the
2256
- * PartySubIdOrType element for identifying an account under an Alias defined
2257
- * by the PartyIdentifier.
2258
- * - CONSENT - TBD
2259
- * - THIRD_PARTY_LINK - TBD
2260
- *
2261
- * @example PERSONAL_ID
2262
- * @enum {string}
2263
- */
2264
- partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS" | "CONSENT" | "THIRD_PARTY_LINK";
2265
- /**
2266
- * PartyIdentifier
2267
- * @description Identifier of the Party.
2268
- * @example 16135551212
2269
- */
2270
- partyIdentifier: string;
2271
- /**
2272
- * PartySubIdOrType
2273
- * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
2274
- */
2275
- partySubIdOrType?: string;
2276
1626
  };
1627
+ /**
1628
+ * MerchantClassificationCode
1629
+ * @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.
1630
+ */
1631
+ merchantClassificationCode?: string;
1632
+ /**
1633
+ * PartyName
1634
+ * @description Name of the Party. Could be a real name or a nickname.
1635
+ */
1636
+ name?: string;
2277
1637
  /**
2278
1638
  * PartyPersonalInfo
2279
1639
  * @description Data model for the complex type PartyPersonalInfo.
@@ -2284,34 +1644,24 @@ export interface components {
2284
1644
  * @description Data model for the complex type PartyComplexName.
2285
1645
  */
2286
1646
  complexName?: {
2287
- /** @description Display name of the sender if known */
2288
- displayName?: string;
2289
1647
  /**
2290
1648
  * FirstName
2291
1649
  * @description First name of the Party (Name Type).
2292
1650
  * @example Henrik
2293
1651
  */
2294
1652
  firstName?: string;
2295
- /** @description The sub identifier string used to identify the sender */
2296
- idSubValue?: string;
2297
- /** @enum {string} */
2298
- idType?: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
2299
- /** @description The identifier string used to identify the sender */
2300
- idValue?: string;
2301
- /**
2302
- * LastName
2303
- * @description Last name of the Party (Name Type).
2304
- * @example Karlsson
2305
- */
2306
- lastName?: string;
2307
1653
  /**
2308
1654
  * MiddleName
2309
1655
  * @description Middle name of the Party (Name Type).
2310
1656
  * @example Johannes
2311
1657
  */
2312
1658
  middleName?: string;
2313
- /** @enum {string} */
2314
- type?: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
1659
+ /**
1660
+ * LastName
1661
+ * @description Last name of the Party (Name Type).
1662
+ * @example Karlsson
1663
+ */
1664
+ lastName?: string;
2315
1665
  };
2316
1666
  /**
2317
1667
  * DateofBirth (type Date)
@@ -2403,69 +1753,1775 @@ export interface components {
2403
1753
  * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type). Based on FSPIOP TransactionSubScenario.
2404
1754
  * @example LOCALLY_DEFINED_SUBSCENARIO
2405
1755
  */
2406
- subScenario?: string;
2407
- to: {
2408
- /** @description Date of birth in the form YYYY-MM-DD. */
2409
- dateOfBirth?: string;
2410
- /** @description Display name of the sender, if known. */
2411
- displayName?: string;
2412
- extensionList?: {
2413
- key?: string;
2414
- value?: string;
1756
+ subScenario?: string;
1757
+ to: {
1758
+ /** @description Date of birth in the form YYYY-MM-DD. */
1759
+ dateOfBirth?: string;
1760
+ /** @description Display name of the sender, if known. */
1761
+ displayName?: string;
1762
+ extensionList?: {
1763
+ key?: string;
1764
+ value?: string;
1765
+ }[];
1766
+ /** @description Party first name. */
1767
+ firstName?: string;
1768
+ /** @description Mojaloop scheme FSPID of the DFSP which owns the party account. */
1769
+ fspId?: string;
1770
+ idSubValue?: string;
1771
+ /** @enum {string} */
1772
+ idType: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
1773
+ /** @description The identifier string used to identify the sender. */
1774
+ idValue: string;
1775
+ /** @description Party last name. */
1776
+ lastName?: string;
1777
+ /** @description Up to 4 digits specifying the sender's merchant classification, if known and applicable. */
1778
+ merchantClassificationCode?: string;
1779
+ /** @description Party middle name. */
1780
+ middleName?: string;
1781
+ /** @enum {string} */
1782
+ type?: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
1783
+ };
1784
+ /** @enum {string} */
1785
+ transactionType: "TRANSFER" | "DEPOSIT" | "PAYMENT";
1786
+ /** @description A Mojaloop API transfer identifier (UUID). */
1787
+ transferId: string;
1788
+ };
1789
+ transferResponse: {
1790
+ /**
1791
+ * @description An ISO-8601 formatted timestamp.
1792
+ * @example 2020-05-19T08:38:08.699-04:00
1793
+ */
1794
+ completedTimestamp?: string;
1795
+ /**
1796
+ * IlpFulfilment
1797
+ * @description Fulfilment that must be attached to the transfer by the Payee.
1798
+ * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
1799
+ */
1800
+ fulfilment?: string;
1801
+ /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
1802
+ homeTransactionId: string;
1803
+ /**
1804
+ * @description 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.
1805
+ *
1806
+ * @example ABORTED
1807
+ * @enum {string}
1808
+ */
1809
+ transferState?: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
1810
+ };
1811
+ /**
1812
+ * @description 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.
1813
+ *
1814
+ * @enum {string}
1815
+ */
1816
+ transferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
1817
+ /** @enum {string} */
1818
+ transferStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED";
1819
+ /**
1820
+ * CorrelationId
1821
+ * @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 (‘-‘).
1822
+ * @example b51ec534-ee48-4575-b6a9-ead2955b8069
1823
+ */
1824
+ CorrelationId: string;
1825
+ /** @enum {string} */
1826
+ bulkTransactionStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED";
1827
+ autoAcceptPartyOption: {
1828
+ /** @enum {boolean} */
1829
+ enabled: false | true;
1830
+ };
1831
+ /**
1832
+ * Currency
1833
+ * @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.
1834
+ * @enum {string}
1835
+ */
1836
+ Currency: "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";
1837
+ /**
1838
+ * Amount
1839
+ * @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.
1840
+ * @example 123.45
1841
+ */
1842
+ Amount: string;
1843
+ bulkPerTransferFeeLimit: {
1844
+ /**
1845
+ * Currency
1846
+ * @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.
1847
+ * @enum {string}
1848
+ */
1849
+ currency: "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";
1850
+ /**
1851
+ * Amount
1852
+ * @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.
1853
+ * @example 123.45
1854
+ */
1855
+ amount: string;
1856
+ };
1857
+ autoAcceptQuote: {
1858
+ /** @enum {boolean} */
1859
+ enabled: true | false;
1860
+ perTransferFeeLimits?: {
1861
+ /**
1862
+ * Currency
1863
+ * @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.
1864
+ * @enum {string}
1865
+ */
1866
+ currency: "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";
1867
+ /**
1868
+ * Amount
1869
+ * @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.
1870
+ * @example 123.45
1871
+ */
1872
+ amount: string;
1873
+ }[];
1874
+ };
1875
+ /**
1876
+ * DateTime
1877
+ * @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).
1878
+ * @example 2016-05-24T08:38:08.699-04:00
1879
+ */
1880
+ DateTime: string;
1881
+ bulkTransactionOptions: {
1882
+ /** @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. */
1883
+ onlyValidateParty?: boolean;
1884
+ autoAcceptParty: {
1885
+ /** @enum {boolean} */
1886
+ enabled: false | true;
1887
+ };
1888
+ /** @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. */
1889
+ autoAcceptQuote: {
1890
+ /** @enum {boolean} */
1891
+ enabled: true | false;
1892
+ perTransferFeeLimits?: {
1893
+ /**
1894
+ * Currency
1895
+ * @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.
1896
+ * @enum {string}
1897
+ */
1898
+ currency: "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";
1899
+ /**
1900
+ * Amount
1901
+ * @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.
1902
+ * @example 123.45
1903
+ */
1904
+ amount: string;
1905
+ }[];
1906
+ };
1907
+ /** @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. */
1908
+ skipPartyLookup?: boolean;
1909
+ /** @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 */
1910
+ synchronous?: boolean;
1911
+ /**
1912
+ * DateTime
1913
+ * @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).
1914
+ * @example 2016-05-24T08:38:08.699-04:00
1915
+ */
1916
+ bulkExpiration: string;
1917
+ };
1918
+ /**
1919
+ * PartyIdType
1920
+ * @description Below are the allowed values for the enumeration.
1921
+ * - 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.
1922
+ * - 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).
1923
+ * - 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.
1924
+ * - 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.
1925
+ * - 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.
1926
+ * - 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.
1927
+ * - 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.
1928
+ * - 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.
1929
+ * @enum {string}
1930
+ */
1931
+ PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
1932
+ /**
1933
+ * PartyIdentifier
1934
+ * @description Identifier of the Party.
1935
+ * @example 16135551212
1936
+ */
1937
+ PartyIdentifier: string;
1938
+ /**
1939
+ * PartySubIdOrType
1940
+ * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
1941
+ */
1942
+ PartySubIdOrType: string;
1943
+ /**
1944
+ * ExtensionKey
1945
+ * @description Extension key.
1946
+ */
1947
+ ExtensionKey: string;
1948
+ /**
1949
+ * ExtensionValue
1950
+ * @description Extension value.
1951
+ */
1952
+ ExtensionValue: string;
1953
+ /**
1954
+ * Extension
1955
+ * @description Data model for the complex type Extension.
1956
+ */
1957
+ Extension: {
1958
+ /**
1959
+ * ExtensionKey
1960
+ * @description Extension key.
1961
+ */
1962
+ key: string;
1963
+ /**
1964
+ * ExtensionValue
1965
+ * @description Extension value.
1966
+ */
1967
+ value: string;
1968
+ };
1969
+ /**
1970
+ * ExtensionList
1971
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
1972
+ */
1973
+ ExtensionList: {
1974
+ /** @description Number of Extension elements. */
1975
+ extension: {
1976
+ /**
1977
+ * ExtensionKey
1978
+ * @description Extension key.
1979
+ */
1980
+ key: string;
1981
+ /**
1982
+ * ExtensionValue
1983
+ * @description Extension value.
1984
+ */
1985
+ value: string;
1986
+ }[];
1987
+ };
1988
+ /**
1989
+ * PartyIdInfo
1990
+ * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
1991
+ */
1992
+ PartyIdInfo: {
1993
+ /**
1994
+ * PartyIdType
1995
+ * @description Below are the allowed values for the enumeration.
1996
+ * - 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.
1997
+ * - 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).
1998
+ * - 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.
1999
+ * - 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.
2000
+ * - 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.
2001
+ * - 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.
2002
+ * - 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.
2003
+ * - 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.
2004
+ * @enum {string}
2005
+ */
2006
+ partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
2007
+ /**
2008
+ * PartyIdentifier
2009
+ * @description Identifier of the Party.
2010
+ * @example 16135551212
2011
+ */
2012
+ partyIdentifier: string;
2013
+ /**
2014
+ * PartySubIdOrType
2015
+ * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
2016
+ */
2017
+ partySubIdOrType?: string;
2018
+ /**
2019
+ * FspId
2020
+ * @description FSP identifier.
2021
+ */
2022
+ fspId?: string;
2023
+ /**
2024
+ * ExtensionList
2025
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
2026
+ */
2027
+ extensionList?: {
2028
+ /** @description Number of Extension elements. */
2029
+ extension: {
2030
+ /**
2031
+ * ExtensionKey
2032
+ * @description Extension key.
2033
+ */
2034
+ key: string;
2035
+ /**
2036
+ * ExtensionValue
2037
+ * @description Extension value.
2038
+ */
2039
+ value: string;
2040
+ }[];
2041
+ };
2042
+ };
2043
+ /**
2044
+ * PartyName
2045
+ * @description Name of the Party. Could be a real name or a nickname.
2046
+ */
2047
+ PartyName: string;
2048
+ /**
2049
+ * PartyComplexName
2050
+ * @description Data model for the complex type PartyComplexName.
2051
+ */
2052
+ PartyComplexName: {
2053
+ /**
2054
+ * FirstName
2055
+ * @description First name of the Party (Name Type).
2056
+ * @example Henrik
2057
+ */
2058
+ firstName?: string;
2059
+ /**
2060
+ * MiddleName
2061
+ * @description Middle name of the Party (Name Type).
2062
+ * @example Johannes
2063
+ */
2064
+ middleName?: string;
2065
+ /**
2066
+ * LastName
2067
+ * @description Last name of the Party (Name Type).
2068
+ * @example Karlsson
2069
+ */
2070
+ lastName?: string;
2071
+ };
2072
+ /**
2073
+ * PartyPersonalInfo
2074
+ * @description Data model for the complex type PartyPersonalInfo.
2075
+ */
2076
+ PartyPersonalInfo: {
2077
+ /**
2078
+ * PartyComplexName
2079
+ * @description Data model for the complex type PartyComplexName.
2080
+ */
2081
+ complexName?: {
2082
+ /**
2083
+ * FirstName
2084
+ * @description First name of the Party (Name Type).
2085
+ * @example Henrik
2086
+ */
2087
+ firstName?: string;
2088
+ /**
2089
+ * MiddleName
2090
+ * @description Middle name of the Party (Name Type).
2091
+ * @example Johannes
2092
+ */
2093
+ middleName?: string;
2094
+ /**
2095
+ * LastName
2096
+ * @description Last name of the Party (Name Type).
2097
+ * @example Karlsson
2098
+ */
2099
+ lastName?: string;
2100
+ };
2101
+ /**
2102
+ * DateofBirth (type Date)
2103
+ * @description Date of Birth of the Party.
2104
+ * @example 1966-06-16
2105
+ */
2106
+ dateOfBirth?: string;
2107
+ };
2108
+ /**
2109
+ * Party
2110
+ * @description Data model for the complex type Party.
2111
+ */
2112
+ Party: {
2113
+ /**
2114
+ * PartyIdInfo
2115
+ * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
2116
+ */
2117
+ partyIdInfo: {
2118
+ /**
2119
+ * PartyIdType
2120
+ * @description Below are the allowed values for the enumeration.
2121
+ * - 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.
2122
+ * - 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).
2123
+ * - 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.
2124
+ * - 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.
2125
+ * - 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.
2126
+ * - 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.
2127
+ * - 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.
2128
+ * - 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.
2129
+ * @enum {string}
2130
+ */
2131
+ partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
2132
+ /**
2133
+ * PartyIdentifier
2134
+ * @description Identifier of the Party.
2135
+ * @example 16135551212
2136
+ */
2137
+ partyIdentifier: string;
2138
+ /**
2139
+ * PartySubIdOrType
2140
+ * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
2141
+ */
2142
+ partySubIdOrType?: string;
2143
+ /**
2144
+ * FspId
2145
+ * @description FSP identifier.
2146
+ */
2147
+ fspId?: string;
2148
+ /**
2149
+ * ExtensionList
2150
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
2151
+ */
2152
+ extensionList?: {
2153
+ /** @description Number of Extension elements. */
2154
+ extension: {
2155
+ /**
2156
+ * ExtensionKey
2157
+ * @description Extension key.
2158
+ */
2159
+ key: string;
2160
+ /**
2161
+ * ExtensionValue
2162
+ * @description Extension value.
2163
+ */
2164
+ value: string;
2165
+ }[];
2166
+ };
2167
+ };
2168
+ /**
2169
+ * MerchantClassificationCode
2170
+ * @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.
2171
+ */
2172
+ merchantClassificationCode?: string;
2173
+ /**
2174
+ * PartyName
2175
+ * @description Name of the Party. Could be a real name or a nickname.
2176
+ */
2177
+ name?: string;
2178
+ /**
2179
+ * PartyPersonalInfo
2180
+ * @description Data model for the complex type PartyPersonalInfo.
2181
+ */
2182
+ personalInfo?: {
2183
+ /**
2184
+ * PartyComplexName
2185
+ * @description Data model for the complex type PartyComplexName.
2186
+ */
2187
+ complexName?: {
2188
+ /**
2189
+ * FirstName
2190
+ * @description First name of the Party (Name Type).
2191
+ * @example Henrik
2192
+ */
2193
+ firstName?: string;
2194
+ /**
2195
+ * MiddleName
2196
+ * @description Middle name of the Party (Name Type).
2197
+ * @example Johannes
2198
+ */
2199
+ middleName?: string;
2200
+ /**
2201
+ * LastName
2202
+ * @description Last name of the Party (Name Type).
2203
+ * @example Karlsson
2204
+ */
2205
+ lastName?: string;
2206
+ };
2207
+ /**
2208
+ * DateofBirth (type Date)
2209
+ * @description Date of Birth of the Party.
2210
+ * @example 1966-06-16
2211
+ */
2212
+ dateOfBirth?: string;
2213
+ };
2214
+ };
2215
+ /**
2216
+ * AmountType
2217
+ * @description Below are the allowed values for the enumeration AmountType.
2218
+ * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
2219
+ * - 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.
2220
+ * @example RECEIVE
2221
+ * @enum {string}
2222
+ */
2223
+ AmountType: "SEND" | "RECEIVE";
2224
+ /**
2225
+ * Note
2226
+ * @description Memo assigned to transaction.
2227
+ * @example Note sent to Payee.
2228
+ */
2229
+ Note: string;
2230
+ /**
2231
+ * Money
2232
+ * @description Data model for the complex type Money.
2233
+ */
2234
+ Money: {
2235
+ /**
2236
+ * Currency
2237
+ * @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.
2238
+ * @enum {string}
2239
+ */
2240
+ currency: "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";
2241
+ /**
2242
+ * Amount
2243
+ * @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.
2244
+ * @example 123.45
2245
+ */
2246
+ amount: string;
2247
+ };
2248
+ /**
2249
+ * Latitude
2250
+ * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
2251
+ * @example +45.4215
2252
+ */
2253
+ Latitude: string;
2254
+ /**
2255
+ * Longitude
2256
+ * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
2257
+ * @example +75.6972
2258
+ */
2259
+ Longitude: string;
2260
+ /**
2261
+ * GeoCode
2262
+ * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
2263
+ */
2264
+ GeoCode: {
2265
+ /**
2266
+ * Latitude
2267
+ * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
2268
+ * @example +45.4215
2269
+ */
2270
+ latitude: string;
2271
+ /**
2272
+ * Longitude
2273
+ * @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
+ * @example +75.6972
2275
+ */
2276
+ longitude: string;
2277
+ };
2278
+ /**
2279
+ * IlpPacket
2280
+ * @description Information for recipient (transport layer information).
2281
+ * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
2282
+ */
2283
+ IlpPacket: string;
2284
+ /**
2285
+ * IlpCondition
2286
+ * @description Condition that must be attached to the transfer by the Payer.
2287
+ */
2288
+ IlpCondition: string;
2289
+ /**
2290
+ * QuotesIDPutResponse
2291
+ * @description The object sent in the PUT /quotes/{ID} callback.
2292
+ */
2293
+ QuotesIDPutResponse: {
2294
+ /**
2295
+ * Money
2296
+ * @description Data model for the complex type Money.
2297
+ */
2298
+ transferAmount: {
2299
+ /**
2300
+ * Currency
2301
+ * @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.
2302
+ * @enum {string}
2303
+ */
2304
+ currency: "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";
2305
+ /**
2306
+ * Amount
2307
+ * @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.
2308
+ * @example 123.45
2309
+ */
2310
+ amount: string;
2311
+ };
2312
+ /**
2313
+ * Money
2314
+ * @description Data model for the complex type Money.
2315
+ */
2316
+ payeeReceiveAmount?: {
2317
+ /**
2318
+ * Currency
2319
+ * @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.
2320
+ * @enum {string}
2321
+ */
2322
+ currency: "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";
2323
+ /**
2324
+ * Amount
2325
+ * @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.
2326
+ * @example 123.45
2327
+ */
2328
+ amount: string;
2329
+ };
2330
+ /**
2331
+ * Money
2332
+ * @description Data model for the complex type Money.
2333
+ */
2334
+ payeeFspFee?: {
2335
+ /**
2336
+ * Currency
2337
+ * @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.
2338
+ * @enum {string}
2339
+ */
2340
+ currency: "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";
2341
+ /**
2342
+ * Amount
2343
+ * @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.
2344
+ * @example 123.45
2345
+ */
2346
+ amount: string;
2347
+ };
2348
+ /**
2349
+ * Money
2350
+ * @description Data model for the complex type Money.
2351
+ */
2352
+ payeeFspCommission?: {
2353
+ /**
2354
+ * Currency
2355
+ * @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.
2356
+ * @enum {string}
2357
+ */
2358
+ currency: "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";
2359
+ /**
2360
+ * Amount
2361
+ * @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.
2362
+ * @example 123.45
2363
+ */
2364
+ amount: string;
2365
+ };
2366
+ /**
2367
+ * DateTime
2368
+ * @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).
2369
+ * @example 2016-05-24T08:38:08.699-04:00
2370
+ */
2371
+ expiration: string;
2372
+ /**
2373
+ * GeoCode
2374
+ * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
2375
+ */
2376
+ geoCode?: {
2377
+ /**
2378
+ * Latitude
2379
+ * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
2380
+ * @example +45.4215
2381
+ */
2382
+ latitude: string;
2383
+ /**
2384
+ * Longitude
2385
+ * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
2386
+ * @example +75.6972
2387
+ */
2388
+ longitude: string;
2389
+ };
2390
+ /**
2391
+ * IlpPacket
2392
+ * @description Information for recipient (transport layer information).
2393
+ * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
2394
+ */
2395
+ ilpPacket: string;
2396
+ /**
2397
+ * IlpCondition
2398
+ * @description Condition that must be attached to the transfer by the Payer.
2399
+ */
2400
+ condition: string;
2401
+ /**
2402
+ * ExtensionList
2403
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
2404
+ */
2405
+ extensionList?: {
2406
+ /** @description Number of Extension elements. */
2407
+ extension: {
2408
+ /**
2409
+ * ExtensionKey
2410
+ * @description Extension key.
2411
+ */
2412
+ key: string;
2413
+ /**
2414
+ * ExtensionValue
2415
+ * @description Extension value.
2416
+ */
2417
+ value: string;
2418
+ }[];
2419
+ };
2420
+ };
2421
+ /**
2422
+ * IlpFulfilment
2423
+ * @description Fulfilment that must be attached to the transfer by the Payee.
2424
+ * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
2425
+ */
2426
+ IlpFulfilment: string;
2427
+ /**
2428
+ * TransferState
2429
+ * @description Below are the allowed values for the enumeration.
2430
+ * - RECEIVED - Next ledger has received the transfer.
2431
+ * - RESERVED - Next ledger has reserved the transfer.
2432
+ * - COMMITTED - Next ledger has successfully performed the transfer.
2433
+ * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
2434
+ * @example RESERVED
2435
+ * @enum {string}
2436
+ */
2437
+ TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
2438
+ /**
2439
+ * TransfersIDPutResponse
2440
+ * @description The object sent in the PUT /transfers/{ID} callback.
2441
+ */
2442
+ TransfersIDPutResponse: {
2443
+ /**
2444
+ * IlpFulfilment
2445
+ * @description Fulfilment that must be attached to the transfer by the Payee.
2446
+ * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
2447
+ */
2448
+ fulfilment?: string;
2449
+ /**
2450
+ * DateTime
2451
+ * @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).
2452
+ * @example 2016-05-24T08:38:08.699-04:00
2453
+ */
2454
+ completedTimestamp?: string;
2455
+ /**
2456
+ * TransferState
2457
+ * @description Below are the allowed values for the enumeration.
2458
+ * - RECEIVED - Next ledger has received the transfer.
2459
+ * - RESERVED - Next ledger has reserved the transfer.
2460
+ * - COMMITTED - Next ledger has successfully performed the transfer.
2461
+ * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
2462
+ * @example RESERVED
2463
+ * @enum {string}
2464
+ */
2465
+ transferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
2466
+ /**
2467
+ * ExtensionList
2468
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
2469
+ */
2470
+ extensionList?: {
2471
+ /** @description Number of Extension elements. */
2472
+ extension: {
2473
+ /**
2474
+ * ExtensionKey
2475
+ * @description Extension key.
2476
+ */
2477
+ key: string;
2478
+ /**
2479
+ * ExtensionValue
2480
+ * @description Extension value.
2481
+ */
2482
+ value: string;
2483
+ }[];
2484
+ };
2485
+ };
2486
+ /**
2487
+ * ErrorCode
2488
+ * @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.
2489
+ * @example 5100
2490
+ */
2491
+ ErrorCode: string;
2492
+ /**
2493
+ * ErrorDescription
2494
+ * @description Error description string.
2495
+ */
2496
+ ErrorDescription: string;
2497
+ /**
2498
+ * ErrorInformation
2499
+ * @description Data model for the complex type ErrorInformation.
2500
+ */
2501
+ ErrorInformation: {
2502
+ /**
2503
+ * ErrorCode
2504
+ * @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.
2505
+ * @example 5100
2506
+ */
2507
+ errorCode: string;
2508
+ /**
2509
+ * ErrorDescription
2510
+ * @description Error description string.
2511
+ */
2512
+ errorDescription: string;
2513
+ /**
2514
+ * ExtensionList
2515
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
2516
+ */
2517
+ extensionList?: {
2518
+ /** @description Number of Extension elements. */
2519
+ extension: {
2520
+ /**
2521
+ * ExtensionKey
2522
+ * @description Extension key.
2523
+ */
2524
+ key: string;
2525
+ /**
2526
+ * ExtensionValue
2527
+ * @description Extension value.
2528
+ */
2529
+ value: string;
2530
+ }[];
2531
+ };
2532
+ };
2533
+ mojaloopError: {
2534
+ /**
2535
+ * ErrorInformation
2536
+ * @description Data model for the complex type ErrorInformation.
2537
+ */
2538
+ errorInformation?: {
2539
+ /**
2540
+ * ErrorCode
2541
+ * @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.
2542
+ * @example 5100
2543
+ */
2544
+ errorCode: string;
2545
+ /**
2546
+ * ErrorDescription
2547
+ * @description Error description string.
2548
+ */
2549
+ errorDescription: string;
2550
+ /**
2551
+ * ExtensionList
2552
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
2553
+ */
2554
+ extensionList?: {
2555
+ /** @description Number of Extension elements. */
2556
+ extension: {
2557
+ /**
2558
+ * ExtensionKey
2559
+ * @description Extension key.
2560
+ */
2561
+ key: string;
2562
+ /**
2563
+ * ExtensionValue
2564
+ * @description Extension value.
2565
+ */
2566
+ value: string;
2567
+ }[];
2568
+ };
2569
+ };
2570
+ };
2571
+ /** @description This object represents a Mojaloop API error received at any time during the transfer process */
2572
+ transferError: {
2573
+ /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
2574
+ httpStatusCode?: number;
2575
+ /** @description If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object. */
2576
+ mojaloopError?: {
2577
+ /**
2578
+ * ErrorInformation
2579
+ * @description Data model for the complex type ErrorInformation.
2580
+ */
2581
+ errorInformation?: {
2582
+ /**
2583
+ * ErrorCode
2584
+ * @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.
2585
+ * @example 5100
2586
+ */
2587
+ errorCode: string;
2588
+ /**
2589
+ * ErrorDescription
2590
+ * @description Error description string.
2591
+ */
2592
+ errorDescription: string;
2593
+ /**
2594
+ * ExtensionList
2595
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
2596
+ */
2597
+ extensionList?: {
2598
+ /** @description Number of Extension elements. */
2599
+ extension: {
2600
+ /**
2601
+ * ExtensionKey
2602
+ * @description Extension key.
2603
+ */
2604
+ key: string;
2605
+ /**
2606
+ * ExtensionValue
2607
+ * @description Extension value.
2608
+ */
2609
+ value: string;
2610
+ }[];
2611
+ };
2612
+ };
2613
+ };
2614
+ };
2615
+ bulkTransactionIndividualTransferResult: {
2616
+ /**
2617
+ * CorrelationId
2618
+ * @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 (‘-‘).
2619
+ * @example b51ec534-ee48-4575-b6a9-ead2955b8069
2620
+ */
2621
+ transferId: string;
2622
+ /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
2623
+ homeTransactionId: string;
2624
+ /**
2625
+ * CorrelationId
2626
+ * @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 (‘-‘).
2627
+ * @example b51ec534-ee48-4575-b6a9-ead2955b8069
2628
+ */
2629
+ transactionId?: string;
2630
+ /**
2631
+ * Party
2632
+ * @description Data model for the complex type Party.
2633
+ */
2634
+ to: {
2635
+ /**
2636
+ * PartyIdInfo
2637
+ * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
2638
+ */
2639
+ partyIdInfo: {
2640
+ /**
2641
+ * PartyIdType
2642
+ * @description Below are the allowed values for the enumeration.
2643
+ * - 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.
2644
+ * - 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).
2645
+ * - 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.
2646
+ * - 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.
2647
+ * - 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.
2648
+ * - 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.
2649
+ * - 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.
2650
+ * - 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.
2651
+ * @enum {string}
2652
+ */
2653
+ partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
2654
+ /**
2655
+ * PartyIdentifier
2656
+ * @description Identifier of the Party.
2657
+ * @example 16135551212
2658
+ */
2659
+ partyIdentifier: string;
2660
+ /**
2661
+ * PartySubIdOrType
2662
+ * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
2663
+ */
2664
+ partySubIdOrType?: string;
2665
+ /**
2666
+ * FspId
2667
+ * @description FSP identifier.
2668
+ */
2669
+ fspId?: string;
2670
+ /**
2671
+ * ExtensionList
2672
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
2673
+ */
2674
+ extensionList?: {
2675
+ /** @description Number of Extension elements. */
2676
+ extension: {
2677
+ /**
2678
+ * ExtensionKey
2679
+ * @description Extension key.
2680
+ */
2681
+ key: string;
2682
+ /**
2683
+ * ExtensionValue
2684
+ * @description Extension value.
2685
+ */
2686
+ value: string;
2687
+ }[];
2688
+ };
2689
+ };
2690
+ /**
2691
+ * MerchantClassificationCode
2692
+ * @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.
2693
+ */
2694
+ merchantClassificationCode?: string;
2695
+ /**
2696
+ * PartyName
2697
+ * @description Name of the Party. Could be a real name or a nickname.
2698
+ */
2699
+ name?: string;
2700
+ /**
2701
+ * PartyPersonalInfo
2702
+ * @description Data model for the complex type PartyPersonalInfo.
2703
+ */
2704
+ personalInfo?: {
2705
+ /**
2706
+ * PartyComplexName
2707
+ * @description Data model for the complex type PartyComplexName.
2708
+ */
2709
+ complexName?: {
2710
+ /**
2711
+ * FirstName
2712
+ * @description First name of the Party (Name Type).
2713
+ * @example Henrik
2714
+ */
2715
+ firstName?: string;
2716
+ /**
2717
+ * MiddleName
2718
+ * @description Middle name of the Party (Name Type).
2719
+ * @example Johannes
2720
+ */
2721
+ middleName?: string;
2722
+ /**
2723
+ * LastName
2724
+ * @description Last name of the Party (Name Type).
2725
+ * @example Karlsson
2726
+ */
2727
+ lastName?: string;
2728
+ };
2729
+ /**
2730
+ * DateofBirth (type Date)
2731
+ * @description Date of Birth of the Party.
2732
+ * @example 1966-06-16
2733
+ */
2734
+ dateOfBirth?: string;
2735
+ };
2736
+ };
2737
+ /** @description Payer Loan reference */
2738
+ reference?: string;
2739
+ /**
2740
+ * AmountType
2741
+ * @description Below are the allowed values for the enumeration AmountType.
2742
+ * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
2743
+ * - 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.
2744
+ * @example RECEIVE
2745
+ * @enum {string}
2746
+ */
2747
+ amountType: "SEND" | "RECEIVE";
2748
+ /**
2749
+ * Currency
2750
+ * @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.
2751
+ * @enum {string}
2752
+ */
2753
+ currency: "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";
2754
+ /**
2755
+ * Amount
2756
+ * @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.
2757
+ * @example 123.45
2758
+ */
2759
+ amount: string;
2760
+ /**
2761
+ * Note
2762
+ * @description Memo assigned to transaction.
2763
+ * @example Note sent to Payee.
2764
+ */
2765
+ note?: string;
2766
+ /**
2767
+ * CorrelationId
2768
+ * @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 (‘-‘).
2769
+ * @example b51ec534-ee48-4575-b6a9-ead2955b8069
2770
+ */
2771
+ quoteId?: string;
2772
+ /**
2773
+ * QuotesIDPutResponse
2774
+ * @description The object sent in the PUT /quotes/{ID} callback.
2775
+ */
2776
+ quoteResponse?: {
2777
+ /**
2778
+ * Money
2779
+ * @description Data model for the complex type Money.
2780
+ */
2781
+ transferAmount: {
2782
+ /**
2783
+ * Currency
2784
+ * @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.
2785
+ * @enum {string}
2786
+ */
2787
+ currency: "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";
2788
+ /**
2789
+ * Amount
2790
+ * @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.
2791
+ * @example 123.45
2792
+ */
2793
+ amount: string;
2794
+ };
2795
+ /**
2796
+ * Money
2797
+ * @description Data model for the complex type Money.
2798
+ */
2799
+ payeeReceiveAmount?: {
2800
+ /**
2801
+ * Currency
2802
+ * @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.
2803
+ * @enum {string}
2804
+ */
2805
+ currency: "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";
2806
+ /**
2807
+ * Amount
2808
+ * @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.
2809
+ * @example 123.45
2810
+ */
2811
+ amount: string;
2812
+ };
2813
+ /**
2814
+ * Money
2815
+ * @description Data model for the complex type Money.
2816
+ */
2817
+ payeeFspFee?: {
2818
+ /**
2819
+ * Currency
2820
+ * @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.
2821
+ * @enum {string}
2822
+ */
2823
+ currency: "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";
2824
+ /**
2825
+ * Amount
2826
+ * @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.
2827
+ * @example 123.45
2828
+ */
2829
+ amount: string;
2830
+ };
2831
+ /**
2832
+ * Money
2833
+ * @description Data model for the complex type Money.
2834
+ */
2835
+ payeeFspCommission?: {
2836
+ /**
2837
+ * Currency
2838
+ * @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.
2839
+ * @enum {string}
2840
+ */
2841
+ currency: "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";
2842
+ /**
2843
+ * Amount
2844
+ * @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.
2845
+ * @example 123.45
2846
+ */
2847
+ amount: string;
2848
+ };
2849
+ /**
2850
+ * DateTime
2851
+ * @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).
2852
+ * @example 2016-05-24T08:38:08.699-04:00
2853
+ */
2854
+ expiration: string;
2855
+ /**
2856
+ * GeoCode
2857
+ * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
2858
+ */
2859
+ geoCode?: {
2860
+ /**
2861
+ * Latitude
2862
+ * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
2863
+ * @example +45.4215
2864
+ */
2865
+ latitude: string;
2866
+ /**
2867
+ * Longitude
2868
+ * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
2869
+ * @example +75.6972
2870
+ */
2871
+ longitude: string;
2872
+ };
2873
+ /**
2874
+ * IlpPacket
2875
+ * @description Information for recipient (transport layer information).
2876
+ * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
2877
+ */
2878
+ ilpPacket: string;
2879
+ /**
2880
+ * IlpCondition
2881
+ * @description Condition that must be attached to the transfer by the Payer.
2882
+ */
2883
+ condition: string;
2884
+ /**
2885
+ * ExtensionList
2886
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
2887
+ */
2888
+ extensionList?: {
2889
+ /** @description Number of Extension elements. */
2890
+ extension: {
2891
+ /**
2892
+ * ExtensionKey
2893
+ * @description Extension key.
2894
+ */
2895
+ key: string;
2896
+ /**
2897
+ * ExtensionValue
2898
+ * @description Extension value.
2899
+ */
2900
+ value: string;
2901
+ }[];
2902
+ };
2903
+ };
2904
+ /**
2905
+ * TransfersIDPutResponse
2906
+ * @description The object sent in the PUT /transfers/{ID} callback.
2907
+ */
2908
+ fulfil?: {
2909
+ /**
2910
+ * IlpFulfilment
2911
+ * @description Fulfilment that must be attached to the transfer by the Payee.
2912
+ * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
2913
+ */
2914
+ fulfilment?: string;
2915
+ /**
2916
+ * DateTime
2917
+ * @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).
2918
+ * @example 2016-05-24T08:38:08.699-04:00
2919
+ */
2920
+ completedTimestamp?: string;
2921
+ /**
2922
+ * TransferState
2923
+ * @description Below are the allowed values for the enumeration.
2924
+ * - RECEIVED - Next ledger has received the transfer.
2925
+ * - RESERVED - Next ledger has reserved the transfer.
2926
+ * - COMMITTED - Next ledger has successfully performed the transfer.
2927
+ * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
2928
+ * @example RESERVED
2929
+ * @enum {string}
2930
+ */
2931
+ transferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
2932
+ /**
2933
+ * ExtensionList
2934
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
2935
+ */
2936
+ extensionList?: {
2937
+ /** @description Number of Extension elements. */
2938
+ extension: {
2939
+ /**
2940
+ * ExtensionKey
2941
+ * @description Extension key.
2942
+ */
2943
+ key: string;
2944
+ /**
2945
+ * ExtensionValue
2946
+ * @description Extension value.
2947
+ */
2948
+ value: string;
2949
+ }[];
2950
+ };
2951
+ };
2952
+ /**
2953
+ * ExtensionList
2954
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
2955
+ */
2956
+ quoteExtensions?: {
2957
+ /** @description Number of Extension elements. */
2958
+ extension: {
2959
+ /**
2960
+ * ExtensionKey
2961
+ * @description Extension key.
2962
+ */
2963
+ key: string;
2964
+ /**
2965
+ * ExtensionValue
2966
+ * @description Extension value.
2967
+ */
2968
+ value: string;
2969
+ }[];
2970
+ };
2971
+ /**
2972
+ * ExtensionList
2973
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
2974
+ */
2975
+ transferExtensions?: {
2976
+ /** @description Number of Extension elements. */
2977
+ extension: {
2978
+ /**
2979
+ * ExtensionKey
2980
+ * @description Extension key.
2981
+ */
2982
+ key: string;
2983
+ /**
2984
+ * ExtensionValue
2985
+ * @description Extension value.
2986
+ */
2987
+ value: string;
2988
+ }[];
2989
+ };
2990
+ /** @description This object represents a Mojaloop API error received at any time during the transfer process */
2991
+ lastError?: {
2992
+ /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
2993
+ httpStatusCode?: number;
2994
+ /** @description If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object. */
2995
+ mojaloopError?: {
2996
+ /**
2997
+ * ErrorInformation
2998
+ * @description Data model for the complex type ErrorInformation.
2999
+ */
3000
+ errorInformation?: {
3001
+ /**
3002
+ * ErrorCode
3003
+ * @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.
3004
+ * @example 5100
3005
+ */
3006
+ errorCode: string;
3007
+ /**
3008
+ * ErrorDescription
3009
+ * @description Error description string.
3010
+ */
3011
+ errorDescription: string;
3012
+ /**
3013
+ * ExtensionList
3014
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
3015
+ */
3016
+ extensionList?: {
3017
+ /** @description Number of Extension elements. */
3018
+ extension: {
3019
+ /**
3020
+ * ExtensionKey
3021
+ * @description Extension key.
3022
+ */
3023
+ key: string;
3024
+ /**
3025
+ * ExtensionValue
3026
+ * @description Extension value.
3027
+ */
3028
+ value: string;
3029
+ }[];
3030
+ };
3031
+ };
3032
+ };
3033
+ };
3034
+ };
3035
+ /** BulkTransactionResponse */
3036
+ bulkTransactionResponse: {
3037
+ /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
3038
+ bulkHomeTransactionID: string;
3039
+ /**
3040
+ * CorrelationId
3041
+ * @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 (‘-‘).
3042
+ * @example b51ec534-ee48-4575-b6a9-ead2955b8069
3043
+ */
3044
+ bulkTransactionId: string;
3045
+ /** @enum {string} */
3046
+ currentState: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED";
3047
+ options?: {
3048
+ /** @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. */
3049
+ onlyValidateParty?: boolean;
3050
+ autoAcceptParty: {
3051
+ /** @enum {boolean} */
3052
+ enabled: false | true;
3053
+ };
3054
+ /** @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. */
3055
+ autoAcceptQuote: {
3056
+ /** @enum {boolean} */
3057
+ enabled: true | false;
3058
+ perTransferFeeLimits?: {
3059
+ /**
3060
+ * Currency
3061
+ * @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.
3062
+ * @enum {string}
3063
+ */
3064
+ currency: "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";
3065
+ /**
3066
+ * Amount
3067
+ * @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.
3068
+ * @example 123.45
3069
+ */
3070
+ amount: string;
3071
+ }[];
3072
+ };
3073
+ /** @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. */
3074
+ skipPartyLookup?: boolean;
3075
+ /** @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 */
3076
+ synchronous?: boolean;
3077
+ /**
3078
+ * DateTime
3079
+ * @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).
3080
+ * @example 2016-05-24T08:38:08.699-04:00
3081
+ */
3082
+ bulkExpiration: string;
3083
+ };
3084
+ /** @description List of individual transfer result in a bulk transfer response. */
3085
+ individualTransferResults: {
3086
+ /**
3087
+ * CorrelationId
3088
+ * @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 (‘-‘).
3089
+ * @example b51ec534-ee48-4575-b6a9-ead2955b8069
3090
+ */
3091
+ transferId: string;
3092
+ /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
3093
+ homeTransactionId: string;
3094
+ /**
3095
+ * CorrelationId
3096
+ * @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 (‘-‘).
3097
+ * @example b51ec534-ee48-4575-b6a9-ead2955b8069
3098
+ */
3099
+ transactionId?: string;
3100
+ /**
3101
+ * Party
3102
+ * @description Data model for the complex type Party.
3103
+ */
3104
+ to: {
3105
+ /**
3106
+ * PartyIdInfo
3107
+ * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
3108
+ */
3109
+ partyIdInfo: {
3110
+ /**
3111
+ * PartyIdType
3112
+ * @description Below are the allowed values for the enumeration.
3113
+ * - 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.
3114
+ * - 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).
3115
+ * - 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.
3116
+ * - 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.
3117
+ * - 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.
3118
+ * - 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.
3119
+ * - 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.
3120
+ * - 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.
3121
+ * @enum {string}
3122
+ */
3123
+ partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
3124
+ /**
3125
+ * PartyIdentifier
3126
+ * @description Identifier of the Party.
3127
+ * @example 16135551212
3128
+ */
3129
+ partyIdentifier: string;
3130
+ /**
3131
+ * PartySubIdOrType
3132
+ * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
3133
+ */
3134
+ partySubIdOrType?: string;
3135
+ /**
3136
+ * FspId
3137
+ * @description FSP identifier.
3138
+ */
3139
+ fspId?: string;
3140
+ /**
3141
+ * ExtensionList
3142
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
3143
+ */
3144
+ extensionList?: {
3145
+ /** @description Number of Extension elements. */
3146
+ extension: {
3147
+ /**
3148
+ * ExtensionKey
3149
+ * @description Extension key.
3150
+ */
3151
+ key: string;
3152
+ /**
3153
+ * ExtensionValue
3154
+ * @description Extension value.
3155
+ */
3156
+ value: string;
3157
+ }[];
3158
+ };
3159
+ };
3160
+ /**
3161
+ * MerchantClassificationCode
3162
+ * @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.
3163
+ */
3164
+ merchantClassificationCode?: string;
3165
+ /**
3166
+ * PartyName
3167
+ * @description Name of the Party. Could be a real name or a nickname.
3168
+ */
3169
+ name?: string;
3170
+ /**
3171
+ * PartyPersonalInfo
3172
+ * @description Data model for the complex type PartyPersonalInfo.
3173
+ */
3174
+ personalInfo?: {
3175
+ /**
3176
+ * PartyComplexName
3177
+ * @description Data model for the complex type PartyComplexName.
3178
+ */
3179
+ complexName?: {
3180
+ /**
3181
+ * FirstName
3182
+ * @description First name of the Party (Name Type).
3183
+ * @example Henrik
3184
+ */
3185
+ firstName?: string;
3186
+ /**
3187
+ * MiddleName
3188
+ * @description Middle name of the Party (Name Type).
3189
+ * @example Johannes
3190
+ */
3191
+ middleName?: string;
3192
+ /**
3193
+ * LastName
3194
+ * @description Last name of the Party (Name Type).
3195
+ * @example Karlsson
3196
+ */
3197
+ lastName?: string;
3198
+ };
3199
+ /**
3200
+ * DateofBirth (type Date)
3201
+ * @description Date of Birth of the Party.
3202
+ * @example 1966-06-16
3203
+ */
3204
+ dateOfBirth?: string;
3205
+ };
3206
+ };
3207
+ /** @description Payer Loan reference */
3208
+ reference?: string;
3209
+ /**
3210
+ * AmountType
3211
+ * @description Below are the allowed values for the enumeration AmountType.
3212
+ * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
3213
+ * - 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.
3214
+ * @example RECEIVE
3215
+ * @enum {string}
3216
+ */
3217
+ amountType: "SEND" | "RECEIVE";
3218
+ /**
3219
+ * Currency
3220
+ * @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.
3221
+ * @enum {string}
3222
+ */
3223
+ currency: "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";
3224
+ /**
3225
+ * Amount
3226
+ * @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.
3227
+ * @example 123.45
3228
+ */
3229
+ amount: string;
3230
+ /**
3231
+ * Note
3232
+ * @description Memo assigned to transaction.
3233
+ * @example Note sent to Payee.
3234
+ */
3235
+ note?: string;
3236
+ /**
3237
+ * CorrelationId
3238
+ * @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 (‘-‘).
3239
+ * @example b51ec534-ee48-4575-b6a9-ead2955b8069
3240
+ */
3241
+ quoteId?: string;
3242
+ /**
3243
+ * QuotesIDPutResponse
3244
+ * @description The object sent in the PUT /quotes/{ID} callback.
3245
+ */
3246
+ quoteResponse?: {
3247
+ /**
3248
+ * Money
3249
+ * @description Data model for the complex type Money.
3250
+ */
3251
+ transferAmount: {
3252
+ /**
3253
+ * Currency
3254
+ * @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.
3255
+ * @enum {string}
3256
+ */
3257
+ currency: "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";
3258
+ /**
3259
+ * Amount
3260
+ * @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.
3261
+ * @example 123.45
3262
+ */
3263
+ amount: string;
3264
+ };
3265
+ /**
3266
+ * Money
3267
+ * @description Data model for the complex type Money.
3268
+ */
3269
+ payeeReceiveAmount?: {
3270
+ /**
3271
+ * Currency
3272
+ * @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.
3273
+ * @enum {string}
3274
+ */
3275
+ currency: "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";
3276
+ /**
3277
+ * Amount
3278
+ * @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.
3279
+ * @example 123.45
3280
+ */
3281
+ amount: string;
3282
+ };
3283
+ /**
3284
+ * Money
3285
+ * @description Data model for the complex type Money.
3286
+ */
3287
+ payeeFspFee?: {
3288
+ /**
3289
+ * Currency
3290
+ * @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.
3291
+ * @enum {string}
3292
+ */
3293
+ currency: "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";
3294
+ /**
3295
+ * Amount
3296
+ * @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.
3297
+ * @example 123.45
3298
+ */
3299
+ amount: string;
3300
+ };
3301
+ /**
3302
+ * Money
3303
+ * @description Data model for the complex type Money.
3304
+ */
3305
+ payeeFspCommission?: {
3306
+ /**
3307
+ * Currency
3308
+ * @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.
3309
+ * @enum {string}
3310
+ */
3311
+ currency: "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";
3312
+ /**
3313
+ * Amount
3314
+ * @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.
3315
+ * @example 123.45
3316
+ */
3317
+ amount: string;
3318
+ };
3319
+ /**
3320
+ * DateTime
3321
+ * @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).
3322
+ * @example 2016-05-24T08:38:08.699-04:00
3323
+ */
3324
+ expiration: string;
3325
+ /**
3326
+ * GeoCode
3327
+ * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
3328
+ */
3329
+ geoCode?: {
3330
+ /**
3331
+ * Latitude
3332
+ * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
3333
+ * @example +45.4215
3334
+ */
3335
+ latitude: string;
3336
+ /**
3337
+ * Longitude
3338
+ * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
3339
+ * @example +75.6972
3340
+ */
3341
+ longitude: string;
3342
+ };
3343
+ /**
3344
+ * IlpPacket
3345
+ * @description Information for recipient (transport layer information).
3346
+ * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
3347
+ */
3348
+ ilpPacket: string;
3349
+ /**
3350
+ * IlpCondition
3351
+ * @description Condition that must be attached to the transfer by the Payer.
3352
+ */
3353
+ condition: string;
3354
+ /**
3355
+ * ExtensionList
3356
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
3357
+ */
3358
+ extensionList?: {
3359
+ /** @description Number of Extension elements. */
3360
+ extension: {
3361
+ /**
3362
+ * ExtensionKey
3363
+ * @description Extension key.
3364
+ */
3365
+ key: string;
3366
+ /**
3367
+ * ExtensionValue
3368
+ * @description Extension value.
3369
+ */
3370
+ value: string;
3371
+ }[];
3372
+ };
3373
+ };
3374
+ /**
3375
+ * TransfersIDPutResponse
3376
+ * @description The object sent in the PUT /transfers/{ID} callback.
3377
+ */
3378
+ fulfil?: {
3379
+ /**
3380
+ * IlpFulfilment
3381
+ * @description Fulfilment that must be attached to the transfer by the Payee.
3382
+ * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
3383
+ */
3384
+ fulfilment?: string;
3385
+ /**
3386
+ * DateTime
3387
+ * @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).
3388
+ * @example 2016-05-24T08:38:08.699-04:00
3389
+ */
3390
+ completedTimestamp?: string;
3391
+ /**
3392
+ * TransferState
3393
+ * @description Below are the allowed values for the enumeration.
3394
+ * - RECEIVED - Next ledger has received the transfer.
3395
+ * - RESERVED - Next ledger has reserved the transfer.
3396
+ * - COMMITTED - Next ledger has successfully performed the transfer.
3397
+ * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
3398
+ * @example RESERVED
3399
+ * @enum {string}
3400
+ */
3401
+ transferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
3402
+ /**
3403
+ * ExtensionList
3404
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
3405
+ */
3406
+ extensionList?: {
3407
+ /** @description Number of Extension elements. */
3408
+ extension: {
3409
+ /**
3410
+ * ExtensionKey
3411
+ * @description Extension key.
3412
+ */
3413
+ key: string;
3414
+ /**
3415
+ * ExtensionValue
3416
+ * @description Extension value.
3417
+ */
3418
+ value: string;
3419
+ }[];
3420
+ };
3421
+ };
3422
+ /**
3423
+ * ExtensionList
3424
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
3425
+ */
3426
+ quoteExtensions?: {
3427
+ /** @description Number of Extension elements. */
3428
+ extension: {
3429
+ /**
3430
+ * ExtensionKey
3431
+ * @description Extension key.
3432
+ */
3433
+ key: string;
3434
+ /**
3435
+ * ExtensionValue
3436
+ * @description Extension value.
3437
+ */
3438
+ value: string;
3439
+ }[];
3440
+ };
3441
+ /**
3442
+ * ExtensionList
3443
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
3444
+ */
3445
+ transferExtensions?: {
3446
+ /** @description Number of Extension elements. */
3447
+ extension: {
3448
+ /**
3449
+ * ExtensionKey
3450
+ * @description Extension key.
3451
+ */
3452
+ key: string;
3453
+ /**
3454
+ * ExtensionValue
3455
+ * @description Extension value.
3456
+ */
3457
+ value: string;
3458
+ }[];
3459
+ };
3460
+ /** @description This object represents a Mojaloop API error received at any time during the transfer process */
3461
+ lastError?: {
3462
+ /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
3463
+ httpStatusCode?: number;
3464
+ /** @description If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object. */
3465
+ mojaloopError?: {
3466
+ /**
3467
+ * ErrorInformation
3468
+ * @description Data model for the complex type ErrorInformation.
3469
+ */
3470
+ errorInformation?: {
3471
+ /**
3472
+ * ErrorCode
3473
+ * @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.
3474
+ * @example 5100
3475
+ */
3476
+ errorCode: string;
3477
+ /**
3478
+ * ErrorDescription
3479
+ * @description Error description string.
3480
+ */
3481
+ errorDescription: string;
3482
+ /**
3483
+ * ExtensionList
3484
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
3485
+ */
3486
+ extensionList?: {
3487
+ /** @description Number of Extension elements. */
3488
+ extension: {
3489
+ /**
3490
+ * ExtensionKey
3491
+ * @description Extension key.
3492
+ */
3493
+ key: string;
3494
+ /**
3495
+ * ExtensionValue
3496
+ * @description Extension value.
3497
+ */
3498
+ value: string;
3499
+ }[];
3500
+ };
3501
+ };
3502
+ };
3503
+ };
3504
+ }[];
3505
+ /**
3506
+ * ExtensionList
3507
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
3508
+ */
3509
+ extensions?: {
3510
+ /** @description Number of Extension elements. */
3511
+ extension: {
3512
+ /**
3513
+ * ExtensionKey
3514
+ * @description Extension key.
3515
+ */
3516
+ key: string;
3517
+ /**
3518
+ * ExtensionValue
3519
+ * @description Extension value.
3520
+ */
3521
+ value: string;
2415
3522
  }[];
2416
- /** @description Party first name. */
2417
- firstName?: string;
2418
- /** @description Mojaloop scheme FSPID of the DFSP which owns the party account. */
2419
- fspId?: string;
2420
- idSubValue?: string;
2421
- /** @enum {string} */
2422
- idType: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
2423
- /** @description The identifier string used to identify the sender. */
2424
- idValue: string;
2425
- /** @description Party last name. */
2426
- lastName?: string;
2427
- /** @description Up to 4 digits specifying the sender's merchant classification, if known and applicable. */
2428
- merchantClassificationCode?: string;
2429
- /** @description Party middle name. */
2430
- middleName?: string;
2431
- /** @enum {string} */
2432
- type?: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
2433
3523
  };
2434
- /** @enum {string} */
2435
- transactionType: "TRANSFER" | "DEPOSIT" | "PAYMENT";
2436
- /** @description A Mojaloop API transfer identifier (UUID). */
2437
- transferId: string;
2438
- };
2439
- transferResponse: {
2440
- /**
2441
- * @description An ISO-8601 formatted timestamp.
2442
- * @example 2020-05-19T08:38:08.699-04:00
2443
- */
2444
- completedTimestamp?: string;
2445
- /**
2446
- * ilpFulfilment
2447
- * @description Fulfilment that must be attached to the transfer by the Payee.
2448
- * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
2449
- */
2450
- fulfilment?: string;
2451
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
2452
- homeTransactionId: string;
2453
- /**
2454
- * @description 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.
2455
- *
2456
- * @example ABORTED
2457
- * @enum {string}
2458
- */
2459
- transferState?: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
2460
3524
  };
2461
- /**
2462
- * @description 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.
2463
- *
2464
- * @enum {string}
2465
- */
2466
- transferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
2467
- /** @enum {string} */
2468
- transferStatus: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED";
2469
3525
  };
2470
3526
  responses: {
2471
3527
  /** Malformed or missing required headers or parameters. */
@@ -2500,8 +3556,6 @@ export interface components {
2500
3556
  };
2501
3557
  };
2502
3558
  parameters: {
2503
- /** @description Identifier of the bulk transaction to continue as returned in. */
2504
- bulkTransactionId: string;
2505
3559
  /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
2506
3560
  idSubValue: string;
2507
3561
  /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
@@ -2510,6 +3564,8 @@ export interface components {
2510
3564
  idValue: string;
2511
3565
  requestToPayId: string;
2512
3566
  transferId: string;
3567
+ /** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */
3568
+ bulkTransactionId: string;
2513
3569
  };
2514
3570
  }
2515
3571
  export interface operations {
@@ -2775,7 +3831,7 @@ export interface operations {
2775
3831
  BackendBulkTransactionsPut: {
2776
3832
  parameters: {
2777
3833
  path: {
2778
- /** Identifier of the bulk transaction to continue as returned in. */
3834
+ /** Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */
2779
3835
  bulkTransactionId: string;
2780
3836
  };
2781
3837
  };
@@ -2803,31 +3859,504 @@ export interface operations {
2803
3859
  /** @description Error message text */
2804
3860
  message?: string;
2805
3861
  /**
2806
- * @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.
2807
- * Otherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message.
3862
+ * @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.
3863
+ * Otherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message.
3864
+ */
3865
+ statusCode?: string;
3866
+ };
3867
+ };
3868
+ };
3869
+ };
3870
+ requestBody: {
3871
+ content: {
3872
+ "application/json": {
3873
+ /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
3874
+ bulkHomeTransactionID: string;
3875
+ /**
3876
+ * CorrelationId
3877
+ * @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 (‘-‘).
3878
+ * @example b51ec534-ee48-4575-b6a9-ead2955b8069
3879
+ */
3880
+ bulkTransactionId: string;
3881
+ /** @enum {string} */
3882
+ currentState: "ERROR_OCCURRED" | "WAITING_FOR_PARTY_ACCEPTANCE" | "WAITING_FOR_QUOTE_ACCEPTANCE" | "COMPLETED";
3883
+ options?: {
3884
+ /** @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. */
3885
+ onlyValidateParty?: boolean;
3886
+ autoAcceptParty: {
3887
+ /** @enum {boolean} */
3888
+ enabled: false | true;
3889
+ };
3890
+ /** @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. */
3891
+ autoAcceptQuote: {
3892
+ /** @enum {boolean} */
3893
+ enabled: true | false;
3894
+ perTransferFeeLimits?: {
3895
+ /**
3896
+ * Currency
3897
+ * @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.
3898
+ * @enum {string}
3899
+ */
3900
+ currency: "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";
3901
+ /**
3902
+ * Amount
3903
+ * @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.
3904
+ * @example 123.45
3905
+ */
3906
+ amount: string;
3907
+ }[];
3908
+ };
3909
+ /** @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. */
3910
+ skipPartyLookup?: boolean;
3911
+ /** @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 */
3912
+ synchronous?: boolean;
3913
+ /**
3914
+ * DateTime
3915
+ * @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).
3916
+ * @example 2016-05-24T08:38:08.699-04:00
3917
+ */
3918
+ bulkExpiration: string;
3919
+ };
3920
+ /** @description List of individual transfer result in a bulk transfer response. */
3921
+ individualTransferResults: {
3922
+ /**
3923
+ * CorrelationId
3924
+ * @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 (‘-‘).
3925
+ * @example b51ec534-ee48-4575-b6a9-ead2955b8069
3926
+ */
3927
+ transferId: string;
3928
+ /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
3929
+ homeTransactionId: string;
3930
+ /**
3931
+ * CorrelationId
3932
+ * @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 (‘-‘).
3933
+ * @example b51ec534-ee48-4575-b6a9-ead2955b8069
3934
+ */
3935
+ transactionId?: string;
3936
+ /**
3937
+ * Party
3938
+ * @description Data model for the complex type Party.
3939
+ */
3940
+ to: {
3941
+ /**
3942
+ * PartyIdInfo
3943
+ * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
3944
+ */
3945
+ partyIdInfo: {
3946
+ /**
3947
+ * PartyIdType
3948
+ * @description Below are the allowed values for the enumeration.
3949
+ * - 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.
3950
+ * - 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).
3951
+ * - 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.
3952
+ * - 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.
3953
+ * - 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.
3954
+ * - 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.
3955
+ * - 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.
3956
+ * - 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.
3957
+ * @enum {string}
3958
+ */
3959
+ partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
3960
+ /**
3961
+ * PartyIdentifier
3962
+ * @description Identifier of the Party.
3963
+ * @example 16135551212
3964
+ */
3965
+ partyIdentifier: string;
3966
+ /**
3967
+ * PartySubIdOrType
3968
+ * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
3969
+ */
3970
+ partySubIdOrType?: string;
3971
+ /**
3972
+ * FspId
3973
+ * @description FSP identifier.
3974
+ */
3975
+ fspId?: string;
3976
+ /**
3977
+ * ExtensionList
3978
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
3979
+ */
3980
+ extensionList?: {
3981
+ /** @description Number of Extension elements. */
3982
+ extension: {
3983
+ /**
3984
+ * ExtensionKey
3985
+ * @description Extension key.
3986
+ */
3987
+ key: string;
3988
+ /**
3989
+ * ExtensionValue
3990
+ * @description Extension value.
3991
+ */
3992
+ value: string;
3993
+ }[];
3994
+ };
3995
+ };
3996
+ /**
3997
+ * MerchantClassificationCode
3998
+ * @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.
3999
+ */
4000
+ merchantClassificationCode?: string;
4001
+ /**
4002
+ * PartyName
4003
+ * @description Name of the Party. Could be a real name or a nickname.
4004
+ */
4005
+ name?: string;
4006
+ /**
4007
+ * PartyPersonalInfo
4008
+ * @description Data model for the complex type PartyPersonalInfo.
4009
+ */
4010
+ personalInfo?: {
4011
+ /**
4012
+ * PartyComplexName
4013
+ * @description Data model for the complex type PartyComplexName.
4014
+ */
4015
+ complexName?: {
4016
+ /**
4017
+ * FirstName
4018
+ * @description First name of the Party (Name Type).
4019
+ * @example Henrik
4020
+ */
4021
+ firstName?: string;
4022
+ /**
4023
+ * MiddleName
4024
+ * @description Middle name of the Party (Name Type).
4025
+ * @example Johannes
4026
+ */
4027
+ middleName?: string;
4028
+ /**
4029
+ * LastName
4030
+ * @description Last name of the Party (Name Type).
4031
+ * @example Karlsson
4032
+ */
4033
+ lastName?: string;
4034
+ };
4035
+ /**
4036
+ * DateofBirth (type Date)
4037
+ * @description Date of Birth of the Party.
4038
+ * @example 1966-06-16
4039
+ */
4040
+ dateOfBirth?: string;
4041
+ };
4042
+ };
4043
+ /** @description Payer Loan reference */
4044
+ reference?: string;
4045
+ /**
4046
+ * AmountType
4047
+ * @description Below are the allowed values for the enumeration AmountType.
4048
+ * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
4049
+ * - 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.
4050
+ * @example RECEIVE
4051
+ * @enum {string}
4052
+ */
4053
+ amountType: "SEND" | "RECEIVE";
4054
+ /**
4055
+ * Currency
4056
+ * @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.
4057
+ * @enum {string}
4058
+ */
4059
+ currency: "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";
4060
+ /**
4061
+ * Amount
4062
+ * @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.
4063
+ * @example 123.45
4064
+ */
4065
+ amount: string;
4066
+ /**
4067
+ * Note
4068
+ * @description Memo assigned to transaction.
4069
+ * @example Note sent to Payee.
4070
+ */
4071
+ note?: string;
4072
+ /**
4073
+ * CorrelationId
4074
+ * @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 (‘-‘).
4075
+ * @example b51ec534-ee48-4575-b6a9-ead2955b8069
4076
+ */
4077
+ quoteId?: string;
4078
+ /**
4079
+ * QuotesIDPutResponse
4080
+ * @description The object sent in the PUT /quotes/{ID} callback.
4081
+ */
4082
+ quoteResponse?: {
4083
+ /**
4084
+ * Money
4085
+ * @description Data model for the complex type Money.
4086
+ */
4087
+ transferAmount: {
4088
+ /**
4089
+ * Currency
4090
+ * @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.
4091
+ * @enum {string}
4092
+ */
4093
+ currency: "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";
4094
+ /**
4095
+ * Amount
4096
+ * @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.
4097
+ * @example 123.45
4098
+ */
4099
+ amount: string;
4100
+ };
4101
+ /**
4102
+ * Money
4103
+ * @description Data model for the complex type Money.
4104
+ */
4105
+ payeeReceiveAmount?: {
4106
+ /**
4107
+ * Currency
4108
+ * @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.
4109
+ * @enum {string}
4110
+ */
4111
+ currency: "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";
4112
+ /**
4113
+ * Amount
4114
+ * @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.
4115
+ * @example 123.45
4116
+ */
4117
+ amount: string;
4118
+ };
4119
+ /**
4120
+ * Money
4121
+ * @description Data model for the complex type Money.
4122
+ */
4123
+ payeeFspFee?: {
4124
+ /**
4125
+ * Currency
4126
+ * @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.
4127
+ * @enum {string}
4128
+ */
4129
+ currency: "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";
4130
+ /**
4131
+ * Amount
4132
+ * @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.
4133
+ * @example 123.45
4134
+ */
4135
+ amount: string;
4136
+ };
4137
+ /**
4138
+ * Money
4139
+ * @description Data model for the complex type Money.
4140
+ */
4141
+ payeeFspCommission?: {
4142
+ /**
4143
+ * Currency
4144
+ * @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.
4145
+ * @enum {string}
4146
+ */
4147
+ currency: "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";
4148
+ /**
4149
+ * Amount
4150
+ * @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.
4151
+ * @example 123.45
4152
+ */
4153
+ amount: string;
4154
+ };
4155
+ /**
4156
+ * DateTime
4157
+ * @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).
4158
+ * @example 2016-05-24T08:38:08.699-04:00
4159
+ */
4160
+ expiration: string;
4161
+ /**
4162
+ * GeoCode
4163
+ * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
4164
+ */
4165
+ geoCode?: {
4166
+ /**
4167
+ * Latitude
4168
+ * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
4169
+ * @example +45.4215
4170
+ */
4171
+ latitude: string;
4172
+ /**
4173
+ * Longitude
4174
+ * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
4175
+ * @example +75.6972
4176
+ */
4177
+ longitude: string;
4178
+ };
4179
+ /**
4180
+ * IlpPacket
4181
+ * @description Information for recipient (transport layer information).
4182
+ * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
4183
+ */
4184
+ ilpPacket: string;
4185
+ /**
4186
+ * IlpCondition
4187
+ * @description Condition that must be attached to the transfer by the Payer.
4188
+ */
4189
+ condition: string;
4190
+ /**
4191
+ * ExtensionList
4192
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
4193
+ */
4194
+ extensionList?: {
4195
+ /** @description Number of Extension elements. */
4196
+ extension: {
4197
+ /**
4198
+ * ExtensionKey
4199
+ * @description Extension key.
4200
+ */
4201
+ key: string;
4202
+ /**
4203
+ * ExtensionValue
4204
+ * @description Extension value.
4205
+ */
4206
+ value: string;
4207
+ }[];
4208
+ };
4209
+ };
4210
+ /**
4211
+ * TransfersIDPutResponse
4212
+ * @description The object sent in the PUT /transfers/{ID} callback.
2808
4213
  */
2809
- statusCode?: string;
2810
- };
2811
- };
2812
- };
2813
- };
2814
- /** Bulk transaction request body. */
2815
- requestBody: {
2816
- content: {
2817
- "application/json": {
2818
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
2819
- bulkHomeTransactionID: string;
2820
- /** @description List of individual transfers in a bulk transfer with accept party information. */
2821
- individualTransferResults: {
2822
- /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
2823
- homeTransactionId: string;
4214
+ fulfil?: {
4215
+ /**
4216
+ * IlpFulfilment
4217
+ * @description Fulfilment that must be attached to the transfer by the Payee.
4218
+ * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
4219
+ */
4220
+ fulfilment?: string;
4221
+ /**
4222
+ * DateTime
4223
+ * @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).
4224
+ * @example 2016-05-24T08:38:08.699-04:00
4225
+ */
4226
+ completedTimestamp?: string;
4227
+ /**
4228
+ * TransferState
4229
+ * @description Below are the allowed values for the enumeration.
4230
+ * - RECEIVED - Next ledger has received the transfer.
4231
+ * - RESERVED - Next ledger has reserved the transfer.
4232
+ * - COMMITTED - Next ledger has successfully performed the transfer.
4233
+ * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
4234
+ * @example RESERVED
4235
+ * @enum {string}
4236
+ */
4237
+ transferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
4238
+ /**
4239
+ * ExtensionList
4240
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
4241
+ */
4242
+ extensionList?: {
4243
+ /** @description Number of Extension elements. */
4244
+ extension: {
4245
+ /**
4246
+ * ExtensionKey
4247
+ * @description Extension key.
4248
+ */
4249
+ key: string;
4250
+ /**
4251
+ * ExtensionValue
4252
+ * @description Extension value.
4253
+ */
4254
+ value: string;
4255
+ }[];
4256
+ };
4257
+ };
2824
4258
  /**
2825
- * CorrelationId
2826
- * @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 (‘-‘).
2827
- * @example b51ec534-ee48-4575-b6a9-ead2955b8069
4259
+ * ExtensionList
4260
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
2828
4261
  */
2829
- transactionId?: string;
4262
+ quoteExtensions?: {
4263
+ /** @description Number of Extension elements. */
4264
+ extension: {
4265
+ /**
4266
+ * ExtensionKey
4267
+ * @description Extension key.
4268
+ */
4269
+ key: string;
4270
+ /**
4271
+ * ExtensionValue
4272
+ * @description Extension value.
4273
+ */
4274
+ value: string;
4275
+ }[];
4276
+ };
4277
+ /**
4278
+ * ExtensionList
4279
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
4280
+ */
4281
+ transferExtensions?: {
4282
+ /** @description Number of Extension elements. */
4283
+ extension: {
4284
+ /**
4285
+ * ExtensionKey
4286
+ * @description Extension key.
4287
+ */
4288
+ key: string;
4289
+ /**
4290
+ * ExtensionValue
4291
+ * @description Extension value.
4292
+ */
4293
+ value: string;
4294
+ }[];
4295
+ };
4296
+ /** @description This object represents a Mojaloop API error received at any time during the transfer process */
4297
+ lastError?: {
4298
+ /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
4299
+ httpStatusCode?: number;
4300
+ /** @description If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object. */
4301
+ mojaloopError?: {
4302
+ /**
4303
+ * ErrorInformation
4304
+ * @description Data model for the complex type ErrorInformation.
4305
+ */
4306
+ errorInformation?: {
4307
+ /**
4308
+ * ErrorCode
4309
+ * @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.
4310
+ * @example 5100
4311
+ */
4312
+ errorCode: string;
4313
+ /**
4314
+ * ErrorDescription
4315
+ * @description Error description string.
4316
+ */
4317
+ errorDescription: string;
4318
+ /**
4319
+ * ExtensionList
4320
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
4321
+ */
4322
+ extensionList?: {
4323
+ /** @description Number of Extension elements. */
4324
+ extension: {
4325
+ /**
4326
+ * ExtensionKey
4327
+ * @description Extension key.
4328
+ */
4329
+ key: string;
4330
+ /**
4331
+ * ExtensionValue
4332
+ * @description Extension value.
4333
+ */
4334
+ value: string;
4335
+ }[];
4336
+ };
4337
+ };
4338
+ };
4339
+ };
2830
4340
  }[];
4341
+ /**
4342
+ * ExtensionList
4343
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
4344
+ */
4345
+ extensions?: {
4346
+ /** @description Number of Extension elements. */
4347
+ extension: {
4348
+ /**
4349
+ * ExtensionKey
4350
+ * @description Extension key.
4351
+ */
4352
+ key: string;
4353
+ /**
4354
+ * ExtensionValue
4355
+ * @description Extension value.
4356
+ */
4357
+ value: string;
4358
+ }[];
4359
+ };
2831
4360
  };
2832
4361
  };
2833
4362
  };
@@ -3739,7 +5268,7 @@ export interface operations {
3739
5268
  */
3740
5269
  completedTimestamp?: string;
3741
5270
  /**
3742
- * ilpFulfilment
5271
+ * IlpFulfilment
3743
5272
  * @description Fulfilment that must be attached to the transfer by the Payee.
3744
5273
  * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
3745
5274
  */
@@ -3835,27 +5364,47 @@ export interface operations {
3835
5364
  * @description Data model for the complex type Party.
3836
5365
  */
3837
5366
  payee: {
3838
- /**
3839
- * MerchantClassificationCode
3840
- * @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.
3841
- */
3842
- merchantClassificationCode?: string;
3843
- /**
3844
- * PartyName
3845
- * @description Name of the Party. Could be a real name or a nickname.
3846
- */
3847
- name?: string;
3848
5367
  /**
3849
5368
  * PartyIdInfo
3850
- * @description Data model for the complex type PartyIdInfo.
5369
+ * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
3851
5370
  */
3852
5371
  partyIdInfo: {
5372
+ /**
5373
+ * PartyIdType
5374
+ * @description Below are the allowed values for the enumeration.
5375
+ * - 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.
5376
+ * - 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).
5377
+ * - 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.
5378
+ * - 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.
5379
+ * - 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.
5380
+ * - 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.
5381
+ * - 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.
5382
+ * - 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.
5383
+ * @enum {string}
5384
+ */
5385
+ partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
5386
+ /**
5387
+ * PartyIdentifier
5388
+ * @description Identifier of the Party.
5389
+ * @example 16135551212
5390
+ */
5391
+ partyIdentifier: string;
5392
+ /**
5393
+ * PartySubIdOrType
5394
+ * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
5395
+ */
5396
+ partySubIdOrType?: string;
5397
+ /**
5398
+ * FspId
5399
+ * @description FSP identifier.
5400
+ */
5401
+ fspId?: string;
3853
5402
  /**
3854
5403
  * ExtensionList
3855
- * @description Data model for the complex type ExtensionList
5404
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
3856
5405
  */
3857
5406
  extensionList?: {
3858
- /** @description Number of Extension elements */
5407
+ /** @description Number of Extension elements. */
3859
5408
  extension: {
3860
5409
  /**
3861
5410
  * ExtensionKey
@@ -3869,70 +5418,17 @@ export interface operations {
3869
5418
  value: string;
3870
5419
  }[];
3871
5420
  };
3872
- /**
3873
- * FspId
3874
- * @description FSP identifier.
3875
- */
3876
- fspId?: string;
3877
- /**
3878
- * PartyIdType
3879
- * @description This is a variant based on FSPIOP `PartyIdType` specification.
3880
- * Main difference being the CONSENT and THIRD_PARTY_LINK enums.
3881
- *
3882
- * Below are the allowed values for the enumeration.
3883
- * - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
3884
- * Number, that is, the phone number) is used as reference to a participant.
3885
- * The MSISDN identifier should be in international format according to the
3886
- * [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en).
3887
- * Optionally, the MSISDN may be prefixed by a single plus sign, indicating the
3888
- * international prefix.
3889
- * - EMAIL - An email is used as reference to a
3890
- * participant. The format of the email should be according to the informational
3891
- * [RFC 3696](https://tools.ietf.org/html/rfc3696).
3892
- * - PERSONAL_ID - A personal identifier is used as reference to a participant.
3893
- * Examples of personal identification are passport number, birth certificate
3894
- * number, and national registration number. The identifier number is added in
3895
- * the PartyIdentifier element. The personal identifier type is added in the
3896
- * PartySubIdOrType element.
3897
- * - BUSINESS - A specific Business (for example, an organization or a company)
3898
- * is used as reference to a participant. The BUSINESS identifier can be in any
3899
- * format. To make a transaction connected to a specific username or bill number
3900
- * in a Business, the PartySubIdOrType element should be used.
3901
- * - DEVICE - A specific device (for example, a POS or ATM) ID connected to a
3902
- * specific business or organization is used as reference to a Party.
3903
- * For referencing a specific device under a specific business or organization,
3904
- * use the PartySubIdOrType element.
3905
- * - ACCOUNT_ID - A bank account number or FSP account ID should be used as
3906
- * reference to a participant. The ACCOUNT_ID identifier can be in any format,
3907
- * as formats can greatly differ depending on country and FSP.
3908
- * - IBAN - A bank account number or FSP account ID is used as reference to a
3909
- * participant. The IBAN identifier can consist of up to 34 alphanumeric
3910
- * characters and should be entered without whitespace.
3911
- * - ALIAS An alias is used as reference to a participant. The alias should be
3912
- * created in the FSP as an alternative reference to an account owner.
3913
- * Another example of an alias is a username in the FSP system.
3914
- * The ALIAS identifier can be in any format. It is also possible to use the
3915
- * PartySubIdOrType element for identifying an account under an Alias defined
3916
- * by the PartyIdentifier.
3917
- * - CONSENT - TBD
3918
- * - THIRD_PARTY_LINK - TBD
3919
- *
3920
- * @example PERSONAL_ID
3921
- * @enum {string}
3922
- */
3923
- partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS" | "CONSENT" | "THIRD_PARTY_LINK";
3924
- /**
3925
- * PartyIdentifier
3926
- * @description Identifier of the Party.
3927
- * @example 16135551212
3928
- */
3929
- partyIdentifier: string;
3930
- /**
3931
- * PartySubIdOrType
3932
- * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
3933
- */
3934
- partySubIdOrType?: string;
3935
5421
  };
5422
+ /**
5423
+ * MerchantClassificationCode
5424
+ * @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.
5425
+ */
5426
+ merchantClassificationCode?: string;
5427
+ /**
5428
+ * PartyName
5429
+ * @description Name of the Party. Could be a real name or a nickname.
5430
+ */
5431
+ name?: string;
3936
5432
  /**
3937
5433
  * PartyPersonalInfo
3938
5434
  * @description Data model for the complex type PartyPersonalInfo.
@@ -3943,34 +5439,24 @@ export interface operations {
3943
5439
  * @description Data model for the complex type PartyComplexName.
3944
5440
  */
3945
5441
  complexName?: {
3946
- /** @description Display name of the sender if known */
3947
- displayName?: string;
3948
5442
  /**
3949
5443
  * FirstName
3950
5444
  * @description First name of the Party (Name Type).
3951
5445
  * @example Henrik
3952
5446
  */
3953
5447
  firstName?: string;
3954
- /** @description The sub identifier string used to identify the sender */
3955
- idSubValue?: string;
3956
- /** @enum {string} */
3957
- idType?: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
3958
- /** @description The identifier string used to identify the sender */
3959
- idValue?: string;
3960
- /**
3961
- * LastName
3962
- * @description Last name of the Party (Name Type).
3963
- * @example Karlsson
3964
- */
3965
- lastName?: string;
3966
5448
  /**
3967
5449
  * MiddleName
3968
5450
  * @description Middle name of the Party (Name Type).
3969
5451
  * @example Johannes
3970
5452
  */
3971
5453
  middleName?: string;
3972
- /** @enum {string} */
3973
- type?: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
5454
+ /**
5455
+ * LastName
5456
+ * @description Last name of the Party (Name Type).
5457
+ * @example Karlsson
5458
+ */
5459
+ lastName?: string;
3974
5460
  };
3975
5461
  /**
3976
5462
  * DateofBirth (type Date)
@@ -3985,27 +5471,47 @@ export interface operations {
3985
5471
  * @description Data model for the complex type Party.
3986
5472
  */
3987
5473
  payer: {
3988
- /**
3989
- * MerchantClassificationCode
3990
- * @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.
3991
- */
3992
- merchantClassificationCode?: string;
3993
- /**
3994
- * PartyName
3995
- * @description Name of the Party. Could be a real name or a nickname.
3996
- */
3997
- name?: string;
3998
5474
  /**
3999
5475
  * PartyIdInfo
4000
- * @description Data model for the complex type PartyIdInfo.
5476
+ * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
4001
5477
  */
4002
5478
  partyIdInfo: {
5479
+ /**
5480
+ * PartyIdType
5481
+ * @description Below are the allowed values for the enumeration.
5482
+ * - 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.
5483
+ * - 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).
5484
+ * - 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.
5485
+ * - 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.
5486
+ * - 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.
5487
+ * - 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.
5488
+ * - 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.
5489
+ * - 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.
5490
+ * @enum {string}
5491
+ */
5492
+ partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
5493
+ /**
5494
+ * PartyIdentifier
5495
+ * @description Identifier of the Party.
5496
+ * @example 16135551212
5497
+ */
5498
+ partyIdentifier: string;
5499
+ /**
5500
+ * PartySubIdOrType
5501
+ * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
5502
+ */
5503
+ partySubIdOrType?: string;
5504
+ /**
5505
+ * FspId
5506
+ * @description FSP identifier.
5507
+ */
5508
+ fspId?: string;
4003
5509
  /**
4004
5510
  * ExtensionList
4005
- * @description Data model for the complex type ExtensionList
5511
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
4006
5512
  */
4007
5513
  extensionList?: {
4008
- /** @description Number of Extension elements */
5514
+ /** @description Number of Extension elements. */
4009
5515
  extension: {
4010
5516
  /**
4011
5517
  * ExtensionKey
@@ -4019,70 +5525,17 @@ export interface operations {
4019
5525
  value: string;
4020
5526
  }[];
4021
5527
  };
4022
- /**
4023
- * FspId
4024
- * @description FSP identifier.
4025
- */
4026
- fspId?: string;
4027
- /**
4028
- * PartyIdType
4029
- * @description This is a variant based on FSPIOP `PartyIdType` specification.
4030
- * Main difference being the CONSENT and THIRD_PARTY_LINK enums.
4031
- *
4032
- * Below are the allowed values for the enumeration.
4033
- * - MSISDN - An MSISDN (Mobile Station International Subscriber Directory
4034
- * Number, that is, the phone number) is used as reference to a participant.
4035
- * The MSISDN identifier should be in international format according to the
4036
- * [ITU-T E.164 standard](https://www.itu.int/rec/T-REC-E.164/en).
4037
- * Optionally, the MSISDN may be prefixed by a single plus sign, indicating the
4038
- * international prefix.
4039
- * - EMAIL - An email is used as reference to a
4040
- * participant. The format of the email should be according to the informational
4041
- * [RFC 3696](https://tools.ietf.org/html/rfc3696).
4042
- * - PERSONAL_ID - A personal identifier is used as reference to a participant.
4043
- * Examples of personal identification are passport number, birth certificate
4044
- * number, and national registration number. The identifier number is added in
4045
- * the PartyIdentifier element. The personal identifier type is added in the
4046
- * PartySubIdOrType element.
4047
- * - BUSINESS - A specific Business (for example, an organization or a company)
4048
- * is used as reference to a participant. The BUSINESS identifier can be in any
4049
- * format. To make a transaction connected to a specific username or bill number
4050
- * in a Business, the PartySubIdOrType element should be used.
4051
- * - DEVICE - A specific device (for example, a POS or ATM) ID connected to a
4052
- * specific business or organization is used as reference to a Party.
4053
- * For referencing a specific device under a specific business or organization,
4054
- * use the PartySubIdOrType element.
4055
- * - ACCOUNT_ID - A bank account number or FSP account ID should be used as
4056
- * reference to a participant. The ACCOUNT_ID identifier can be in any format,
4057
- * as formats can greatly differ depending on country and FSP.
4058
- * - IBAN - A bank account number or FSP account ID is used as reference to a
4059
- * participant. The IBAN identifier can consist of up to 34 alphanumeric
4060
- * characters and should be entered without whitespace.
4061
- * - ALIAS An alias is used as reference to a participant. The alias should be
4062
- * created in the FSP as an alternative reference to an account owner.
4063
- * Another example of an alias is a username in the FSP system.
4064
- * The ALIAS identifier can be in any format. It is also possible to use the
4065
- * PartySubIdOrType element for identifying an account under an Alias defined
4066
- * by the PartyIdentifier.
4067
- * - CONSENT - TBD
4068
- * - THIRD_PARTY_LINK - TBD
4069
- *
4070
- * @example PERSONAL_ID
4071
- * @enum {string}
4072
- */
4073
- partyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS" | "CONSENT" | "THIRD_PARTY_LINK";
4074
- /**
4075
- * PartyIdentifier
4076
- * @description Identifier of the Party.
4077
- * @example 16135551212
4078
- */
4079
- partyIdentifier: string;
4080
- /**
4081
- * PartySubIdOrType
4082
- * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
4083
- */
4084
- partySubIdOrType?: string;
4085
5528
  };
5529
+ /**
5530
+ * MerchantClassificationCode
5531
+ * @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.
5532
+ */
5533
+ merchantClassificationCode?: string;
5534
+ /**
5535
+ * PartyName
5536
+ * @description Name of the Party. Could be a real name or a nickname.
5537
+ */
5538
+ name?: string;
4086
5539
  /**
4087
5540
  * PartyPersonalInfo
4088
5541
  * @description Data model for the complex type PartyPersonalInfo.
@@ -4093,34 +5546,24 @@ export interface operations {
4093
5546
  * @description Data model for the complex type PartyComplexName.
4094
5547
  */
4095
5548
  complexName?: {
4096
- /** @description Display name of the sender if known */
4097
- displayName?: string;
4098
5549
  /**
4099
5550
  * FirstName
4100
5551
  * @description First name of the Party (Name Type).
4101
5552
  * @example Henrik
4102
5553
  */
4103
5554
  firstName?: string;
4104
- /** @description The sub identifier string used to identify the sender */
4105
- idSubValue?: string;
4106
- /** @enum {string} */
4107
- idType?: "MSISDN" | "ACCOUNT_NO" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
4108
- /** @description The identifier string used to identify the sender */
4109
- idValue?: string;
4110
- /**
4111
- * LastName
4112
- * @description Last name of the Party (Name Type).
4113
- * @example Karlsson
4114
- */
4115
- lastName?: string;
4116
5555
  /**
4117
5556
  * MiddleName
4118
5557
  * @description Middle name of the Party (Name Type).
4119
5558
  * @example Johannes
4120
5559
  */
4121
5560
  middleName?: string;
4122
- /** @enum {string} */
4123
- type?: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
5561
+ /**
5562
+ * LastName
5563
+ * @description Last name of the Party (Name Type).
5564
+ * @example Karlsson
5565
+ */
5566
+ lastName?: string;
4124
5567
  };
4125
5568
  /**
4126
5569
  * DateofBirth (type Date)
@@ -4423,7 +5866,7 @@ export interface operations {
4423
5866
  };
4424
5867
  /** @description An ISO-8601 formatted timestamp. */
4425
5868
  initiatedTimestamp?: string;
4426
- /** @description This object represents a Mojaloop API error received at any time during the transfer process. */
5869
+ /** @description This object represents a Mojaloop API error received at any time during the transfer process */
4427
5870
  lastError?: {
4428
5871
  /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
4429
5872
  httpStatusCode?: number;
@@ -4431,12 +5874,13 @@ export interface operations {
4431
5874
  mojaloopError?: {
4432
5875
  /**
4433
5876
  * ErrorInformation
4434
- * @description A Mojaloop API error information construct.
5877
+ * @description Data model for the complex type ErrorInformation.
4435
5878
  */
4436
5879
  errorInformation?: {
4437
5880
  /**
4438
5881
  * ErrorCode
4439
- * @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) represents the specific error.
5882
+ * @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.
5883
+ * @example 5100
4440
5884
  */
4441
5885
  errorCode: string;
4442
5886
  /**
@@ -4444,12 +5888,23 @@ export interface operations {
4444
5888
  * @description Error description string.
4445
5889
  */
4446
5890
  errorDescription: string;
4447
- /** @description Data model for the complex type ExtensionList. */
5891
+ /**
5892
+ * ExtensionList
5893
+ * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
5894
+ */
4448
5895
  extensionList?: {
4449
5896
  /** @description Number of Extension elements. */
4450
5897
  extension: {
4451
- key?: string;
4452
- value?: string;
5898
+ /**
5899
+ * ExtensionKey
5900
+ * @description Extension key.
5901
+ */
5902
+ key: string;
5903
+ /**
5904
+ * ExtensionValue
5905
+ * @description Extension value.
5906
+ */
5907
+ value: string;
4453
5908
  }[];
4454
5909
  };
4455
5910
  };