@mojaloop/api-snippets 17.7.4 → 17.7.6
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.
- package/CHANGELOG.md +14 -0
- package/docs/sdk-scheme-adapter-backend-v2_1_0-openapi3-snippets.yaml +216 -9
- package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +5 -0
- package/lib/sdk-scheme-adapter/v2_1_0/backend/json-schemas.json +12778 -1915
- package/lib/sdk-scheme-adapter/v2_1_0/backend/openapi.d.ts +133 -9
- package/lib/sdk-scheme-adapter/v2_1_0/backend/schemas.d.ts +7721 -4313
- package/lib/sdk-scheme-adapter/v2_1_0/backend/schemas.js +11 -0
- package/lib/sdk-scheme-adapter/v2_1_0/backend/schemas.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_1_0/backend/types.d.ts +11 -0
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +706 -2
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/openapi.d.ts +3 -1
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/schemas.d.ts +332 -0
- package/package.json +14 -14
- package/sdk-scheme-adapter/v2_1_0/backend/openapi.yaml +9 -9
- package/sdk-scheme-adapter/v2_1_0/components/schemas/transferResponse.yaml +5 -0
|
@@ -26511,7 +26511,359 @@
|
|
|
26511
26511
|
],
|
|
26512
26512
|
"properties": {
|
|
26513
26513
|
"body": {
|
|
26514
|
-
"type": "object"
|
|
26514
|
+
"type": "object",
|
|
26515
|
+
"properties": {
|
|
26516
|
+
"party": {
|
|
26517
|
+
"title": "Party",
|
|
26518
|
+
"type": "object",
|
|
26519
|
+
"description": "Data model for the complex type Party.",
|
|
26520
|
+
"properties": {
|
|
26521
|
+
"partyIdInfo": {
|
|
26522
|
+
"title": "PartyIdInfo",
|
|
26523
|
+
"type": "object",
|
|
26524
|
+
"description": "Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1",
|
|
26525
|
+
"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",
|
|
26565
|
+
"type": "object",
|
|
26566
|
+
"description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
|
|
26567
|
+
"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",
|
|
26635
|
+
"type": "string",
|
|
26636
|
+
"minLength": 1,
|
|
26637
|
+
"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"
|
|
26641
|
+
},
|
|
26642
|
+
"middleName": {
|
|
26643
|
+
"title": "MiddleName",
|
|
26644
|
+
"type": "string",
|
|
26645
|
+
"minLength": 1,
|
|
26646
|
+
"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"
|
|
26650
|
+
},
|
|
26651
|
+
"lastName": {
|
|
26652
|
+
"title": "LastName",
|
|
26653
|
+
"type": "string",
|
|
26654
|
+
"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"
|
|
26659
|
+
}
|
|
26660
|
+
}
|
|
26661
|
+
},
|
|
26662
|
+
"dateOfBirth": {
|
|
26663
|
+
"title": "DateofBirth (type Date)",
|
|
26664
|
+
"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"
|
|
26668
|
+
},
|
|
26669
|
+
"kycInformation": {
|
|
26670
|
+
"title": "KYCInformation",
|
|
26671
|
+
"type": "string",
|
|
26672
|
+
"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
|
+
]
|
|
26854
|
+
},
|
|
26855
|
+
"minItems": 0,
|
|
26856
|
+
"maxItems": 16
|
|
26857
|
+
}
|
|
26858
|
+
},
|
|
26859
|
+
"required": [
|
|
26860
|
+
"partyIdInfo"
|
|
26861
|
+
]
|
|
26862
|
+
}
|
|
26863
|
+
},
|
|
26864
|
+
"required": [
|
|
26865
|
+
"party"
|
|
26866
|
+
]
|
|
26515
26867
|
},
|
|
26516
26868
|
"headers": {
|
|
26517
26869
|
"type": "object"
|
|
@@ -29518,7 +29870,359 @@
|
|
|
29518
29870
|
],
|
|
29519
29871
|
"properties": {
|
|
29520
29872
|
"body": {
|
|
29521
|
-
"type": "object"
|
|
29873
|
+
"type": "object",
|
|
29874
|
+
"properties": {
|
|
29875
|
+
"party": {
|
|
29876
|
+
"title": "Party",
|
|
29877
|
+
"type": "object",
|
|
29878
|
+
"description": "Data model for the complex type Party.",
|
|
29879
|
+
"properties": {
|
|
29880
|
+
"partyIdInfo": {
|
|
29881
|
+
"title": "PartyIdInfo",
|
|
29882
|
+
"type": "object",
|
|
29883
|
+
"description": "Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1",
|
|
29884
|
+
"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",
|
|
29902
|
+
"type": "string",
|
|
29903
|
+
"minLength": 1,
|
|
29904
|
+
"maxLength": 128,
|
|
29905
|
+
"description": "Identifier of the Party.",
|
|
29906
|
+
"example": "16135551212"
|
|
29907
|
+
},
|
|
29908
|
+
"partySubIdOrType": {
|
|
29909
|
+
"title": "PartySubIdOrType",
|
|
29910
|
+
"type": "string",
|
|
29911
|
+
"minLength": 1,
|
|
29912
|
+
"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."
|
|
29921
|
+
},
|
|
29922
|
+
"extensionList": {
|
|
29923
|
+
"title": "ExtensionList",
|
|
29924
|
+
"type": "object",
|
|
29925
|
+
"description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
|
|
29926
|
+
"properties": {
|
|
29927
|
+
"extension": {
|
|
29928
|
+
"type": "array",
|
|
29929
|
+
"items": {
|
|
29930
|
+
"title": "Extension",
|
|
29931
|
+
"type": "object",
|
|
29932
|
+
"description": "Data model for the complex type Extension.",
|
|
29933
|
+
"properties": {
|
|
29934
|
+
"key": {
|
|
29935
|
+
"title": "ExtensionKey",
|
|
29936
|
+
"type": "string",
|
|
29937
|
+
"minLength": 1,
|
|
29938
|
+
"maxLength": 32,
|
|
29939
|
+
"description": "Extension key."
|
|
29940
|
+
},
|
|
29941
|
+
"value": {
|
|
29942
|
+
"title": "ExtensionValue",
|
|
29943
|
+
"type": "string",
|
|
29944
|
+
"minLength": 1,
|
|
29945
|
+
"maxLength": 128,
|
|
29946
|
+
"description": "Extension value."
|
|
29947
|
+
}
|
|
29948
|
+
},
|
|
29949
|
+
"required": [
|
|
29950
|
+
"key",
|
|
29951
|
+
"value"
|
|
29952
|
+
]
|
|
29953
|
+
},
|
|
29954
|
+
"minItems": 1,
|
|
29955
|
+
"maxItems": 16,
|
|
29956
|
+
"description": "Number of Extension elements."
|
|
29957
|
+
}
|
|
29958
|
+
},
|
|
29959
|
+
"required": [
|
|
29960
|
+
"extension"
|
|
29961
|
+
]
|
|
29962
|
+
}
|
|
29963
|
+
},
|
|
29964
|
+
"required": [
|
|
29965
|
+
"partyIdType",
|
|
29966
|
+
"partyIdentifier"
|
|
29967
|
+
]
|
|
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
|
+
}
|
|
30217
|
+
},
|
|
30218
|
+
"required": [
|
|
30219
|
+
"partyIdInfo"
|
|
30220
|
+
]
|
|
30221
|
+
}
|
|
30222
|
+
},
|
|
30223
|
+
"required": [
|
|
30224
|
+
"party"
|
|
30225
|
+
]
|
|
29522
30226
|
},
|
|
29523
30227
|
"headers": {
|
|
29524
30228
|
"type": "object"
|