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