@mojaloop/api-snippets 17.7.5 → 17.7.7

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.
Files changed (7) hide show
  1. package/CHANGELOG.md +14 -0
  2. package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +15 -3
  3. package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +830 -658
  4. package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.d.ts +5 -1
  5. package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.d.ts +416 -270
  6. package/package.json +8 -8
  7. package/sdk-scheme-adapter/v2_1_0/components/schemas/transferResponse.yaml +15 -3
package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json CHANGED
@@ -26506,361 +26506,447 @@
26506
26506
  },
26507
26507
  "getPartiesResponse": {
26508
26508
  "type": "object",
26509
- "required": [
26510
- "body"
26511
- ],
26512
26509
  "properties": {
26513
26510
  "body": {
26514
- "title": "Party",
26515
- "type": "object",
26516
- "description": "Data model for the complex type Party.",
26517
- "properties": {
26518
- "partyIdInfo": {
26519
- "title": "PartyIdInfo",
26511
+ "oneOf": [
26512
+ {
26520
26513
  "type": "object",
26521
- "description": "Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1",
26522
26514
  "properties": {
26523
- "partyIdType": {
26524
- "title": "PartyIdType",
26525
- "type": "string",
26526
- "enum": [
26527
- "MSISDN",
26528
- "EMAIL",
26529
- "PERSONAL_ID",
26530
- "BUSINESS",
26531
- "DEVICE",
26532
- "ACCOUNT_ID",
26533
- "IBAN",
26534
- "ALIAS"
26535
- ],
26536
- "description": "Below are the allowed values for the enumeration.\n- 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.\n- 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).\n- 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.\n- 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.\n- 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.\n- 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.\n- 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.\n- 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."
26537
- },
26538
- "partyIdentifier": {
26539
- "title": "PartyIdentifier",
26540
- "type": "string",
26541
- "minLength": 1,
26542
- "maxLength": 128,
26543
- "description": "Identifier of the Party.",
26544
- "example": "16135551212"
26545
- },
26546
- "partySubIdOrType": {
26547
- "title": "PartySubIdOrType",
26548
- "type": "string",
26549
- "minLength": 1,
26550
- "maxLength": 128,
26551
- "description": "Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType."
26552
- },
26553
- "fspId": {
26554
- "title": "FspId",
26555
- "type": "string",
26556
- "minLength": 1,
26557
- "maxLength": 32,
26558
- "description": "FSP identifier."
26559
- },
26560
- "extensionList": {
26561
- "title": "ExtensionList",
26515
+ "party": {
26516
+ "title": "Party",
26562
26517
  "type": "object",
26563
- "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
26518
+ "description": "Data model for the complex type Party.",
26564
26519
  "properties": {
26565
- "extension": {
26566
- "type": "array",
26567
- "items": {
26568
- "title": "Extension",
26569
- "type": "object",
26570
- "description": "Data model for the complex type Extension.",
26571
- "properties": {
26572
- "key": {
26573
- "title": "ExtensionKey",
26574
- "type": "string",
26575
- "minLength": 1,
26576
- "maxLength": 32,
26577
- "description": "Extension key."
26578
- },
26579
- "value": {
26580
- "title": "ExtensionValue",
26581
- "type": "string",
26582
- "minLength": 1,
26583
- "maxLength": 128,
26584
- "description": "Extension value."
26585
- }
26520
+ "partyIdInfo": {
26521
+ "title": "PartyIdInfo",
26522
+ "type": "object",
26523
+ "description": "Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1",
26524
+ "properties": {
26525
+ "partyIdType": {
26526
+ "title": "PartyIdType",
26527
+ "type": "string",
26528
+ "enum": [
26529
+ "MSISDN",
26530
+ "EMAIL",
26531
+ "PERSONAL_ID",
26532
+ "BUSINESS",
26533
+ "DEVICE",
26534
+ "ACCOUNT_ID",
26535
+ "IBAN",
26536
+ "ALIAS"
26537
+ ],
26538
+ "description": "Below are the allowed values for the enumeration.\n- 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.\n- 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).\n- 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.\n- 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.\n- 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.\n- 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.\n- 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.\n- 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."
26586
26539
  },
26587
- "required": [
26588
- "key",
26589
- "value"
26590
- ]
26540
+ "partyIdentifier": {
26541
+ "title": "PartyIdentifier",
26542
+ "type": "string",
26543
+ "minLength": 1,
26544
+ "maxLength": 128,
26545
+ "description": "Identifier of the Party.",
26546
+ "example": "16135551212"
26547
+ },
26548
+ "partySubIdOrType": {
26549
+ "title": "PartySubIdOrType",
26550
+ "type": "string",
26551
+ "minLength": 1,
26552
+ "maxLength": 128,
26553
+ "description": "Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType."
26554
+ },
26555
+ "fspId": {
26556
+ "title": "FspId",
26557
+ "type": "string",
26558
+ "minLength": 1,
26559
+ "maxLength": 32,
26560
+ "description": "FSP identifier."
26561
+ },
26562
+ "extensionList": {
26563
+ "title": "ExtensionList",
26564
+ "type": "object",
26565
+ "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
26566
+ "properties": {
26567
+ "extension": {
26568
+ "type": "array",
26569
+ "items": {
26570
+ "title": "Extension",
26571
+ "type": "object",
26572
+ "description": "Data model for the complex type Extension.",
26573
+ "properties": {
26574
+ "key": {
26575
+ "title": "ExtensionKey",
26576
+ "type": "string",
26577
+ "minLength": 1,
26578
+ "maxLength": 32,
26579
+ "description": "Extension key."
26580
+ },
26581
+ "value": {
26582
+ "title": "ExtensionValue",
26583
+ "type": "string",
26584
+ "minLength": 1,
26585
+ "maxLength": 128,
26586
+ "description": "Extension value."
26587
+ }
26588
+ },
26589
+ "required": [
26590
+ "key",
26591
+ "value"
26592
+ ]
26593
+ },
26594
+ "minItems": 1,
26595
+ "maxItems": 16,
26596
+ "description": "Number of Extension elements."
26597
+ }
26598
+ },
26599
+ "required": [
26600
+ "extension"
26601
+ ]
26602
+ }
26591
26603
  },
26592
- "minItems": 1,
26593
- "maxItems": 16,
26594
- "description": "Number of Extension elements."
26595
- }
26596
- },
26597
- "required": [
26598
- "extension"
26599
- ]
26600
- }
26601
- },
26602
- "required": [
26603
- "partyIdType",
26604
- "partyIdentifier"
26605
- ]
26606
- },
26607
- "merchantClassificationCode": {
26608
- "title": "MerchantClassificationCode",
26609
- "type": "string",
26610
- "pattern": "^[\\d]{1,4}$",
26611
- "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."
26612
- },
26613
- "name": {
26614
- "title": "PartyName",
26615
- "type": "string",
26616
- "minLength": 1,
26617
- "maxLength": 128,
26618
- "description": "Name of the Party. Could be a real name or a nickname."
26619
- },
26620
- "personalInfo": {
26621
- "title": "PartyPersonalInfo",
26622
- "type": "object",
26623
- "description": "Data model for the complex type PartyPersonalInfo.",
26624
- "properties": {
26625
- "complexName": {
26626
- "title": "PartyComplexName",
26627
- "type": "object",
26628
- "description": "Data model for the complex type PartyComplexName.",
26629
- "properties": {
26630
- "firstName": {
26631
- "title": "FirstName",
26632
- "type": "string",
26633
- "minLength": 1,
26634
- "maxLength": 128,
26635
- "pattern": "^(?!\\s*$)[\\p{L}\\p{gc=Mark}\\p{digit}\\p{gc=Connector_Punctuation}\\p{Join_Control} .,''-]{1,128}$",
26636
- "description": "First name of the Party (Name Type).",
26637
- "example": "Henrik"
26604
+ "required": [
26605
+ "partyIdType",
26606
+ "partyIdentifier"
26607
+ ]
26638
26608
  },
26639
- "middleName": {
26640
- "title": "MiddleName",
26609
+ "merchantClassificationCode": {
26610
+ "title": "MerchantClassificationCode",
26641
26611
  "type": "string",
26642
- "minLength": 1,
26643
- "maxLength": 128,
26644
- "pattern": "^(?!\\s*$)[\\p{L}\\p{gc=Mark}\\p{digit}\\p{gc=Connector_Punctuation}\\p{Join_Control} .,''-]{1,128}$",
26645
- "description": "Middle name of the Party (Name Type).",
26646
- "example": "Johannes"
26612
+ "pattern": "^[\\d]{1,4}$",
26613
+ "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."
26647
26614
  },
26648
- "lastName": {
26649
- "title": "LastName",
26615
+ "name": {
26616
+ "title": "PartyName",
26650
26617
  "type": "string",
26651
26618
  "minLength": 1,
26652
26619
  "maxLength": 128,
26653
- "pattern": "^(?!\\s*$)[\\p{L}\\p{gc=Mark}\\p{digit}\\p{gc=Connector_Punctuation}\\p{Join_Control} .,''-]{1,128}$",
26654
- "description": "Last name of the Party (Name Type).",
26655
- "example": "Karlsson"
26656
- }
26657
- }
26658
- },
26659
- "dateOfBirth": {
26660
- "title": "DateofBirth (type Date)",
26661
- "type": "string",
26662
- "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$",
26663
- "description": "Date of Birth of the Party.",
26664
- "example": "1966-06-16"
26665
- },
26666
- "kycInformation": {
26667
- "title": "KYCInformation",
26668
- "type": "string",
26669
- "minLength": 1,
26670
- "maxLength": 2048,
26671
- "description": "KYC information for the party in a form mandated by an individual scheme.",
26672
- "example": "{\n \"metadata\": {\n \"format\": \"JSON\",\n \"version\": \"1.0\",\n \"description\": \"Data containing KYC Information\"\n },\n \"data\": {\n \"name\": \"John Doe\",\n \"dob\": \"1980-05-15\",\n \"gender\": \"Male\",\n \"address\": \"123 Main Street, Anytown, USA\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"+1 555-123-4567\",\n \"nationality\": \"US\",\n \"passport_number\": \"AB1234567\",\n \"issue_date\": \"2010-02-20\",\n \"expiry_date\": \"2025-02-20\",\n \"bank_account_number\": \"1234567890\",\n \"bank_name\": \"Example Bank\",\n \"employer\": \"ABC Company\",\n \"occupation\": \"Software Engineer\",\n \"income\": \"$80,000 per year\",\n \"marital_status\": \"Single\",\n \"dependents\": 0,\n \"risk_level\": \"Low\"\n }\n}"
26673
- }
26674
- }
26675
- },
26676
- "supportedCurrencies": {
26677
- "type": "array",
26678
- "description": "Currencies in which the party can receive funds.",
26679
- "items": {
26680
- "title": "Currency",
26681
- "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.",
26682
- "type": "string",
26683
- "minLength": 3,
26684
- "maxLength": 3,
26685
- "enum": [
26686
- "AED",
26687
- "AFN",
26688
- "ALL",
26689
- "AMD",
26690
- "ANG",
26691
- "AOA",
26692
- "ARS",
26693
- "AUD",
26694
- "AWG",
26695
- "AZN",
26696
- "BAM",
26697
- "BBD",
26698
- "BDT",
26699
- "BGN",
26700
- "BHD",
26701
- "BIF",
26702
- "BMD",
26703
- "BND",
26704
- "BOB",
26705
- "BRL",
26706
- "BSD",
26707
- "BTN",
26708
- "BWP",
26709
- "BYN",
26710
- "BZD",
26711
- "CAD",
26712
- "CDF",
26713
- "CHF",
26714
- "CLP",
26715
- "CNY",
26716
- "COP",
26717
- "CRC",
26718
- "CUC",
26719
- "CUP",
26720
- "CVE",
26721
- "CZK",
26722
- "DJF",
26723
- "DKK",
26724
- "DOP",
26725
- "DZD",
26726
- "EGP",
26727
- "ERN",
26728
- "ETB",
26729
- "EUR",
26730
- "FJD",
26731
- "FKP",
26732
- "GBP",
26733
- "GEL",
26734
- "GGP",
26735
- "GHS",
26736
- "GIP",
26737
- "GMD",
26738
- "GNF",
26739
- "GTQ",
26740
- "GYD",
26741
- "HKD",
26742
- "HNL",
26743
- "HRK",
26744
- "HTG",
26745
- "HUF",
26746
- "IDR",
26747
- "ILS",
26748
- "IMP",
26749
- "INR",
26750
- "IQD",
26751
- "IRR",
26752
- "ISK",
26753
- "JEP",
26754
- "JMD",
26755
- "JOD",
26756
- "JPY",
26757
- "KES",
26758
- "KGS",
26759
- "KHR",
26760
- "KMF",
26761
- "KPW",
26762
- "KRW",
26763
- "KWD",
26764
- "KYD",
26765
- "KZT",
26766
- "LAK",
26767
- "LBP",
26768
- "LKR",
26769
- "LRD",
26770
- "LSL",
26771
- "LYD",
26772
- "MAD",
26773
- "MDL",
26774
- "MGA",
26775
- "MKD",
26776
- "MMK",
26777
- "MNT",
26778
- "MOP",
26779
- "MRO",
26780
- "MUR",
26781
- "MVR",
26782
- "MWK",
26783
- "MXN",
26784
- "MYR",
26785
- "MZN",
26786
- "NAD",
26787
- "NGN",
26788
- "NIO",
26789
- "NOK",
26790
- "NPR",
26791
- "NZD",
26792
- "OMR",
26793
- "PAB",
26794
- "PEN",
26795
- "PGK",
26796
- "PHP",
26797
- "PKR",
26798
- "PLN",
26799
- "PYG",
26800
- "QAR",
26801
- "RON",
26802
- "RSD",
26803
- "RUB",
26804
- "RWF",
26805
- "SAR",
26806
- "SBD",
26807
- "SCR",
26808
- "SDG",
26809
- "SEK",
26810
- "SGD",
26811
- "SHP",
26812
- "SLL",
26813
- "SOS",
26814
- "SPL",
26815
- "SRD",
26816
- "STD",
26817
- "SVC",
26818
- "SYP",
26819
- "SZL",
26820
- "THB",
26821
- "TJS",
26822
- "TMT",
26823
- "TND",
26824
- "TOP",
26825
- "TRY",
26826
- "TTD",
26827
- "TVD",
26828
- "TWD",
26829
- "TZS",
26830
- "UAH",
26831
- "UGX",
26832
- "USD",
26833
- "UYU",
26834
- "UZS",
26835
- "VEF",
26836
- "VND",
26837
- "VUV",
26838
- "WST",
26839
- "XAF",
26840
- "XCD",
26841
- "XDR",
26842
- "XOF",
26843
- "XPF",
26844
- "XTS",
26845
- "XXX",
26846
- "YER",
26847
- "ZAR",
26848
- "ZMW",
26849
- "ZWD"
26850
- ]
26620
+ "description": "Name of the Party. Could be a real name or a nickname."
26621
+ },
26622
+ "personalInfo": {
26623
+ "title": "PartyPersonalInfo",
26624
+ "type": "object",
26625
+ "description": "Data model for the complex type PartyPersonalInfo.",
26626
+ "properties": {
26627
+ "complexName": {
26628
+ "title": "PartyComplexName",
26629
+ "type": "object",
26630
+ "description": "Data model for the complex type PartyComplexName.",
26631
+ "properties": {
26632
+ "firstName": {
26633
+ "title": "FirstName",
26634
+ "type": "string",
26635
+ "minLength": 1,
26636
+ "maxLength": 128,
26637
+ "pattern": "^(?!\\s*$)[\\p{L}\\p{gc=Mark}\\p{digit}\\p{gc=Connector_Punctuation}\\p{Join_Control} .,''-]{1,128}$",
26638
+ "description": "First name of the Party (Name Type).",
26639
+ "example": "Henrik"
26640
+ },
26641
+ "middleName": {
26642
+ "title": "MiddleName",
26643
+ "type": "string",
26644
+ "minLength": 1,
26645
+ "maxLength": 128,
26646
+ "pattern": "^(?!\\s*$)[\\p{L}\\p{gc=Mark}\\p{digit}\\p{gc=Connector_Punctuation}\\p{Join_Control} .,''-]{1,128}$",
26647
+ "description": "Middle name of the Party (Name Type).",
26648
+ "example": "Johannes"
26649
+ },
26650
+ "lastName": {
26651
+ "title": "LastName",
26652
+ "type": "string",
26653
+ "minLength": 1,
26654
+ "maxLength": 128,
26655
+ "pattern": "^(?!\\s*$)[\\p{L}\\p{gc=Mark}\\p{digit}\\p{gc=Connector_Punctuation}\\p{Join_Control} .,''-]{1,128}$",
26656
+ "description": "Last name of the Party (Name Type).",
26657
+ "example": "Karlsson"
26658
+ }
26659
+ }
26660
+ },
26661
+ "dateOfBirth": {
26662
+ "title": "DateofBirth (type Date)",
26663
+ "type": "string",
26664
+ "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$",
26665
+ "description": "Date of Birth of the Party.",
26666
+ "example": "1966-06-16"
26667
+ },
26668
+ "kycInformation": {
26669
+ "title": "KYCInformation",
26670
+ "type": "string",
26671
+ "minLength": 1,
26672
+ "maxLength": 2048,
26673
+ "description": "KYC information for the party in a form mandated by an individual scheme.",
26674
+ "example": "{\n \"metadata\": {\n \"format\": \"JSON\",\n \"version\": \"1.0\",\n \"description\": \"Data containing KYC Information\"\n },\n \"data\": {\n \"name\": \"John Doe\",\n \"dob\": \"1980-05-15\",\n \"gender\": \"Male\",\n \"address\": \"123 Main Street, Anytown, USA\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"+1 555-123-4567\",\n \"nationality\": \"US\",\n \"passport_number\": \"AB1234567\",\n \"issue_date\": \"2010-02-20\",\n \"expiry_date\": \"2025-02-20\",\n \"bank_account_number\": \"1234567890\",\n \"bank_name\": \"Example Bank\",\n \"employer\": \"ABC Company\",\n \"occupation\": \"Software Engineer\",\n \"income\": \"$80,000 per year\",\n \"marital_status\": \"Single\",\n \"dependents\": 0,\n \"risk_level\": \"Low\"\n }\n}"
26675
+ }
26676
+ }
26677
+ },
26678
+ "supportedCurrencies": {
26679
+ "type": "array",
26680
+ "description": "Currencies in which the party can receive funds.",
26681
+ "items": {
26682
+ "title": "Currency",
26683
+ "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.",
26684
+ "type": "string",
26685
+ "minLength": 3,
26686
+ "maxLength": 3,
26687
+ "enum": [
26688
+ "AED",
26689
+ "AFN",
26690
+ "ALL",
26691
+ "AMD",
26692
+ "ANG",
26693
+ "AOA",
26694
+ "ARS",
26695
+ "AUD",
26696
+ "AWG",
26697
+ "AZN",
26698
+ "BAM",
26699
+ "BBD",
26700
+ "BDT",
26701
+ "BGN",
26702
+ "BHD",
26703
+ "BIF",
26704
+ "BMD",
26705
+ "BND",
26706
+ "BOB",
26707
+ "BRL",
26708
+ "BSD",
26709
+ "BTN",
26710
+ "BWP",
26711
+ "BYN",
26712
+ "BZD",
26713
+ "CAD",
26714
+ "CDF",
26715
+ "CHF",
26716
+ "CLP",
26717
+ "CNY",
26718
+ "COP",
26719
+ "CRC",
26720
+ "CUC",
26721
+ "CUP",
26722
+ "CVE",
26723
+ "CZK",
26724
+ "DJF",
26725
+ "DKK",
26726
+ "DOP",
26727
+ "DZD",
26728
+ "EGP",
26729
+ "ERN",
26730
+ "ETB",
26731
+ "EUR",
26732
+ "FJD",
26733
+ "FKP",
26734
+ "GBP",
26735
+ "GEL",
26736
+ "GGP",
26737
+ "GHS",
26738
+ "GIP",
26739
+ "GMD",
26740
+ "GNF",
26741
+ "GTQ",
26742
+ "GYD",
26743
+ "HKD",
26744
+ "HNL",
26745
+ "HRK",
26746
+ "HTG",
26747
+ "HUF",
26748
+ "IDR",
26749
+ "ILS",
26750
+ "IMP",
26751
+ "INR",
26752
+ "IQD",
26753
+ "IRR",
26754
+ "ISK",
26755
+ "JEP",
26756
+ "JMD",
26757
+ "JOD",
26758
+ "JPY",
26759
+ "KES",
26760
+ "KGS",
26761
+ "KHR",
26762
+ "KMF",
26763
+ "KPW",
26764
+ "KRW",
26765
+ "KWD",
26766
+ "KYD",
26767
+ "KZT",
26768
+ "LAK",
26769
+ "LBP",
26770
+ "LKR",
26771
+ "LRD",
26772
+ "LSL",
26773
+ "LYD",
26774
+ "MAD",
26775
+ "MDL",
26776
+ "MGA",
26777
+ "MKD",
26778
+ "MMK",
26779
+ "MNT",
26780
+ "MOP",
26781
+ "MRO",
26782
+ "MUR",
26783
+ "MVR",
26784
+ "MWK",
26785
+ "MXN",
26786
+ "MYR",
26787
+ "MZN",
26788
+ "NAD",
26789
+ "NGN",
26790
+ "NIO",
26791
+ "NOK",
26792
+ "NPR",
26793
+ "NZD",
26794
+ "OMR",
26795
+ "PAB",
26796
+ "PEN",
26797
+ "PGK",
26798
+ "PHP",
26799
+ "PKR",
26800
+ "PLN",
26801
+ "PYG",
26802
+ "QAR",
26803
+ "RON",
26804
+ "RSD",
26805
+ "RUB",
26806
+ "RWF",
26807
+ "SAR",
26808
+ "SBD",
26809
+ "SCR",
26810
+ "SDG",
26811
+ "SEK",
26812
+ "SGD",
26813
+ "SHP",
26814
+ "SLL",
26815
+ "SOS",
26816
+ "SPL",
26817
+ "SRD",
26818
+ "STD",
26819
+ "SVC",
26820
+ "SYP",
26821
+ "SZL",
26822
+ "THB",
26823
+ "TJS",
26824
+ "TMT",
26825
+ "TND",
26826
+ "TOP",
26827
+ "TRY",
26828
+ "TTD",
26829
+ "TVD",
26830
+ "TWD",
26831
+ "TZS",
26832
+ "UAH",
26833
+ "UGX",
26834
+ "USD",
26835
+ "UYU",
26836
+ "UZS",
26837
+ "VEF",
26838
+ "VND",
26839
+ "VUV",
26840
+ "WST",
26841
+ "XAF",
26842
+ "XCD",
26843
+ "XDR",
26844
+ "XOF",
26845
+ "XPF",
26846
+ "XTS",
26847
+ "XXX",
26848
+ "YER",
26849
+ "ZAR",
26850
+ "ZMW",
26851
+ "ZWD"
26852
+ ]
26853
+ },
26854
+ "minItems": 0,
26855
+ "maxItems": 16
26856
+ }
26857
+ },
26858
+ "required": [
26859
+ "partyIdInfo"
26860
+ ]
26861
+ }
26862
+ },
26863
+ "required": [
26864
+ "party"
26865
+ ]
26866
+ },
26867
+ {
26868
+ "type": "object",
26869
+ "properties": {
26870
+ "errorInformation": {
26871
+ "title": "ErrorInformation",
26872
+ "type": "object",
26873
+ "description": "Data model for the complex type ErrorInformation.",
26874
+ "properties": {
26875
+ "errorCode": {
26876
+ "title": "ErrorCode",
26877
+ "type": "string",
26878
+ "pattern": "^[1-9]\\d{3}$",
26879
+ "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.",
26880
+ "example": "5100"
26881
+ },
26882
+ "errorDescription": {
26883
+ "title": "ErrorDescription",
26884
+ "type": "string",
26885
+ "minLength": 1,
26886
+ "maxLength": 128,
26887
+ "description": "Error description string."
26888
+ },
26889
+ "extensionList": {
26890
+ "title": "ExtensionList",
26891
+ "type": "object",
26892
+ "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
26893
+ "properties": {
26894
+ "extension": {
26895
+ "type": "array",
26896
+ "items": {
26897
+ "title": "Extension",
26898
+ "type": "object",
26899
+ "description": "Data model for the complex type Extension.",
26900
+ "properties": {
26901
+ "key": {
26902
+ "title": "ExtensionKey",
26903
+ "type": "string",
26904
+ "minLength": 1,
26905
+ "maxLength": 32,
26906
+ "description": "Extension key."
26907
+ },
26908
+ "value": {
26909
+ "title": "ExtensionValue",
26910
+ "type": "string",
26911
+ "minLength": 1,
26912
+ "maxLength": 128,
26913
+ "description": "Extension value."
26914
+ }
26915
+ },
26916
+ "required": [
26917
+ "key",
26918
+ "value"
26919
+ ]
26920
+ },
26921
+ "minItems": 1,
26922
+ "maxItems": 16,
26923
+ "description": "Number of Extension elements."
26924
+ }
26925
+ },
26926
+ "required": [
26927
+ "extension"
26928
+ ]
26929
+ }
26930
+ },
26931
+ "required": [
26932
+ "errorCode",
26933
+ "errorDescription"
26934
+ ]
26935
+ }
26851
26936
  },
26852
- "minItems": 0,
26853
- "maxItems": 16
26937
+ "required": [
26938
+ "errorInformation"
26939
+ ]
26854
26940
  }
26855
- },
26856
- "required": [
26857
- "partyIdInfo"
26858
26941
  ]
26859
26942
  },
26860
26943
  "headers": {
26861
26944
  "type": "object"
26862
26945
  }
26863
- }
26946
+ },
26947
+ "required": [
26948
+ "body"
26949
+ ]
26864
26950
  },
26865
26951
  "quoteResponse": {
26866
26952
  "type": "object",
@@ -29857,361 +29943,447 @@
29857
29943
  },
29858
29944
  "getPartiesResponse": {
29859
29945
  "type": "object",
29860
- "required": [
29861
- "body"
29862
- ],
29863
29946
  "properties": {
29864
29947
  "body": {
29865
- "title": "Party",
29866
- "type": "object",
29867
- "description": "Data model for the complex type Party.",
29868
- "properties": {
29869
- "partyIdInfo": {
29870
- "title": "PartyIdInfo",
29948
+ "oneOf": [
29949
+ {
29871
29950
  "type": "object",
29872
- "description": "Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1",
29873
29951
  "properties": {
29874
- "partyIdType": {
29875
- "title": "PartyIdType",
29876
- "type": "string",
29877
- "enum": [
29878
- "MSISDN",
29879
- "EMAIL",
29880
- "PERSONAL_ID",
29881
- "BUSINESS",
29882
- "DEVICE",
29883
- "ACCOUNT_ID",
29884
- "IBAN",
29885
- "ALIAS"
29886
- ],
29887
- "description": "Below are the allowed values for the enumeration.\n- 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.\n- 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).\n- 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.\n- 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.\n- 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.\n- 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.\n- 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.\n- 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."
29888
- },
29889
- "partyIdentifier": {
29890
- "title": "PartyIdentifier",
29891
- "type": "string",
29892
- "minLength": 1,
29893
- "maxLength": 128,
29894
- "description": "Identifier of the Party.",
29895
- "example": "16135551212"
29896
- },
29897
- "partySubIdOrType": {
29898
- "title": "PartySubIdOrType",
29899
- "type": "string",
29900
- "minLength": 1,
29901
- "maxLength": 128,
29902
- "description": "Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType."
29903
- },
29904
- "fspId": {
29905
- "title": "FspId",
29906
- "type": "string",
29907
- "minLength": 1,
29908
- "maxLength": 32,
29909
- "description": "FSP identifier."
29910
- },
29911
- "extensionList": {
29912
- "title": "ExtensionList",
29952
+ "party": {
29953
+ "title": "Party",
29913
29954
  "type": "object",
29914
- "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
29955
+ "description": "Data model for the complex type Party.",
29915
29956
  "properties": {
29916
- "extension": {
29917
- "type": "array",
29918
- "items": {
29919
- "title": "Extension",
29920
- "type": "object",
29921
- "description": "Data model for the complex type Extension.",
29922
- "properties": {
29923
- "key": {
29924
- "title": "ExtensionKey",
29925
- "type": "string",
29926
- "minLength": 1,
29927
- "maxLength": 32,
29928
- "description": "Extension key."
29957
+ "partyIdInfo": {
29958
+ "title": "PartyIdInfo",
29959
+ "type": "object",
29960
+ "description": "Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1",
29961
+ "properties": {
29962
+ "partyIdType": {
29963
+ "title": "PartyIdType",
29964
+ "type": "string",
29965
+ "enum": [
29966
+ "MSISDN",
29967
+ "EMAIL",
29968
+ "PERSONAL_ID",
29969
+ "BUSINESS",
29970
+ "DEVICE",
29971
+ "ACCOUNT_ID",
29972
+ "IBAN",
29973
+ "ALIAS"
29974
+ ],
29975
+ "description": "Below are the allowed values for the enumeration.\n- 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.\n- 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).\n- 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.\n- 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.\n- 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.\n- 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.\n- 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.\n- 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."
29976
+ },
29977
+ "partyIdentifier": {
29978
+ "title": "PartyIdentifier",
29979
+ "type": "string",
29980
+ "minLength": 1,
29981
+ "maxLength": 128,
29982
+ "description": "Identifier of the Party.",
29983
+ "example": "16135551212"
29984
+ },
29985
+ "partySubIdOrType": {
29986
+ "title": "PartySubIdOrType",
29987
+ "type": "string",
29988
+ "minLength": 1,
29989
+ "maxLength": 128,
29990
+ "description": "Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType."
29991
+ },
29992
+ "fspId": {
29993
+ "title": "FspId",
29994
+ "type": "string",
29995
+ "minLength": 1,
29996
+ "maxLength": 32,
29997
+ "description": "FSP identifier."
29998
+ },
29999
+ "extensionList": {
30000
+ "title": "ExtensionList",
30001
+ "type": "object",
30002
+ "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
30003
+ "properties": {
30004
+ "extension": {
30005
+ "type": "array",
30006
+ "items": {
30007
+ "title": "Extension",
30008
+ "type": "object",
30009
+ "description": "Data model for the complex type Extension.",
30010
+ "properties": {
30011
+ "key": {
30012
+ "title": "ExtensionKey",
30013
+ "type": "string",
30014
+ "minLength": 1,
30015
+ "maxLength": 32,
30016
+ "description": "Extension key."
30017
+ },
30018
+ "value": {
30019
+ "title": "ExtensionValue",
30020
+ "type": "string",
30021
+ "minLength": 1,
30022
+ "maxLength": 128,
30023
+ "description": "Extension value."
30024
+ }
30025
+ },
30026
+ "required": [
30027
+ "key",
30028
+ "value"
30029
+ ]
30030
+ },
30031
+ "minItems": 1,
30032
+ "maxItems": 16,
30033
+ "description": "Number of Extension elements."
30034
+ }
29929
30035
  },
29930
- "value": {
29931
- "title": "ExtensionValue",
29932
- "type": "string",
29933
- "minLength": 1,
29934
- "maxLength": 128,
29935
- "description": "Extension value."
30036
+ "required": [
30037
+ "extension"
30038
+ ]
30039
+ }
30040
+ },
30041
+ "required": [
30042
+ "partyIdType",
30043
+ "partyIdentifier"
30044
+ ]
30045
+ },
30046
+ "merchantClassificationCode": {
30047
+ "title": "MerchantClassificationCode",
30048
+ "type": "string",
30049
+ "pattern": "^[\\d]{1,4}$",
30050
+ "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."
30051
+ },
30052
+ "name": {
30053
+ "title": "PartyName",
30054
+ "type": "string",
30055
+ "minLength": 1,
30056
+ "maxLength": 128,
30057
+ "description": "Name of the Party. Could be a real name or a nickname."
30058
+ },
30059
+ "personalInfo": {
30060
+ "title": "PartyPersonalInfo",
30061
+ "type": "object",
30062
+ "description": "Data model for the complex type PartyPersonalInfo.",
30063
+ "properties": {
30064
+ "complexName": {
30065
+ "title": "PartyComplexName",
30066
+ "type": "object",
30067
+ "description": "Data model for the complex type PartyComplexName.",
30068
+ "properties": {
30069
+ "firstName": {
30070
+ "title": "FirstName",
30071
+ "type": "string",
30072
+ "minLength": 1,
30073
+ "maxLength": 128,
30074
+ "pattern": "^(?!\\s*$)[\\p{L}\\p{gc=Mark}\\p{digit}\\p{gc=Connector_Punctuation}\\p{Join_Control} .,''-]{1,128}$",
30075
+ "description": "First name of the Party (Name Type).",
30076
+ "example": "Henrik"
30077
+ },
30078
+ "middleName": {
30079
+ "title": "MiddleName",
30080
+ "type": "string",
30081
+ "minLength": 1,
30082
+ "maxLength": 128,
30083
+ "pattern": "^(?!\\s*$)[\\p{L}\\p{gc=Mark}\\p{digit}\\p{gc=Connector_Punctuation}\\p{Join_Control} .,''-]{1,128}$",
30084
+ "description": "Middle name of the Party (Name Type).",
30085
+ "example": "Johannes"
30086
+ },
30087
+ "lastName": {
30088
+ "title": "LastName",
30089
+ "type": "string",
30090
+ "minLength": 1,
30091
+ "maxLength": 128,
30092
+ "pattern": "^(?!\\s*$)[\\p{L}\\p{gc=Mark}\\p{digit}\\p{gc=Connector_Punctuation}\\p{Join_Control} .,''-]{1,128}$",
30093
+ "description": "Last name of the Party (Name Type).",
30094
+ "example": "Karlsson"
30095
+ }
29936
30096
  }
29937
30097
  },
29938
- "required": [
29939
- "key",
29940
- "value"
30098
+ "dateOfBirth": {
30099
+ "title": "DateofBirth (type Date)",
30100
+ "type": "string",
30101
+ "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$",
30102
+ "description": "Date of Birth of the Party.",
30103
+ "example": "1966-06-16"
30104
+ },
30105
+ "kycInformation": {
30106
+ "title": "KYCInformation",
30107
+ "type": "string",
30108
+ "minLength": 1,
30109
+ "maxLength": 2048,
30110
+ "description": "KYC information for the party in a form mandated by an individual scheme.",
30111
+ "example": "{\n \"metadata\": {\n \"format\": \"JSON\",\n \"version\": \"1.0\",\n \"description\": \"Data containing KYC Information\"\n },\n \"data\": {\n \"name\": \"John Doe\",\n \"dob\": \"1980-05-15\",\n \"gender\": \"Male\",\n \"address\": \"123 Main Street, Anytown, USA\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"+1 555-123-4567\",\n \"nationality\": \"US\",\n \"passport_number\": \"AB1234567\",\n \"issue_date\": \"2010-02-20\",\n \"expiry_date\": \"2025-02-20\",\n \"bank_account_number\": \"1234567890\",\n \"bank_name\": \"Example Bank\",\n \"employer\": \"ABC Company\",\n \"occupation\": \"Software Engineer\",\n \"income\": \"$80,000 per year\",\n \"marital_status\": \"Single\",\n \"dependents\": 0,\n \"risk_level\": \"Low\"\n }\n}"
30112
+ }
30113
+ }
30114
+ },
30115
+ "supportedCurrencies": {
30116
+ "type": "array",
30117
+ "description": "Currencies in which the party can receive funds.",
30118
+ "items": {
30119
+ "title": "Currency",
30120
+ "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.",
30121
+ "type": "string",
30122
+ "minLength": 3,
30123
+ "maxLength": 3,
30124
+ "enum": [
30125
+ "AED",
30126
+ "AFN",
30127
+ "ALL",
30128
+ "AMD",
30129
+ "ANG",
30130
+ "AOA",
30131
+ "ARS",
30132
+ "AUD",
30133
+ "AWG",
30134
+ "AZN",
30135
+ "BAM",
30136
+ "BBD",
30137
+ "BDT",
30138
+ "BGN",
30139
+ "BHD",
30140
+ "BIF",
30141
+ "BMD",
30142
+ "BND",
30143
+ "BOB",
30144
+ "BRL",
30145
+ "BSD",
30146
+ "BTN",
30147
+ "BWP",
30148
+ "BYN",
30149
+ "BZD",
30150
+ "CAD",
30151
+ "CDF",
30152
+ "CHF",
30153
+ "CLP",
30154
+ "CNY",
30155
+ "COP",
30156
+ "CRC",
30157
+ "CUC",
30158
+ "CUP",
30159
+ "CVE",
30160
+ "CZK",
30161
+ "DJF",
30162
+ "DKK",
30163
+ "DOP",
30164
+ "DZD",
30165
+ "EGP",
30166
+ "ERN",
30167
+ "ETB",
30168
+ "EUR",
30169
+ "FJD",
30170
+ "FKP",
30171
+ "GBP",
30172
+ "GEL",
30173
+ "GGP",
30174
+ "GHS",
30175
+ "GIP",
30176
+ "GMD",
30177
+ "GNF",
30178
+ "GTQ",
30179
+ "GYD",
30180
+ "HKD",
30181
+ "HNL",
30182
+ "HRK",
30183
+ "HTG",
30184
+ "HUF",
30185
+ "IDR",
30186
+ "ILS",
30187
+ "IMP",
30188
+ "INR",
30189
+ "IQD",
30190
+ "IRR",
30191
+ "ISK",
30192
+ "JEP",
30193
+ "JMD",
30194
+ "JOD",
30195
+ "JPY",
30196
+ "KES",
30197
+ "KGS",
30198
+ "KHR",
30199
+ "KMF",
30200
+ "KPW",
30201
+ "KRW",
30202
+ "KWD",
30203
+ "KYD",
30204
+ "KZT",
30205
+ "LAK",
30206
+ "LBP",
30207
+ "LKR",
30208
+ "LRD",
30209
+ "LSL",
30210
+ "LYD",
30211
+ "MAD",
30212
+ "MDL",
30213
+ "MGA",
30214
+ "MKD",
30215
+ "MMK",
30216
+ "MNT",
30217
+ "MOP",
30218
+ "MRO",
30219
+ "MUR",
30220
+ "MVR",
30221
+ "MWK",
30222
+ "MXN",
30223
+ "MYR",
30224
+ "MZN",
30225
+ "NAD",
30226
+ "NGN",
30227
+ "NIO",
30228
+ "NOK",
30229
+ "NPR",
30230
+ "NZD",
30231
+ "OMR",
30232
+ "PAB",
30233
+ "PEN",
30234
+ "PGK",
30235
+ "PHP",
30236
+ "PKR",
30237
+ "PLN",
30238
+ "PYG",
30239
+ "QAR",
30240
+ "RON",
30241
+ "RSD",
30242
+ "RUB",
30243
+ "RWF",
30244
+ "SAR",
30245
+ "SBD",
30246
+ "SCR",
30247
+ "SDG",
30248
+ "SEK",
30249
+ "SGD",
30250
+ "SHP",
30251
+ "SLL",
30252
+ "SOS",
30253
+ "SPL",
30254
+ "SRD",
30255
+ "STD",
30256
+ "SVC",
30257
+ "SYP",
30258
+ "SZL",
30259
+ "THB",
30260
+ "TJS",
30261
+ "TMT",
30262
+ "TND",
30263
+ "TOP",
30264
+ "TRY",
30265
+ "TTD",
30266
+ "TVD",
30267
+ "TWD",
30268
+ "TZS",
30269
+ "UAH",
30270
+ "UGX",
30271
+ "USD",
30272
+ "UYU",
30273
+ "UZS",
30274
+ "VEF",
30275
+ "VND",
30276
+ "VUV",
30277
+ "WST",
30278
+ "XAF",
30279
+ "XCD",
30280
+ "XDR",
30281
+ "XOF",
30282
+ "XPF",
30283
+ "XTS",
30284
+ "XXX",
30285
+ "YER",
30286
+ "ZAR",
30287
+ "ZMW",
30288
+ "ZWD"
29941
30289
  ]
29942
30290
  },
29943
- "minItems": 1,
29944
- "maxItems": 16,
29945
- "description": "Number of Extension elements."
29946
- }
29947
- },
29948
- "required": [
29949
- "extension"
29950
- ]
29951
- }
29952
- },
29953
- "required": [
29954
- "partyIdType",
29955
- "partyIdentifier"
29956
- ]
29957
- },
29958
- "merchantClassificationCode": {
29959
- "title": "MerchantClassificationCode",
29960
- "type": "string",
29961
- "pattern": "^[\\d]{1,4}$",
29962
- "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."
29963
- },
29964
- "name": {
29965
- "title": "PartyName",
29966
- "type": "string",
29967
- "minLength": 1,
29968
- "maxLength": 128,
29969
- "description": "Name of the Party. Could be a real name or a nickname."
30291
+ "minItems": 0,
30292
+ "maxItems": 16
30293
+ }
30294
+ },
30295
+ "required": [
30296
+ "partyIdInfo"
30297
+ ]
30298
+ }
30299
+ },
30300
+ "required": [
30301
+ "party"
30302
+ ]
29970
30303
  },
29971
- "personalInfo": {
29972
- "title": "PartyPersonalInfo",
30304
+ {
29973
30305
  "type": "object",
29974
- "description": "Data model for the complex type PartyPersonalInfo.",
29975
30306
  "properties": {
29976
- "complexName": {
29977
- "title": "PartyComplexName",
30307
+ "errorInformation": {
30308
+ "title": "ErrorInformation",
29978
30309
  "type": "object",
29979
- "description": "Data model for the complex type PartyComplexName.",
30310
+ "description": "Data model for the complex type ErrorInformation.",
29980
30311
  "properties": {
29981
- "firstName": {
29982
- "title": "FirstName",
30312
+ "errorCode": {
30313
+ "title": "ErrorCode",
29983
30314
  "type": "string",
29984
- "minLength": 1,
29985
- "maxLength": 128,
29986
- "pattern": "^(?!\\s*$)[\\p{L}\\p{gc=Mark}\\p{digit}\\p{gc=Connector_Punctuation}\\p{Join_Control} .,''-]{1,128}$",
29987
- "description": "First name of the Party (Name Type).",
29988
- "example": "Henrik"
30315
+ "pattern": "^[1-9]\\d{3}$",
30316
+ "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.",
30317
+ "example": "5100"
29989
30318
  },
29990
- "middleName": {
29991
- "title": "MiddleName",
30319
+ "errorDescription": {
30320
+ "title": "ErrorDescription",
29992
30321
  "type": "string",
29993
30322
  "minLength": 1,
29994
30323
  "maxLength": 128,
29995
- "pattern": "^(?!\\s*$)[\\p{L}\\p{gc=Mark}\\p{digit}\\p{gc=Connector_Punctuation}\\p{Join_Control} .,''-]{1,128}$",
29996
- "description": "Middle name of the Party (Name Type).",
29997
- "example": "Johannes"
30324
+ "description": "Error description string."
29998
30325
  },
29999
- "lastName": {
30000
- "title": "LastName",
30001
- "type": "string",
30002
- "minLength": 1,
30003
- "maxLength": 128,
30004
- "pattern": "^(?!\\s*$)[\\p{L}\\p{gc=Mark}\\p{digit}\\p{gc=Connector_Punctuation}\\p{Join_Control} .,''-]{1,128}$",
30005
- "description": "Last name of the Party (Name Type).",
30006
- "example": "Karlsson"
30326
+ "extensionList": {
30327
+ "title": "ExtensionList",
30328
+ "type": "object",
30329
+ "description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
30330
+ "properties": {
30331
+ "extension": {
30332
+ "type": "array",
30333
+ "items": {
30334
+ "title": "Extension",
30335
+ "type": "object",
30336
+ "description": "Data model for the complex type Extension.",
30337
+ "properties": {
30338
+ "key": {
30339
+ "title": "ExtensionKey",
30340
+ "type": "string",
30341
+ "minLength": 1,
30342
+ "maxLength": 32,
30343
+ "description": "Extension key."
30344
+ },
30345
+ "value": {
30346
+ "title": "ExtensionValue",
30347
+ "type": "string",
30348
+ "minLength": 1,
30349
+ "maxLength": 128,
30350
+ "description": "Extension value."
30351
+ }
30352
+ },
30353
+ "required": [
30354
+ "key",
30355
+ "value"
30356
+ ]
30357
+ },
30358
+ "minItems": 1,
30359
+ "maxItems": 16,
30360
+ "description": "Number of Extension elements."
30361
+ }
30362
+ },
30363
+ "required": [
30364
+ "extension"
30365
+ ]
30007
30366
  }
30008
- }
30009
- },
30010
- "dateOfBirth": {
30011
- "title": "DateofBirth (type Date)",
30012
- "type": "string",
30013
- "pattern": "^(?:[1-9]\\d{3}-(?:(?:0[1-9]|1[0-2])-(?:0[1-9]|1\\d|2[0-8])|(?:0[13-9]|1[0-2])-(?:29|30)|(?:0[13578]|1[02])-31)|(?:[1-9]\\d(?:0[48]|[2468][048]|[13579][26])|(?:[2468][048]|[13579][26])00)-02-29)$",
30014
- "description": "Date of Birth of the Party.",
30015
- "example": "1966-06-16"
30016
- },
30017
- "kycInformation": {
30018
- "title": "KYCInformation",
30019
- "type": "string",
30020
- "minLength": 1,
30021
- "maxLength": 2048,
30022
- "description": "KYC information for the party in a form mandated by an individual scheme.",
30023
- "example": "{\n \"metadata\": {\n \"format\": \"JSON\",\n \"version\": \"1.0\",\n \"description\": \"Data containing KYC Information\"\n },\n \"data\": {\n \"name\": \"John Doe\",\n \"dob\": \"1980-05-15\",\n \"gender\": \"Male\",\n \"address\": \"123 Main Street, Anytown, USA\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"+1 555-123-4567\",\n \"nationality\": \"US\",\n \"passport_number\": \"AB1234567\",\n \"issue_date\": \"2010-02-20\",\n \"expiry_date\": \"2025-02-20\",\n \"bank_account_number\": \"1234567890\",\n \"bank_name\": \"Example Bank\",\n \"employer\": \"ABC Company\",\n \"occupation\": \"Software Engineer\",\n \"income\": \"$80,000 per year\",\n \"marital_status\": \"Single\",\n \"dependents\": 0,\n \"risk_level\": \"Low\"\n }\n}"
30367
+ },
30368
+ "required": [
30369
+ "errorCode",
30370
+ "errorDescription"
30371
+ ]
30024
30372
  }
30025
- }
30026
- },
30027
- "supportedCurrencies": {
30028
- "type": "array",
30029
- "description": "Currencies in which the party can receive funds.",
30030
- "items": {
30031
- "title": "Currency",
30032
- "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.",
30033
- "type": "string",
30034
- "minLength": 3,
30035
- "maxLength": 3,
30036
- "enum": [
30037
- "AED",
30038
- "AFN",
30039
- "ALL",
30040
- "AMD",
30041
- "ANG",
30042
- "AOA",
30043
- "ARS",
30044
- "AUD",
30045
- "AWG",
30046
- "AZN",
30047
- "BAM",
30048
- "BBD",
30049
- "BDT",
30050
- "BGN",
30051
- "BHD",
30052
- "BIF",
30053
- "BMD",
30054
- "BND",
30055
- "BOB",
30056
- "BRL",
30057
- "BSD",
30058
- "BTN",
30059
- "BWP",
30060
- "BYN",
30061
- "BZD",
30062
- "CAD",
30063
- "CDF",
30064
- "CHF",
30065
- "CLP",
30066
- "CNY",
30067
- "COP",
30068
- "CRC",
30069
- "CUC",
30070
- "CUP",
30071
- "CVE",
30072
- "CZK",
30073
- "DJF",
30074
- "DKK",
30075
- "DOP",
30076
- "DZD",
30077
- "EGP",
30078
- "ERN",
30079
- "ETB",
30080
- "EUR",
30081
- "FJD",
30082
- "FKP",
30083
- "GBP",
30084
- "GEL",
30085
- "GGP",
30086
- "GHS",
30087
- "GIP",
30088
- "GMD",
30089
- "GNF",
30090
- "GTQ",
30091
- "GYD",
30092
- "HKD",
30093
- "HNL",
30094
- "HRK",
30095
- "HTG",
30096
- "HUF",
30097
- "IDR",
30098
- "ILS",
30099
- "IMP",
30100
- "INR",
30101
- "IQD",
30102
- "IRR",
30103
- "ISK",
30104
- "JEP",
30105
- "JMD",
30106
- "JOD",
30107
- "JPY",
30108
- "KES",
30109
- "KGS",
30110
- "KHR",
30111
- "KMF",
30112
- "KPW",
30113
- "KRW",
30114
- "KWD",
30115
- "KYD",
30116
- "KZT",
30117
- "LAK",
30118
- "LBP",
30119
- "LKR",
30120
- "LRD",
30121
- "LSL",
30122
- "LYD",
30123
- "MAD",
30124
- "MDL",
30125
- "MGA",
30126
- "MKD",
30127
- "MMK",
30128
- "MNT",
30129
- "MOP",
30130
- "MRO",
30131
- "MUR",
30132
- "MVR",
30133
- "MWK",
30134
- "MXN",
30135
- "MYR",
30136
- "MZN",
30137
- "NAD",
30138
- "NGN",
30139
- "NIO",
30140
- "NOK",
30141
- "NPR",
30142
- "NZD",
30143
- "OMR",
30144
- "PAB",
30145
- "PEN",
30146
- "PGK",
30147
- "PHP",
30148
- "PKR",
30149
- "PLN",
30150
- "PYG",
30151
- "QAR",
30152
- "RON",
30153
- "RSD",
30154
- "RUB",
30155
- "RWF",
30156
- "SAR",
30157
- "SBD",
30158
- "SCR",
30159
- "SDG",
30160
- "SEK",
30161
- "SGD",
30162
- "SHP",
30163
- "SLL",
30164
- "SOS",
30165
- "SPL",
30166
- "SRD",
30167
- "STD",
30168
- "SVC",
30169
- "SYP",
30170
- "SZL",
30171
- "THB",
30172
- "TJS",
30173
- "TMT",
30174
- "TND",
30175
- "TOP",
30176
- "TRY",
30177
- "TTD",
30178
- "TVD",
30179
- "TWD",
30180
- "TZS",
30181
- "UAH",
30182
- "UGX",
30183
- "USD",
30184
- "UYU",
30185
- "UZS",
30186
- "VEF",
30187
- "VND",
30188
- "VUV",
30189
- "WST",
30190
- "XAF",
30191
- "XCD",
30192
- "XDR",
30193
- "XOF",
30194
- "XPF",
30195
- "XTS",
30196
- "XXX",
30197
- "YER",
30198
- "ZAR",
30199
- "ZMW",
30200
- "ZWD"
30201
- ]
30202
30373
  },
30203
- "minItems": 0,
30204
- "maxItems": 16
30374
+ "required": [
30375
+ "errorInformation"
30376
+ ]
30205
30377
  }
30206
- },
30207
- "required": [
30208
- "partyIdInfo"
30209
30378
  ]
30210
30379
  },
30211
30380
  "headers": {
30212
30381
  "type": "object"
30213
30382
  }
30214
- }
30383
+ },
30384
+ "required": [
30385
+ "body"
30386
+ ]
30215
30387
  },
30216
30388
  "quoteResponse": {
30217
30389
  "type": "object",