@mojaloop/api-snippets 17.0.5-snapshot.1 → 17.1.0-snapshot.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml +25 -7
- package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +84 -27
- package/lib/sdk-scheme-adapter/v2_0_0/backend/json-schemas.json +26 -0
- package/lib/sdk-scheme-adapter/v2_0_0/backend/openapi.d.ts +16 -3
- package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.d.ts +18 -0
- package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js +1 -0
- package/lib/sdk-scheme-adapter/v2_0_0/backend/schemas.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/backend/types.d.ts +1 -0
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/json-schemas.json +549 -21
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/openapi.d.ts +59 -20
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.d.ts +451 -11
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js +6 -1
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/schemas.js.map +1 -1
- package/lib/sdk-scheme-adapter/v2_0_0/outbound/types.d.ts +6 -1
- package/package.json +7 -7
- package/sdk-scheme-adapter/v2_0_0/backend/openapi.yaml +12 -7
- package/sdk-scheme-adapter/v2_0_0/components/parameters/{requestToPayId.yaml → transactionRequestId.yaml} +1 -1
- package/sdk-scheme-adapter/v2_0_0/components/schemas/TransactionRequestResponse.yaml +20 -0
- package/sdk-scheme-adapter/v2_0_0/components/schemas/getPartiesResponse.yaml +12 -0
- package/sdk-scheme-adapter/v2_0_0/components/schemas/requestToPayRequest.yaml +4 -2
- package/sdk-scheme-adapter/v2_0_0/components/schemas/requestToPayResponse.yaml +5 -17
- package/sdk-scheme-adapter/v2_0_0/components/schemas/requestToPayStatus.yaml +5 -0
- package/sdk-scheme-adapter/v2_0_0/outbound/openapi.yaml +2 -2
- package/sdk-scheme-adapter/v2_0_0/outbound/paths/{requestToPay_requestToPayId.yaml → requestToPay_transactionRequestId.yaml} +2 -3
|
@@ -14860,10 +14860,21 @@
|
|
|
14860
14860
|
}
|
|
14861
14861
|
]
|
|
14862
14862
|
},
|
|
14863
|
+
"AuthenticationType": {
|
|
14864
|
+
"title": "AuthenticationType",
|
|
14865
|
+
"type": "string",
|
|
14866
|
+
"enum": [
|
|
14867
|
+
"OTP",
|
|
14868
|
+
"QRCODE",
|
|
14869
|
+
"U2F"
|
|
14870
|
+
],
|
|
14871
|
+
"description": "Below are the allowed values for the enumeration AuthenticationType.\n- OTP - One-time password generated by the Payer FSP.\n- QRCODE - QR code used as One Time Password.\n- U2F - U2F is a new addition isolated to Thirdparty stream.",
|
|
14872
|
+
"example": "OTP"
|
|
14873
|
+
},
|
|
14863
14874
|
"requestToPayRequest": {
|
|
14864
14875
|
"type": "object",
|
|
14865
14876
|
"required": [
|
|
14866
|
-
"
|
|
14877
|
+
"homeR2PTransactionId",
|
|
14867
14878
|
"from",
|
|
14868
14879
|
"to",
|
|
14869
14880
|
"amountType",
|
|
@@ -14872,7 +14883,7 @@
|
|
|
14872
14883
|
"transactionType"
|
|
14873
14884
|
],
|
|
14874
14885
|
"properties": {
|
|
14875
|
-
"
|
|
14886
|
+
"homeR2PTransactionId": {
|
|
14876
14887
|
"type": "string",
|
|
14877
14888
|
"description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
|
|
14878
14889
|
},
|
|
@@ -15353,22 +15364,300 @@
|
|
|
15353
15364
|
"pattern": "^[A-Z_]{1,32}$",
|
|
15354
15365
|
"description": "Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).",
|
|
15355
15366
|
"example": "LOCALLY_DEFINED_SUBSCENARIO"
|
|
15367
|
+
},
|
|
15368
|
+
"authenticationType": {
|
|
15369
|
+
"title": "AuthenticationType",
|
|
15370
|
+
"type": "string",
|
|
15371
|
+
"enum": [
|
|
15372
|
+
"OTP",
|
|
15373
|
+
"QRCODE",
|
|
15374
|
+
"U2F"
|
|
15375
|
+
],
|
|
15376
|
+
"description": "Below are the allowed values for the enumeration AuthenticationType.\n- OTP - One-time password generated by the Payer FSP.\n- QRCODE - QR code used as One Time Password.\n- U2F - U2F is a new addition isolated to Thirdparty stream.",
|
|
15377
|
+
"example": "OTP"
|
|
15356
15378
|
}
|
|
15357
15379
|
}
|
|
15358
15380
|
},
|
|
15359
|
-
"
|
|
15381
|
+
"requestToPayStatus": {
|
|
15360
15382
|
"type": "string",
|
|
15361
15383
|
"enum": [
|
|
15362
15384
|
"ERROR_OCCURRED",
|
|
15363
15385
|
"WAITING_FOR_PARTY_ACCEPTANCE",
|
|
15364
|
-
"WAITING_FOR_QUOTE_ACCEPTANCE",
|
|
15365
15386
|
"COMPLETED"
|
|
15366
15387
|
]
|
|
15367
15388
|
},
|
|
15389
|
+
"getPartiesResponse": {
|
|
15390
|
+
"title": "getPartiesResponse",
|
|
15391
|
+
"type": "object",
|
|
15392
|
+
"description": "The object sent in the GET /parties/{Type}/{ID} callback.",
|
|
15393
|
+
"properties": {
|
|
15394
|
+
"body": {
|
|
15395
|
+
"title": "Party",
|
|
15396
|
+
"type": "object",
|
|
15397
|
+
"description": "Data model for the complex type Party.",
|
|
15398
|
+
"properties": {
|
|
15399
|
+
"partyIdInfo": {
|
|
15400
|
+
"title": "PartyIdInfo",
|
|
15401
|
+
"type": "object",
|
|
15402
|
+
"description": "Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1",
|
|
15403
|
+
"properties": {
|
|
15404
|
+
"partyIdType": {
|
|
15405
|
+
"title": "PartyIdType",
|
|
15406
|
+
"type": "string",
|
|
15407
|
+
"enum": [
|
|
15408
|
+
"MSISDN",
|
|
15409
|
+
"EMAIL",
|
|
15410
|
+
"PERSONAL_ID",
|
|
15411
|
+
"BUSINESS",
|
|
15412
|
+
"DEVICE",
|
|
15413
|
+
"ACCOUNT_ID",
|
|
15414
|
+
"IBAN",
|
|
15415
|
+
"ALIAS"
|
|
15416
|
+
],
|
|
15417
|
+
"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."
|
|
15418
|
+
},
|
|
15419
|
+
"partyIdentifier": {
|
|
15420
|
+
"title": "PartyIdentifier",
|
|
15421
|
+
"type": "string",
|
|
15422
|
+
"minLength": 1,
|
|
15423
|
+
"maxLength": 128,
|
|
15424
|
+
"description": "Identifier of the Party.",
|
|
15425
|
+
"example": "16135551212"
|
|
15426
|
+
},
|
|
15427
|
+
"partySubIdOrType": {
|
|
15428
|
+
"title": "PartySubIdOrType",
|
|
15429
|
+
"type": "string",
|
|
15430
|
+
"minLength": 1,
|
|
15431
|
+
"maxLength": 128,
|
|
15432
|
+
"description": "Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType."
|
|
15433
|
+
},
|
|
15434
|
+
"fspId": {
|
|
15435
|
+
"title": "FspId",
|
|
15436
|
+
"type": "string",
|
|
15437
|
+
"minLength": 1,
|
|
15438
|
+
"maxLength": 32,
|
|
15439
|
+
"description": "FSP identifier."
|
|
15440
|
+
},
|
|
15441
|
+
"extensionList": {
|
|
15442
|
+
"title": "ExtensionList",
|
|
15443
|
+
"type": "object",
|
|
15444
|
+
"description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
|
|
15445
|
+
"properties": {
|
|
15446
|
+
"extension": {
|
|
15447
|
+
"type": "array",
|
|
15448
|
+
"items": {
|
|
15449
|
+
"title": "Extension",
|
|
15450
|
+
"type": "object",
|
|
15451
|
+
"description": "Data model for the complex type Extension.",
|
|
15452
|
+
"properties": {
|
|
15453
|
+
"key": {
|
|
15454
|
+
"title": "ExtensionKey",
|
|
15455
|
+
"type": "string",
|
|
15456
|
+
"minLength": 1,
|
|
15457
|
+
"maxLength": 32,
|
|
15458
|
+
"description": "Extension key."
|
|
15459
|
+
},
|
|
15460
|
+
"value": {
|
|
15461
|
+
"title": "ExtensionValue",
|
|
15462
|
+
"type": "string",
|
|
15463
|
+
"minLength": 1,
|
|
15464
|
+
"maxLength": 128,
|
|
15465
|
+
"description": "Extension value."
|
|
15466
|
+
}
|
|
15467
|
+
},
|
|
15468
|
+
"required": [
|
|
15469
|
+
"key",
|
|
15470
|
+
"value"
|
|
15471
|
+
]
|
|
15472
|
+
},
|
|
15473
|
+
"minItems": 1,
|
|
15474
|
+
"maxItems": 16,
|
|
15475
|
+
"description": "Number of Extension elements."
|
|
15476
|
+
}
|
|
15477
|
+
},
|
|
15478
|
+
"required": [
|
|
15479
|
+
"extension"
|
|
15480
|
+
]
|
|
15481
|
+
}
|
|
15482
|
+
},
|
|
15483
|
+
"required": [
|
|
15484
|
+
"partyIdType",
|
|
15485
|
+
"partyIdentifier"
|
|
15486
|
+
]
|
|
15487
|
+
},
|
|
15488
|
+
"merchantClassificationCode": {
|
|
15489
|
+
"title": "MerchantClassificationCode",
|
|
15490
|
+
"type": "string",
|
|
15491
|
+
"pattern": "^[\\d]{1,4}$",
|
|
15492
|
+
"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."
|
|
15493
|
+
},
|
|
15494
|
+
"name": {
|
|
15495
|
+
"title": "PartyName",
|
|
15496
|
+
"type": "string",
|
|
15497
|
+
"minLength": 1,
|
|
15498
|
+
"maxLength": 128,
|
|
15499
|
+
"description": "Name of the Party. Could be a real name or a nickname."
|
|
15500
|
+
},
|
|
15501
|
+
"personalInfo": {
|
|
15502
|
+
"title": "PartyPersonalInfo",
|
|
15503
|
+
"type": "object",
|
|
15504
|
+
"description": "Data model for the complex type PartyPersonalInfo.",
|
|
15505
|
+
"properties": {
|
|
15506
|
+
"complexName": {
|
|
15507
|
+
"title": "PartyComplexName",
|
|
15508
|
+
"type": "object",
|
|
15509
|
+
"description": "Data model for the complex type PartyComplexName.",
|
|
15510
|
+
"properties": {
|
|
15511
|
+
"firstName": {
|
|
15512
|
+
"title": "FirstName",
|
|
15513
|
+
"type": "string",
|
|
15514
|
+
"minLength": 1,
|
|
15515
|
+
"maxLength": 128,
|
|
15516
|
+
"pattern": "^(?!\\s*$)[\\p{L}\\p{gc=Mark}\\p{digit}\\p{gc=Connector_Punctuation}\\p{Join_Control} .,''-]{1,128}$",
|
|
15517
|
+
"description": "First name of the Party (Name Type).",
|
|
15518
|
+
"example": "Henrik"
|
|
15519
|
+
},
|
|
15520
|
+
"middleName": {
|
|
15521
|
+
"title": "MiddleName",
|
|
15522
|
+
"type": "string",
|
|
15523
|
+
"minLength": 1,
|
|
15524
|
+
"maxLength": 128,
|
|
15525
|
+
"pattern": "^(?!\\s*$)[\\p{L}\\p{gc=Mark}\\p{digit}\\p{gc=Connector_Punctuation}\\p{Join_Control} .,''-]{1,128}$",
|
|
15526
|
+
"description": "Middle name of the Party (Name Type).",
|
|
15527
|
+
"example": "Johannes"
|
|
15528
|
+
},
|
|
15529
|
+
"lastName": {
|
|
15530
|
+
"title": "LastName",
|
|
15531
|
+
"type": "string",
|
|
15532
|
+
"minLength": 1,
|
|
15533
|
+
"maxLength": 128,
|
|
15534
|
+
"pattern": "^(?!\\s*$)[\\p{L}\\p{gc=Mark}\\p{digit}\\p{gc=Connector_Punctuation}\\p{Join_Control} .,''-]{1,128}$",
|
|
15535
|
+
"description": "Last name of the Party (Name Type).",
|
|
15536
|
+
"example": "Karlsson"
|
|
15537
|
+
}
|
|
15538
|
+
}
|
|
15539
|
+
},
|
|
15540
|
+
"dateOfBirth": {
|
|
15541
|
+
"title": "DateofBirth (type Date)",
|
|
15542
|
+
"type": "string",
|
|
15543
|
+
"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)$",
|
|
15544
|
+
"description": "Date of Birth of the Party.",
|
|
15545
|
+
"example": "1966-06-16"
|
|
15546
|
+
}
|
|
15547
|
+
}
|
|
15548
|
+
}
|
|
15549
|
+
},
|
|
15550
|
+
"required": [
|
|
15551
|
+
"partyIdInfo"
|
|
15552
|
+
]
|
|
15553
|
+
},
|
|
15554
|
+
"headers": {
|
|
15555
|
+
"type": "object"
|
|
15556
|
+
}
|
|
15557
|
+
},
|
|
15558
|
+
"required": [
|
|
15559
|
+
"body",
|
|
15560
|
+
"headers"
|
|
15561
|
+
]
|
|
15562
|
+
},
|
|
15563
|
+
"TransactionRequestState": {
|
|
15564
|
+
"title": "TransactionRequestState",
|
|
15565
|
+
"type": "string",
|
|
15566
|
+
"enum": [
|
|
15567
|
+
"RECEIVED",
|
|
15568
|
+
"PENDING",
|
|
15569
|
+
"ACCEPTED",
|
|
15570
|
+
"REJECTED"
|
|
15571
|
+
],
|
|
15572
|
+
"description": "Below are the allowed values for the enumeration.\n- RECEIVED - Payer FSP has received the transaction from the Payee FSP.\n- PENDING - Payer FSP has sent the transaction request to the Payer.\n- ACCEPTED - Payer has approved the transaction.\n- REJECTED - Payer has rejected the transaction.",
|
|
15573
|
+
"example": "RECEIVED"
|
|
15574
|
+
},
|
|
15575
|
+
"TransactionRequestResponse": {
|
|
15576
|
+
"title": "TransactionRequestResponse",
|
|
15577
|
+
"type": "object",
|
|
15578
|
+
"description": "The object sent in the PUT /transactionRequests/{ID} callback.",
|
|
15579
|
+
"properties": {
|
|
15580
|
+
"body": {
|
|
15581
|
+
"type": "object",
|
|
15582
|
+
"properties": {
|
|
15583
|
+
"transactionId": {
|
|
15584
|
+
"title": "CorrelationId",
|
|
15585
|
+
"type": "string",
|
|
15586
|
+
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
|
|
15587
|
+
"description": "Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).",
|
|
15588
|
+
"example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
|
|
15589
|
+
},
|
|
15590
|
+
"transactionRequestState": {
|
|
15591
|
+
"title": "TransactionRequestState",
|
|
15592
|
+
"type": "string",
|
|
15593
|
+
"enum": [
|
|
15594
|
+
"RECEIVED",
|
|
15595
|
+
"PENDING",
|
|
15596
|
+
"ACCEPTED",
|
|
15597
|
+
"REJECTED"
|
|
15598
|
+
],
|
|
15599
|
+
"description": "Below are the allowed values for the enumeration.\n- RECEIVED - Payer FSP has received the transaction from the Payee FSP.\n- PENDING - Payer FSP has sent the transaction request to the Payer.\n- ACCEPTED - Payer has approved the transaction.\n- REJECTED - Payer has rejected the transaction.",
|
|
15600
|
+
"example": "RECEIVED"
|
|
15601
|
+
},
|
|
15602
|
+
"extensionList": {
|
|
15603
|
+
"title": "ExtensionList",
|
|
15604
|
+
"type": "object",
|
|
15605
|
+
"description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
|
|
15606
|
+
"properties": {
|
|
15607
|
+
"extension": {
|
|
15608
|
+
"type": "array",
|
|
15609
|
+
"items": {
|
|
15610
|
+
"title": "Extension",
|
|
15611
|
+
"type": "object",
|
|
15612
|
+
"description": "Data model for the complex type Extension.",
|
|
15613
|
+
"properties": {
|
|
15614
|
+
"key": {
|
|
15615
|
+
"title": "ExtensionKey",
|
|
15616
|
+
"type": "string",
|
|
15617
|
+
"minLength": 1,
|
|
15618
|
+
"maxLength": 32,
|
|
15619
|
+
"description": "Extension key."
|
|
15620
|
+
},
|
|
15621
|
+
"value": {
|
|
15622
|
+
"title": "ExtensionValue",
|
|
15623
|
+
"type": "string",
|
|
15624
|
+
"minLength": 1,
|
|
15625
|
+
"maxLength": 128,
|
|
15626
|
+
"description": "Extension value."
|
|
15627
|
+
}
|
|
15628
|
+
},
|
|
15629
|
+
"required": [
|
|
15630
|
+
"key",
|
|
15631
|
+
"value"
|
|
15632
|
+
]
|
|
15633
|
+
},
|
|
15634
|
+
"minItems": 1,
|
|
15635
|
+
"maxItems": 16,
|
|
15636
|
+
"description": "Number of Extension elements."
|
|
15637
|
+
}
|
|
15638
|
+
},
|
|
15639
|
+
"required": [
|
|
15640
|
+
"extension"
|
|
15641
|
+
]
|
|
15642
|
+
}
|
|
15643
|
+
},
|
|
15644
|
+
"required": [
|
|
15645
|
+
"transactionRequestState"
|
|
15646
|
+
]
|
|
15647
|
+
},
|
|
15648
|
+
"headers": {
|
|
15649
|
+
"type": "object"
|
|
15650
|
+
}
|
|
15651
|
+
},
|
|
15652
|
+
"required": [
|
|
15653
|
+
"body",
|
|
15654
|
+
"headers"
|
|
15655
|
+
]
|
|
15656
|
+
},
|
|
15368
15657
|
"requestToPayResponse": {
|
|
15369
15658
|
"type": "object",
|
|
15370
15659
|
"required": [
|
|
15371
|
-
"
|
|
15660
|
+
"transactionRequestId",
|
|
15372
15661
|
"from",
|
|
15373
15662
|
"to",
|
|
15374
15663
|
"amountType",
|
|
@@ -15378,13 +15667,6 @@
|
|
|
15378
15667
|
"currentState"
|
|
15379
15668
|
],
|
|
15380
15669
|
"properties": {
|
|
15381
|
-
"requestToPayId": {
|
|
15382
|
-
"title": "CorrelationId",
|
|
15383
|
-
"type": "string",
|
|
15384
|
-
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
|
|
15385
|
-
"description": "Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).",
|
|
15386
|
-
"example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
|
|
15387
|
-
},
|
|
15388
15670
|
"transactionRequestId": {
|
|
15389
15671
|
"title": "CorrelationId",
|
|
15390
15672
|
"type": "string",
|
|
@@ -15392,10 +15674,6 @@
|
|
|
15392
15674
|
"description": "Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).",
|
|
15393
15675
|
"example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
|
|
15394
15676
|
},
|
|
15395
|
-
"homeTransactionId": {
|
|
15396
|
-
"type": "string",
|
|
15397
|
-
"description": "Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems."
|
|
15398
|
-
},
|
|
15399
15677
|
"from": {
|
|
15400
15678
|
"type": "object",
|
|
15401
15679
|
"required": [
|
|
@@ -15879,23 +16157,264 @@
|
|
|
15879
16157
|
"enum": [
|
|
15880
16158
|
"ERROR_OCCURRED",
|
|
15881
16159
|
"WAITING_FOR_PARTY_ACCEPTANCE",
|
|
15882
|
-
"WAITING_FOR_QUOTE_ACCEPTANCE",
|
|
15883
16160
|
"COMPLETED"
|
|
15884
16161
|
]
|
|
15885
16162
|
},
|
|
15886
16163
|
"getPartiesResponse": {
|
|
16164
|
+
"title": "getPartiesResponse",
|
|
15887
16165
|
"type": "object",
|
|
15888
|
-
"
|
|
15889
|
-
"body"
|
|
15890
|
-
],
|
|
16166
|
+
"description": "The object sent in the GET /parties/{Type}/{ID} callback.",
|
|
15891
16167
|
"properties": {
|
|
15892
16168
|
"body": {
|
|
16169
|
+
"title": "Party",
|
|
16170
|
+
"type": "object",
|
|
16171
|
+
"description": "Data model for the complex type Party.",
|
|
16172
|
+
"properties": {
|
|
16173
|
+
"partyIdInfo": {
|
|
16174
|
+
"title": "PartyIdInfo",
|
|
16175
|
+
"type": "object",
|
|
16176
|
+
"description": "Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1",
|
|
16177
|
+
"properties": {
|
|
16178
|
+
"partyIdType": {
|
|
16179
|
+
"title": "PartyIdType",
|
|
16180
|
+
"type": "string",
|
|
16181
|
+
"enum": [
|
|
16182
|
+
"MSISDN",
|
|
16183
|
+
"EMAIL",
|
|
16184
|
+
"PERSONAL_ID",
|
|
16185
|
+
"BUSINESS",
|
|
16186
|
+
"DEVICE",
|
|
16187
|
+
"ACCOUNT_ID",
|
|
16188
|
+
"IBAN",
|
|
16189
|
+
"ALIAS"
|
|
16190
|
+
],
|
|
16191
|
+
"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."
|
|
16192
|
+
},
|
|
16193
|
+
"partyIdentifier": {
|
|
16194
|
+
"title": "PartyIdentifier",
|
|
16195
|
+
"type": "string",
|
|
16196
|
+
"minLength": 1,
|
|
16197
|
+
"maxLength": 128,
|
|
16198
|
+
"description": "Identifier of the Party.",
|
|
16199
|
+
"example": "16135551212"
|
|
16200
|
+
},
|
|
16201
|
+
"partySubIdOrType": {
|
|
16202
|
+
"title": "PartySubIdOrType",
|
|
16203
|
+
"type": "string",
|
|
16204
|
+
"minLength": 1,
|
|
16205
|
+
"maxLength": 128,
|
|
16206
|
+
"description": "Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType."
|
|
16207
|
+
},
|
|
16208
|
+
"fspId": {
|
|
16209
|
+
"title": "FspId",
|
|
16210
|
+
"type": "string",
|
|
16211
|
+
"minLength": 1,
|
|
16212
|
+
"maxLength": 32,
|
|
16213
|
+
"description": "FSP identifier."
|
|
16214
|
+
},
|
|
16215
|
+
"extensionList": {
|
|
16216
|
+
"title": "ExtensionList",
|
|
16217
|
+
"type": "object",
|
|
16218
|
+
"description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
|
|
16219
|
+
"properties": {
|
|
16220
|
+
"extension": {
|
|
16221
|
+
"type": "array",
|
|
16222
|
+
"items": {
|
|
16223
|
+
"title": "Extension",
|
|
16224
|
+
"type": "object",
|
|
16225
|
+
"description": "Data model for the complex type Extension.",
|
|
16226
|
+
"properties": {
|
|
16227
|
+
"key": {
|
|
16228
|
+
"title": "ExtensionKey",
|
|
16229
|
+
"type": "string",
|
|
16230
|
+
"minLength": 1,
|
|
16231
|
+
"maxLength": 32,
|
|
16232
|
+
"description": "Extension key."
|
|
16233
|
+
},
|
|
16234
|
+
"value": {
|
|
16235
|
+
"title": "ExtensionValue",
|
|
16236
|
+
"type": "string",
|
|
16237
|
+
"minLength": 1,
|
|
16238
|
+
"maxLength": 128,
|
|
16239
|
+
"description": "Extension value."
|
|
16240
|
+
}
|
|
16241
|
+
},
|
|
16242
|
+
"required": [
|
|
16243
|
+
"key",
|
|
16244
|
+
"value"
|
|
16245
|
+
]
|
|
16246
|
+
},
|
|
16247
|
+
"minItems": 1,
|
|
16248
|
+
"maxItems": 16,
|
|
16249
|
+
"description": "Number of Extension elements."
|
|
16250
|
+
}
|
|
16251
|
+
},
|
|
16252
|
+
"required": [
|
|
16253
|
+
"extension"
|
|
16254
|
+
]
|
|
16255
|
+
}
|
|
16256
|
+
},
|
|
16257
|
+
"required": [
|
|
16258
|
+
"partyIdType",
|
|
16259
|
+
"partyIdentifier"
|
|
16260
|
+
]
|
|
16261
|
+
},
|
|
16262
|
+
"merchantClassificationCode": {
|
|
16263
|
+
"title": "MerchantClassificationCode",
|
|
16264
|
+
"type": "string",
|
|
16265
|
+
"pattern": "^[\\d]{1,4}$",
|
|
16266
|
+
"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."
|
|
16267
|
+
},
|
|
16268
|
+
"name": {
|
|
16269
|
+
"title": "PartyName",
|
|
16270
|
+
"type": "string",
|
|
16271
|
+
"minLength": 1,
|
|
16272
|
+
"maxLength": 128,
|
|
16273
|
+
"description": "Name of the Party. Could be a real name or a nickname."
|
|
16274
|
+
},
|
|
16275
|
+
"personalInfo": {
|
|
16276
|
+
"title": "PartyPersonalInfo",
|
|
16277
|
+
"type": "object",
|
|
16278
|
+
"description": "Data model for the complex type PartyPersonalInfo.",
|
|
16279
|
+
"properties": {
|
|
16280
|
+
"complexName": {
|
|
16281
|
+
"title": "PartyComplexName",
|
|
16282
|
+
"type": "object",
|
|
16283
|
+
"description": "Data model for the complex type PartyComplexName.",
|
|
16284
|
+
"properties": {
|
|
16285
|
+
"firstName": {
|
|
16286
|
+
"title": "FirstName",
|
|
16287
|
+
"type": "string",
|
|
16288
|
+
"minLength": 1,
|
|
16289
|
+
"maxLength": 128,
|
|
16290
|
+
"pattern": "^(?!\\s*$)[\\p{L}\\p{gc=Mark}\\p{digit}\\p{gc=Connector_Punctuation}\\p{Join_Control} .,''-]{1,128}$",
|
|
16291
|
+
"description": "First name of the Party (Name Type).",
|
|
16292
|
+
"example": "Henrik"
|
|
16293
|
+
},
|
|
16294
|
+
"middleName": {
|
|
16295
|
+
"title": "MiddleName",
|
|
16296
|
+
"type": "string",
|
|
16297
|
+
"minLength": 1,
|
|
16298
|
+
"maxLength": 128,
|
|
16299
|
+
"pattern": "^(?!\\s*$)[\\p{L}\\p{gc=Mark}\\p{digit}\\p{gc=Connector_Punctuation}\\p{Join_Control} .,''-]{1,128}$",
|
|
16300
|
+
"description": "Middle name of the Party (Name Type).",
|
|
16301
|
+
"example": "Johannes"
|
|
16302
|
+
},
|
|
16303
|
+
"lastName": {
|
|
16304
|
+
"title": "LastName",
|
|
16305
|
+
"type": "string",
|
|
16306
|
+
"minLength": 1,
|
|
16307
|
+
"maxLength": 128,
|
|
16308
|
+
"pattern": "^(?!\\s*$)[\\p{L}\\p{gc=Mark}\\p{digit}\\p{gc=Connector_Punctuation}\\p{Join_Control} .,''-]{1,128}$",
|
|
16309
|
+
"description": "Last name of the Party (Name Type).",
|
|
16310
|
+
"example": "Karlsson"
|
|
16311
|
+
}
|
|
16312
|
+
}
|
|
16313
|
+
},
|
|
16314
|
+
"dateOfBirth": {
|
|
16315
|
+
"title": "DateofBirth (type Date)",
|
|
16316
|
+
"type": "string",
|
|
16317
|
+
"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)$",
|
|
16318
|
+
"description": "Date of Birth of the Party.",
|
|
16319
|
+
"example": "1966-06-16"
|
|
16320
|
+
}
|
|
16321
|
+
}
|
|
16322
|
+
}
|
|
16323
|
+
},
|
|
16324
|
+
"required": [
|
|
16325
|
+
"partyIdInfo"
|
|
16326
|
+
]
|
|
16327
|
+
},
|
|
16328
|
+
"headers": {
|
|
15893
16329
|
"type": "object"
|
|
16330
|
+
}
|
|
16331
|
+
},
|
|
16332
|
+
"required": [
|
|
16333
|
+
"body",
|
|
16334
|
+
"headers"
|
|
16335
|
+
]
|
|
16336
|
+
},
|
|
16337
|
+
"transactionRequestResponse": {
|
|
16338
|
+
"title": "TransactionRequestResponse",
|
|
16339
|
+
"type": "object",
|
|
16340
|
+
"description": "The object sent in the PUT /transactionRequests/{ID} callback.",
|
|
16341
|
+
"properties": {
|
|
16342
|
+
"body": {
|
|
16343
|
+
"type": "object",
|
|
16344
|
+
"properties": {
|
|
16345
|
+
"transactionId": {
|
|
16346
|
+
"title": "CorrelationId",
|
|
16347
|
+
"type": "string",
|
|
16348
|
+
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$",
|
|
16349
|
+
"description": "Identifier that correlates all messages of the same sequence. The API data type UUID (Universally Unique Identifier) is a JSON String in canonical format, conforming to [RFC 4122](https://tools.ietf.org/html/rfc4122), that is restricted by a regular expression for interoperability reasons. A UUID is always 36 characters long, 32 hexadecimal symbols and 4 dashes (‘-‘).",
|
|
16350
|
+
"example": "b51ec534-ee48-4575-b6a9-ead2955b8069"
|
|
16351
|
+
},
|
|
16352
|
+
"transactionRequestState": {
|
|
16353
|
+
"title": "TransactionRequestState",
|
|
16354
|
+
"type": "string",
|
|
16355
|
+
"enum": [
|
|
16356
|
+
"RECEIVED",
|
|
16357
|
+
"PENDING",
|
|
16358
|
+
"ACCEPTED",
|
|
16359
|
+
"REJECTED"
|
|
16360
|
+
],
|
|
16361
|
+
"description": "Below are the allowed values for the enumeration.\n- RECEIVED - Payer FSP has received the transaction from the Payee FSP.\n- PENDING - Payer FSP has sent the transaction request to the Payer.\n- ACCEPTED - Payer has approved the transaction.\n- REJECTED - Payer has rejected the transaction.",
|
|
16362
|
+
"example": "RECEIVED"
|
|
16363
|
+
},
|
|
16364
|
+
"extensionList": {
|
|
16365
|
+
"title": "ExtensionList",
|
|
16366
|
+
"type": "object",
|
|
16367
|
+
"description": "Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.",
|
|
16368
|
+
"properties": {
|
|
16369
|
+
"extension": {
|
|
16370
|
+
"type": "array",
|
|
16371
|
+
"items": {
|
|
16372
|
+
"title": "Extension",
|
|
16373
|
+
"type": "object",
|
|
16374
|
+
"description": "Data model for the complex type Extension.",
|
|
16375
|
+
"properties": {
|
|
16376
|
+
"key": {
|
|
16377
|
+
"title": "ExtensionKey",
|
|
16378
|
+
"type": "string",
|
|
16379
|
+
"minLength": 1,
|
|
16380
|
+
"maxLength": 32,
|
|
16381
|
+
"description": "Extension key."
|
|
16382
|
+
},
|
|
16383
|
+
"value": {
|
|
16384
|
+
"title": "ExtensionValue",
|
|
16385
|
+
"type": "string",
|
|
16386
|
+
"minLength": 1,
|
|
16387
|
+
"maxLength": 128,
|
|
16388
|
+
"description": "Extension value."
|
|
16389
|
+
}
|
|
16390
|
+
},
|
|
16391
|
+
"required": [
|
|
16392
|
+
"key",
|
|
16393
|
+
"value"
|
|
16394
|
+
]
|
|
16395
|
+
},
|
|
16396
|
+
"minItems": 1,
|
|
16397
|
+
"maxItems": 16,
|
|
16398
|
+
"description": "Number of Extension elements."
|
|
16399
|
+
}
|
|
16400
|
+
},
|
|
16401
|
+
"required": [
|
|
16402
|
+
"extension"
|
|
16403
|
+
]
|
|
16404
|
+
}
|
|
16405
|
+
},
|
|
16406
|
+
"required": [
|
|
16407
|
+
"transactionRequestState"
|
|
16408
|
+
]
|
|
15894
16409
|
},
|
|
15895
16410
|
"headers": {
|
|
15896
16411
|
"type": "object"
|
|
15897
16412
|
}
|
|
15898
|
-
}
|
|
16413
|
+
},
|
|
16414
|
+
"required": [
|
|
16415
|
+
"body",
|
|
16416
|
+
"headers"
|
|
16417
|
+
]
|
|
15899
16418
|
},
|
|
15900
16419
|
"lastError": {
|
|
15901
16420
|
"type": "object",
|
|
@@ -15980,6 +16499,15 @@
|
|
|
15980
16499
|
}
|
|
15981
16500
|
}
|
|
15982
16501
|
},
|
|
16502
|
+
"transferStatus": {
|
|
16503
|
+
"type": "string",
|
|
16504
|
+
"enum": [
|
|
16505
|
+
"ERROR_OCCURRED",
|
|
16506
|
+
"WAITING_FOR_PARTY_ACCEPTANCE",
|
|
16507
|
+
"WAITING_FOR_QUOTE_ACCEPTANCE",
|
|
16508
|
+
"COMPLETED"
|
|
16509
|
+
]
|
|
16510
|
+
},
|
|
15983
16511
|
"QuotesIDPutResponse": {
|
|
15984
16512
|
"title": "QuotesIDPutResponse",
|
|
15985
16513
|
"type": "object",
|