@mojaloop/api-snippets 17.7.5 → 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 +7 -0
- package/docs/sdk-scheme-adapter-outbound-v2_1_0-openapi3-snippets.yaml +6 -1
- package/lib/sdk-scheme-adapter/v2_1_0/outbound/json-schemas.json +655 -639
- 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 +232 -220
- package/package.json +8 -8
- package/sdk-scheme-adapter/v2_1_0/components/schemas/transferResponse.yaml +6 -1
|
@@ -26511,350 +26511,358 @@
|
|
|
26511
26511
|
],
|
|
26512
26512
|
"properties": {
|
|
26513
26513
|
"body": {
|
|
26514
|
-
"title": "Party",
|
|
26515
26514
|
"type": "object",
|
|
26516
|
-
"description": "Data model for the complex type Party.",
|
|
26517
26515
|
"properties": {
|
|
26518
|
-
"
|
|
26519
|
-
"title": "
|
|
26520
|
-
"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
|
-
"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",
|
|
26562
|
-
"type": "object",
|
|
26563
|
-
"description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
|
|
26564
|
-
"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
|
-
}
|
|
26586
|
-
},
|
|
26587
|
-
"required": [
|
|
26588
|
-
"key",
|
|
26589
|
-
"value"
|
|
26590
|
-
]
|
|
26591
|
-
},
|
|
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",
|
|
26516
|
+
"party": {
|
|
26517
|
+
"title": "Party",
|
|
26622
26518
|
"type": "object",
|
|
26623
|
-
"description": "Data model for the complex type
|
|
26519
|
+
"description": "Data model for the complex type Party.",
|
|
26624
26520
|
"properties": {
|
|
26625
|
-
"
|
|
26626
|
-
"title": "
|
|
26521
|
+
"partyIdInfo": {
|
|
26522
|
+
"title": "PartyIdInfo",
|
|
26627
26523
|
"type": "object",
|
|
26628
|
-
"description": "Data model for the complex type
|
|
26524
|
+
"description": "Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1",
|
|
26629
26525
|
"properties": {
|
|
26630
|
-
"
|
|
26631
|
-
"title": "
|
|
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",
|
|
26632
26543
|
"type": "string",
|
|
26633
26544
|
"minLength": 1,
|
|
26634
26545
|
"maxLength": 128,
|
|
26635
|
-
"
|
|
26636
|
-
"
|
|
26637
|
-
"example": "Henrik"
|
|
26546
|
+
"description": "Identifier of the Party.",
|
|
26547
|
+
"example": "16135551212"
|
|
26638
26548
|
},
|
|
26639
|
-
"
|
|
26640
|
-
"title": "
|
|
26549
|
+
"partySubIdOrType": {
|
|
26550
|
+
"title": "PartySubIdOrType",
|
|
26641
26551
|
"type": "string",
|
|
26642
26552
|
"minLength": 1,
|
|
26643
26553
|
"maxLength": 128,
|
|
26644
|
-
"
|
|
26645
|
-
"description": "Middle name of the Party (Name Type).",
|
|
26646
|
-
"example": "Johannes"
|
|
26554
|
+
"description": "Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType."
|
|
26647
26555
|
},
|
|
26648
|
-
"
|
|
26649
|
-
"title": "
|
|
26556
|
+
"fspId": {
|
|
26557
|
+
"title": "FspId",
|
|
26650
26558
|
"type": "string",
|
|
26651
26559
|
"minLength": 1,
|
|
26652
|
-
"maxLength":
|
|
26653
|
-
"
|
|
26654
|
-
|
|
26655
|
-
|
|
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
|
+
]
|
|
26656
26603
|
}
|
|
26657
|
-
}
|
|
26604
|
+
},
|
|
26605
|
+
"required": [
|
|
26606
|
+
"partyIdType",
|
|
26607
|
+
"partyIdentifier"
|
|
26608
|
+
]
|
|
26658
26609
|
},
|
|
26659
|
-
"
|
|
26660
|
-
"title": "
|
|
26610
|
+
"merchantClassificationCode": {
|
|
26611
|
+
"title": "MerchantClassificationCode",
|
|
26661
26612
|
"type": "string",
|
|
26662
|
-
"pattern": "^
|
|
26663
|
-
"description": "
|
|
26664
|
-
"example": "1966-06-16"
|
|
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."
|
|
26665
26615
|
},
|
|
26666
|
-
"
|
|
26667
|
-
"title": "
|
|
26616
|
+
"name": {
|
|
26617
|
+
"title": "PartyName",
|
|
26668
26618
|
"type": "string",
|
|
26669
26619
|
"minLength": 1,
|
|
26670
|
-
"maxLength":
|
|
26671
|
-
"description": "
|
|
26672
|
-
|
|
26673
|
-
|
|
26674
|
-
|
|
26675
|
-
|
|
26676
|
-
|
|
26677
|
-
|
|
26678
|
-
|
|
26679
|
-
|
|
26680
|
-
|
|
26681
|
-
|
|
26682
|
-
|
|
26683
|
-
|
|
26684
|
-
|
|
26685
|
-
|
|
26686
|
-
|
|
26687
|
-
|
|
26688
|
-
|
|
26689
|
-
|
|
26690
|
-
|
|
26691
|
-
|
|
26692
|
-
|
|
26693
|
-
|
|
26694
|
-
|
|
26695
|
-
|
|
26696
|
-
|
|
26697
|
-
|
|
26698
|
-
|
|
26699
|
-
|
|
26700
|
-
|
|
26701
|
-
|
|
26702
|
-
|
|
26703
|
-
|
|
26704
|
-
|
|
26705
|
-
|
|
26706
|
-
|
|
26707
|
-
|
|
26708
|
-
|
|
26709
|
-
|
|
26710
|
-
|
|
26711
|
-
|
|
26712
|
-
|
|
26713
|
-
|
|
26714
|
-
|
|
26715
|
-
|
|
26716
|
-
|
|
26717
|
-
|
|
26718
|
-
|
|
26719
|
-
|
|
26720
|
-
|
|
26721
|
-
|
|
26722
|
-
|
|
26723
|
-
|
|
26724
|
-
|
|
26725
|
-
|
|
26726
|
-
|
|
26727
|
-
|
|
26728
|
-
|
|
26729
|
-
|
|
26730
|
-
"
|
|
26731
|
-
"
|
|
26732
|
-
"
|
|
26733
|
-
|
|
26734
|
-
|
|
26735
|
-
|
|
26736
|
-
|
|
26737
|
-
|
|
26738
|
-
|
|
26739
|
-
|
|
26740
|
-
|
|
26741
|
-
|
|
26742
|
-
|
|
26743
|
-
|
|
26744
|
-
|
|
26745
|
-
|
|
26746
|
-
|
|
26747
|
-
|
|
26748
|
-
|
|
26749
|
-
|
|
26750
|
-
|
|
26751
|
-
|
|
26752
|
-
|
|
26753
|
-
|
|
26754
|
-
|
|
26755
|
-
|
|
26756
|
-
|
|
26757
|
-
|
|
26758
|
-
|
|
26759
|
-
|
|
26760
|
-
|
|
26761
|
-
|
|
26762
|
-
|
|
26763
|
-
|
|
26764
|
-
|
|
26765
|
-
|
|
26766
|
-
|
|
26767
|
-
|
|
26768
|
-
|
|
26769
|
-
|
|
26770
|
-
|
|
26771
|
-
|
|
26772
|
-
|
|
26773
|
-
|
|
26774
|
-
|
|
26775
|
-
|
|
26776
|
-
|
|
26777
|
-
|
|
26778
|
-
|
|
26779
|
-
|
|
26780
|
-
|
|
26781
|
-
|
|
26782
|
-
|
|
26783
|
-
|
|
26784
|
-
|
|
26785
|
-
|
|
26786
|
-
|
|
26787
|
-
|
|
26788
|
-
|
|
26789
|
-
|
|
26790
|
-
|
|
26791
|
-
|
|
26792
|
-
|
|
26793
|
-
|
|
26794
|
-
|
|
26795
|
-
|
|
26796
|
-
|
|
26797
|
-
|
|
26798
|
-
|
|
26799
|
-
|
|
26800
|
-
|
|
26801
|
-
|
|
26802
|
-
|
|
26803
|
-
|
|
26804
|
-
|
|
26805
|
-
|
|
26806
|
-
|
|
26807
|
-
|
|
26808
|
-
|
|
26809
|
-
|
|
26810
|
-
|
|
26811
|
-
|
|
26812
|
-
|
|
26813
|
-
|
|
26814
|
-
|
|
26815
|
-
|
|
26816
|
-
|
|
26817
|
-
|
|
26818
|
-
|
|
26819
|
-
|
|
26820
|
-
|
|
26821
|
-
|
|
26822
|
-
|
|
26823
|
-
|
|
26824
|
-
|
|
26825
|
-
|
|
26826
|
-
|
|
26827
|
-
|
|
26828
|
-
|
|
26829
|
-
|
|
26830
|
-
|
|
26831
|
-
|
|
26832
|
-
|
|
26833
|
-
|
|
26834
|
-
|
|
26835
|
-
|
|
26836
|
-
|
|
26837
|
-
|
|
26838
|
-
|
|
26839
|
-
|
|
26840
|
-
|
|
26841
|
-
|
|
26842
|
-
|
|
26843
|
-
|
|
26844
|
-
|
|
26845
|
-
|
|
26846
|
-
|
|
26847
|
-
|
|
26848
|
-
|
|
26849
|
-
|
|
26850
|
-
|
|
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
|
+
}
|
|
26851
26858
|
},
|
|
26852
|
-
"
|
|
26853
|
-
|
|
26859
|
+
"required": [
|
|
26860
|
+
"partyIdInfo"
|
|
26861
|
+
]
|
|
26854
26862
|
}
|
|
26855
26863
|
},
|
|
26856
26864
|
"required": [
|
|
26857
|
-
"
|
|
26865
|
+
"party"
|
|
26858
26866
|
]
|
|
26859
26867
|
},
|
|
26860
26868
|
"headers": {
|
|
@@ -29862,350 +29870,358 @@
|
|
|
29862
29870
|
],
|
|
29863
29871
|
"properties": {
|
|
29864
29872
|
"body": {
|
|
29865
|
-
"title": "Party",
|
|
29866
29873
|
"type": "object",
|
|
29867
|
-
"description": "Data model for the complex type Party.",
|
|
29868
29874
|
"properties": {
|
|
29869
|
-
"
|
|
29870
|
-
"title": "
|
|
29875
|
+
"party": {
|
|
29876
|
+
"title": "Party",
|
|
29871
29877
|
"type": "object",
|
|
29872
|
-
"description": "Data model for the complex type
|
|
29878
|
+
"description": "Data model for the complex type Party.",
|
|
29873
29879
|
"properties": {
|
|
29874
|
-
"
|
|
29875
|
-
"title": "
|
|
29876
|
-
"type": "
|
|
29877
|
-
"
|
|
29878
|
-
|
|
29879
|
-
"
|
|
29880
|
-
|
|
29881
|
-
|
|
29882
|
-
|
|
29883
|
-
|
|
29884
|
-
|
|
29885
|
-
|
|
29886
|
-
|
|
29887
|
-
|
|
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
|
+
]
|
|
29888
29968
|
},
|
|
29889
|
-
"
|
|
29890
|
-
"title": "
|
|
29969
|
+
"merchantClassificationCode": {
|
|
29970
|
+
"title": "MerchantClassificationCode",
|
|
29891
29971
|
"type": "string",
|
|
29892
|
-
"
|
|
29893
|
-
"
|
|
29894
|
-
"description": "Identifier of the Party.",
|
|
29895
|
-
"example": "16135551212"
|
|
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."
|
|
29896
29974
|
},
|
|
29897
|
-
"
|
|
29898
|
-
"title": "
|
|
29975
|
+
"name": {
|
|
29976
|
+
"title": "PartyName",
|
|
29899
29977
|
"type": "string",
|
|
29900
29978
|
"minLength": 1,
|
|
29901
29979
|
"maxLength": 128,
|
|
29902
|
-
"description": "
|
|
29903
|
-
},
|
|
29904
|
-
"fspId": {
|
|
29905
|
-
"title": "FspId",
|
|
29906
|
-
"type": "string",
|
|
29907
|
-
"minLength": 1,
|
|
29908
|
-
"maxLength": 32,
|
|
29909
|
-
"description": "FSP identifier."
|
|
29980
|
+
"description": "Name of the Party. Could be a real name or a nickname."
|
|
29910
29981
|
},
|
|
29911
|
-
"
|
|
29912
|
-
"title": "
|
|
29982
|
+
"personalInfo": {
|
|
29983
|
+
"title": "PartyPersonalInfo",
|
|
29913
29984
|
"type": "object",
|
|
29914
|
-
"description": "Data model for the complex type
|
|
29985
|
+
"description": "Data model for the complex type PartyPersonalInfo.",
|
|
29915
29986
|
"properties": {
|
|
29916
|
-
"
|
|
29917
|
-
"
|
|
29918
|
-
"
|
|
29919
|
-
|
|
29920
|
-
|
|
29921
|
-
"
|
|
29922
|
-
|
|
29923
|
-
"
|
|
29924
|
-
|
|
29925
|
-
|
|
29926
|
-
|
|
29927
|
-
|
|
29928
|
-
|
|
29929
|
-
},
|
|
29930
|
-
"value": {
|
|
29931
|
-
"title": "ExtensionValue",
|
|
29932
|
-
"type": "string",
|
|
29933
|
-
"minLength": 1,
|
|
29934
|
-
"maxLength": 128,
|
|
29935
|
-
"description": "Extension value."
|
|
29936
|
-
}
|
|
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"
|
|
29937
30000
|
},
|
|
29938
|
-
"
|
|
29939
|
-
"
|
|
29940
|
-
"
|
|
29941
|
-
|
|
29942
|
-
|
|
29943
|
-
|
|
29944
|
-
|
|
29945
|
-
|
|
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}"
|
|
29946
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
|
+
]
|
|
29947
30213
|
},
|
|
29948
|
-
"
|
|
29949
|
-
|
|
29950
|
-
]
|
|
30214
|
+
"minItems": 0,
|
|
30215
|
+
"maxItems": 16
|
|
29951
30216
|
}
|
|
29952
30217
|
},
|
|
29953
30218
|
"required": [
|
|
29954
|
-
"
|
|
29955
|
-
"partyIdentifier"
|
|
30219
|
+
"partyIdInfo"
|
|
29956
30220
|
]
|
|
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."
|
|
29970
|
-
},
|
|
29971
|
-
"personalInfo": {
|
|
29972
|
-
"title": "PartyPersonalInfo",
|
|
29973
|
-
"type": "object",
|
|
29974
|
-
"description": "Data model for the complex type PartyPersonalInfo.",
|
|
29975
|
-
"properties": {
|
|
29976
|
-
"complexName": {
|
|
29977
|
-
"title": "PartyComplexName",
|
|
29978
|
-
"type": "object",
|
|
29979
|
-
"description": "Data model for the complex type PartyComplexName.",
|
|
29980
|
-
"properties": {
|
|
29981
|
-
"firstName": {
|
|
29982
|
-
"title": "FirstName",
|
|
29983
|
-
"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"
|
|
29989
|
-
},
|
|
29990
|
-
"middleName": {
|
|
29991
|
-
"title": "MiddleName",
|
|
29992
|
-
"type": "string",
|
|
29993
|
-
"minLength": 1,
|
|
29994
|
-
"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"
|
|
29998
|
-
},
|
|
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"
|
|
30007
|
-
}
|
|
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}"
|
|
30024
|
-
}
|
|
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
|
-
},
|
|
30203
|
-
"minItems": 0,
|
|
30204
|
-
"maxItems": 16
|
|
30205
30221
|
}
|
|
30206
30222
|
},
|
|
30207
30223
|
"required": [
|
|
30208
|
-
"
|
|
30224
|
+
"party"
|
|
30209
30225
|
]
|
|
30210
30226
|
},
|
|
30211
30227
|
"headers": {
|