@mojaloop/api-snippets 17.2.5 → 17.3.0
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/audit-ci.jsonc +1 -0
- package/docs/fspiop-rest-v1.0-openapi3-snippets.yaml +204 -805
- package/docs/fspiop-rest-v1.1-openapi3-snippets.yaml +2432 -2447
- package/docs/fspiop-rest-v2.0-openapi3-snippets.yaml +4841 -0
- package/docs/index.html +1 -0
- package/docs/sdk-scheme-adapter-backend-v2_0_0-openapi3-snippets.yaml +103 -345
- package/docs/sdk-scheme-adapter-outbound-v2_0_0-openapi3-snippets.yaml +150 -492
- package/docs/thirdparty-openapi3-snippets.yaml +296 -886
- package/fspiop/v1_1/openapi3/openapi.yaml +10 -2
- package/fspiop/v2_0/openapi3/components/headers/Content-Length.yaml +9 -0
- package/fspiop/v2_0/openapi3/components/headers/Content-Type.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/parameters/Accept.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/parameters/Content-Length.yaml +11 -0
- package/fspiop/v2_0/openapi3/components/parameters/Content-Type.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/parameters/Date.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-Destination.yaml +13 -0
- package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-Encryption.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-HTTP-Method.yaml +11 -0
- package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-Signature.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-Source.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/parameters/FSPIOP-URI.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/parameters/ID.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/parameters/SourceCurrency.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/parameters/SubId.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/parameters/TargetCurrency.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/parameters/Type.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/parameters/X-Forwarded-For.yaml +15 -0
- package/fspiop/v2_0/openapi3/components/responses/200.yaml +1 -0
- package/fspiop/v2_0/openapi3/components/responses/202.yaml +1 -0
- package/fspiop/v2_0/openapi3/components/responses/400.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/responses/401.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/responses/403.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/responses/404.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/responses/405.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/responses/406.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/responses/501.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/responses/503.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/schemas/Amount.yaml +11 -0
- package/fspiop/v2_0/openapi3/components/schemas/AmountType.yaml +14 -0
- package/fspiop/v2_0/openapi3/components/schemas/AuthenticationInfo.yaml +11 -0
- package/fspiop/v2_0/openapi3/components/schemas/AuthenticationType.yaml +12 -0
- package/fspiop/v2_0/openapi3/components/schemas/AuthenticationValue.yaml +9 -0
- package/fspiop/v2_0/openapi3/components/schemas/AuthorizationResponse.yaml +12 -0
- package/fspiop/v2_0/openapi3/components/schemas/AuthorizationsIDPutResponse.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/schemas/BalanceOfPayments.yaml +9 -0
- package/fspiop/v2_0/openapi3/components/schemas/BinaryString.yaml +7 -0
- package/fspiop/v2_0/openapi3/components/schemas/BinaryString32.yaml +7 -0
- package/fspiop/v2_0/openapi3/components/schemas/BulkQuotesIDPutResponse.yaml +18 -0
- package/fspiop/v2_0/openapi3/components/schemas/BulkQuotesPostRequest.yaml +25 -0
- package/fspiop/v2_0/openapi3/components/schemas/BulkTransferState.yaml +18 -0
- package/fspiop/v2_0/openapi3/components/schemas/BulkTransfersIDPutResponse.yaml +18 -0
- package/fspiop/v2_0/openapi3/components/schemas/BulkTransfersPostRequest.yaml +30 -0
- package/fspiop/v2_0/openapi3/components/schemas/Code.yaml +5 -0
- package/fspiop/v2_0/openapi3/components/schemas/CorrelationId.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/schemas/Currency.yaml +174 -0
- package/fspiop/v2_0/openapi3/components/schemas/CurrencyConverter.yaml +9 -0
- package/fspiop/v2_0/openapi3/components/schemas/Date.yaml +9 -0
- package/fspiop/v2_0/openapi3/components/schemas/DateOfBirth.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/schemas/DateTime.yaml +14 -0
- package/fspiop/v2_0/openapi3/components/schemas/ErrorCode.yaml +11 -0
- package/fspiop/v2_0/openapi3/components/schemas/ErrorDescription.yaml +5 -0
- package/fspiop/v2_0/openapi3/components/schemas/ErrorInformation.yaml +13 -0
- package/fspiop/v2_0/openapi3/components/schemas/ErrorInformationObject.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/schemas/ErrorInformationResponse.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/schemas/Extension.yaml +11 -0
- package/fspiop/v2_0/openapi3/components/schemas/ExtensionKey.yaml +5 -0
- package/fspiop/v2_0/openapi3/components/schemas/ExtensionList.yaml +15 -0
- package/fspiop/v2_0/openapi3/components/schemas/ExtensionValue.yaml +5 -0
- package/fspiop/v2_0/openapi3/components/schemas/FirstName.yaml +9 -0
- package/fspiop/v2_0/openapi3/components/schemas/FspId.yaml +5 -0
- package/fspiop/v2_0/openapi3/components/schemas/FxCharge.yaml +19 -0
- package/fspiop/v2_0/openapi3/components/schemas/FxConversion.yaml +57 -0
- package/fspiop/v2_0/openapi3/components/schemas/FxMoney.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/schemas/FxQuotesIDPutResponse.yaml +15 -0
- package/fspiop/v2_0/openapi3/components/schemas/FxQuotesPostRequest.yaml +15 -0
- package/fspiop/v2_0/openapi3/components/schemas/FxRate.yaml +15 -0
- package/fspiop/v2_0/openapi3/components/schemas/FxTransfersIDPatchResponse.yaml +16 -0
- package/fspiop/v2_0/openapi3/components/schemas/FxTransfersIDPutResponse.yaml +20 -0
- package/fspiop/v2_0/openapi3/components/schemas/FxTransfersPostRequest.yaml +41 -0
- package/fspiop/v2_0/openapi3/components/schemas/GeoCode.yaml +13 -0
- package/fspiop/v2_0/openapi3/components/schemas/IlpCondition.yaml +5 -0
- package/fspiop/v2_0/openapi3/components/schemas/IlpFulfilment.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/schemas/IlpPacket.yaml +7 -0
- package/fspiop/v2_0/openapi3/components/schemas/IndividualQuote.yaml +29 -0
- package/fspiop/v2_0/openapi3/components/schemas/IndividualQuoteResult.yaml +26 -0
- package/fspiop/v2_0/openapi3/components/schemas/IndividualTransfer.yaml +19 -0
- package/fspiop/v2_0/openapi3/components/schemas/IndividualTransferResult.yaml +14 -0
- package/fspiop/v2_0/openapi3/components/schemas/Integer.yaml +7 -0
- package/fspiop/v2_0/openapi3/components/schemas/KYCInformation.yaml +33 -0
- package/fspiop/v2_0/openapi3/components/schemas/LastName.yaml +9 -0
- package/fspiop/v2_0/openapi3/components/schemas/Latitude.yaml +7 -0
- package/fspiop/v2_0/openapi3/components/schemas/Longitude.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/schemas/MerchantClassificationCode.yaml +7 -0
- package/fspiop/v2_0/openapi3/components/schemas/MiddleName.yaml +9 -0
- package/fspiop/v2_0/openapi3/components/schemas/Money.yaml +11 -0
- package/fspiop/v2_0/openapi3/components/schemas/Name.yaml +17 -0
- package/fspiop/v2_0/openapi3/components/schemas/Note.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/schemas/OtpValue.yaml +7 -0
- package/fspiop/v2_0/openapi3/components/schemas/ParticipantsIDPutResponse.yaml +17 -0
- package/fspiop/v2_0/openapi3/components/schemas/ParticipantsPostRequest.yaml +20 -0
- package/fspiop/v2_0/openapi3/components/schemas/ParticipantsTypeIDPutResponse.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/schemas/ParticipantsTypeIDSubIDPostRequest.yaml +15 -0
- package/fspiop/v2_0/openapi3/components/schemas/PartiesTypeIDPutResponse.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/schemas/Party.yaml +21 -0
- package/fspiop/v2_0/openapi3/components/schemas/PartyComplexName.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/schemas/PartyIdInfo.yaml +19 -0
- package/fspiop/v2_0/openapi3/components/schemas/PartyIdType.yaml +54 -0
- package/fspiop/v2_0/openapi3/components/schemas/PartyIdentifier.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/schemas/PartyName.yaml +5 -0
- package/fspiop/v2_0/openapi3/components/schemas/PartyPersonalInfo.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/schemas/PartyResult.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/schemas/PartySubIdOrType.yaml +7 -0
- package/fspiop/v2_0/openapi3/components/schemas/PersonalIdentifierType.yaml +51 -0
- package/fspiop/v2_0/openapi3/components/schemas/QRCODE.yaml +5 -0
- package/fspiop/v2_0/openapi3/components/schemas/QuotesIDPutResponse.yaml +27 -0
- package/fspiop/v2_0/openapi3/components/schemas/QuotesPostRequest.yaml +53 -0
- package/fspiop/v2_0/openapi3/components/schemas/Refund.yaml +10 -0
- package/fspiop/v2_0/openapi3/components/schemas/RefundReason.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/schemas/ServicesFXPPutResponse.yaml +13 -0
- package/fspiop/v2_0/openapi3/components/schemas/ServicesFXPSourceCurrencyTargetCurrencyPutResponse.yaml +13 -0
- package/fspiop/v2_0/openapi3/components/schemas/TokenCode.yaml +6 -0
- package/fspiop/v2_0/openapi3/components/schemas/Transaction.yaml +50 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionInitiator.yaml +16 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionInitiatorType.yaml +14 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionRequestState.yaml +14 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionRequestsIDPutResponse.yaml +12 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionRequestsPostRequest.yaml +30 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionScenario.yaml +32 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionState.yaml +14 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionSubScenario.yaml +5 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionType.yaml +20 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransactionsIDPutResponse.yaml +14 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransferState.yaml +19 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransfersIDPatchResponse.yaml +13 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransfersIDPutResponse.yaml +14 -0
- package/fspiop/v2_0/openapi3/components/schemas/TransfersPostRequest.yaml +28 -0
- package/fspiop/v2_0/openapi3/components/schemas/U2FPIN.yaml +8 -0
- package/fspiop/v2_0/openapi3/components/schemas/U2FPinValue.yaml +19 -0
- package/fspiop/v2_0/openapi3/components/schemas/UndefinedEnum.yaml +6 -0
- package/fspiop/v2_0/openapi3/openapi.yaml +136 -0
- package/fspiop/v2_0/openapi3/paths/authorizations_ID.yaml +110 -0
- package/fspiop/v2_0/openapi3/paths/authorizations_ID_error.yaml +48 -0
- package/fspiop/v2_0/openapi3/paths/bulkQuotes.yaml +46 -0
- package/fspiop/v2_0/openapi3/paths/bulkQuotes_ID.yaml +79 -0
- package/fspiop/v2_0/openapi3/paths/bulkQuotes_ID_error.yaml +49 -0
- package/fspiop/v2_0/openapi3/paths/bulkTransfers.yaml +46 -0
- package/fspiop/v2_0/openapi3/paths/bulkTransfers_ID.yaml +81 -0
- package/fspiop/v2_0/openapi3/paths/bulkTransfers_ID_error.yaml +49 -0
- package/fspiop/v2_0/openapi3/paths/fxQuotes.yaml +45 -0
- package/fspiop/v2_0/openapi3/paths/fxQuotes_ID.yaml +79 -0
- package/fspiop/v2_0/openapi3/paths/fxQuotes_ID_error.yaml +49 -0
- package/fspiop/v2_0/openapi3/paths/fxTransfers.yaml +45 -0
- package/fspiop/v2_0/openapi3/paths/fxTransfers_ID.yaml +118 -0
- package/fspiop/v2_0/openapi3/paths/fxTransfers_ID_error.yaml +49 -0
- package/fspiop/v2_0/openapi3/paths/participants.yaml +49 -0
- package/fspiop/v2_0/openapi3/paths/participants_ID.yaml +46 -0
- package/fspiop/v2_0/openapi3/paths/participants_ID_error.yaml +48 -0
- package/fspiop/v2_0/openapi3/paths/participants_Type_ID.yaml +167 -0
- package/fspiop/v2_0/openapi3/paths/participants_Type_ID_SubId.yaml +168 -0
- package/fspiop/v2_0/openapi3/paths/participants_Type_ID_SubId_error.yaml +50 -0
- package/fspiop/v2_0/openapi3/paths/participants_Type_ID_error.yaml +49 -0
- package/fspiop/v2_0/openapi3/paths/parties_Type_ID.yaml +81 -0
- package/fspiop/v2_0/openapi3/paths/parties_Type_ID_SubId.yaml +82 -0
- package/fspiop/v2_0/openapi3/paths/parties_Type_ID_SubId_error.yaml +50 -0
- package/fspiop/v2_0/openapi3/paths/parties_Type_ID_error.yaml +49 -0
- package/fspiop/v2_0/openapi3/paths/quotes.yaml +46 -0
- package/fspiop/v2_0/openapi3/paths/quotes_ID.yaml +79 -0
- package/fspiop/v2_0/openapi3/paths/quotes_ID_error.yaml +49 -0
- package/fspiop/v2_0/openapi3/paths/services_FXP.yaml +73 -0
- package/fspiop/v2_0/openapi3/paths/services_FXP_SourceCurrency_TargetCurrency.yaml +77 -0
- package/fspiop/v2_0/openapi3/paths/transactionRequests.yaml +47 -0
- package/fspiop/v2_0/openapi3/paths/transactionRequests_ID.yaml +81 -0
- package/fspiop/v2_0/openapi3/paths/transactionRequests_ID_error.yaml +50 -0
- package/fspiop/v2_0/openapi3/paths/transactions_ID.yaml +80 -0
- package/fspiop/v2_0/openapi3/paths/transactions_ID_error.yaml +48 -0
- package/fspiop/v2_0/openapi3/paths/transfers.yaml +46 -0
- package/fspiop/v2_0/openapi3/paths/transfers_ID.yaml +119 -0
- package/fspiop/v2_0/openapi3/paths/transfers_ID_error.yaml +49 -0
- package/lib/fspiop/v1_1/openapi.d.ts +524 -542
- package/lib/fspiop/v2_0/openapi.d.ts +3964 -0
- package/lib/fspiop/v2_0/openapi.js +7 -0
- package/lib/fspiop/v2_0/openapi.js.map +1 -0
- package/lib/scripts/json-schema-generator.js +4 -5
- package/lib/scripts/json-schema-generator.js.map +1 -1
- package/lib/scripts/openapi-refactor.d.ts +29 -0
- package/lib/scripts/openapi-refactor.js +70 -0
- package/lib/scripts/openapi-refactor.js.map +1 -0
- package/package.json +29 -21
- package/tsconfig.build.json +1 -1
@@ -0,0 +1,3964 @@
|
|
1
|
+
/**
|
2
|
+
* This file was auto-generated by openapi-typescript.
|
3
|
+
* Do not make direct changes to the file.
|
4
|
+
*/
|
5
|
+
export interface paths {
|
6
|
+
"/participants/{Type}/{ID}": {
|
7
|
+
/**
|
8
|
+
* Look up participant information
|
9
|
+
* @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
|
10
|
+
*/
|
11
|
+
get: operations["ParticipantsByTypeAndID"];
|
12
|
+
/**
|
13
|
+
* Return participant information
|
14
|
+
* @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party.
|
15
|
+
*/
|
16
|
+
put: operations["ParticipantsByTypeAndID3"];
|
17
|
+
/**
|
18
|
+
* Create participant information
|
19
|
+
* @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1
|
20
|
+
*/
|
21
|
+
post: operations["ParticipantsByIDAndType"];
|
22
|
+
/**
|
23
|
+
* Delete participant information
|
24
|
+
* @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
|
25
|
+
*
|
26
|
+
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
27
|
+
*/
|
28
|
+
delete: operations["ParticipantsByTypeAndID2"];
|
29
|
+
parameters: {
|
30
|
+
header: {
|
31
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
32
|
+
Date: components["parameters"]["Date"];
|
33
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
34
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
35
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
36
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
37
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
38
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
39
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
40
|
+
};
|
41
|
+
path: {
|
42
|
+
Type: components["parameters"]["Type"];
|
43
|
+
ID: components["parameters"]["ID"];
|
44
|
+
};
|
45
|
+
};
|
46
|
+
};
|
47
|
+
"/participants/{Type}/{ID}/error": {
|
48
|
+
/**
|
49
|
+
* Return participant information error
|
50
|
+
* @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used.
|
51
|
+
*/
|
52
|
+
put: operations["ParticipantsErrorByTypeAndID"];
|
53
|
+
};
|
54
|
+
"/participants/{Type}/{ID}/{SubId}": {
|
55
|
+
/**
|
56
|
+
* Look up participant information
|
57
|
+
* @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
|
58
|
+
*/
|
59
|
+
get: operations["ParticipantsSubIdByTypeAndID"];
|
60
|
+
/**
|
61
|
+
* Return participant information
|
62
|
+
* @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party.
|
63
|
+
*/
|
64
|
+
put: operations["ParticipantsSubIdByTypeAndID3"];
|
65
|
+
/**
|
66
|
+
* Create participant information
|
67
|
+
* @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1
|
68
|
+
*/
|
69
|
+
post: operations["ParticipantsSubIdByTypeAndIDPost"];
|
70
|
+
/**
|
71
|
+
* Delete participant information
|
72
|
+
* @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
|
73
|
+
*
|
74
|
+
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
75
|
+
*/
|
76
|
+
delete: operations["ParticipantsSubIdByTypeAndID2"];
|
77
|
+
parameters: {
|
78
|
+
header: {
|
79
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
80
|
+
Date: components["parameters"]["Date"];
|
81
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
82
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
83
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
84
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
85
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
86
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
87
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
88
|
+
};
|
89
|
+
path: {
|
90
|
+
Type: components["parameters"]["Type"];
|
91
|
+
ID: components["parameters"]["ID"];
|
92
|
+
SubId: components["parameters"]["SubId"];
|
93
|
+
};
|
94
|
+
};
|
95
|
+
};
|
96
|
+
"/participants/{Type}/{ID}/{SubId}/error": {
|
97
|
+
/**
|
98
|
+
* Return participant information error
|
99
|
+
* @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used.
|
100
|
+
*/
|
101
|
+
put: operations["ParticipantsSubIdErrorByTypeAndID"];
|
102
|
+
};
|
103
|
+
"/participants": {
|
104
|
+
/**
|
105
|
+
* Create bulk participant information
|
106
|
+
* @description The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency.
|
107
|
+
*/
|
108
|
+
post: operations["Participants1"];
|
109
|
+
};
|
110
|
+
"/participants/{ID}": {
|
111
|
+
/**
|
112
|
+
* Return bulk participant information
|
113
|
+
* @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
|
114
|
+
*/
|
115
|
+
put: operations["putParticipantsByID"];
|
116
|
+
};
|
117
|
+
"/participants/{ID}/error": {
|
118
|
+
/**
|
119
|
+
* Return bulk participant information error
|
120
|
+
* @description If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information.
|
121
|
+
*/
|
122
|
+
put: operations["ParticipantsByIDAndError"];
|
123
|
+
};
|
124
|
+
"/parties/{Type}/{ID}": {
|
125
|
+
/**
|
126
|
+
* Look up party information
|
127
|
+
* @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).
|
128
|
+
*/
|
129
|
+
get: operations["PartiesByTypeAndID"];
|
130
|
+
/**
|
131
|
+
* Return party information
|
132
|
+
* @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.
|
133
|
+
*/
|
134
|
+
put: operations["PartiesByTypeAndID2"];
|
135
|
+
parameters: {
|
136
|
+
header: {
|
137
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
138
|
+
Date: components["parameters"]["Date"];
|
139
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
140
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
141
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
142
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
143
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
144
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
145
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
146
|
+
};
|
147
|
+
path: {
|
148
|
+
Type: components["parameters"]["Type"];
|
149
|
+
ID: components["parameters"]["ID"];
|
150
|
+
};
|
151
|
+
};
|
152
|
+
};
|
153
|
+
"/parties/{Type}/{ID}/error": {
|
154
|
+
/**
|
155
|
+
* Return party information error
|
156
|
+
* @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used.
|
157
|
+
*/
|
158
|
+
put: operations["PartiesErrorByTypeAndID"];
|
159
|
+
};
|
160
|
+
"/parties/{Type}/{ID}/{SubId}": {
|
161
|
+
/**
|
162
|
+
* Look up party information
|
163
|
+
* @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).
|
164
|
+
*/
|
165
|
+
get: operations["PartiesSubIdByTypeAndID"];
|
166
|
+
/**
|
167
|
+
* Return party information
|
168
|
+
* @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.
|
169
|
+
*/
|
170
|
+
put: operations["PartiesSubIdByTypeAndIDPut"];
|
171
|
+
parameters: {
|
172
|
+
header: {
|
173
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
174
|
+
Date: components["parameters"]["Date"];
|
175
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
176
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
177
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
178
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
179
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
180
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
181
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
182
|
+
};
|
183
|
+
path: {
|
184
|
+
Type: components["parameters"]["Type"];
|
185
|
+
ID: components["parameters"]["ID"];
|
186
|
+
SubId: components["parameters"]["SubId"];
|
187
|
+
};
|
188
|
+
};
|
189
|
+
};
|
190
|
+
"/parties/{Type}/{ID}/{SubId}/error": {
|
191
|
+
/**
|
192
|
+
* Return party information error
|
193
|
+
* @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used.
|
194
|
+
*/
|
195
|
+
put: operations["PartiesSubIdErrorByTypeAndID"];
|
196
|
+
};
|
197
|
+
"/transactionRequests": {
|
198
|
+
/**
|
199
|
+
* Perform transaction request
|
200
|
+
* @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server.
|
201
|
+
*/
|
202
|
+
post: operations["TransactionRequests"];
|
203
|
+
};
|
204
|
+
"/transactionRequests/{ID}": {
|
205
|
+
/**
|
206
|
+
* Retrieve transaction request information
|
207
|
+
* @description The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request.
|
208
|
+
*/
|
209
|
+
get: operations["TransactionRequestsByID"];
|
210
|
+
/**
|
211
|
+
* Return transaction request information
|
212
|
+
* @description The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`.
|
213
|
+
*/
|
214
|
+
put: operations["TransactionRequestsByIDPut"];
|
215
|
+
parameters: {
|
216
|
+
header: {
|
217
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
218
|
+
Date: components["parameters"]["Date"];
|
219
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
220
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
221
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
222
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
223
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
224
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
225
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
226
|
+
};
|
227
|
+
path: {
|
228
|
+
ID: components["parameters"]["ID"];
|
229
|
+
};
|
230
|
+
};
|
231
|
+
};
|
232
|
+
"/transactionRequests/{ID}/error": {
|
233
|
+
/**
|
234
|
+
* Return transaction request information error
|
235
|
+
* @description If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`.
|
236
|
+
*/
|
237
|
+
put: operations["TransactionRequestsErrorByID"];
|
238
|
+
};
|
239
|
+
"/quotes": {
|
240
|
+
/**
|
241
|
+
* Calculate quote
|
242
|
+
* @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server.
|
243
|
+
*/
|
244
|
+
post: operations["Quotes"];
|
245
|
+
};
|
246
|
+
"/quotes/{ID}": {
|
247
|
+
/**
|
248
|
+
* Retrieve quote information
|
249
|
+
* @description The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote.
|
250
|
+
*/
|
251
|
+
get: operations["QuotesByID"];
|
252
|
+
/**
|
253
|
+
* Return quote information
|
254
|
+
* @description The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request.
|
255
|
+
*/
|
256
|
+
put: operations["QuotesByID1"];
|
257
|
+
parameters: {
|
258
|
+
header: {
|
259
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
260
|
+
Date: components["parameters"]["Date"];
|
261
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
262
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
263
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
264
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
265
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
266
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
267
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
268
|
+
};
|
269
|
+
path: {
|
270
|
+
ID: components["parameters"]["ID"];
|
271
|
+
};
|
272
|
+
};
|
273
|
+
};
|
274
|
+
"/quotes/{ID}/error": {
|
275
|
+
/**
|
276
|
+
* Return quote information error
|
277
|
+
* @description If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request.
|
278
|
+
*/
|
279
|
+
put: operations["QuotesByIDAndError"];
|
280
|
+
};
|
281
|
+
"/authorizations/{ID}": {
|
282
|
+
/**
|
283
|
+
* Perform authorization
|
284
|
+
* @description The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:*
|
285
|
+
*
|
286
|
+
* - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`.
|
287
|
+
*
|
288
|
+
* - `retriesLeft=={NrOfRetries}`, where `{NrOfRetries}` is the number of retries left before the financial transaction is rejected. `{NrOfRetries}` must be expressed in the form of the data type `Integer`. `retriesLeft=1` means that this is the last retry before the financial transaction is rejected.
|
289
|
+
*
|
290
|
+
* - `amount={Amount}`, where `{Amount}` is the transaction amount that will be withdrawn from the Payer’s account. `{Amount}` must be expressed in the form of the data type `Amount`.
|
291
|
+
*
|
292
|
+
* - `currency={Currency}`, where `{Currency}` is the transaction currency for the amount that will be withdrawn from the Payer’s account. The `{Currency}` value must be expressed in the form of the enumeration `CurrencyCode`.
|
293
|
+
*
|
294
|
+
* The following is an example URI containing all the required key-value pairs in the query string*:*
|
295
|
+
*
|
296
|
+
* `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102¤cy=USD`
|
297
|
+
*/
|
298
|
+
get: operations["AuthorizationsByIDGet"];
|
299
|
+
/**
|
300
|
+
* Return authorization result
|
301
|
+
* @description The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request.
|
302
|
+
*/
|
303
|
+
put: operations["AuthorizationsByIDPut"];
|
304
|
+
parameters: {
|
305
|
+
header: {
|
306
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
307
|
+
Date: components["parameters"]["Date"];
|
308
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
309
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
310
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
311
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
312
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
313
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
314
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
315
|
+
};
|
316
|
+
path: {
|
317
|
+
ID: components["parameters"]["ID"];
|
318
|
+
};
|
319
|
+
};
|
320
|
+
};
|
321
|
+
"/authorizations/{ID}/error": {
|
322
|
+
/**
|
323
|
+
* Return authorization error
|
324
|
+
* @description If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`.
|
325
|
+
*/
|
326
|
+
put: operations["AuthorizationsByIDAndError"];
|
327
|
+
};
|
328
|
+
"/transfers": {
|
329
|
+
/**
|
330
|
+
* Perform transfer
|
331
|
+
* @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP.
|
332
|
+
*/
|
333
|
+
post: operations["transfers"];
|
334
|
+
};
|
335
|
+
"/transfers/{ID}": {
|
336
|
+
/**
|
337
|
+
* Retrieve transfer information
|
338
|
+
* @description The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer.
|
339
|
+
*/
|
340
|
+
get: operations["TransfersByIDGet"];
|
341
|
+
/**
|
342
|
+
* Return transfer information
|
343
|
+
* @description The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request.
|
344
|
+
*/
|
345
|
+
put: operations["TransfersByIDPut"];
|
346
|
+
/**
|
347
|
+
* Return transfer information
|
348
|
+
* @description The HTTP request PATCH /transfers/<ID> is used by a Switch to update the state of a previously reserved transfer, if the Payee FSP has requested a commit notification when the Switch has completed processing of the transfer. The <ID> in the URI should contain the transferId that was used for the creation of the transfer. Please note that this request does not generate a callback.
|
349
|
+
*/
|
350
|
+
patch: operations["TransfersByIDPatch"];
|
351
|
+
parameters: {
|
352
|
+
header: {
|
353
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
354
|
+
Date: components["parameters"]["Date"];
|
355
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
356
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
357
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
358
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
359
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
360
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
361
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
362
|
+
};
|
363
|
+
path: {
|
364
|
+
ID: components["parameters"]["ID"];
|
365
|
+
};
|
366
|
+
};
|
367
|
+
};
|
368
|
+
"/transfers/{ID}/error": {
|
369
|
+
/**
|
370
|
+
* Return transfer information error
|
371
|
+
* @description If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`.
|
372
|
+
*/
|
373
|
+
put: operations["TransfersByIDAndError"];
|
374
|
+
};
|
375
|
+
"/transactions/{ID}": {
|
376
|
+
/**
|
377
|
+
* Retrieve transaction information
|
378
|
+
* @description The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process).
|
379
|
+
*/
|
380
|
+
get: operations["TransactionsByID"];
|
381
|
+
/**
|
382
|
+
* Return transaction information
|
383
|
+
* @description The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request.
|
384
|
+
*/
|
385
|
+
put: operations["TransactionsByID1"];
|
386
|
+
parameters: {
|
387
|
+
header: {
|
388
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
389
|
+
Date: components["parameters"]["Date"];
|
390
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
391
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
392
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
393
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
394
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
395
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
396
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
397
|
+
};
|
398
|
+
path: {
|
399
|
+
ID: components["parameters"]["ID"];
|
400
|
+
};
|
401
|
+
};
|
402
|
+
};
|
403
|
+
"/transactions/{ID}/error": {
|
404
|
+
/**
|
405
|
+
* Return transaction information error
|
406
|
+
* @description If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request.
|
407
|
+
*/
|
408
|
+
put: operations["TransactionsErrorByID"];
|
409
|
+
};
|
410
|
+
"/bulkQuotes": {
|
411
|
+
/**
|
412
|
+
* Calculate bulk quote
|
413
|
+
* @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server.
|
414
|
+
*/
|
415
|
+
post: operations["BulkQuotes"];
|
416
|
+
};
|
417
|
+
"/bulkQuotes/{ID}": {
|
418
|
+
/**
|
419
|
+
* Retrieve bulk quote information
|
420
|
+
* @description The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote.
|
421
|
+
*/
|
422
|
+
get: operations["BulkQuotesByID"];
|
423
|
+
/**
|
424
|
+
* Return bulk quote information
|
425
|
+
* @description The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request.
|
426
|
+
*/
|
427
|
+
put: operations["BulkQuotesByID1"];
|
428
|
+
parameters: {
|
429
|
+
header: {
|
430
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
431
|
+
Date: components["parameters"]["Date"];
|
432
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
433
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
434
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
435
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
436
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
437
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
438
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
439
|
+
};
|
440
|
+
path: {
|
441
|
+
ID: components["parameters"]["ID"];
|
442
|
+
};
|
443
|
+
};
|
444
|
+
};
|
445
|
+
"/bulkQuotes/{ID}/error": {
|
446
|
+
/**
|
447
|
+
* Return bulk quote information error
|
448
|
+
* @description If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request.
|
449
|
+
*/
|
450
|
+
put: operations["BulkQuotesErrorByID"];
|
451
|
+
};
|
452
|
+
"/bulkTransfers": {
|
453
|
+
/**
|
454
|
+
* Perform bulk transfer
|
455
|
+
* @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server.
|
456
|
+
*/
|
457
|
+
post: operations["BulkTransfers"];
|
458
|
+
};
|
459
|
+
"/bulkTransfers/{ID}": {
|
460
|
+
/**
|
461
|
+
* Retrieve bulk transfer information
|
462
|
+
* @description The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer.
|
463
|
+
*/
|
464
|
+
get: operations["BulkTransferByID"];
|
465
|
+
/**
|
466
|
+
* Return bulk transfer information
|
467
|
+
* @description The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request.
|
468
|
+
*/
|
469
|
+
put: operations["BulkTransfersByIDPut"];
|
470
|
+
parameters: {
|
471
|
+
header: {
|
472
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
473
|
+
Date: components["parameters"]["Date"];
|
474
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
475
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
476
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
477
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
478
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
479
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
480
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
481
|
+
};
|
482
|
+
path: {
|
483
|
+
ID: components["parameters"]["ID"];
|
484
|
+
};
|
485
|
+
};
|
486
|
+
};
|
487
|
+
"/bulkTransfers/{ID}/error": {
|
488
|
+
/**
|
489
|
+
* Return bulk transfer information error
|
490
|
+
* @description If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request.
|
491
|
+
*/
|
492
|
+
put: operations["BulkTransfersErrorByID"];
|
493
|
+
};
|
494
|
+
"/fxQuotes": {
|
495
|
+
/**
|
496
|
+
* Calculate FX quote
|
497
|
+
* @description The HTTP request `POST /fxQuotes` is used to ask an FXP to provide a quotation for a currency conversion.
|
498
|
+
*/
|
499
|
+
post: operations["FxQuotesPost"];
|
500
|
+
};
|
501
|
+
"/fxQuotes/{ID}": {
|
502
|
+
/**
|
503
|
+
* Retrieve FX quote information
|
504
|
+
* @description The HTTP request `GET /fxQuotes/{ID}` is used to request information regarding a request for quotation for a currency conversion which the sender has previously issued. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the quote.
|
505
|
+
*/
|
506
|
+
get: operations["FxQuotesByIDGet"];
|
507
|
+
/**
|
508
|
+
* Return FX quote information
|
509
|
+
* @description The callback `PUT /fxQuotes/{ID}` is used to inform the requester about the outcome of a request for quotation for a currency conversion. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the FX quote, or the `{ID}` that was used in the `GET /fxQuotes/{ID}` request.
|
510
|
+
*/
|
511
|
+
put: operations["FxQuotesByIdPut"];
|
512
|
+
parameters: {
|
513
|
+
header: {
|
514
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
515
|
+
Date: components["parameters"]["Date"];
|
516
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
517
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
518
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
519
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
520
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
521
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
522
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
523
|
+
};
|
524
|
+
path: {
|
525
|
+
ID: components["parameters"]["ID"];
|
526
|
+
};
|
527
|
+
};
|
528
|
+
};
|
529
|
+
"/fxQuotes/{ID}/error": {
|
530
|
+
/**
|
531
|
+
* Return FX quote information error
|
532
|
+
* @description If the FXP is unable to find or create a FX quote, or some other processing error occurs, the error callback `PUT /fxQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the FX quote, or the `{ID}` that was used in the `GET /fxQuotes/{ID}` request.
|
533
|
+
*/
|
534
|
+
put: operations["FxQuotesByIDAndErrorPut"];
|
535
|
+
};
|
536
|
+
"/fxTransfers": {
|
537
|
+
/**
|
538
|
+
* Perform FX transfer
|
539
|
+
* @description The HTTP request `POST /fxTransfers` is used to ask an FXP to confirm the execution of an agreed currency conversion.
|
540
|
+
*/
|
541
|
+
post: operations["FxTransfersPost"];
|
542
|
+
};
|
543
|
+
"/fxTransfers/{ID}": {
|
544
|
+
/**
|
545
|
+
* Retrieve FX transfer information
|
546
|
+
* @description The HTTP request `GET /fxTransfers/{ID}` s used to request information regarding a request for confirmation of a currency conversion which the sender has previously issued. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer.
|
547
|
+
*/
|
548
|
+
get: operations["FxTransfersByIDGet"];
|
549
|
+
/**
|
550
|
+
* Return FX transfer information
|
551
|
+
* @description The callback `PUT /fxTransfers/{ID}` is used to inform the requester about the outcome of a request for execution of a currency conversion. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer, or the `{ID}` that was used in the `GET /fxTransfers/{ID}` request.
|
552
|
+
*/
|
553
|
+
put: operations["FxTransfersByIDPut"];
|
554
|
+
/**
|
555
|
+
* Return FX transfer information
|
556
|
+
* @description The HTTP request PATCH /fxTransfers/<ID> is used to inform the requester about the final determination by the switch of the transfer a request for execution of a currency conversion. The <ID> in the URI should contain the commitRequestId that was used for the creation of the FX transfer. Please note that this request does not generate a callback.
|
557
|
+
*/
|
558
|
+
patch: operations["FxTransfersByIDPatch"];
|
559
|
+
parameters: {
|
560
|
+
header: {
|
561
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
562
|
+
Date: components["parameters"]["Date"];
|
563
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
564
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
565
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
566
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
567
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
568
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
569
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
570
|
+
};
|
571
|
+
path: {
|
572
|
+
ID: components["parameters"]["ID"];
|
573
|
+
};
|
574
|
+
};
|
575
|
+
};
|
576
|
+
"/fxTransfers/{ID}/error": {
|
577
|
+
/**
|
578
|
+
* Return FX transfer information error
|
579
|
+
* @description If the switch or FXP is unable to find or create a FX transfer, or another processing error occurs, the error callback `PUT /fxTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer, or the `{ID}` that was used in the `GET /fxTransfers/{ID}`.
|
580
|
+
*/
|
581
|
+
put: operations["FxTransfersByIDAndErrorPut"];
|
582
|
+
};
|
583
|
+
"/services/FXP": {
|
584
|
+
/**
|
585
|
+
* Obtain a list of the DFSPs in the scheme who provide FXP service
|
586
|
+
* @description The HTTP request `GET /services/FXP` is used to request information about the participants in a scheme who offer currency conversion services.
|
587
|
+
*/
|
588
|
+
get: operations["ServicesFXPGet"];
|
589
|
+
/** @description The callback `PUT /services/FXP` is used to inform the requester about participants in a scheme who offer currency conversion services. If no participants offer these services, the return object will be blank. */
|
590
|
+
put: operations["ServicesFXPPut"];
|
591
|
+
parameters: {
|
592
|
+
header: {
|
593
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
594
|
+
Date: components["parameters"]["Date"];
|
595
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
596
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
597
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
598
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
599
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
600
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
601
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
602
|
+
};
|
603
|
+
};
|
604
|
+
};
|
605
|
+
"/services/FXP/{SourceCurrency}/{TargetCurrency}": {
|
606
|
+
/**
|
607
|
+
* Obtain a list of the DFSPs in the scheme who provide FXP service
|
608
|
+
* @description The HTTP request `GET /services/FXP/{SourceCurrency}/{TargetCurrency}` is used to request information about the participants in a scheme who offer currency conversion services in a particular currency corridor. The required corridor is specified by giving the ISO 4217 currency code for the SourceCurrency and the TargetCurrency.
|
609
|
+
*/
|
610
|
+
get: operations["ServicesFXPSourceCurrencyTargetCurrencyGet"];
|
611
|
+
/** @description The callback `PUT /services/FXP/{SourceCurrency}/{TargetCurrency}` is used to inform the requester about participants in a scheme who offer currency conversion services. If no participants offer these services, the return object will be blank. The required corridor is specified by giving the ISO 4217 currency code for the SourceCurrency and the TargetCurrency. */
|
612
|
+
put: operations["ServicesFXPSourceCurrencyTargetCurrencyPut"];
|
613
|
+
parameters: {
|
614
|
+
header: {
|
615
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
616
|
+
Date: components["parameters"]["Date"];
|
617
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
618
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
619
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
620
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
621
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
622
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
623
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
624
|
+
};
|
625
|
+
path: {
|
626
|
+
SourceCurrency: components["parameters"]["SourceCurrency"];
|
627
|
+
TargetCurrency: components["parameters"]["TargetCurrency"];
|
628
|
+
};
|
629
|
+
};
|
630
|
+
};
|
631
|
+
}
|
632
|
+
export type webhooks = Record<string, never>;
|
633
|
+
export interface components {
|
634
|
+
schemas: {
|
635
|
+
/**
|
636
|
+
* Amount
|
637
|
+
* @description The API data type Amount is a JSON String in a canonical format that is restricted by a regular expression for interoperability reasons. This pattern does not allow any trailing zeroes at all, but allows an amount without a minor currency unit. It also only allows four digits in the minor currency unit; a negative value is not allowed. Using more than 18 digits in the major currency unit is not allowed.
|
638
|
+
* @example 123.45
|
639
|
+
*/
|
640
|
+
Amount: string;
|
641
|
+
/**
|
642
|
+
* AmountType
|
643
|
+
* @description Below are the allowed values for the enumeration AmountType.
|
644
|
+
* - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
|
645
|
+
* - RECEIVE - Amount the Payer would like the Payee to receive, that is, the amount that should be sent to the receiver exclusive of any fees.
|
646
|
+
* @example RECEIVE
|
647
|
+
* @enum {string}
|
648
|
+
*/
|
649
|
+
AmountType: "SEND" | "RECEIVE";
|
650
|
+
/**
|
651
|
+
* AuthenticationInfo
|
652
|
+
* @description Data model for the complex type AuthenticationInfo.
|
653
|
+
*/
|
654
|
+
AuthenticationInfo: {
|
655
|
+
authentication: components["schemas"]["AuthenticationType"];
|
656
|
+
authenticationValue: components["schemas"]["AuthenticationValue"];
|
657
|
+
};
|
658
|
+
/**
|
659
|
+
* AuthenticationType
|
660
|
+
* @description Below are the allowed values for the enumeration AuthenticationType.
|
661
|
+
* - OTP - One-time password generated by the Payer FSP.
|
662
|
+
* - QRCODE - QR code used as One Time Password.
|
663
|
+
* - U2F - U2F is a new addition isolated to Thirdparty stream.
|
664
|
+
* @example OTP
|
665
|
+
* @enum {string}
|
666
|
+
*/
|
667
|
+
AuthenticationType: "OTP" | "QRCODE" | "U2F";
|
668
|
+
/**
|
669
|
+
* AuthenticationValue
|
670
|
+
* @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type.
|
671
|
+
*/
|
672
|
+
AuthenticationValue: components["schemas"]["OtpValue"] | components["schemas"]["QRCODE"] | components["schemas"]["U2FPinValue"];
|
673
|
+
/**
|
674
|
+
* AuthorizationResponse
|
675
|
+
* @description Below are the allowed values for the enumeration.
|
676
|
+
* - ENTERED - Consumer entered the authentication value.
|
677
|
+
* - REJECTED - Consumer rejected the transaction.
|
678
|
+
* - RESEND - Consumer requested to resend the authentication value.
|
679
|
+
* @example ENTERED
|
680
|
+
* @enum {string}
|
681
|
+
*/
|
682
|
+
AuthorizationResponse: "ENTERED" | "REJECTED" | "RESEND";
|
683
|
+
/**
|
684
|
+
* AuthorizationsIDPutResponse
|
685
|
+
* @description The object sent in the PUT /authorizations/{ID} callback.
|
686
|
+
*/
|
687
|
+
AuthorizationsIDPutResponse: {
|
688
|
+
authenticationInfo?: components["schemas"]["AuthenticationInfo"];
|
689
|
+
responseType: components["schemas"]["AuthorizationResponse"];
|
690
|
+
};
|
691
|
+
/**
|
692
|
+
* BalanceOfPayments
|
693
|
+
* @description (BopCode) The API data type [BopCode](https://www.imf.org/external/np/sta/bopcode/) is a JSON String of 3 characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed.
|
694
|
+
* @example 123
|
695
|
+
*/
|
696
|
+
BalanceOfPayments: string;
|
697
|
+
/** @description The API data type BinaryString is a JSON String. The string is a base64url encoding of a string of raw bytes, where padding (character ‘=’) is added at the end of the data if needed to ensure that the string is a multiple of 4 characters. The length restriction indicates the allowed number of characters. */
|
698
|
+
BinaryString: string;
|
699
|
+
/** @description The API data type BinaryString32 is a fixed size version of the API data type BinaryString, where the raw underlying data is always of 32 bytes. The data type BinaryString32 should not use a padding character as the size of the underlying data is fixed. */
|
700
|
+
BinaryString32: string;
|
701
|
+
/**
|
702
|
+
* BulkQuotesIDPutResponse
|
703
|
+
* @description The object sent in the PUT /bulkQuotes/{ID} callback.
|
704
|
+
*/
|
705
|
+
BulkQuotesIDPutResponse: {
|
706
|
+
/** @description Fees for each individual transaction, if any of them are charged per transaction. */
|
707
|
+
individualQuoteResults?: components["schemas"]["IndividualQuoteResult"][];
|
708
|
+
expiration: components["schemas"]["DateTime"];
|
709
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
710
|
+
};
|
711
|
+
/**
|
712
|
+
* BulkQuotesPostRequest
|
713
|
+
* @description The object sent in the POST /bulkQuotes request.
|
714
|
+
*/
|
715
|
+
BulkQuotesPostRequest: {
|
716
|
+
bulkQuoteId: components["schemas"]["CorrelationId"];
|
717
|
+
payer: components["schemas"]["Party"];
|
718
|
+
geoCode?: components["schemas"]["GeoCode"];
|
719
|
+
expiration?: components["schemas"]["DateTime"];
|
720
|
+
/** @description List of quotes elements. */
|
721
|
+
individualQuotes: components["schemas"]["IndividualQuote"][];
|
722
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
723
|
+
};
|
724
|
+
/**
|
725
|
+
* BulkTransactionState
|
726
|
+
* @description Below are the allowed values for the enumeration.
|
727
|
+
* - RECEIVED - Payee FSP has received the bulk transfer from the Payer FSP.
|
728
|
+
* - PENDING - Payee FSP has validated the bulk transfer.
|
729
|
+
* - ACCEPTED - Payee FSP has accepted to process the bulk transfer.
|
730
|
+
* - PROCESSING - Payee FSP has started to transfer fund to the Payees.
|
731
|
+
* - COMPLETED - Payee FSP has completed transfer of funds to the Payees.
|
732
|
+
* - REJECTED - Payee FSP has rejected to process the bulk transfer.
|
733
|
+
* @example RECEIVED
|
734
|
+
* @enum {string}
|
735
|
+
*/
|
736
|
+
BulkTransferState: "RECEIVED" | "PENDING" | "ACCEPTED" | "PROCESSING" | "COMPLETED" | "REJECTED";
|
737
|
+
/**
|
738
|
+
* BulkTransfersIDPutResponse
|
739
|
+
* @description The object sent in the PUT /bulkTransfers/{ID} callback.
|
740
|
+
*/
|
741
|
+
BulkTransfersIDPutResponse: {
|
742
|
+
completedTimestamp?: components["schemas"]["DateTime"];
|
743
|
+
/** @description List of IndividualTransferResult elements. */
|
744
|
+
individualTransferResults?: components["schemas"]["IndividualTransferResult"][];
|
745
|
+
bulkTransferState: components["schemas"]["BulkTransferState"];
|
746
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
747
|
+
};
|
748
|
+
/**
|
749
|
+
* BulkTransfersPostRequest
|
750
|
+
* @description The object sent in the POST /bulkTransfers request.
|
751
|
+
*/
|
752
|
+
BulkTransfersPostRequest: {
|
753
|
+
bulkTransferId: components["schemas"]["CorrelationId"];
|
754
|
+
bulkQuoteId: components["schemas"]["CorrelationId"];
|
755
|
+
payerFsp: components["schemas"]["FspId"];
|
756
|
+
payeeFsp: components["schemas"]["FspId"];
|
757
|
+
/** @description List of IndividualTransfer elements. */
|
758
|
+
individualTransfers: components["schemas"]["IndividualTransfer"][];
|
759
|
+
expiration: components["schemas"]["DateTime"];
|
760
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
761
|
+
};
|
762
|
+
/**
|
763
|
+
* Code
|
764
|
+
* @description Any code/token returned by the Payee FSP (TokenCode Type).
|
765
|
+
* @example Test-Code
|
766
|
+
*/
|
767
|
+
Code: string;
|
768
|
+
/**
|
769
|
+
* CorrelationId
|
770
|
+
* @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 (‘-‘).
|
771
|
+
* @example b51ec534-ee48-4575-b6a9-ead2955b8069
|
772
|
+
*/
|
773
|
+
CorrelationId: string;
|
774
|
+
/**
|
775
|
+
* Currency
|
776
|
+
* @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.
|
777
|
+
* @enum {string}
|
778
|
+
*/
|
779
|
+
Currency: "AED" | "AFN" | "ALL" | "AMD" | "ANG" | "AOA" | "ARS" | "AUD" | "AWG" | "AZN" | "BAM" | "BBD" | "BDT" | "BGN" | "BHD" | "BIF" | "BMD" | "BND" | "BOB" | "BRL" | "BSD" | "BTN" | "BWP" | "BYN" | "BZD" | "CAD" | "CDF" | "CHF" | "CLP" | "CNY" | "COP" | "CRC" | "CUC" | "CUP" | "CVE" | "CZK" | "DJF" | "DKK" | "DOP" | "DZD" | "EGP" | "ERN" | "ETB" | "EUR" | "FJD" | "FKP" | "GBP" | "GEL" | "GGP" | "GHS" | "GIP" | "GMD" | "GNF" | "GTQ" | "GYD" | "HKD" | "HNL" | "HRK" | "HTG" | "HUF" | "IDR" | "ILS" | "IMP" | "INR" | "IQD" | "IRR" | "ISK" | "JEP" | "JMD" | "JOD" | "JPY" | "KES" | "KGS" | "KHR" | "KMF" | "KPW" | "KRW" | "KWD" | "KYD" | "KZT" | "LAK" | "LBP" | "LKR" | "LRD" | "LSL" | "LYD" | "MAD" | "MDL" | "MGA" | "MKD" | "MMK" | "MNT" | "MOP" | "MRO" | "MUR" | "MVR" | "MWK" | "MXN" | "MYR" | "MZN" | "NAD" | "NGN" | "NIO" | "NOK" | "NPR" | "NZD" | "OMR" | "PAB" | "PEN" | "PGK" | "PHP" | "PKR" | "PLN" | "PYG" | "QAR" | "RON" | "RSD" | "RUB" | "RWF" | "SAR" | "SBD" | "SCR" | "SDG" | "SEK" | "SGD" | "SHP" | "SLL" | "SOS" | "SPL" | "SRD" | "STD" | "SVC" | "SYP" | "SZL" | "THB" | "TJS" | "TMT" | "TND" | "TOP" | "TRY" | "TTD" | "TVD" | "TWD" | "TZS" | "UAH" | "UGX" | "USD" | "UYU" | "UZS" | "VEF" | "VND" | "VUV" | "WST" | "XAF" | "XCD" | "XDR" | "XOF" | "XPF" | "XTS" | "XXX" | "YER" | "ZAR" | "ZMW" | "ZWD";
|
780
|
+
/**
|
781
|
+
* CurrencyConverter
|
782
|
+
* @description Below are the allowed values for the enumeration CurrencyConverter. - PAYER - Currency conversion should be performed by the payer. - PAYEE - Currency conversion should be performed by the payee.
|
783
|
+
* @enum {string}
|
784
|
+
*/
|
785
|
+
CurrencyConverter: "PAYER" | "PAYEE";
|
786
|
+
/**
|
787
|
+
* Date
|
788
|
+
* @description The API data type Date is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. This format, as specified in ISO 8601, contains a date only. A more readable version of the format is yyyy-MM-dd. Examples are "1982-05-23", "1987-08-05”.
|
789
|
+
*/
|
790
|
+
Date: string;
|
791
|
+
/**
|
792
|
+
* DateofBirth (type Date)
|
793
|
+
* @description Date of Birth of the Party.
|
794
|
+
* @example 1966-06-16
|
795
|
+
*/
|
796
|
+
DateOfBirth: string;
|
797
|
+
/**
|
798
|
+
* DateTime
|
799
|
+
* @description The API data type DateTime is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons. The format is according to [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html), expressed in a combined date, time and time zone format. A more readable version of the format is yyyy-MM-ddTHH:mm:ss.SSS[-HH:MM]. Examples are "2016-05-24T08:38:08.699-04:00", "2016-05-24T08:38:08.699Z" (where Z indicates Zulu time zone, same as UTC).
|
800
|
+
* @example 2016-05-24T08:38:08.699-04:00
|
801
|
+
*/
|
802
|
+
DateTime: string;
|
803
|
+
/**
|
804
|
+
* ErrorCode
|
805
|
+
* @description The API data type ErrorCode is a JSON String of four characters, consisting of digits only. Negative numbers are not allowed. A leading zero is not allowed. Each error code in the API is a four-digit number, for example, 1234, where the first number (1 in the example) represents the high-level error category, the second number (2 in the example) represents the low-level error category, and the last two numbers (34 in the example) represent the specific error.
|
806
|
+
* @example 5100
|
807
|
+
*/
|
808
|
+
ErrorCode: string;
|
809
|
+
/**
|
810
|
+
* ErrorDescription
|
811
|
+
* @description Error description string.
|
812
|
+
*/
|
813
|
+
ErrorDescription: string;
|
814
|
+
/**
|
815
|
+
* ErrorInformation
|
816
|
+
* @description Data model for the complex type ErrorInformation.
|
817
|
+
*/
|
818
|
+
ErrorInformation: {
|
819
|
+
errorCode: components["schemas"]["ErrorCode"];
|
820
|
+
errorDescription: components["schemas"]["ErrorDescription"];
|
821
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
822
|
+
};
|
823
|
+
/**
|
824
|
+
* ErrorInformationObject
|
825
|
+
* @description Data model for the complex type object that contains ErrorInformation.
|
826
|
+
*/
|
827
|
+
ErrorInformationObject: {
|
828
|
+
errorInformation: components["schemas"]["ErrorInformation"];
|
829
|
+
};
|
830
|
+
/**
|
831
|
+
* ErrorInformationResponse
|
832
|
+
* @description Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses.
|
833
|
+
*/
|
834
|
+
ErrorInformationResponse: {
|
835
|
+
errorInformation?: components["schemas"]["ErrorInformation"];
|
836
|
+
};
|
837
|
+
/**
|
838
|
+
* Extension
|
839
|
+
* @description Data model for the complex type Extension.
|
840
|
+
*/
|
841
|
+
Extension: {
|
842
|
+
key: components["schemas"]["ExtensionKey"];
|
843
|
+
value: components["schemas"]["ExtensionValue"];
|
844
|
+
};
|
845
|
+
/**
|
846
|
+
* ExtensionKey
|
847
|
+
* @description Extension key.
|
848
|
+
*/
|
849
|
+
ExtensionKey: string;
|
850
|
+
/**
|
851
|
+
* ExtensionList
|
852
|
+
* @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
|
853
|
+
*/
|
854
|
+
ExtensionList: {
|
855
|
+
/** @description Number of Extension elements. */
|
856
|
+
extension: components["schemas"]["Extension"][];
|
857
|
+
};
|
858
|
+
/**
|
859
|
+
* ExtensionValue
|
860
|
+
* @description Extension value.
|
861
|
+
*/
|
862
|
+
ExtensionValue: string;
|
863
|
+
/**
|
864
|
+
* FirstName
|
865
|
+
* @description First name of the Party (Name Type).
|
866
|
+
* @example Henrik
|
867
|
+
*/
|
868
|
+
FirstName: string;
|
869
|
+
/**
|
870
|
+
* FspId
|
871
|
+
* @description FSP identifier.
|
872
|
+
*/
|
873
|
+
FspId: string;
|
874
|
+
/**
|
875
|
+
* FxCharge
|
876
|
+
* @description An FXP will be able to specify a charge which it proposes to levy on the currency conversion operation using a FxCharge object.
|
877
|
+
*/
|
878
|
+
FxCharge: {
|
879
|
+
/** @description A description of the charge which is being levied. */
|
880
|
+
chargeType: string;
|
881
|
+
sourceAmount?: components["schemas"]["Money"];
|
882
|
+
targetAmount?: components["schemas"]["Money"];
|
883
|
+
};
|
884
|
+
/**
|
885
|
+
* FxConversion
|
886
|
+
* @description A DFSP will be able to request a currency conversion, and an FX provider will be able to describe its involvement in a proposed transfer, using a FxConversion object.
|
887
|
+
*/
|
888
|
+
FxConversion: {
|
889
|
+
conversionId: components["schemas"]["CorrelationId"];
|
890
|
+
determiningTransferId?: components["schemas"]["CorrelationId"];
|
891
|
+
initiatingFsp: components["schemas"]["FspId"];
|
892
|
+
counterPartyFsp: components["schemas"]["FspId"];
|
893
|
+
amountType: components["schemas"]["AmountType"];
|
894
|
+
sourceAmount: components["schemas"]["FxMoney"];
|
895
|
+
targetAmount: components["schemas"]["FxMoney"];
|
896
|
+
expiration: components["schemas"]["DateTime"];
|
897
|
+
/** @description One or more charges which the FXP intends to levy as part of the currency conversion, or which the payee DFSP intends to add to the amount transferred. */
|
898
|
+
charges?: components["schemas"]["FxCharge"][];
|
899
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
900
|
+
};
|
901
|
+
/**
|
902
|
+
* FxMoney
|
903
|
+
* @description Data model for the complex type FxMoney; This is based on the type Money but allows the amount to be optional to support FX quotations.
|
904
|
+
*/
|
905
|
+
FxMoney: {
|
906
|
+
currency: components["schemas"]["Currency"];
|
907
|
+
amount?: components["schemas"]["Amount"];
|
908
|
+
};
|
909
|
+
/**
|
910
|
+
* FxQuotesIDPutResponse
|
911
|
+
* @description The object sent in the PUT /fxQuotes/{ID} callback.
|
912
|
+
*/
|
913
|
+
FxQuotesIDPutResponse: {
|
914
|
+
condition?: components["schemas"]["IlpCondition"];
|
915
|
+
conversionTerms: components["schemas"]["FxConversion"];
|
916
|
+
};
|
917
|
+
/**
|
918
|
+
* FxQuotesPostRequest
|
919
|
+
* @description The object sent in the POST /fxQuotes request.
|
920
|
+
*/
|
921
|
+
FxQuotesPostRequest: {
|
922
|
+
conversionRequestId: components["schemas"]["CorrelationId"];
|
923
|
+
conversionTerms: components["schemas"]["FxConversion"];
|
924
|
+
};
|
925
|
+
/**
|
926
|
+
* FxRate
|
927
|
+
* @description The FxRate object contains information about a currency conversion in the transfer. It can be used by parties to the transfer to exchange information with each other about the exchange rate for the transfer, to ensure that the best rate can be agreed on.
|
928
|
+
*/
|
929
|
+
FxRate: {
|
930
|
+
sourceAmount: components["schemas"]["Money"];
|
931
|
+
targetAmount: components["schemas"]["Money"];
|
932
|
+
};
|
933
|
+
/**
|
934
|
+
* FxTransfersIDPatchResponse
|
935
|
+
* @description PATCH /fxTransfers/{ID} object
|
936
|
+
*/
|
937
|
+
FxTransfersIDPatchResponse: {
|
938
|
+
completedTimestamp?: components["schemas"]["DateTime"];
|
939
|
+
conversionState: components["schemas"]["TransferState"];
|
940
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
941
|
+
};
|
942
|
+
/**
|
943
|
+
* FxTransfersIDPutResponse
|
944
|
+
* @description The object sent in the PUT /fxTransfers/{ID} callback.
|
945
|
+
*/
|
946
|
+
FxTransfersIDPutResponse: {
|
947
|
+
fulfilment?: components["schemas"]["IlpFulfilment"];
|
948
|
+
completedTimestamp?: components["schemas"]["DateTime"];
|
949
|
+
conversionState: components["schemas"]["TransferState"];
|
950
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
951
|
+
};
|
952
|
+
/**
|
953
|
+
* FxTransfersPostRequest
|
954
|
+
* @description The object sent in the POST /fxTransfers request.
|
955
|
+
*/
|
956
|
+
FxTransfersPostRequest: {
|
957
|
+
commitRequestId: components["schemas"]["CorrelationId"];
|
958
|
+
determiningTransferId?: components["schemas"]["CorrelationId"];
|
959
|
+
initiatingFsp: components["schemas"]["FspId"];
|
960
|
+
counterPartyFsp: components["schemas"]["FspId"];
|
961
|
+
sourceAmount: components["schemas"]["Money"];
|
962
|
+
targetAmount: components["schemas"]["Money"];
|
963
|
+
condition: components["schemas"]["IlpCondition"];
|
964
|
+
expiration?: components["schemas"]["DateTime"];
|
965
|
+
};
|
966
|
+
/**
|
967
|
+
* GeoCode
|
968
|
+
* @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
|
969
|
+
*/
|
970
|
+
GeoCode: {
|
971
|
+
latitude: components["schemas"]["Latitude"];
|
972
|
+
longitude: components["schemas"]["Longitude"];
|
973
|
+
};
|
974
|
+
/**
|
975
|
+
* IlpCondition
|
976
|
+
* @description Condition that must be attached to the transfer by the Payer.
|
977
|
+
*/
|
978
|
+
IlpCondition: string;
|
979
|
+
/**
|
980
|
+
* IlpFulfilment
|
981
|
+
* @description Fulfilment that must be attached to the transfer by the Payee.
|
982
|
+
* @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
|
983
|
+
*/
|
984
|
+
IlpFulfilment: string;
|
985
|
+
/**
|
986
|
+
* IlpPacket
|
987
|
+
* @description Information for recipient (transport layer information).
|
988
|
+
* @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
|
989
|
+
*/
|
990
|
+
IlpPacket: string;
|
991
|
+
/**
|
992
|
+
* IndividualQuote
|
993
|
+
* @description Data model for the complex type IndividualQuote.
|
994
|
+
*/
|
995
|
+
IndividualQuote: {
|
996
|
+
quoteId: components["schemas"]["CorrelationId"];
|
997
|
+
transactionId: components["schemas"]["CorrelationId"];
|
998
|
+
payee: components["schemas"]["Party"];
|
999
|
+
amountType: components["schemas"]["AmountType"];
|
1000
|
+
amount: components["schemas"]["Money"];
|
1001
|
+
fees?: components["schemas"]["Money"];
|
1002
|
+
transactionType: components["schemas"]["TransactionType"];
|
1003
|
+
note?: components["schemas"]["Note"];
|
1004
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
1005
|
+
};
|
1006
|
+
/**
|
1007
|
+
* IndividualQuoteResult
|
1008
|
+
* @description Data model for the complex type IndividualQuoteResult.
|
1009
|
+
*/
|
1010
|
+
IndividualQuoteResult: {
|
1011
|
+
quoteId: components["schemas"]["CorrelationId"];
|
1012
|
+
payee?: components["schemas"]["Party"];
|
1013
|
+
transferAmount?: components["schemas"]["Money"];
|
1014
|
+
payeeReceiveAmount?: components["schemas"]["Money"];
|
1015
|
+
payeeFspFee?: components["schemas"]["Money"];
|
1016
|
+
payeeFspCommission?: components["schemas"]["Money"];
|
1017
|
+
ilpPacket?: components["schemas"]["IlpPacket"];
|
1018
|
+
condition?: components["schemas"]["IlpCondition"];
|
1019
|
+
errorInformation?: components["schemas"]["ErrorInformation"];
|
1020
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
1021
|
+
};
|
1022
|
+
/**
|
1023
|
+
* IndividualTransfer
|
1024
|
+
* @description Data model for the complex type IndividualTransfer.
|
1025
|
+
*/
|
1026
|
+
IndividualTransfer: {
|
1027
|
+
transferId: components["schemas"]["CorrelationId"];
|
1028
|
+
transferAmount: components["schemas"]["Money"];
|
1029
|
+
ilpPacket: components["schemas"]["IlpPacket"];
|
1030
|
+
condition: components["schemas"]["IlpCondition"];
|
1031
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
1032
|
+
};
|
1033
|
+
/**
|
1034
|
+
* IndividualTransferResult
|
1035
|
+
* @description Data model for the complex type IndividualTransferResult.
|
1036
|
+
*/
|
1037
|
+
IndividualTransferResult: {
|
1038
|
+
transferId: components["schemas"]["CorrelationId"];
|
1039
|
+
fulfilment?: components["schemas"]["IlpFulfilment"];
|
1040
|
+
errorInformation?: components["schemas"]["ErrorInformation"];
|
1041
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
1042
|
+
};
|
1043
|
+
/**
|
1044
|
+
* Integer
|
1045
|
+
* @description The API data type Integer is a JSON String consisting of digits only. Negative numbers and leading zeroes are not allowed. The data type is always limited to a specific number of digits.
|
1046
|
+
*/
|
1047
|
+
Integer: string;
|
1048
|
+
/**
|
1049
|
+
* KYCInformation
|
1050
|
+
* @description KYC information for the party in a form mandated by an individual scheme.
|
1051
|
+
* @example {
|
1052
|
+
* "metadata": {
|
1053
|
+
* "format": "JSON",
|
1054
|
+
* "version": "1.0",
|
1055
|
+
* "description": "Data containing KYC Information"
|
1056
|
+
* },
|
1057
|
+
* "data": {
|
1058
|
+
* "name": "John Doe",
|
1059
|
+
* "dob": "1980-05-15",
|
1060
|
+
* "gender": "Male",
|
1061
|
+
* "address": "123 Main Street, Anytown, USA",
|
1062
|
+
* "email": "johndoe@example.com",
|
1063
|
+
* "phone": "+1 555-123-4567",
|
1064
|
+
* "nationality": "US",
|
1065
|
+
* "passport_number": "AB1234567",
|
1066
|
+
* "issue_date": "2010-02-20",
|
1067
|
+
* "expiry_date": "2025-02-20",
|
1068
|
+
* "bank_account_number": "1234567890",
|
1069
|
+
* "bank_name": "Example Bank",
|
1070
|
+
* "employer": "ABC Company",
|
1071
|
+
* "occupation": "Software Engineer",
|
1072
|
+
* "income": "$80,000 per year",
|
1073
|
+
* "marital_status": "Single",
|
1074
|
+
* "dependents": 0,
|
1075
|
+
* "risk_level": "Low"
|
1076
|
+
* }
|
1077
|
+
* }
|
1078
|
+
*/
|
1079
|
+
KYCInformation: string;
|
1080
|
+
/**
|
1081
|
+
* LastName
|
1082
|
+
* @description Last name of the Party (Name Type).
|
1083
|
+
* @example Karlsson
|
1084
|
+
*/
|
1085
|
+
LastName: string;
|
1086
|
+
/**
|
1087
|
+
* Latitude
|
1088
|
+
* @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
|
1089
|
+
* @example +45.4215
|
1090
|
+
*/
|
1091
|
+
Latitude: string;
|
1092
|
+
/**
|
1093
|
+
* Longitude
|
1094
|
+
* @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
|
1095
|
+
* @example +75.6972
|
1096
|
+
*/
|
1097
|
+
Longitude: string;
|
1098
|
+
/**
|
1099
|
+
* MerchantClassificationCode
|
1100
|
+
* @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.
|
1101
|
+
*/
|
1102
|
+
MerchantClassificationCode: string;
|
1103
|
+
/**
|
1104
|
+
* MiddleName
|
1105
|
+
* @description Middle name of the Party (Name Type).
|
1106
|
+
* @example Johannes
|
1107
|
+
*/
|
1108
|
+
MiddleName: string;
|
1109
|
+
/**
|
1110
|
+
* Money
|
1111
|
+
* @description Data model for the complex type Money.
|
1112
|
+
*/
|
1113
|
+
Money: {
|
1114
|
+
currency: components["schemas"]["Currency"];
|
1115
|
+
amount: components["schemas"]["Amount"];
|
1116
|
+
};
|
1117
|
+
/**
|
1118
|
+
* Name
|
1119
|
+
* @description The API data type Name is a JSON String, restricted by a regular expression to avoid characters which are generally not used in a name.
|
1120
|
+
*
|
1121
|
+
* Regular Expression - The regular expression for restricting the Name type is "^(?!\s*$)[\w .,'-]{1,128}$". The restriction does not allow a string consisting of whitespace only, all Unicode characters are allowed, as well as the period (.) (apostrophe (‘), dash (-), comma (,) and space characters ( ).
|
1122
|
+
*
|
1123
|
+
* **Note:** In some programming languages, Unicode support must be specifically enabled. For example, if Java is used, the flag UNICODE_CHARACTER_CLASS must be enabled to allow Unicode characters.
|
1124
|
+
*/
|
1125
|
+
Name: string;
|
1126
|
+
/**
|
1127
|
+
* Note
|
1128
|
+
* @description Memo assigned to transaction.
|
1129
|
+
* @example Note sent to Payee.
|
1130
|
+
*/
|
1131
|
+
Note: string;
|
1132
|
+
/**
|
1133
|
+
* OtpValue
|
1134
|
+
* @description The API data type OtpValue is a JSON String of 3 to 10 characters, consisting of digits only. Negative numbers are not allowed. One or more leading zeros are allowed.
|
1135
|
+
*/
|
1136
|
+
OtpValue: string;
|
1137
|
+
/**
|
1138
|
+
* ParticipantsIDPutResponse
|
1139
|
+
* @description The object sent in the PUT /participants/{ID} callback.
|
1140
|
+
*/
|
1141
|
+
ParticipantsIDPutResponse: {
|
1142
|
+
/** @description List of PartyResult elements that were either created or failed to be created. */
|
1143
|
+
partyList: components["schemas"]["PartyResult"][];
|
1144
|
+
currency?: components["schemas"]["Currency"];
|
1145
|
+
};
|
1146
|
+
/**
|
1147
|
+
* ParticipantsPostRequest
|
1148
|
+
* @description The object sent in the POST /participants request.
|
1149
|
+
*/
|
1150
|
+
ParticipantsPostRequest: {
|
1151
|
+
requestId: components["schemas"]["CorrelationId"];
|
1152
|
+
/** @description List of PartyIdInfo elements that the client would like to update or create FSP information about. */
|
1153
|
+
partyList: components["schemas"]["PartyIdInfo"][];
|
1154
|
+
currency?: components["schemas"]["Currency"];
|
1155
|
+
};
|
1156
|
+
/**
|
1157
|
+
* ParticipantsTypeIDPutResponse
|
1158
|
+
* @description The object sent in the PUT /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} callbacks.
|
1159
|
+
*/
|
1160
|
+
ParticipantsTypeIDPutResponse: {
|
1161
|
+
fspId?: components["schemas"]["FspId"];
|
1162
|
+
};
|
1163
|
+
/**
|
1164
|
+
* ParticipantsTypeIDSubIDPostRequest
|
1165
|
+
* @description The object sent in the POST /participants/{Type}/{ID}/{SubId} and /participants/{Type}/{ID} requests. An additional optional ExtensionList element has been added as part of v1.1 changes.
|
1166
|
+
*/
|
1167
|
+
ParticipantsTypeIDSubIDPostRequest: {
|
1168
|
+
fspId: components["schemas"]["FspId"];
|
1169
|
+
currency?: components["schemas"]["Currency"];
|
1170
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
1171
|
+
};
|
1172
|
+
/**
|
1173
|
+
* PartiesTypeIDPutResponse
|
1174
|
+
* @description The object sent in the PUT /parties/{Type}/{ID} callback.
|
1175
|
+
*/
|
1176
|
+
PartiesTypeIDPutResponse: {
|
1177
|
+
party: components["schemas"]["Party"];
|
1178
|
+
};
|
1179
|
+
/**
|
1180
|
+
* Party
|
1181
|
+
* @description Data model for the complex type Party.
|
1182
|
+
*/
|
1183
|
+
Party: {
|
1184
|
+
partyIdInfo: components["schemas"]["PartyIdInfo"];
|
1185
|
+
merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"];
|
1186
|
+
name?: components["schemas"]["PartyName"];
|
1187
|
+
personalInfo?: components["schemas"]["PartyPersonalInfo"];
|
1188
|
+
/** @description Currencies in which the party can receive funds. */
|
1189
|
+
supportedCurrencies?: components["schemas"]["Currency"][];
|
1190
|
+
};
|
1191
|
+
/**
|
1192
|
+
* PartyComplexName
|
1193
|
+
* @description Data model for the complex type PartyComplexName.
|
1194
|
+
*/
|
1195
|
+
PartyComplexName: {
|
1196
|
+
firstName?: components["schemas"]["FirstName"];
|
1197
|
+
middleName?: components["schemas"]["MiddleName"];
|
1198
|
+
lastName?: components["schemas"]["LastName"];
|
1199
|
+
};
|
1200
|
+
/**
|
1201
|
+
* PartyIdInfo
|
1202
|
+
* @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
|
1203
|
+
*/
|
1204
|
+
PartyIdInfo: {
|
1205
|
+
partyIdType: components["schemas"]["PartyIdType"];
|
1206
|
+
partyIdentifier: components["schemas"]["PartyIdentifier"];
|
1207
|
+
partySubIdOrType?: components["schemas"]["PartySubIdOrType"];
|
1208
|
+
fspId?: components["schemas"]["FspId"];
|
1209
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
1210
|
+
};
|
1211
|
+
/**
|
1212
|
+
* PartyIdType
|
1213
|
+
* @description Below are the allowed values for the enumeration.
|
1214
|
+
* - 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.
|
1215
|
+
* - 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).
|
1216
|
+
* - 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.
|
1217
|
+
* - 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.
|
1218
|
+
* - 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.
|
1219
|
+
* - 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.
|
1220
|
+
* - 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.
|
1221
|
+
* - 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.
|
1222
|
+
* @enum {string}
|
1223
|
+
*/
|
1224
|
+
PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
|
1225
|
+
/**
|
1226
|
+
* PartyIdentifier
|
1227
|
+
* @description Identifier of the Party.
|
1228
|
+
* @example 16135551212
|
1229
|
+
*/
|
1230
|
+
PartyIdentifier: string;
|
1231
|
+
/**
|
1232
|
+
* PartyName
|
1233
|
+
* @description Name of the Party. Could be a real name or a nickname.
|
1234
|
+
*/
|
1235
|
+
PartyName: string;
|
1236
|
+
/**
|
1237
|
+
* PartyPersonalInfo
|
1238
|
+
* @description Data model for the complex type PartyPersonalInfo.
|
1239
|
+
*/
|
1240
|
+
PartyPersonalInfo: {
|
1241
|
+
complexName?: components["schemas"]["PartyComplexName"];
|
1242
|
+
dateOfBirth?: components["schemas"]["DateOfBirth"];
|
1243
|
+
kycInformation?: components["schemas"]["KYCInformation"];
|
1244
|
+
};
|
1245
|
+
/**
|
1246
|
+
* PartyResult
|
1247
|
+
* @description Data model for the complex type PartyResult.
|
1248
|
+
*/
|
1249
|
+
PartyResult: {
|
1250
|
+
partyId: components["schemas"]["PartyIdInfo"];
|
1251
|
+
errorInformation?: components["schemas"]["ErrorInformation"];
|
1252
|
+
};
|
1253
|
+
/**
|
1254
|
+
* PartySubIdOrType
|
1255
|
+
* @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
|
1256
|
+
*/
|
1257
|
+
PartySubIdOrType: string;
|
1258
|
+
/**
|
1259
|
+
* PersonalIdentifierType
|
1260
|
+
* @description Below are the allowed values for the enumeration.
|
1261
|
+
* - PASSPORT - A passport number is used as reference to a Party.
|
1262
|
+
* - NATIONAL_REGISTRATION - A national registration number is used as reference to a Party.
|
1263
|
+
* - DRIVING_LICENSE - A driving license is used as reference to a Party.
|
1264
|
+
* - ALIEN_REGISTRATION - An alien registration number is used as reference to a Party.
|
1265
|
+
* - NATIONAL_ID_CARD - A national ID card number is used as reference to a Party.
|
1266
|
+
* - EMPLOYER_ID - A tax identification number is used as reference to a Party.
|
1267
|
+
* - TAX_ID_NUMBER - A tax identification number is used as reference to a Party.
|
1268
|
+
* - SENIOR_CITIZENS_CARD - A senior citizens card number is used as reference to a Party.
|
1269
|
+
* - MARRIAGE_CERTIFICATE - A marriage certificate number is used as reference to a Party.
|
1270
|
+
* - HEALTH_CARD - A health card number is used as reference to a Party.
|
1271
|
+
* - VOTERS_ID - A voter’s identification number is used as reference to a Party.
|
1272
|
+
* - UNITED_NATIONS - An UN (United Nations) number is used as reference to a Party.
|
1273
|
+
* - OTHER_ID - Any other type of identification type number is used as reference to a Party.
|
1274
|
+
* @enum {string}
|
1275
|
+
*/
|
1276
|
+
PersonalIdentifierType: "PASSPORT" | "NATIONAL_REGISTRATION" | "DRIVING_LICENSE" | "ALIEN_REGISTRATION" | "NATIONAL_ID_CARD" | "EMPLOYER_ID" | "TAX_ID_NUMBER" | "SENIOR_CITIZENS_CARD" | "MARRIAGE_CERTIFICATE" | "HEALTH_CARD" | "VOTERS_ID" | "UNITED_NATIONS" | "OTHER_ID";
|
1277
|
+
/**
|
1278
|
+
* QRCODE
|
1279
|
+
* @description QR code used as a One Time Password.
|
1280
|
+
*/
|
1281
|
+
QRCODE: string;
|
1282
|
+
/**
|
1283
|
+
* QuotesIDPutResponse
|
1284
|
+
* @description The object sent in the PUT /quotes/{ID} callback.
|
1285
|
+
*/
|
1286
|
+
QuotesIDPutResponse: {
|
1287
|
+
transferAmount: components["schemas"]["Money"];
|
1288
|
+
payeeReceiveAmount?: components["schemas"]["Money"];
|
1289
|
+
payeeFspFee?: components["schemas"]["Money"];
|
1290
|
+
payeeFspCommission?: components["schemas"]["Money"];
|
1291
|
+
expiration: components["schemas"]["DateTime"];
|
1292
|
+
geoCode?: components["schemas"]["GeoCode"];
|
1293
|
+
ilpPacket: components["schemas"]["IlpPacket"];
|
1294
|
+
condition: components["schemas"]["IlpCondition"];
|
1295
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
1296
|
+
};
|
1297
|
+
/**
|
1298
|
+
* QuotesPostRequest
|
1299
|
+
* @description The object sent in the POST /quotes request.
|
1300
|
+
*/
|
1301
|
+
QuotesPostRequest: {
|
1302
|
+
quoteId: components["schemas"]["CorrelationId"];
|
1303
|
+
transactionId: components["schemas"]["CorrelationId"];
|
1304
|
+
transactionRequestId?: components["schemas"]["CorrelationId"];
|
1305
|
+
payee: components["schemas"]["Party"];
|
1306
|
+
payer: components["schemas"]["Party"];
|
1307
|
+
amountType: components["schemas"]["AmountType"];
|
1308
|
+
amount: components["schemas"]["Money"];
|
1309
|
+
fees?: components["schemas"]["Money"];
|
1310
|
+
transactionType: components["schemas"]["TransactionType"];
|
1311
|
+
converter?: components["schemas"]["CurrencyConverter"];
|
1312
|
+
currencyConversion?: components["schemas"]["FxRate"];
|
1313
|
+
geoCode?: components["schemas"]["GeoCode"];
|
1314
|
+
note?: components["schemas"]["Note"];
|
1315
|
+
expiration?: components["schemas"]["DateTime"];
|
1316
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
1317
|
+
};
|
1318
|
+
/**
|
1319
|
+
* Refund
|
1320
|
+
* @description Data model for the complex type Refund.
|
1321
|
+
*/
|
1322
|
+
Refund: {
|
1323
|
+
originalTransactionId: components["schemas"]["CorrelationId"];
|
1324
|
+
refundReason?: components["schemas"]["RefundReason"];
|
1325
|
+
};
|
1326
|
+
/**
|
1327
|
+
* RefundReason
|
1328
|
+
* @description Reason for the refund.
|
1329
|
+
* @example Free text indicating reason for the refund.
|
1330
|
+
*/
|
1331
|
+
RefundReason: string;
|
1332
|
+
/**
|
1333
|
+
* ServicesFXPPutResponse
|
1334
|
+
* @description The object sent in the PUT /services/FXP callback.
|
1335
|
+
*/
|
1336
|
+
ServicesFXPPutResponse: {
|
1337
|
+
/** @description The FSP Id(s) of the participant(s) who offer currency conversion services. */
|
1338
|
+
providers: components["schemas"]["FspId"][];
|
1339
|
+
};
|
1340
|
+
/**
|
1341
|
+
* ServicesFXPSourceCurrencyTargetCurrencyPutResponse
|
1342
|
+
* @description The object sent in the PUT /services/FXP/{SourceCurrency}/{TargetCurrency} callback.
|
1343
|
+
*/
|
1344
|
+
ServicesFXPSourceCurrencyTargetCurrencyPutResponse: {
|
1345
|
+
/** @description The FSP Id(s) of the participant(s) who offer currency conversion services. */
|
1346
|
+
providers: components["schemas"]["FspId"][];
|
1347
|
+
};
|
1348
|
+
/**
|
1349
|
+
* TokenCode
|
1350
|
+
* @description The API data type TokenCode is a JSON String between 4 and 32 characters, consisting of digits or upper- or lowercase characters from a to z.
|
1351
|
+
*/
|
1352
|
+
TokenCode: string;
|
1353
|
+
/**
|
1354
|
+
* Transaction
|
1355
|
+
* @description Data model for the complex type Transaction. The Transaction type is used to carry end-to-end data between the Payer FSP and the Payee FSP in the ILP Packet. Both the transactionId and the quoteId in the data model are decided by the Payer FSP in the POST /quotes request.
|
1356
|
+
*/
|
1357
|
+
Transaction: {
|
1358
|
+
transactionId: components["schemas"]["CorrelationId"];
|
1359
|
+
quoteId: components["schemas"]["CorrelationId"];
|
1360
|
+
payee: components["schemas"]["Party"];
|
1361
|
+
payer: components["schemas"]["Party"];
|
1362
|
+
amount: components["schemas"]["Money"];
|
1363
|
+
payeeReceiveAmount?: components["schemas"]["Money"];
|
1364
|
+
converter?: components["schemas"]["CurrencyConverter"];
|
1365
|
+
currencyConversion?: components["schemas"]["FxRate"];
|
1366
|
+
transactionType: components["schemas"]["TransactionType"];
|
1367
|
+
note?: components["schemas"]["Note"];
|
1368
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
1369
|
+
};
|
1370
|
+
/**
|
1371
|
+
* TransactionInitiator
|
1372
|
+
* @description Below are the allowed values for the enumeration.
|
1373
|
+
* - PAYER - Sender of funds is initiating the transaction. The account to send from is either owned by the Payer or is connected to the Payer in some way.
|
1374
|
+
* - PAYEE - Recipient of the funds is initiating the transaction by sending a transaction request. The Payer must approve the transaction, either automatically by a pre-generated OTP or by pre-approval of the Payee, or by manually approving in his or her own Device.
|
1375
|
+
* @example PAYEE
|
1376
|
+
* @enum {string}
|
1377
|
+
*/
|
1378
|
+
TransactionInitiator: "PAYER" | "PAYEE";
|
1379
|
+
/**
|
1380
|
+
* TransactionInitiatorType
|
1381
|
+
* @description Below are the allowed values for the enumeration.
|
1382
|
+
* - CONSUMER - Consumer is the initiator of the transaction.
|
1383
|
+
* - AGENT - Agent is the initiator of the transaction.
|
1384
|
+
* - BUSINESS - Business is the initiator of the transaction.
|
1385
|
+
* - DEVICE - Device is the initiator of the transaction.
|
1386
|
+
* @example CONSUMER
|
1387
|
+
* @enum {string}
|
1388
|
+
*/
|
1389
|
+
TransactionInitiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
|
1390
|
+
/**
|
1391
|
+
* TransactionRequestState
|
1392
|
+
* @description Below are the allowed values for the enumeration.
|
1393
|
+
* - RECEIVED - Payer FSP has received the transaction from the Payee FSP.
|
1394
|
+
* - PENDING - Payer FSP has sent the transaction request to the Payer.
|
1395
|
+
* - ACCEPTED - Payer has approved the transaction.
|
1396
|
+
* - REJECTED - Payer has rejected the transaction.
|
1397
|
+
* @example RECEIVED
|
1398
|
+
* @enum {string}
|
1399
|
+
*/
|
1400
|
+
TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED";
|
1401
|
+
/**
|
1402
|
+
* TransactionRequestsIDPutResponse
|
1403
|
+
* @description The object sent in the PUT /transactionRequests/{ID} callback.
|
1404
|
+
*/
|
1405
|
+
TransactionRequestsIDPutResponse: {
|
1406
|
+
transactionId?: components["schemas"]["CorrelationId"];
|
1407
|
+
transactionRequestState: components["schemas"]["TransactionRequestState"];
|
1408
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
1409
|
+
};
|
1410
|
+
/**
|
1411
|
+
* TransactionRequestsPostRequest
|
1412
|
+
* @description The object sent in the POST /transactionRequests request.
|
1413
|
+
*/
|
1414
|
+
TransactionRequestsPostRequest: {
|
1415
|
+
transactionRequestId: components["schemas"]["CorrelationId"];
|
1416
|
+
payee: components["schemas"]["Party"];
|
1417
|
+
payer: components["schemas"]["PartyIdInfo"];
|
1418
|
+
amount: components["schemas"]["Money"];
|
1419
|
+
transactionType: components["schemas"]["TransactionType"];
|
1420
|
+
note?: components["schemas"]["Note"];
|
1421
|
+
geoCode?: components["schemas"]["GeoCode"];
|
1422
|
+
authenticationType?: components["schemas"]["AuthenticationType"];
|
1423
|
+
expiration?: components["schemas"]["DateTime"];
|
1424
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
1425
|
+
};
|
1426
|
+
/**
|
1427
|
+
* TransactionScenario
|
1428
|
+
* @description Below are the allowed values for the enumeration.
|
1429
|
+
* - DEPOSIT - Used for performing a Cash-In (deposit) transaction. In a normal scenario, electronic funds are transferred from a Business account to a Consumer account, and physical cash is given from the Consumer to the Business User.
|
1430
|
+
* - WITHDRAWAL - Used for performing a Cash-Out (withdrawal) transaction. In a normal scenario, electronic funds are transferred from a Consumer’s account to a Business account, and physical cash is given from the Business User to the Consumer.
|
1431
|
+
* - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.
|
1432
|
+
* - PAYMENT - Usually used for performing a transaction from a Consumer to a Merchant or Organization, but could also be for a B2B (Business to Business) payment. The transaction could be online for a purchase in an Internet store, in a physical store where both the Consumer and Business User are present, a bill payment, a donation, and so on.
|
1433
|
+
* - REFUND - Used for performing a refund of transaction.
|
1434
|
+
* @example DEPOSIT
|
1435
|
+
* @enum {string}
|
1436
|
+
*/
|
1437
|
+
TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND";
|
1438
|
+
/**
|
1439
|
+
* TransactionState
|
1440
|
+
* @description Below are the allowed values for the enumeration.
|
1441
|
+
* - RECEIVED - Payee FSP has received the transaction from the Payer FSP.
|
1442
|
+
* - PENDING - Payee FSP has validated the transaction.
|
1443
|
+
* - COMPLETED - Payee FSP has successfully performed the transaction.
|
1444
|
+
* - REJECTED - Payee FSP has failed to perform the transaction.
|
1445
|
+
* @example RECEIVED
|
1446
|
+
* @enum {string}
|
1447
|
+
*/
|
1448
|
+
TransactionState: "RECEIVED" | "PENDING" | "COMPLETED" | "REJECTED";
|
1449
|
+
/**
|
1450
|
+
* TransactionSubScenario
|
1451
|
+
* @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).
|
1452
|
+
* @example LOCALLY_DEFINED_SUBSCENARIO
|
1453
|
+
*/
|
1454
|
+
TransactionSubScenario: string;
|
1455
|
+
/**
|
1456
|
+
* TransactionType
|
1457
|
+
* @description Data model for the complex type TransactionType.
|
1458
|
+
*/
|
1459
|
+
TransactionType: {
|
1460
|
+
scenario: components["schemas"]["TransactionScenario"];
|
1461
|
+
subScenario?: components["schemas"]["TransactionSubScenario"];
|
1462
|
+
initiator: components["schemas"]["TransactionInitiator"];
|
1463
|
+
initiatorType: components["schemas"]["TransactionInitiatorType"];
|
1464
|
+
refundInfo?: components["schemas"]["Refund"];
|
1465
|
+
balanceOfPayments?: components["schemas"]["BalanceOfPayments"];
|
1466
|
+
};
|
1467
|
+
/**
|
1468
|
+
* TransactionsIDPutResponse
|
1469
|
+
* @description The object sent in the PUT /transactions/{ID} callback.
|
1470
|
+
*/
|
1471
|
+
TransactionsIDPutResponse: {
|
1472
|
+
completedTimestamp?: components["schemas"]["DateTime"];
|
1473
|
+
transactionState: components["schemas"]["TransactionState"];
|
1474
|
+
code?: components["schemas"]["Code"];
|
1475
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
1476
|
+
};
|
1477
|
+
/**
|
1478
|
+
* TransferState
|
1479
|
+
* @description Below are the allowed values for the enumeration.
|
1480
|
+
* - RECEIVED - Next ledger has received the transfer.
|
1481
|
+
* - RESERVED - Next ledger has reserved the transfer.
|
1482
|
+
* - COMMITTED - Next ledger has successfully performed the transfer.
|
1483
|
+
* - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
|
1484
|
+
* @example RESERVED
|
1485
|
+
* @enum {string}
|
1486
|
+
*/
|
1487
|
+
TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
|
1488
|
+
/**
|
1489
|
+
* TransfersIDPatchResponse
|
1490
|
+
* @description PATCH /transfers/{ID} object
|
1491
|
+
*/
|
1492
|
+
TransfersIDPatchResponse: {
|
1493
|
+
completedTimestamp: components["schemas"]["DateTime"];
|
1494
|
+
transferState: components["schemas"]["TransferState"];
|
1495
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
1496
|
+
};
|
1497
|
+
/**
|
1498
|
+
* TransfersIDPutResponse
|
1499
|
+
* @description The object sent in the PUT /transfers/{ID} callback.
|
1500
|
+
*/
|
1501
|
+
TransfersIDPutResponse: {
|
1502
|
+
fulfilment?: components["schemas"]["IlpFulfilment"];
|
1503
|
+
completedTimestamp?: components["schemas"]["DateTime"];
|
1504
|
+
transferState: components["schemas"]["TransferState"];
|
1505
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
1506
|
+
};
|
1507
|
+
/**
|
1508
|
+
* TransfersPostRequest
|
1509
|
+
* @description The object sent in the POST /transfers request.
|
1510
|
+
*/
|
1511
|
+
TransfersPostRequest: {
|
1512
|
+
transferId: components["schemas"]["CorrelationId"];
|
1513
|
+
payeeFsp: components["schemas"]["FspId"];
|
1514
|
+
payerFsp: components["schemas"]["FspId"];
|
1515
|
+
amount: components["schemas"]["Money"];
|
1516
|
+
ilpPacket: components["schemas"]["IlpPacket"];
|
1517
|
+
condition: components["schemas"]["IlpCondition"];
|
1518
|
+
expiration: components["schemas"]["DateTime"];
|
1519
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
1520
|
+
};
|
1521
|
+
/**
|
1522
|
+
* U2FPIN
|
1523
|
+
* @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
|
1524
|
+
*/
|
1525
|
+
U2FPIN: string;
|
1526
|
+
/**
|
1527
|
+
* U2FPinValue
|
1528
|
+
* @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
|
1529
|
+
*/
|
1530
|
+
U2FPinValue: {
|
1531
|
+
/** @description U2F challenge-response. */
|
1532
|
+
pinValue: components["schemas"]["U2FPIN"];
|
1533
|
+
/** @description Sequential counter used for cloning detection. Present only for U2F authentication. */
|
1534
|
+
counter: components["schemas"]["Integer"];
|
1535
|
+
};
|
1536
|
+
/**
|
1537
|
+
* UndefinedEnum
|
1538
|
+
* @description The API data type UndefinedEnum is a JSON String consisting of 1 to 32 uppercase characters including an underscore character (_).
|
1539
|
+
*/
|
1540
|
+
UndefinedEnum: string;
|
1541
|
+
};
|
1542
|
+
responses: {
|
1543
|
+
/** @description OK */
|
1544
|
+
200: {
|
1545
|
+
content: never;
|
1546
|
+
};
|
1547
|
+
/** @description Accepted */
|
1548
|
+
202: {
|
1549
|
+
content: never;
|
1550
|
+
};
|
1551
|
+
/** @description Bad Request */
|
1552
|
+
400: {
|
1553
|
+
headers: {
|
1554
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1555
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1556
|
+
};
|
1557
|
+
content: {
|
1558
|
+
"application/json": components["schemas"]["ErrorInformationResponse"];
|
1559
|
+
};
|
1560
|
+
};
|
1561
|
+
/** @description Unauthorized */
|
1562
|
+
401: {
|
1563
|
+
headers: {
|
1564
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1565
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1566
|
+
};
|
1567
|
+
content: {
|
1568
|
+
"application/json": components["schemas"]["ErrorInformationResponse"];
|
1569
|
+
};
|
1570
|
+
};
|
1571
|
+
/** @description Forbidden */
|
1572
|
+
403: {
|
1573
|
+
headers: {
|
1574
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1575
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1576
|
+
};
|
1577
|
+
content: {
|
1578
|
+
"application/json": components["schemas"]["ErrorInformationResponse"];
|
1579
|
+
};
|
1580
|
+
};
|
1581
|
+
/** @description Not Found */
|
1582
|
+
404: {
|
1583
|
+
headers: {
|
1584
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1585
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1586
|
+
};
|
1587
|
+
content: {
|
1588
|
+
"application/json": components["schemas"]["ErrorInformationResponse"];
|
1589
|
+
};
|
1590
|
+
};
|
1591
|
+
/** @description Method Not Allowed */
|
1592
|
+
405: {
|
1593
|
+
headers: {
|
1594
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1595
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1596
|
+
};
|
1597
|
+
content: {
|
1598
|
+
"application/json": components["schemas"]["ErrorInformationResponse"];
|
1599
|
+
};
|
1600
|
+
};
|
1601
|
+
/** @description Not Acceptable */
|
1602
|
+
406: {
|
1603
|
+
headers: {
|
1604
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1605
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1606
|
+
};
|
1607
|
+
content: {
|
1608
|
+
"application/json": components["schemas"]["ErrorInformationResponse"];
|
1609
|
+
};
|
1610
|
+
};
|
1611
|
+
/** @description Not Implemented */
|
1612
|
+
501: {
|
1613
|
+
headers: {
|
1614
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1615
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1616
|
+
};
|
1617
|
+
content: {
|
1618
|
+
"application/json": components["schemas"]["ErrorInformationResponse"];
|
1619
|
+
};
|
1620
|
+
};
|
1621
|
+
/** @description Service Unavailable */
|
1622
|
+
503: {
|
1623
|
+
headers: {
|
1624
|
+
"Content-Length": components["headers"]["Content-Length"];
|
1625
|
+
"Content-Type": components["headers"]["Content-Type"];
|
1626
|
+
};
|
1627
|
+
content: {
|
1628
|
+
"application/json": components["schemas"]["ErrorInformationResponse"];
|
1629
|
+
};
|
1630
|
+
};
|
1631
|
+
};
|
1632
|
+
parameters: {
|
1633
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1634
|
+
Accept: string;
|
1635
|
+
/**
|
1636
|
+
* @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1637
|
+
*
|
1638
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
1639
|
+
*/
|
1640
|
+
"Content-Length"?: number;
|
1641
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1642
|
+
"Content-Type": string;
|
1643
|
+
/** @description The `Date` header field indicates the date when the request was sent. */
|
1644
|
+
Date: string;
|
1645
|
+
/** @description The `FSPIOP-Destination` header field is a non-HTTP standard field used by the API for HTTP header based routing of requests and responses to the destination. The field must be set by the original sender of the request if the destination is known (valid for all services except GET /parties) so that any entities between the client and the server do not need to parse the payload for routing purposes. If the destination is not known (valid for service GET /parties), the field should be left empty. */
|
1646
|
+
"FSPIOP-Destination"?: string;
|
1647
|
+
/** @description The `FSPIOP-Encryption` header field is a non-HTTP standard field used by the API for applying end-to-end encryption of the request. */
|
1648
|
+
"FSPIOP-Encryption"?: string;
|
1649
|
+
/** @description The `FSPIOP-HTTP-Method` header field is a non-HTTP standard field used by the API for signature verification, should contain the service HTTP method. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
1650
|
+
"FSPIOP-HTTP-Method"?: string;
|
1651
|
+
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1652
|
+
"FSPIOP-Signature"?: string;
|
1653
|
+
/** @description The `FSPIOP-Source` header field is a non-HTTP standard field used by the API for identifying the sender of the HTTP request. The field should be set by the original sender of the request. Required for routing and signature verification (see header field `FSPIOP-Signature`). */
|
1654
|
+
"FSPIOP-Source": string;
|
1655
|
+
/** @description The `FSPIOP-URI` header field is a non-HTTP standard field used by the API for signature verification, should contain the service URI. Required if signature verification is used, for more information, see [the API Signature document](https://github.com/mojaloop/docs/tree/main/Specification%20Document%20Set). */
|
1656
|
+
"FSPIOP-URI"?: string;
|
1657
|
+
/** @description The identifier value. */
|
1658
|
+
ID: string;
|
1659
|
+
/** @description ISO 4217 currency code for the source currency. */
|
1660
|
+
SourceCurrency: string;
|
1661
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1662
|
+
SubId: string;
|
1663
|
+
/** @description ISO 4217 currency code for the target currency. */
|
1664
|
+
TargetCurrency: string;
|
1665
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1666
|
+
Type: string;
|
1667
|
+
/**
|
1668
|
+
* @description The `X-Forwarded-For` header field is an unofficially accepted standard used for informational purposes of the originating client IP address, as a request might pass multiple proxies, firewalls, and so on. Multiple `X-Forwarded-For` values should be expected and supported by implementers of the API.
|
1669
|
+
*
|
1670
|
+
* **Note:** An alternative to `X-Forwarded-For` is defined in [RFC 7239](https://tools.ietf.org/html/rfc7239). However, to this point RFC 7239 is less-used and supported than `X-Forwarded-For`.
|
1671
|
+
*/
|
1672
|
+
"X-Forwarded-For"?: string;
|
1673
|
+
};
|
1674
|
+
requestBodies: never;
|
1675
|
+
headers: {
|
1676
|
+
/**
|
1677
|
+
* @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1678
|
+
*
|
1679
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
1680
|
+
*/
|
1681
|
+
"Content-Length": number;
|
1682
|
+
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1683
|
+
"Content-Type": string;
|
1684
|
+
};
|
1685
|
+
pathItems: never;
|
1686
|
+
}
|
1687
|
+
export type $defs = Record<string, never>;
|
1688
|
+
export type external = Record<string, never>;
|
1689
|
+
export interface operations {
|
1690
|
+
/**
|
1691
|
+
* Look up participant information
|
1692
|
+
* @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
|
1693
|
+
*/
|
1694
|
+
ParticipantsByTypeAndID: {
|
1695
|
+
parameters: {
|
1696
|
+
header: {
|
1697
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
1698
|
+
Date: components["parameters"]["Date"];
|
1699
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1700
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1701
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1702
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1703
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1704
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1705
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1706
|
+
Accept: components["parameters"]["Accept"];
|
1707
|
+
};
|
1708
|
+
path: {
|
1709
|
+
Type: components["parameters"]["Type"];
|
1710
|
+
ID: components["parameters"]["ID"];
|
1711
|
+
};
|
1712
|
+
};
|
1713
|
+
responses: {
|
1714
|
+
202: components["responses"]["202"];
|
1715
|
+
400: components["responses"]["400"];
|
1716
|
+
401: components["responses"]["401"];
|
1717
|
+
403: components["responses"]["403"];
|
1718
|
+
404: components["responses"]["404"];
|
1719
|
+
405: components["responses"]["405"];
|
1720
|
+
406: components["responses"]["406"];
|
1721
|
+
501: components["responses"]["501"];
|
1722
|
+
503: components["responses"]["503"];
|
1723
|
+
};
|
1724
|
+
};
|
1725
|
+
/**
|
1726
|
+
* Return participant information
|
1727
|
+
* @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party.
|
1728
|
+
*/
|
1729
|
+
ParticipantsByTypeAndID3: {
|
1730
|
+
parameters: {
|
1731
|
+
header: {
|
1732
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
1733
|
+
Date: components["parameters"]["Date"];
|
1734
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1735
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1736
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1737
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1738
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1739
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1740
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1741
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
1742
|
+
};
|
1743
|
+
path: {
|
1744
|
+
Type: components["parameters"]["Type"];
|
1745
|
+
ID: components["parameters"]["ID"];
|
1746
|
+
};
|
1747
|
+
};
|
1748
|
+
/** @description Participant information returned. */
|
1749
|
+
requestBody: {
|
1750
|
+
content: {
|
1751
|
+
"application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
|
1752
|
+
};
|
1753
|
+
};
|
1754
|
+
responses: {
|
1755
|
+
200: components["responses"]["200"];
|
1756
|
+
400: components["responses"]["400"];
|
1757
|
+
401: components["responses"]["401"];
|
1758
|
+
403: components["responses"]["403"];
|
1759
|
+
404: components["responses"]["404"];
|
1760
|
+
405: components["responses"]["405"];
|
1761
|
+
406: components["responses"]["406"];
|
1762
|
+
501: components["responses"]["501"];
|
1763
|
+
503: components["responses"]["503"];
|
1764
|
+
};
|
1765
|
+
};
|
1766
|
+
/**
|
1767
|
+
* Create participant information
|
1768
|
+
* @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1
|
1769
|
+
*/
|
1770
|
+
ParticipantsByIDAndType: {
|
1771
|
+
parameters: {
|
1772
|
+
header: {
|
1773
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
1774
|
+
Date: components["parameters"]["Date"];
|
1775
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1776
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1777
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1778
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1779
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1780
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1781
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1782
|
+
Accept: components["parameters"]["Accept"];
|
1783
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
1784
|
+
};
|
1785
|
+
path: {
|
1786
|
+
Type: components["parameters"]["Type"];
|
1787
|
+
ID: components["parameters"]["ID"];
|
1788
|
+
};
|
1789
|
+
};
|
1790
|
+
/** @description Participant information to be created. */
|
1791
|
+
requestBody: {
|
1792
|
+
content: {
|
1793
|
+
"application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
|
1794
|
+
};
|
1795
|
+
};
|
1796
|
+
responses: {
|
1797
|
+
202: components["responses"]["202"];
|
1798
|
+
400: components["responses"]["400"];
|
1799
|
+
401: components["responses"]["401"];
|
1800
|
+
403: components["responses"]["403"];
|
1801
|
+
404: components["responses"]["404"];
|
1802
|
+
405: components["responses"]["405"];
|
1803
|
+
406: components["responses"]["406"];
|
1804
|
+
501: components["responses"]["501"];
|
1805
|
+
503: components["responses"]["503"];
|
1806
|
+
};
|
1807
|
+
};
|
1808
|
+
/**
|
1809
|
+
* Delete participant information
|
1810
|
+
* @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
|
1811
|
+
*
|
1812
|
+
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
1813
|
+
*/
|
1814
|
+
ParticipantsByTypeAndID2: {
|
1815
|
+
parameters: {
|
1816
|
+
header: {
|
1817
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
1818
|
+
Date: components["parameters"]["Date"];
|
1819
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1820
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1821
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1822
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1823
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1824
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1825
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1826
|
+
Accept: components["parameters"]["Accept"];
|
1827
|
+
};
|
1828
|
+
path: {
|
1829
|
+
Type: components["parameters"]["Type"];
|
1830
|
+
ID: components["parameters"]["ID"];
|
1831
|
+
};
|
1832
|
+
};
|
1833
|
+
responses: {
|
1834
|
+
202: components["responses"]["202"];
|
1835
|
+
400: components["responses"]["400"];
|
1836
|
+
401: components["responses"]["401"];
|
1837
|
+
403: components["responses"]["403"];
|
1838
|
+
404: components["responses"]["404"];
|
1839
|
+
405: components["responses"]["405"];
|
1840
|
+
406: components["responses"]["406"];
|
1841
|
+
501: components["responses"]["501"];
|
1842
|
+
503: components["responses"]["503"];
|
1843
|
+
};
|
1844
|
+
};
|
1845
|
+
/**
|
1846
|
+
* Return participant information error
|
1847
|
+
* @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used.
|
1848
|
+
*/
|
1849
|
+
ParticipantsErrorByTypeAndID: {
|
1850
|
+
parameters: {
|
1851
|
+
header: {
|
1852
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
1853
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
1854
|
+
Date: components["parameters"]["Date"];
|
1855
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1856
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1857
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1858
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1859
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1860
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1861
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1862
|
+
};
|
1863
|
+
path: {
|
1864
|
+
Type: components["parameters"]["Type"];
|
1865
|
+
ID: components["parameters"]["ID"];
|
1866
|
+
};
|
1867
|
+
};
|
1868
|
+
/** @description Details of the error returned. */
|
1869
|
+
requestBody: {
|
1870
|
+
content: {
|
1871
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
1872
|
+
};
|
1873
|
+
};
|
1874
|
+
responses: {
|
1875
|
+
200: components["responses"]["200"];
|
1876
|
+
400: components["responses"]["400"];
|
1877
|
+
401: components["responses"]["401"];
|
1878
|
+
403: components["responses"]["403"];
|
1879
|
+
404: components["responses"]["404"];
|
1880
|
+
405: components["responses"]["405"];
|
1881
|
+
406: components["responses"]["406"];
|
1882
|
+
501: components["responses"]["501"];
|
1883
|
+
503: components["responses"]["503"];
|
1884
|
+
};
|
1885
|
+
};
|
1886
|
+
/**
|
1887
|
+
* Look up participant information
|
1888
|
+
* @description The HTTP request `GET /participants/{Type}/{ID}` (or `GET /participants/{Type}/{ID}/{SubId}`) is used to find out in which FSP the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}`, is located (for example, `GET /participants/MSISDN/123456789`, or `GET /participants/BUSINESS/shoecompany/employee1`). This HTTP request should support a query string for filtering of currency. To use filtering of currency, the HTTP request `GET /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
|
1889
|
+
*/
|
1890
|
+
ParticipantsSubIdByTypeAndID: {
|
1891
|
+
parameters: {
|
1892
|
+
header: {
|
1893
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
1894
|
+
Date: components["parameters"]["Date"];
|
1895
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1896
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1897
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1898
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1899
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1900
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1901
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1902
|
+
Accept: components["parameters"]["Accept"];
|
1903
|
+
};
|
1904
|
+
path: {
|
1905
|
+
Type: components["parameters"]["Type"];
|
1906
|
+
ID: components["parameters"]["ID"];
|
1907
|
+
SubId: components["parameters"]["SubId"];
|
1908
|
+
};
|
1909
|
+
};
|
1910
|
+
responses: {
|
1911
|
+
202: components["responses"]["202"];
|
1912
|
+
400: components["responses"]["400"];
|
1913
|
+
401: components["responses"]["401"];
|
1914
|
+
403: components["responses"]["403"];
|
1915
|
+
404: components["responses"]["404"];
|
1916
|
+
405: components["responses"]["405"];
|
1917
|
+
406: components["responses"]["406"];
|
1918
|
+
501: components["responses"]["501"];
|
1919
|
+
503: components["responses"]["503"];
|
1920
|
+
};
|
1921
|
+
};
|
1922
|
+
/**
|
1923
|
+
* Return participant information
|
1924
|
+
* @description The callback `PUT /participants/{Type}/{ID}` (or `PUT /participants/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the lookup, creation, or deletion of the FSP information related to the Party. If the FSP information is deleted, the fspId element should be empty; otherwise the element should include the FSP information for the Party.
|
1925
|
+
*/
|
1926
|
+
ParticipantsSubIdByTypeAndID3: {
|
1927
|
+
parameters: {
|
1928
|
+
header: {
|
1929
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
1930
|
+
Date: components["parameters"]["Date"];
|
1931
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1932
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1933
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1934
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1935
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1936
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1937
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1938
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
1939
|
+
};
|
1940
|
+
path: {
|
1941
|
+
Type: components["parameters"]["Type"];
|
1942
|
+
ID: components["parameters"]["ID"];
|
1943
|
+
SubId: components["parameters"]["SubId"];
|
1944
|
+
};
|
1945
|
+
};
|
1946
|
+
/** @description Participant information returned. */
|
1947
|
+
requestBody: {
|
1948
|
+
content: {
|
1949
|
+
"application/json": components["schemas"]["ParticipantsTypeIDPutResponse"];
|
1950
|
+
};
|
1951
|
+
};
|
1952
|
+
responses: {
|
1953
|
+
200: components["responses"]["200"];
|
1954
|
+
400: components["responses"]["400"];
|
1955
|
+
401: components["responses"]["401"];
|
1956
|
+
403: components["responses"]["403"];
|
1957
|
+
404: components["responses"]["404"];
|
1958
|
+
405: components["responses"]["405"];
|
1959
|
+
406: components["responses"]["406"];
|
1960
|
+
501: components["responses"]["501"];
|
1961
|
+
503: components["responses"]["503"];
|
1962
|
+
};
|
1963
|
+
};
|
1964
|
+
/**
|
1965
|
+
* Create participant information
|
1966
|
+
* @description The HTTP request `POST /participants/{Type}/{ID}` (or `POST /participants/{Type}/{ID}/{SubId}`) is used to create information in the server regarding the provided identity, defined by `{Type}`, `{ID}`, and optionally `{SubId}` (for example, `POST /participants/MSISDN/123456789` or `POST /participants/BUSINESS/shoecompany/employee1`). An ExtensionList element has been added to this reqeust in version v1.1
|
1967
|
+
*/
|
1968
|
+
ParticipantsSubIdByTypeAndIDPost: {
|
1969
|
+
parameters: {
|
1970
|
+
header: {
|
1971
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
1972
|
+
Date: components["parameters"]["Date"];
|
1973
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
1974
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
1975
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
1976
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
1977
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
1978
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
1979
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
1980
|
+
Accept: components["parameters"]["Accept"];
|
1981
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
1982
|
+
};
|
1983
|
+
path: {
|
1984
|
+
Type: components["parameters"]["Type"];
|
1985
|
+
ID: components["parameters"]["ID"];
|
1986
|
+
SubId: components["parameters"]["SubId"];
|
1987
|
+
};
|
1988
|
+
};
|
1989
|
+
/** @description Participant information to be created. */
|
1990
|
+
requestBody: {
|
1991
|
+
content: {
|
1992
|
+
"application/json": components["schemas"]["ParticipantsTypeIDSubIDPostRequest"];
|
1993
|
+
};
|
1994
|
+
};
|
1995
|
+
responses: {
|
1996
|
+
202: components["responses"]["202"];
|
1997
|
+
400: components["responses"]["400"];
|
1998
|
+
401: components["responses"]["401"];
|
1999
|
+
403: components["responses"]["403"];
|
2000
|
+
404: components["responses"]["404"];
|
2001
|
+
405: components["responses"]["405"];
|
2002
|
+
406: components["responses"]["406"];
|
2003
|
+
501: components["responses"]["501"];
|
2004
|
+
503: components["responses"]["503"];
|
2005
|
+
};
|
2006
|
+
};
|
2007
|
+
/**
|
2008
|
+
* Delete participant information
|
2009
|
+
* @description The HTTP request `DELETE /participants/{Type}/{ID}` (or `DELETE /participants/{Type}/{ID}/{SubId}`) is used to delete information in the server regarding the provided identity, defined by `{Type}` and `{ID}`) (for example, `DELETE /participants/MSISDN/123456789`), and optionally `{SubId}`. This HTTP request should support a query string to delete FSP information regarding a specific currency only. To delete a specific currency only, the HTTP request `DELETE /participants/{Type}/{ID}?currency=XYZ` should be used, where `XYZ` is the requested currency.
|
2010
|
+
*
|
2011
|
+
* **Note:** The Account Lookup System should verify that it is the Party’s current FSP that is deleting the FSP information.
|
2012
|
+
*/
|
2013
|
+
ParticipantsSubIdByTypeAndID2: {
|
2014
|
+
parameters: {
|
2015
|
+
header: {
|
2016
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2017
|
+
Date: components["parameters"]["Date"];
|
2018
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2019
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2020
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2021
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2022
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2023
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2024
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2025
|
+
Accept: components["parameters"]["Accept"];
|
2026
|
+
};
|
2027
|
+
path: {
|
2028
|
+
Type: components["parameters"]["Type"];
|
2029
|
+
ID: components["parameters"]["ID"];
|
2030
|
+
SubId: components["parameters"]["SubId"];
|
2031
|
+
};
|
2032
|
+
};
|
2033
|
+
responses: {
|
2034
|
+
202: components["responses"]["202"];
|
2035
|
+
400: components["responses"]["400"];
|
2036
|
+
401: components["responses"]["401"];
|
2037
|
+
403: components["responses"]["403"];
|
2038
|
+
404: components["responses"]["404"];
|
2039
|
+
405: components["responses"]["405"];
|
2040
|
+
406: components["responses"]["406"];
|
2041
|
+
501: components["responses"]["501"];
|
2042
|
+
503: components["responses"]["503"];
|
2043
|
+
};
|
2044
|
+
};
|
2045
|
+
/**
|
2046
|
+
* Return participant information error
|
2047
|
+
* @description If the server is unable to find, create or delete the associated FSP of the provided identity, or another processing error occurred, the error callback `PUT /participants/{Type}/{ID}/error` (or `PUT /participants/{Type}/{ID}/{SubId}/error`) is used.
|
2048
|
+
*/
|
2049
|
+
ParticipantsSubIdErrorByTypeAndID: {
|
2050
|
+
parameters: {
|
2051
|
+
header: {
|
2052
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2053
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2054
|
+
Date: components["parameters"]["Date"];
|
2055
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2056
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2057
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2058
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2059
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2060
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2061
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2062
|
+
};
|
2063
|
+
path: {
|
2064
|
+
Type: components["parameters"]["Type"];
|
2065
|
+
ID: components["parameters"]["ID"];
|
2066
|
+
SubId: components["parameters"]["SubId"];
|
2067
|
+
};
|
2068
|
+
};
|
2069
|
+
/** @description Details of the error returned. */
|
2070
|
+
requestBody: {
|
2071
|
+
content: {
|
2072
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2073
|
+
};
|
2074
|
+
};
|
2075
|
+
responses: {
|
2076
|
+
200: components["responses"]["200"];
|
2077
|
+
400: components["responses"]["400"];
|
2078
|
+
401: components["responses"]["401"];
|
2079
|
+
403: components["responses"]["403"];
|
2080
|
+
404: components["responses"]["404"];
|
2081
|
+
405: components["responses"]["405"];
|
2082
|
+
406: components["responses"]["406"];
|
2083
|
+
501: components["responses"]["501"];
|
2084
|
+
503: components["responses"]["503"];
|
2085
|
+
};
|
2086
|
+
};
|
2087
|
+
/**
|
2088
|
+
* Create bulk participant information
|
2089
|
+
* @description The HTTP request `POST /participants` is used to create information in the server regarding the provided list of identities. This request should be used for bulk creation of FSP information for more than one Party. The optional currency parameter should indicate that each provided Party supports the currency.
|
2090
|
+
*/
|
2091
|
+
Participants1: {
|
2092
|
+
parameters: {
|
2093
|
+
header: {
|
2094
|
+
Accept: components["parameters"]["Accept"];
|
2095
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2096
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2097
|
+
Date: components["parameters"]["Date"];
|
2098
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2099
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2100
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2101
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2102
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2103
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2104
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2105
|
+
};
|
2106
|
+
};
|
2107
|
+
/** @description Participant information to be created. */
|
2108
|
+
requestBody: {
|
2109
|
+
content: {
|
2110
|
+
"application/json": components["schemas"]["ParticipantsPostRequest"];
|
2111
|
+
};
|
2112
|
+
};
|
2113
|
+
responses: {
|
2114
|
+
202: components["responses"]["202"];
|
2115
|
+
400: components["responses"]["400"];
|
2116
|
+
401: components["responses"]["401"];
|
2117
|
+
403: components["responses"]["403"];
|
2118
|
+
404: components["responses"]["404"];
|
2119
|
+
405: components["responses"]["405"];
|
2120
|
+
406: components["responses"]["406"];
|
2121
|
+
501: components["responses"]["501"];
|
2122
|
+
503: components["responses"]["503"];
|
2123
|
+
};
|
2124
|
+
};
|
2125
|
+
/**
|
2126
|
+
* Return bulk participant information
|
2127
|
+
* @description The callback `PUT /participants/{ID}` is used to inform the client of the result of the creation of the provided list of identities.
|
2128
|
+
*/
|
2129
|
+
putParticipantsByID: {
|
2130
|
+
parameters: {
|
2131
|
+
header: {
|
2132
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2133
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2134
|
+
Date: components["parameters"]["Date"];
|
2135
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2136
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2137
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2138
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2139
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2140
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2141
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2142
|
+
};
|
2143
|
+
path: {
|
2144
|
+
ID: components["parameters"]["ID"];
|
2145
|
+
};
|
2146
|
+
};
|
2147
|
+
/** @description Participant information returned. */
|
2148
|
+
requestBody: {
|
2149
|
+
content: {
|
2150
|
+
"application/json": components["schemas"]["ParticipantsIDPutResponse"];
|
2151
|
+
};
|
2152
|
+
};
|
2153
|
+
responses: {
|
2154
|
+
200: components["responses"]["200"];
|
2155
|
+
400: components["responses"]["400"];
|
2156
|
+
401: components["responses"]["401"];
|
2157
|
+
403: components["responses"]["403"];
|
2158
|
+
404: components["responses"]["404"];
|
2159
|
+
405: components["responses"]["405"];
|
2160
|
+
406: components["responses"]["406"];
|
2161
|
+
501: components["responses"]["501"];
|
2162
|
+
503: components["responses"]["503"];
|
2163
|
+
};
|
2164
|
+
};
|
2165
|
+
/**
|
2166
|
+
* Return bulk participant information error
|
2167
|
+
* @description If there is an error during FSP information creation in the server, the error callback `PUT /participants/{ID}/error` is used. The `{ID}` in the URI should contain the requestId that was used for the creation of the participant information.
|
2168
|
+
*/
|
2169
|
+
ParticipantsByIDAndError: {
|
2170
|
+
parameters: {
|
2171
|
+
header: {
|
2172
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2173
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2174
|
+
Date: components["parameters"]["Date"];
|
2175
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2176
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2177
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2178
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2179
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2180
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2181
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2182
|
+
};
|
2183
|
+
path: {
|
2184
|
+
ID: components["parameters"]["ID"];
|
2185
|
+
};
|
2186
|
+
};
|
2187
|
+
/** @description Details of the error returned. */
|
2188
|
+
requestBody: {
|
2189
|
+
content: {
|
2190
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2191
|
+
};
|
2192
|
+
};
|
2193
|
+
responses: {
|
2194
|
+
200: components["responses"]["200"];
|
2195
|
+
400: components["responses"]["400"];
|
2196
|
+
401: components["responses"]["401"];
|
2197
|
+
403: components["responses"]["403"];
|
2198
|
+
404: components["responses"]["404"];
|
2199
|
+
405: components["responses"]["405"];
|
2200
|
+
406: components["responses"]["406"];
|
2201
|
+
501: components["responses"]["501"];
|
2202
|
+
503: components["responses"]["503"];
|
2203
|
+
};
|
2204
|
+
};
|
2205
|
+
/**
|
2206
|
+
* Look up party information
|
2207
|
+
* @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).
|
2208
|
+
*/
|
2209
|
+
PartiesByTypeAndID: {
|
2210
|
+
parameters: {
|
2211
|
+
header: {
|
2212
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2213
|
+
Date: components["parameters"]["Date"];
|
2214
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2215
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2216
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2217
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2218
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2219
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2220
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2221
|
+
Accept: components["parameters"]["Accept"];
|
2222
|
+
};
|
2223
|
+
path: {
|
2224
|
+
Type: components["parameters"]["Type"];
|
2225
|
+
ID: components["parameters"]["ID"];
|
2226
|
+
};
|
2227
|
+
};
|
2228
|
+
responses: {
|
2229
|
+
202: components["responses"]["202"];
|
2230
|
+
400: components["responses"]["400"];
|
2231
|
+
401: components["responses"]["401"];
|
2232
|
+
403: components["responses"]["403"];
|
2233
|
+
404: components["responses"]["404"];
|
2234
|
+
405: components["responses"]["405"];
|
2235
|
+
406: components["responses"]["406"];
|
2236
|
+
501: components["responses"]["501"];
|
2237
|
+
503: components["responses"]["503"];
|
2238
|
+
};
|
2239
|
+
};
|
2240
|
+
/**
|
2241
|
+
* Return party information
|
2242
|
+
* @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.
|
2243
|
+
*/
|
2244
|
+
PartiesByTypeAndID2: {
|
2245
|
+
parameters: {
|
2246
|
+
header: {
|
2247
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2248
|
+
Date: components["parameters"]["Date"];
|
2249
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2250
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2251
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2252
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2253
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2254
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2255
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2256
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2257
|
+
};
|
2258
|
+
path: {
|
2259
|
+
Type: components["parameters"]["Type"];
|
2260
|
+
ID: components["parameters"]["ID"];
|
2261
|
+
};
|
2262
|
+
};
|
2263
|
+
/** @description Party information returned. */
|
2264
|
+
requestBody: {
|
2265
|
+
content: {
|
2266
|
+
"application/json": components["schemas"]["PartiesTypeIDPutResponse"];
|
2267
|
+
};
|
2268
|
+
};
|
2269
|
+
responses: {
|
2270
|
+
200: components["responses"]["200"];
|
2271
|
+
400: components["responses"]["400"];
|
2272
|
+
401: components["responses"]["401"];
|
2273
|
+
403: components["responses"]["403"];
|
2274
|
+
404: components["responses"]["404"];
|
2275
|
+
405: components["responses"]["405"];
|
2276
|
+
406: components["responses"]["406"];
|
2277
|
+
501: components["responses"]["501"];
|
2278
|
+
503: components["responses"]["503"];
|
2279
|
+
};
|
2280
|
+
};
|
2281
|
+
/**
|
2282
|
+
* Return party information error
|
2283
|
+
* @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubI}/error`) is used.
|
2284
|
+
*/
|
2285
|
+
PartiesErrorByTypeAndID: {
|
2286
|
+
parameters: {
|
2287
|
+
header: {
|
2288
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2289
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2290
|
+
Date: components["parameters"]["Date"];
|
2291
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2292
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2293
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2294
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2295
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2296
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2297
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2298
|
+
};
|
2299
|
+
path: {
|
2300
|
+
Type: components["parameters"]["Type"];
|
2301
|
+
ID: components["parameters"]["ID"];
|
2302
|
+
};
|
2303
|
+
};
|
2304
|
+
/** @description Details of the error returned. */
|
2305
|
+
requestBody: {
|
2306
|
+
content: {
|
2307
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2308
|
+
};
|
2309
|
+
};
|
2310
|
+
responses: {
|
2311
|
+
200: components["responses"]["200"];
|
2312
|
+
400: components["responses"]["400"];
|
2313
|
+
401: components["responses"]["401"];
|
2314
|
+
403: components["responses"]["403"];
|
2315
|
+
404: components["responses"]["404"];
|
2316
|
+
405: components["responses"]["405"];
|
2317
|
+
406: components["responses"]["406"];
|
2318
|
+
501: components["responses"]["501"];
|
2319
|
+
503: components["responses"]["503"];
|
2320
|
+
};
|
2321
|
+
};
|
2322
|
+
/**
|
2323
|
+
* Look up party information
|
2324
|
+
* @description The HTTP request `GET /parties/{Type}/{ID}` (or `GET /parties/{Type}/{ID}/{SubId}`) is used to look up information regarding the requested Party, defined by `{Type}`, `{ID}` and optionally `{SubId}` (for example, `GET /parties/MSISDN/123456789`, or `GET /parties/BUSINESS/shoecompany/employee1`).
|
2325
|
+
*/
|
2326
|
+
PartiesSubIdByTypeAndID: {
|
2327
|
+
parameters: {
|
2328
|
+
header: {
|
2329
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2330
|
+
Date: components["parameters"]["Date"];
|
2331
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2332
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2333
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2334
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2335
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2336
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2337
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2338
|
+
Accept: components["parameters"]["Accept"];
|
2339
|
+
};
|
2340
|
+
path: {
|
2341
|
+
Type: components["parameters"]["Type"];
|
2342
|
+
ID: components["parameters"]["ID"];
|
2343
|
+
SubId: components["parameters"]["SubId"];
|
2344
|
+
};
|
2345
|
+
};
|
2346
|
+
responses: {
|
2347
|
+
202: components["responses"]["202"];
|
2348
|
+
400: components["responses"]["400"];
|
2349
|
+
401: components["responses"]["401"];
|
2350
|
+
403: components["responses"]["403"];
|
2351
|
+
404: components["responses"]["404"];
|
2352
|
+
405: components["responses"]["405"];
|
2353
|
+
406: components["responses"]["406"];
|
2354
|
+
501: components["responses"]["501"];
|
2355
|
+
503: components["responses"]["503"];
|
2356
|
+
};
|
2357
|
+
};
|
2358
|
+
/**
|
2359
|
+
* Return party information
|
2360
|
+
* @description The callback `PUT /parties/{Type}/{ID}` (or `PUT /parties/{Type}/{ID}/{SubId}`) is used to inform the client of a successful result of the Party information lookup.
|
2361
|
+
*/
|
2362
|
+
PartiesSubIdByTypeAndIDPut: {
|
2363
|
+
parameters: {
|
2364
|
+
header: {
|
2365
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2366
|
+
Date: components["parameters"]["Date"];
|
2367
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2368
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2369
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2370
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2371
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2372
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2373
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2374
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2375
|
+
};
|
2376
|
+
path: {
|
2377
|
+
Type: components["parameters"]["Type"];
|
2378
|
+
ID: components["parameters"]["ID"];
|
2379
|
+
SubId: components["parameters"]["SubId"];
|
2380
|
+
};
|
2381
|
+
};
|
2382
|
+
/** @description Party information returned. */
|
2383
|
+
requestBody: {
|
2384
|
+
content: {
|
2385
|
+
"application/json": components["schemas"]["PartiesTypeIDPutResponse"];
|
2386
|
+
};
|
2387
|
+
};
|
2388
|
+
responses: {
|
2389
|
+
200: components["responses"]["200"];
|
2390
|
+
400: components["responses"]["400"];
|
2391
|
+
401: components["responses"]["401"];
|
2392
|
+
403: components["responses"]["403"];
|
2393
|
+
404: components["responses"]["404"];
|
2394
|
+
405: components["responses"]["405"];
|
2395
|
+
406: components["responses"]["406"];
|
2396
|
+
501: components["responses"]["501"];
|
2397
|
+
503: components["responses"]["503"];
|
2398
|
+
};
|
2399
|
+
};
|
2400
|
+
/**
|
2401
|
+
* Return party information error
|
2402
|
+
* @description If the server is unable to find Party information of the provided identity, or another processing error occurred, the error callback `PUT /parties/{Type}/{ID}/error` (or `PUT /parties/{Type}/{ID}/{SubId}/error`) is used.
|
2403
|
+
*/
|
2404
|
+
PartiesSubIdErrorByTypeAndID: {
|
2405
|
+
parameters: {
|
2406
|
+
header: {
|
2407
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2408
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2409
|
+
Date: components["parameters"]["Date"];
|
2410
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2411
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2412
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2413
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2414
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2415
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2416
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2417
|
+
};
|
2418
|
+
path: {
|
2419
|
+
Type: components["parameters"]["Type"];
|
2420
|
+
ID: components["parameters"]["ID"];
|
2421
|
+
SubId: components["parameters"]["SubId"];
|
2422
|
+
};
|
2423
|
+
};
|
2424
|
+
/** @description Details of the error returned. */
|
2425
|
+
requestBody: {
|
2426
|
+
content: {
|
2427
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2428
|
+
};
|
2429
|
+
};
|
2430
|
+
responses: {
|
2431
|
+
200: components["responses"]["200"];
|
2432
|
+
400: components["responses"]["400"];
|
2433
|
+
401: components["responses"]["401"];
|
2434
|
+
403: components["responses"]["403"];
|
2435
|
+
404: components["responses"]["404"];
|
2436
|
+
405: components["responses"]["405"];
|
2437
|
+
406: components["responses"]["406"];
|
2438
|
+
501: components["responses"]["501"];
|
2439
|
+
503: components["responses"]["503"];
|
2440
|
+
};
|
2441
|
+
};
|
2442
|
+
/**
|
2443
|
+
* Perform transaction request
|
2444
|
+
* @description The HTTP request `POST /transactionRequests` is used to request the creation of a transaction request for the provided financial transaction in the server.
|
2445
|
+
*/
|
2446
|
+
TransactionRequests: {
|
2447
|
+
parameters: {
|
2448
|
+
header: {
|
2449
|
+
Accept: components["parameters"]["Accept"];
|
2450
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2451
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2452
|
+
Date: components["parameters"]["Date"];
|
2453
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2454
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2455
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2456
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2457
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2458
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2459
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2460
|
+
};
|
2461
|
+
};
|
2462
|
+
/** @description Transaction request to be created. */
|
2463
|
+
requestBody: {
|
2464
|
+
content: {
|
2465
|
+
"application/json": components["schemas"]["TransactionRequestsPostRequest"];
|
2466
|
+
};
|
2467
|
+
};
|
2468
|
+
responses: {
|
2469
|
+
202: components["responses"]["202"];
|
2470
|
+
400: components["responses"]["400"];
|
2471
|
+
401: components["responses"]["401"];
|
2472
|
+
403: components["responses"]["403"];
|
2473
|
+
404: components["responses"]["404"];
|
2474
|
+
405: components["responses"]["405"];
|
2475
|
+
406: components["responses"]["406"];
|
2476
|
+
501: components["responses"]["501"];
|
2477
|
+
503: components["responses"]["503"];
|
2478
|
+
};
|
2479
|
+
};
|
2480
|
+
/**
|
2481
|
+
* Retrieve transaction request information
|
2482
|
+
* @description The HTTP request `GET /transactionRequests/{ID}` is used to get information regarding a transaction request created or requested earlier. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request.
|
2483
|
+
*/
|
2484
|
+
TransactionRequestsByID: {
|
2485
|
+
parameters: {
|
2486
|
+
header: {
|
2487
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2488
|
+
Date: components["parameters"]["Date"];
|
2489
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2490
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2491
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2492
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2493
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2494
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2495
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2496
|
+
Accept: components["parameters"]["Accept"];
|
2497
|
+
};
|
2498
|
+
path: {
|
2499
|
+
ID: components["parameters"]["ID"];
|
2500
|
+
};
|
2501
|
+
};
|
2502
|
+
responses: {
|
2503
|
+
202: components["responses"]["202"];
|
2504
|
+
400: components["responses"]["400"];
|
2505
|
+
401: components["responses"]["401"];
|
2506
|
+
403: components["responses"]["403"];
|
2507
|
+
404: components["responses"]["404"];
|
2508
|
+
405: components["responses"]["405"];
|
2509
|
+
406: components["responses"]["406"];
|
2510
|
+
501: components["responses"]["501"];
|
2511
|
+
503: components["responses"]["503"];
|
2512
|
+
};
|
2513
|
+
};
|
2514
|
+
/**
|
2515
|
+
* Return transaction request information
|
2516
|
+
* @description The callback `PUT /transactionRequests/{ID}` is used to inform the client of a requested or created transaction request. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`.
|
2517
|
+
*/
|
2518
|
+
TransactionRequestsByIDPut: {
|
2519
|
+
parameters: {
|
2520
|
+
header: {
|
2521
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2522
|
+
Date: components["parameters"]["Date"];
|
2523
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2524
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2525
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2526
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2527
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2528
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2529
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2530
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2531
|
+
};
|
2532
|
+
path: {
|
2533
|
+
ID: components["parameters"]["ID"];
|
2534
|
+
};
|
2535
|
+
};
|
2536
|
+
/** @description Transaction request information returned. */
|
2537
|
+
requestBody: {
|
2538
|
+
content: {
|
2539
|
+
"application/json": components["schemas"]["TransactionRequestsIDPutResponse"];
|
2540
|
+
};
|
2541
|
+
};
|
2542
|
+
responses: {
|
2543
|
+
200: components["responses"]["200"];
|
2544
|
+
400: components["responses"]["400"];
|
2545
|
+
401: components["responses"]["401"];
|
2546
|
+
403: components["responses"]["403"];
|
2547
|
+
404: components["responses"]["404"];
|
2548
|
+
405: components["responses"]["405"];
|
2549
|
+
406: components["responses"]["406"];
|
2550
|
+
501: components["responses"]["501"];
|
2551
|
+
503: components["responses"]["503"];
|
2552
|
+
};
|
2553
|
+
};
|
2554
|
+
/**
|
2555
|
+
* Return transaction request information error
|
2556
|
+
* @description If the server is unable to find or create a transaction request, or another processing error occurs, the error callback `PUT /transactionRequests/{ID}/error` is used. The `{ID}` in the URI should contain the `transactionRequestId` that was used for the creation of the transaction request, or the `{ID}` that was used in the `GET /transactionRequests/{ID}`.
|
2557
|
+
*/
|
2558
|
+
TransactionRequestsErrorByID: {
|
2559
|
+
parameters: {
|
2560
|
+
header: {
|
2561
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2562
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2563
|
+
Date: components["parameters"]["Date"];
|
2564
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2565
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2566
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2567
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2568
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2569
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2570
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2571
|
+
};
|
2572
|
+
path: {
|
2573
|
+
ID: components["parameters"]["ID"];
|
2574
|
+
};
|
2575
|
+
};
|
2576
|
+
/** @description Details of the error returned. */
|
2577
|
+
requestBody: {
|
2578
|
+
content: {
|
2579
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2580
|
+
};
|
2581
|
+
};
|
2582
|
+
responses: {
|
2583
|
+
200: components["responses"]["200"];
|
2584
|
+
400: components["responses"]["400"];
|
2585
|
+
401: components["responses"]["401"];
|
2586
|
+
403: components["responses"]["403"];
|
2587
|
+
404: components["responses"]["404"];
|
2588
|
+
405: components["responses"]["405"];
|
2589
|
+
406: components["responses"]["406"];
|
2590
|
+
501: components["responses"]["501"];
|
2591
|
+
503: components["responses"]["503"];
|
2592
|
+
};
|
2593
|
+
};
|
2594
|
+
/**
|
2595
|
+
* Calculate quote
|
2596
|
+
* @description The HTTP request `POST /quotes` is used to request the creation of a quote for the provided financial transaction in the server.
|
2597
|
+
*/
|
2598
|
+
Quotes: {
|
2599
|
+
parameters: {
|
2600
|
+
header: {
|
2601
|
+
Accept: components["parameters"]["Accept"];
|
2602
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2603
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2604
|
+
Date: components["parameters"]["Date"];
|
2605
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2606
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2607
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2608
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2609
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2610
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2611
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2612
|
+
};
|
2613
|
+
};
|
2614
|
+
/** @description Details of the quote to be created. */
|
2615
|
+
requestBody: {
|
2616
|
+
content: {
|
2617
|
+
"application/json": components["schemas"]["QuotesPostRequest"];
|
2618
|
+
};
|
2619
|
+
};
|
2620
|
+
responses: {
|
2621
|
+
202: components["responses"]["202"];
|
2622
|
+
400: components["responses"]["400"];
|
2623
|
+
401: components["responses"]["401"];
|
2624
|
+
403: components["responses"]["403"];
|
2625
|
+
404: components["responses"]["404"];
|
2626
|
+
405: components["responses"]["405"];
|
2627
|
+
406: components["responses"]["406"];
|
2628
|
+
501: components["responses"]["501"];
|
2629
|
+
503: components["responses"]["503"];
|
2630
|
+
};
|
2631
|
+
};
|
2632
|
+
/**
|
2633
|
+
* Retrieve quote information
|
2634
|
+
* @description The HTTP request `GET /quotes/{ID}` is used to get information regarding a quote created or requested earlier. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote.
|
2635
|
+
*/
|
2636
|
+
QuotesByID: {
|
2637
|
+
parameters: {
|
2638
|
+
header: {
|
2639
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2640
|
+
Date: components["parameters"]["Date"];
|
2641
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2642
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2643
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2644
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2645
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2646
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2647
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2648
|
+
Accept: components["parameters"]["Accept"];
|
2649
|
+
};
|
2650
|
+
path: {
|
2651
|
+
ID: components["parameters"]["ID"];
|
2652
|
+
};
|
2653
|
+
};
|
2654
|
+
responses: {
|
2655
|
+
202: components["responses"]["202"];
|
2656
|
+
400: components["responses"]["400"];
|
2657
|
+
401: components["responses"]["401"];
|
2658
|
+
403: components["responses"]["403"];
|
2659
|
+
404: components["responses"]["404"];
|
2660
|
+
405: components["responses"]["405"];
|
2661
|
+
406: components["responses"]["406"];
|
2662
|
+
501: components["responses"]["501"];
|
2663
|
+
503: components["responses"]["503"];
|
2664
|
+
};
|
2665
|
+
};
|
2666
|
+
/**
|
2667
|
+
* Return quote information
|
2668
|
+
* @description The callback `PUT /quotes/{ID}` is used to inform the client of a requested or created quote. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request.
|
2669
|
+
*/
|
2670
|
+
QuotesByID1: {
|
2671
|
+
parameters: {
|
2672
|
+
header: {
|
2673
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2674
|
+
Date: components["parameters"]["Date"];
|
2675
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2676
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2677
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2678
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2679
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2680
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2681
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2682
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2683
|
+
};
|
2684
|
+
path: {
|
2685
|
+
ID: components["parameters"]["ID"];
|
2686
|
+
};
|
2687
|
+
};
|
2688
|
+
/** @description Quote information returned. */
|
2689
|
+
requestBody: {
|
2690
|
+
content: {
|
2691
|
+
"application/json": components["schemas"]["QuotesIDPutResponse"];
|
2692
|
+
};
|
2693
|
+
};
|
2694
|
+
responses: {
|
2695
|
+
200: components["responses"]["200"];
|
2696
|
+
400: components["responses"]["400"];
|
2697
|
+
401: components["responses"]["401"];
|
2698
|
+
403: components["responses"]["403"];
|
2699
|
+
404: components["responses"]["404"];
|
2700
|
+
405: components["responses"]["405"];
|
2701
|
+
406: components["responses"]["406"];
|
2702
|
+
501: components["responses"]["501"];
|
2703
|
+
503: components["responses"]["503"];
|
2704
|
+
};
|
2705
|
+
};
|
2706
|
+
/**
|
2707
|
+
* Return quote information error
|
2708
|
+
* @description If the server is unable to find or create a quote, or some other processing error occurs, the error callback `PUT /quotes/{ID}/error` is used. The `{ID}` in the URI should contain the `quoteId` that was used for the creation of the quote, or the `{ID}` that was used in the `GET /quotes/{ID}` request.
|
2709
|
+
*/
|
2710
|
+
QuotesByIDAndError: {
|
2711
|
+
parameters: {
|
2712
|
+
header: {
|
2713
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2714
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2715
|
+
Date: components["parameters"]["Date"];
|
2716
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2717
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2718
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2719
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2720
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2721
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2722
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2723
|
+
};
|
2724
|
+
path: {
|
2725
|
+
ID: components["parameters"]["ID"];
|
2726
|
+
};
|
2727
|
+
};
|
2728
|
+
/** @description Details of the error returned. */
|
2729
|
+
requestBody: {
|
2730
|
+
content: {
|
2731
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2732
|
+
};
|
2733
|
+
};
|
2734
|
+
responses: {
|
2735
|
+
200: components["responses"]["200"];
|
2736
|
+
400: components["responses"]["400"];
|
2737
|
+
401: components["responses"]["401"];
|
2738
|
+
403: components["responses"]["403"];
|
2739
|
+
404: components["responses"]["404"];
|
2740
|
+
405: components["responses"]["405"];
|
2741
|
+
406: components["responses"]["406"];
|
2742
|
+
501: components["responses"]["501"];
|
2743
|
+
503: components["responses"]["503"];
|
2744
|
+
};
|
2745
|
+
};
|
2746
|
+
/**
|
2747
|
+
* Perform authorization
|
2748
|
+
* @description The HTTP request `GET /authorizations/{ID}` is used to request the Payer to enter the applicable credentials in the Payee FSP system. The `{ID}` in the URI should contain the `transactionRequestID`, received from the `POST /transactionRequests` service earlier in the process. This request requires a query string to be included in the URI, with the following key-value pairs*:*
|
2749
|
+
*
|
2750
|
+
* - `authenticationType={Type}`, where `{Type}` value is a valid authentication type from the enumeration `AuthenticationType`.
|
2751
|
+
*
|
2752
|
+
* - `retriesLeft=={NrOfRetries}`, where `{NrOfRetries}` is the number of retries left before the financial transaction is rejected. `{NrOfRetries}` must be expressed in the form of the data type `Integer`. `retriesLeft=1` means that this is the last retry before the financial transaction is rejected.
|
2753
|
+
*
|
2754
|
+
* - `amount={Amount}`, where `{Amount}` is the transaction amount that will be withdrawn from the Payer’s account. `{Amount}` must be expressed in the form of the data type `Amount`.
|
2755
|
+
*
|
2756
|
+
* - `currency={Currency}`, where `{Currency}` is the transaction currency for the amount that will be withdrawn from the Payer’s account. The `{Currency}` value must be expressed in the form of the enumeration `CurrencyCode`.
|
2757
|
+
*
|
2758
|
+
* The following is an example URI containing all the required key-value pairs in the query string*:*
|
2759
|
+
*
|
2760
|
+
* `GET /authorization/3d492671-b7af-4f3f-88de-76169b1bdf88?authenticationType=OTP&retriesLeft=2&amount=102¤cy=USD`
|
2761
|
+
*/
|
2762
|
+
AuthorizationsByIDGet: {
|
2763
|
+
parameters: {
|
2764
|
+
header: {
|
2765
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2766
|
+
Date: components["parameters"]["Date"];
|
2767
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2768
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2769
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2770
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2771
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2772
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2773
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2774
|
+
Accept: components["parameters"]["Accept"];
|
2775
|
+
};
|
2776
|
+
path: {
|
2777
|
+
ID: components["parameters"]["ID"];
|
2778
|
+
};
|
2779
|
+
};
|
2780
|
+
responses: {
|
2781
|
+
202: components["responses"]["202"];
|
2782
|
+
400: components["responses"]["400"];
|
2783
|
+
401: components["responses"]["401"];
|
2784
|
+
403: components["responses"]["403"];
|
2785
|
+
404: components["responses"]["404"];
|
2786
|
+
405: components["responses"]["405"];
|
2787
|
+
406: components["responses"]["406"];
|
2788
|
+
501: components["responses"]["501"];
|
2789
|
+
503: components["responses"]["503"];
|
2790
|
+
};
|
2791
|
+
};
|
2792
|
+
/**
|
2793
|
+
* Return authorization result
|
2794
|
+
* @description The callback `PUT /authorizations/{ID}` is used to inform the client of the result of a previously-requested authorization. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}` request.
|
2795
|
+
*/
|
2796
|
+
AuthorizationsByIDPut: {
|
2797
|
+
parameters: {
|
2798
|
+
header: {
|
2799
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2800
|
+
Date: components["parameters"]["Date"];
|
2801
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2802
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2803
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2804
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2805
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2806
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2807
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2808
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2809
|
+
};
|
2810
|
+
path: {
|
2811
|
+
ID: components["parameters"]["ID"];
|
2812
|
+
};
|
2813
|
+
};
|
2814
|
+
/** @description Authorization result returned. */
|
2815
|
+
requestBody: {
|
2816
|
+
content: {
|
2817
|
+
"application/json": components["schemas"]["AuthorizationsIDPutResponse"];
|
2818
|
+
};
|
2819
|
+
};
|
2820
|
+
responses: {
|
2821
|
+
200: components["responses"]["200"];
|
2822
|
+
400: components["responses"]["400"];
|
2823
|
+
401: components["responses"]["401"];
|
2824
|
+
403: components["responses"]["403"];
|
2825
|
+
404: components["responses"]["404"];
|
2826
|
+
405: components["responses"]["405"];
|
2827
|
+
406: components["responses"]["406"];
|
2828
|
+
501: components["responses"]["501"];
|
2829
|
+
503: components["responses"]["503"];
|
2830
|
+
};
|
2831
|
+
};
|
2832
|
+
/**
|
2833
|
+
* Return authorization error
|
2834
|
+
* @description If the server is unable to find the transaction request, or another processing error occurs, the error callback `PUT /authorizations/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /authorizations/{ID}`.
|
2835
|
+
*/
|
2836
|
+
AuthorizationsByIDAndError: {
|
2837
|
+
parameters: {
|
2838
|
+
header: {
|
2839
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2840
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2841
|
+
Date: components["parameters"]["Date"];
|
2842
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2843
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2844
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2845
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2846
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2847
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2848
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2849
|
+
};
|
2850
|
+
path: {
|
2851
|
+
ID: components["parameters"]["ID"];
|
2852
|
+
};
|
2853
|
+
};
|
2854
|
+
/** @description Details of the error returned. */
|
2855
|
+
requestBody: {
|
2856
|
+
content: {
|
2857
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
2858
|
+
};
|
2859
|
+
};
|
2860
|
+
responses: {
|
2861
|
+
200: components["responses"]["200"];
|
2862
|
+
400: components["responses"]["400"];
|
2863
|
+
401: components["responses"]["401"];
|
2864
|
+
403: components["responses"]["403"];
|
2865
|
+
404: components["responses"]["404"];
|
2866
|
+
405: components["responses"]["405"];
|
2867
|
+
406: components["responses"]["406"];
|
2868
|
+
501: components["responses"]["501"];
|
2869
|
+
503: components["responses"]["503"];
|
2870
|
+
};
|
2871
|
+
};
|
2872
|
+
/**
|
2873
|
+
* Perform transfer
|
2874
|
+
* @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the next ledger, and a financial transaction for the Payee FSP.
|
2875
|
+
*/
|
2876
|
+
transfers: {
|
2877
|
+
parameters: {
|
2878
|
+
header: {
|
2879
|
+
Accept: components["parameters"]["Accept"];
|
2880
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2881
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2882
|
+
Date: components["parameters"]["Date"];
|
2883
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2884
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2885
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2886
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2887
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2888
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2889
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2890
|
+
};
|
2891
|
+
};
|
2892
|
+
/** @description Details of the transfer to be created. */
|
2893
|
+
requestBody: {
|
2894
|
+
content: {
|
2895
|
+
"application/json": components["schemas"]["TransfersPostRequest"];
|
2896
|
+
};
|
2897
|
+
};
|
2898
|
+
responses: {
|
2899
|
+
202: components["responses"]["202"];
|
2900
|
+
400: components["responses"]["400"];
|
2901
|
+
401: components["responses"]["401"];
|
2902
|
+
403: components["responses"]["403"];
|
2903
|
+
404: components["responses"]["404"];
|
2904
|
+
405: components["responses"]["405"];
|
2905
|
+
406: components["responses"]["406"];
|
2906
|
+
501: components["responses"]["501"];
|
2907
|
+
503: components["responses"]["503"];
|
2908
|
+
};
|
2909
|
+
};
|
2910
|
+
/**
|
2911
|
+
* Retrieve transfer information
|
2912
|
+
* @description The HTTP request `GET /transfers/{ID}` is used to get information regarding a transfer created or requested earlier. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer.
|
2913
|
+
*/
|
2914
|
+
TransfersByIDGet: {
|
2915
|
+
parameters: {
|
2916
|
+
header: {
|
2917
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2918
|
+
Date: components["parameters"]["Date"];
|
2919
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2920
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2921
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2922
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2923
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2924
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2925
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2926
|
+
Accept: components["parameters"]["Accept"];
|
2927
|
+
};
|
2928
|
+
path: {
|
2929
|
+
ID: components["parameters"]["ID"];
|
2930
|
+
};
|
2931
|
+
};
|
2932
|
+
responses: {
|
2933
|
+
202: components["responses"]["202"];
|
2934
|
+
400: components["responses"]["400"];
|
2935
|
+
401: components["responses"]["401"];
|
2936
|
+
403: components["responses"]["403"];
|
2937
|
+
404: components["responses"]["404"];
|
2938
|
+
405: components["responses"]["405"];
|
2939
|
+
406: components["responses"]["406"];
|
2940
|
+
501: components["responses"]["501"];
|
2941
|
+
503: components["responses"]["503"];
|
2942
|
+
};
|
2943
|
+
};
|
2944
|
+
/**
|
2945
|
+
* Return transfer information
|
2946
|
+
* @description The callback `PUT /transfers/{ID}` is used to inform the client of a requested or created transfer. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}` request.
|
2947
|
+
*/
|
2948
|
+
TransfersByIDPut: {
|
2949
|
+
parameters: {
|
2950
|
+
header: {
|
2951
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2952
|
+
Date: components["parameters"]["Date"];
|
2953
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2954
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2955
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2956
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2957
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2958
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2959
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
2960
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
2961
|
+
};
|
2962
|
+
path: {
|
2963
|
+
ID: components["parameters"]["ID"];
|
2964
|
+
};
|
2965
|
+
};
|
2966
|
+
/** @description Transfer information returned. */
|
2967
|
+
requestBody: {
|
2968
|
+
content: {
|
2969
|
+
"application/json": components["schemas"]["TransfersIDPutResponse"];
|
2970
|
+
};
|
2971
|
+
};
|
2972
|
+
responses: {
|
2973
|
+
200: components["responses"]["200"];
|
2974
|
+
400: components["responses"]["400"];
|
2975
|
+
401: components["responses"]["401"];
|
2976
|
+
403: components["responses"]["403"];
|
2977
|
+
404: components["responses"]["404"];
|
2978
|
+
405: components["responses"]["405"];
|
2979
|
+
406: components["responses"]["406"];
|
2980
|
+
501: components["responses"]["501"];
|
2981
|
+
503: components["responses"]["503"];
|
2982
|
+
};
|
2983
|
+
};
|
2984
|
+
/**
|
2985
|
+
* Return transfer information
|
2986
|
+
* @description The HTTP request PATCH /transfers/<ID> is used by a Switch to update the state of a previously reserved transfer, if the Payee FSP has requested a commit notification when the Switch has completed processing of the transfer. The <ID> in the URI should contain the transferId that was used for the creation of the transfer. Please note that this request does not generate a callback.
|
2987
|
+
*/
|
2988
|
+
TransfersByIDPatch: {
|
2989
|
+
parameters: {
|
2990
|
+
header: {
|
2991
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
2992
|
+
Date: components["parameters"]["Date"];
|
2993
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
2994
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
2995
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
2996
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
2997
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
2998
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
2999
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3000
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3001
|
+
};
|
3002
|
+
path: {
|
3003
|
+
ID: components["parameters"]["ID"];
|
3004
|
+
};
|
3005
|
+
};
|
3006
|
+
/** @description Transfer notification upon completion. */
|
3007
|
+
requestBody: {
|
3008
|
+
content: {
|
3009
|
+
"application/json": components["schemas"]["TransfersIDPatchResponse"];
|
3010
|
+
};
|
3011
|
+
};
|
3012
|
+
responses: {
|
3013
|
+
200: components["responses"]["200"];
|
3014
|
+
400: components["responses"]["400"];
|
3015
|
+
401: components["responses"]["401"];
|
3016
|
+
403: components["responses"]["403"];
|
3017
|
+
404: components["responses"]["404"];
|
3018
|
+
405: components["responses"]["405"];
|
3019
|
+
406: components["responses"]["406"];
|
3020
|
+
501: components["responses"]["501"];
|
3021
|
+
503: components["responses"]["503"];
|
3022
|
+
};
|
3023
|
+
};
|
3024
|
+
/**
|
3025
|
+
* Return transfer information error
|
3026
|
+
* @description If the server is unable to find or create a transfer, or another processing error occurs, the error callback `PUT /transfers/{ID}/error` is used. The `{ID}` in the URI should contain the `transferId` that was used for the creation of the transfer, or the `{ID}` that was used in the `GET /transfers/{ID}`.
|
3027
|
+
*/
|
3028
|
+
TransfersByIDAndError: {
|
3029
|
+
parameters: {
|
3030
|
+
header: {
|
3031
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3032
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3033
|
+
Date: components["parameters"]["Date"];
|
3034
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3035
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3036
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3037
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3038
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3039
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3040
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3041
|
+
};
|
3042
|
+
path: {
|
3043
|
+
ID: components["parameters"]["ID"];
|
3044
|
+
};
|
3045
|
+
};
|
3046
|
+
/** @description Details of the error returned. */
|
3047
|
+
requestBody: {
|
3048
|
+
content: {
|
3049
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
3050
|
+
};
|
3051
|
+
};
|
3052
|
+
responses: {
|
3053
|
+
200: components["responses"]["200"];
|
3054
|
+
400: components["responses"]["400"];
|
3055
|
+
401: components["responses"]["401"];
|
3056
|
+
403: components["responses"]["403"];
|
3057
|
+
404: components["responses"]["404"];
|
3058
|
+
405: components["responses"]["405"];
|
3059
|
+
406: components["responses"]["406"];
|
3060
|
+
501: components["responses"]["501"];
|
3061
|
+
503: components["responses"]["503"];
|
3062
|
+
};
|
3063
|
+
};
|
3064
|
+
/**
|
3065
|
+
* Retrieve transaction information
|
3066
|
+
* @description The HTTP request `GET /transactions/{ID}` is used to get transaction information regarding a financial transaction created earlier. The `{ID}` in the URI should contain the `transactionId` that was used for the creation of the quote, as the transaction is created as part of another process (the transfer process).
|
3067
|
+
*/
|
3068
|
+
TransactionsByID: {
|
3069
|
+
parameters: {
|
3070
|
+
header: {
|
3071
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3072
|
+
Date: components["parameters"]["Date"];
|
3073
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3074
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3075
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3076
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3077
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3078
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3079
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3080
|
+
Accept: components["parameters"]["Accept"];
|
3081
|
+
};
|
3082
|
+
path: {
|
3083
|
+
ID: components["parameters"]["ID"];
|
3084
|
+
};
|
3085
|
+
};
|
3086
|
+
responses: {
|
3087
|
+
202: components["responses"]["202"];
|
3088
|
+
400: components["responses"]["400"];
|
3089
|
+
401: components["responses"]["401"];
|
3090
|
+
403: components["responses"]["403"];
|
3091
|
+
404: components["responses"]["404"];
|
3092
|
+
405: components["responses"]["405"];
|
3093
|
+
406: components["responses"]["406"];
|
3094
|
+
501: components["responses"]["501"];
|
3095
|
+
503: components["responses"]["503"];
|
3096
|
+
};
|
3097
|
+
};
|
3098
|
+
/**
|
3099
|
+
* Return transaction information
|
3100
|
+
* @description The callback `PUT /transactions/{ID}` is used to inform the client of a requested transaction. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request.
|
3101
|
+
*/
|
3102
|
+
TransactionsByID1: {
|
3103
|
+
parameters: {
|
3104
|
+
header: {
|
3105
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3106
|
+
Date: components["parameters"]["Date"];
|
3107
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3108
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3109
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3110
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3111
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3112
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3113
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3114
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3115
|
+
};
|
3116
|
+
path: {
|
3117
|
+
ID: components["parameters"]["ID"];
|
3118
|
+
};
|
3119
|
+
};
|
3120
|
+
/** @description Transaction information returned. */
|
3121
|
+
requestBody: {
|
3122
|
+
content: {
|
3123
|
+
"application/json": components["schemas"]["TransactionsIDPutResponse"];
|
3124
|
+
};
|
3125
|
+
};
|
3126
|
+
responses: {
|
3127
|
+
200: components["responses"]["200"];
|
3128
|
+
400: components["responses"]["400"];
|
3129
|
+
401: components["responses"]["401"];
|
3130
|
+
403: components["responses"]["403"];
|
3131
|
+
404: components["responses"]["404"];
|
3132
|
+
405: components["responses"]["405"];
|
3133
|
+
406: components["responses"]["406"];
|
3134
|
+
501: components["responses"]["501"];
|
3135
|
+
503: components["responses"]["503"];
|
3136
|
+
};
|
3137
|
+
};
|
3138
|
+
/**
|
3139
|
+
* Return transaction information error
|
3140
|
+
* @description If the server is unable to find or create a transaction, or another processing error occurs, the error callback `PUT /transactions/{ID}/error` is used. The `{ID}` in the URI should contain the `{ID}` that was used in the `GET /transactions/{ID}` request.
|
3141
|
+
*/
|
3142
|
+
TransactionsErrorByID: {
|
3143
|
+
parameters: {
|
3144
|
+
header: {
|
3145
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3146
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3147
|
+
Date: components["parameters"]["Date"];
|
3148
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3149
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3150
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3151
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3152
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3153
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3154
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3155
|
+
};
|
3156
|
+
path: {
|
3157
|
+
ID: components["parameters"]["ID"];
|
3158
|
+
};
|
3159
|
+
};
|
3160
|
+
/** @description Details of the error returned. */
|
3161
|
+
requestBody: {
|
3162
|
+
content: {
|
3163
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
3164
|
+
};
|
3165
|
+
};
|
3166
|
+
responses: {
|
3167
|
+
200: components["responses"]["200"];
|
3168
|
+
400: components["responses"]["400"];
|
3169
|
+
401: components["responses"]["401"];
|
3170
|
+
403: components["responses"]["403"];
|
3171
|
+
404: components["responses"]["404"];
|
3172
|
+
405: components["responses"]["405"];
|
3173
|
+
406: components["responses"]["406"];
|
3174
|
+
501: components["responses"]["501"];
|
3175
|
+
503: components["responses"]["503"];
|
3176
|
+
};
|
3177
|
+
};
|
3178
|
+
/**
|
3179
|
+
* Calculate bulk quote
|
3180
|
+
* @description The HTTP request `POST /bulkQuotes` is used to request the creation of a bulk quote for the provided financial transactions in the server.
|
3181
|
+
*/
|
3182
|
+
BulkQuotes: {
|
3183
|
+
parameters: {
|
3184
|
+
header: {
|
3185
|
+
Accept: components["parameters"]["Accept"];
|
3186
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3187
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3188
|
+
Date: components["parameters"]["Date"];
|
3189
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3190
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3191
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3192
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3193
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3194
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3195
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3196
|
+
};
|
3197
|
+
};
|
3198
|
+
/** @description Details of the bulk quote to be created. */
|
3199
|
+
requestBody: {
|
3200
|
+
content: {
|
3201
|
+
"application/json": components["schemas"]["BulkQuotesPostRequest"];
|
3202
|
+
};
|
3203
|
+
};
|
3204
|
+
responses: {
|
3205
|
+
202: components["responses"]["202"];
|
3206
|
+
400: components["responses"]["400"];
|
3207
|
+
401: components["responses"]["401"];
|
3208
|
+
403: components["responses"]["403"];
|
3209
|
+
404: components["responses"]["404"];
|
3210
|
+
405: components["responses"]["405"];
|
3211
|
+
406: components["responses"]["406"];
|
3212
|
+
501: components["responses"]["501"];
|
3213
|
+
503: components["responses"]["503"];
|
3214
|
+
};
|
3215
|
+
};
|
3216
|
+
/**
|
3217
|
+
* Retrieve bulk quote information
|
3218
|
+
* @description The HTTP request `GET /bulkQuotes/{ID}` is used to get information regarding a bulk quote created or requested earlier. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote.
|
3219
|
+
*/
|
3220
|
+
BulkQuotesByID: {
|
3221
|
+
parameters: {
|
3222
|
+
header: {
|
3223
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3224
|
+
Date: components["parameters"]["Date"];
|
3225
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3226
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3227
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3228
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3229
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3230
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3231
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3232
|
+
Accept: components["parameters"]["Accept"];
|
3233
|
+
};
|
3234
|
+
path: {
|
3235
|
+
ID: components["parameters"]["ID"];
|
3236
|
+
};
|
3237
|
+
};
|
3238
|
+
responses: {
|
3239
|
+
202: components["responses"]["202"];
|
3240
|
+
400: components["responses"]["400"];
|
3241
|
+
401: components["responses"]["401"];
|
3242
|
+
403: components["responses"]["403"];
|
3243
|
+
404: components["responses"]["404"];
|
3244
|
+
405: components["responses"]["405"];
|
3245
|
+
406: components["responses"]["406"];
|
3246
|
+
501: components["responses"]["501"];
|
3247
|
+
503: components["responses"]["503"];
|
3248
|
+
};
|
3249
|
+
};
|
3250
|
+
/**
|
3251
|
+
* Return bulk quote information
|
3252
|
+
* @description The callback `PUT /bulkQuotes/{ID}` is used to inform the client of a requested or created bulk quote. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request.
|
3253
|
+
*/
|
3254
|
+
BulkQuotesByID1: {
|
3255
|
+
parameters: {
|
3256
|
+
header: {
|
3257
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3258
|
+
Date: components["parameters"]["Date"];
|
3259
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3260
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3261
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3262
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3263
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3264
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3265
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3266
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3267
|
+
};
|
3268
|
+
path: {
|
3269
|
+
ID: components["parameters"]["ID"];
|
3270
|
+
};
|
3271
|
+
};
|
3272
|
+
/** @description Bulk quote information returned. */
|
3273
|
+
requestBody: {
|
3274
|
+
content: {
|
3275
|
+
"application/json": components["schemas"]["BulkQuotesIDPutResponse"];
|
3276
|
+
};
|
3277
|
+
};
|
3278
|
+
responses: {
|
3279
|
+
200: components["responses"]["200"];
|
3280
|
+
400: components["responses"]["400"];
|
3281
|
+
401: components["responses"]["401"];
|
3282
|
+
403: components["responses"]["403"];
|
3283
|
+
404: components["responses"]["404"];
|
3284
|
+
405: components["responses"]["405"];
|
3285
|
+
406: components["responses"]["406"];
|
3286
|
+
501: components["responses"]["501"];
|
3287
|
+
503: components["responses"]["503"];
|
3288
|
+
};
|
3289
|
+
};
|
3290
|
+
/**
|
3291
|
+
* Return bulk quote information error
|
3292
|
+
* @description If the server is unable to find or create a bulk quote, or another processing error occurs, the error callback `PUT /bulkQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkQuoteId` that was used for the creation of the bulk quote, or the `{ID}` that was used in the `GET /bulkQuotes/{ID}` request.
|
3293
|
+
*/
|
3294
|
+
BulkQuotesErrorByID: {
|
3295
|
+
parameters: {
|
3296
|
+
header: {
|
3297
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3298
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3299
|
+
Date: components["parameters"]["Date"];
|
3300
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3301
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3302
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3303
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3304
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3305
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3306
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3307
|
+
};
|
3308
|
+
path: {
|
3309
|
+
ID: components["parameters"]["ID"];
|
3310
|
+
};
|
3311
|
+
};
|
3312
|
+
/** @description Details of the error returned. */
|
3313
|
+
requestBody: {
|
3314
|
+
content: {
|
3315
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
3316
|
+
};
|
3317
|
+
};
|
3318
|
+
responses: {
|
3319
|
+
200: components["responses"]["200"];
|
3320
|
+
400: components["responses"]["400"];
|
3321
|
+
401: components["responses"]["401"];
|
3322
|
+
403: components["responses"]["403"];
|
3323
|
+
404: components["responses"]["404"];
|
3324
|
+
405: components["responses"]["405"];
|
3325
|
+
406: components["responses"]["406"];
|
3326
|
+
501: components["responses"]["501"];
|
3327
|
+
503: components["responses"]["503"];
|
3328
|
+
};
|
3329
|
+
};
|
3330
|
+
/**
|
3331
|
+
* Perform bulk transfer
|
3332
|
+
* @description The HTTP request `POST /bulkTransfers` is used to request the creation of a bulk transfer in the server.
|
3333
|
+
*/
|
3334
|
+
BulkTransfers: {
|
3335
|
+
parameters: {
|
3336
|
+
header: {
|
3337
|
+
Accept: components["parameters"]["Accept"];
|
3338
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3339
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3340
|
+
Date: components["parameters"]["Date"];
|
3341
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3342
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3343
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3344
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3345
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3346
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3347
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3348
|
+
};
|
3349
|
+
};
|
3350
|
+
/** @description Details of the bulk transfer to be created. */
|
3351
|
+
requestBody: {
|
3352
|
+
content: {
|
3353
|
+
"application/json": components["schemas"]["BulkTransfersPostRequest"];
|
3354
|
+
};
|
3355
|
+
};
|
3356
|
+
responses: {
|
3357
|
+
202: components["responses"]["202"];
|
3358
|
+
400: components["responses"]["400"];
|
3359
|
+
401: components["responses"]["401"];
|
3360
|
+
403: components["responses"]["403"];
|
3361
|
+
404: components["responses"]["404"];
|
3362
|
+
405: components["responses"]["405"];
|
3363
|
+
406: components["responses"]["406"];
|
3364
|
+
501: components["responses"]["501"];
|
3365
|
+
503: components["responses"]["503"];
|
3366
|
+
};
|
3367
|
+
};
|
3368
|
+
/**
|
3369
|
+
* Retrieve bulk transfer information
|
3370
|
+
* @description The HTTP request `GET /bulkTransfers/{ID}` is used to get information regarding a bulk transfer created or requested earlier. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer.
|
3371
|
+
*/
|
3372
|
+
BulkTransferByID: {
|
3373
|
+
parameters: {
|
3374
|
+
header: {
|
3375
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3376
|
+
Date: components["parameters"]["Date"];
|
3377
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3378
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3379
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3380
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3381
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3382
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3383
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3384
|
+
Accept: components["parameters"]["Accept"];
|
3385
|
+
};
|
3386
|
+
path: {
|
3387
|
+
ID: components["parameters"]["ID"];
|
3388
|
+
};
|
3389
|
+
};
|
3390
|
+
responses: {
|
3391
|
+
202: components["responses"]["202"];
|
3392
|
+
400: components["responses"]["400"];
|
3393
|
+
401: components["responses"]["401"];
|
3394
|
+
403: components["responses"]["403"];
|
3395
|
+
404: components["responses"]["404"];
|
3396
|
+
405: components["responses"]["405"];
|
3397
|
+
406: components["responses"]["406"];
|
3398
|
+
501: components["responses"]["501"];
|
3399
|
+
503: components["responses"]["503"];
|
3400
|
+
};
|
3401
|
+
};
|
3402
|
+
/**
|
3403
|
+
* Return bulk transfer information
|
3404
|
+
* @description The callback `PUT /bulkTransfers/{ID}` is used to inform the client of a requested or created bulk transfer. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request.
|
3405
|
+
*/
|
3406
|
+
BulkTransfersByIDPut: {
|
3407
|
+
parameters: {
|
3408
|
+
header: {
|
3409
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3410
|
+
Date: components["parameters"]["Date"];
|
3411
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3412
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3413
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3414
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3415
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3416
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3417
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3418
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3419
|
+
};
|
3420
|
+
path: {
|
3421
|
+
ID: components["parameters"]["ID"];
|
3422
|
+
};
|
3423
|
+
};
|
3424
|
+
/** @description Bulk transfer information returned. */
|
3425
|
+
requestBody: {
|
3426
|
+
content: {
|
3427
|
+
"application/json": components["schemas"]["BulkTransfersIDPutResponse"];
|
3428
|
+
};
|
3429
|
+
};
|
3430
|
+
responses: {
|
3431
|
+
200: components["responses"]["200"];
|
3432
|
+
400: components["responses"]["400"];
|
3433
|
+
401: components["responses"]["401"];
|
3434
|
+
403: components["responses"]["403"];
|
3435
|
+
404: components["responses"]["404"];
|
3436
|
+
405: components["responses"]["405"];
|
3437
|
+
406: components["responses"]["406"];
|
3438
|
+
501: components["responses"]["501"];
|
3439
|
+
503: components["responses"]["503"];
|
3440
|
+
};
|
3441
|
+
};
|
3442
|
+
/**
|
3443
|
+
* Return bulk transfer information error
|
3444
|
+
* @description If the server is unable to find or create a bulk transfer, or another processing error occurs, the error callback `PUT /bulkTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `bulkTransferId` that was used for the creation of the bulk transfer (`POST /bulkTransfers`), or the `{ID}` that was used in the `GET /bulkTransfers/{ID}` request.
|
3445
|
+
*/
|
3446
|
+
BulkTransfersErrorByID: {
|
3447
|
+
parameters: {
|
3448
|
+
header: {
|
3449
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3450
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3451
|
+
Date: components["parameters"]["Date"];
|
3452
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3453
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3454
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3455
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3456
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3457
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3458
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3459
|
+
};
|
3460
|
+
path: {
|
3461
|
+
ID: components["parameters"]["ID"];
|
3462
|
+
};
|
3463
|
+
};
|
3464
|
+
/** @description Details of the error returned. */
|
3465
|
+
requestBody: {
|
3466
|
+
content: {
|
3467
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
3468
|
+
};
|
3469
|
+
};
|
3470
|
+
responses: {
|
3471
|
+
200: components["responses"]["200"];
|
3472
|
+
400: components["responses"]["400"];
|
3473
|
+
401: components["responses"]["401"];
|
3474
|
+
403: components["responses"]["403"];
|
3475
|
+
404: components["responses"]["404"];
|
3476
|
+
405: components["responses"]["405"];
|
3477
|
+
406: components["responses"]["406"];
|
3478
|
+
501: components["responses"]["501"];
|
3479
|
+
503: components["responses"]["503"];
|
3480
|
+
};
|
3481
|
+
};
|
3482
|
+
/**
|
3483
|
+
* Calculate FX quote
|
3484
|
+
* @description The HTTP request `POST /fxQuotes` is used to ask an FXP to provide a quotation for a currency conversion.
|
3485
|
+
*/
|
3486
|
+
FxQuotesPost: {
|
3487
|
+
parameters: {
|
3488
|
+
header: {
|
3489
|
+
Accept: components["parameters"]["Accept"];
|
3490
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3491
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3492
|
+
Date: components["parameters"]["Date"];
|
3493
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3494
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3495
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3496
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3497
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3498
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3499
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3500
|
+
};
|
3501
|
+
};
|
3502
|
+
/** @description Details of the FX quote to be created. */
|
3503
|
+
requestBody: {
|
3504
|
+
content: {
|
3505
|
+
"application/json": components["schemas"]["FxQuotesPostRequest"];
|
3506
|
+
};
|
3507
|
+
};
|
3508
|
+
responses: {
|
3509
|
+
202: components["responses"]["202"];
|
3510
|
+
400: components["responses"]["400"];
|
3511
|
+
401: components["responses"]["401"];
|
3512
|
+
403: components["responses"]["403"];
|
3513
|
+
404: components["responses"]["404"];
|
3514
|
+
405: components["responses"]["405"];
|
3515
|
+
406: components["responses"]["406"];
|
3516
|
+
501: components["responses"]["501"];
|
3517
|
+
503: components["responses"]["503"];
|
3518
|
+
};
|
3519
|
+
};
|
3520
|
+
/**
|
3521
|
+
* Retrieve FX quote information
|
3522
|
+
* @description The HTTP request `GET /fxQuotes/{ID}` is used to request information regarding a request for quotation for a currency conversion which the sender has previously issued. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the quote.
|
3523
|
+
*/
|
3524
|
+
FxQuotesByIDGet: {
|
3525
|
+
parameters: {
|
3526
|
+
header: {
|
3527
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3528
|
+
Date: components["parameters"]["Date"];
|
3529
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3530
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3531
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3532
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3533
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3534
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3535
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3536
|
+
Accept: components["parameters"]["Accept"];
|
3537
|
+
};
|
3538
|
+
path: {
|
3539
|
+
ID: components["parameters"]["ID"];
|
3540
|
+
};
|
3541
|
+
};
|
3542
|
+
responses: {
|
3543
|
+
202: components["responses"]["202"];
|
3544
|
+
400: components["responses"]["400"];
|
3545
|
+
401: components["responses"]["401"];
|
3546
|
+
403: components["responses"]["403"];
|
3547
|
+
404: components["responses"]["404"];
|
3548
|
+
405: components["responses"]["405"];
|
3549
|
+
406: components["responses"]["406"];
|
3550
|
+
501: components["responses"]["501"];
|
3551
|
+
503: components["responses"]["503"];
|
3552
|
+
};
|
3553
|
+
};
|
3554
|
+
/**
|
3555
|
+
* Return FX quote information
|
3556
|
+
* @description The callback `PUT /fxQuotes/{ID}` is used to inform the requester about the outcome of a request for quotation for a currency conversion. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the FX quote, or the `{ID}` that was used in the `GET /fxQuotes/{ID}` request.
|
3557
|
+
*/
|
3558
|
+
FxQuotesByIdPut: {
|
3559
|
+
parameters: {
|
3560
|
+
header: {
|
3561
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3562
|
+
Date: components["parameters"]["Date"];
|
3563
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3564
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3565
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3566
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3567
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3568
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3569
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3570
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3571
|
+
};
|
3572
|
+
path: {
|
3573
|
+
ID: components["parameters"]["ID"];
|
3574
|
+
};
|
3575
|
+
};
|
3576
|
+
/** @description FX Quote information returned. */
|
3577
|
+
requestBody: {
|
3578
|
+
content: {
|
3579
|
+
"application/json": components["schemas"]["FxQuotesIDPutResponse"];
|
3580
|
+
};
|
3581
|
+
};
|
3582
|
+
responses: {
|
3583
|
+
200: components["responses"]["200"];
|
3584
|
+
400: components["responses"]["400"];
|
3585
|
+
401: components["responses"]["401"];
|
3586
|
+
403: components["responses"]["403"];
|
3587
|
+
404: components["responses"]["404"];
|
3588
|
+
405: components["responses"]["405"];
|
3589
|
+
406: components["responses"]["406"];
|
3590
|
+
501: components["responses"]["501"];
|
3591
|
+
503: components["responses"]["503"];
|
3592
|
+
};
|
3593
|
+
};
|
3594
|
+
/**
|
3595
|
+
* Return FX quote information error
|
3596
|
+
* @description If the FXP is unable to find or create a FX quote, or some other processing error occurs, the error callback `PUT /fxQuotes/{ID}/error` is used. The `{ID}` in the URI should contain the `conversionRequestId` that was used for the creation of the FX quote, or the `{ID}` that was used in the `GET /fxQuotes/{ID}` request.
|
3597
|
+
*/
|
3598
|
+
FxQuotesByIDAndErrorPut: {
|
3599
|
+
parameters: {
|
3600
|
+
header: {
|
3601
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3602
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3603
|
+
Date: components["parameters"]["Date"];
|
3604
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3605
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3606
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3607
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3608
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3609
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3610
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3611
|
+
};
|
3612
|
+
path: {
|
3613
|
+
ID: components["parameters"]["ID"];
|
3614
|
+
};
|
3615
|
+
};
|
3616
|
+
/** @description Details of the error returned. */
|
3617
|
+
requestBody: {
|
3618
|
+
content: {
|
3619
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
3620
|
+
};
|
3621
|
+
};
|
3622
|
+
responses: {
|
3623
|
+
200: components["responses"]["200"];
|
3624
|
+
400: components["responses"]["400"];
|
3625
|
+
401: components["responses"]["401"];
|
3626
|
+
403: components["responses"]["403"];
|
3627
|
+
404: components["responses"]["404"];
|
3628
|
+
405: components["responses"]["405"];
|
3629
|
+
406: components["responses"]["406"];
|
3630
|
+
501: components["responses"]["501"];
|
3631
|
+
503: components["responses"]["503"];
|
3632
|
+
};
|
3633
|
+
};
|
3634
|
+
/**
|
3635
|
+
* Perform FX transfer
|
3636
|
+
* @description The HTTP request `POST /fxTransfers` is used to ask an FXP to confirm the execution of an agreed currency conversion.
|
3637
|
+
*/
|
3638
|
+
FxTransfersPost: {
|
3639
|
+
parameters: {
|
3640
|
+
header: {
|
3641
|
+
Accept: components["parameters"]["Accept"];
|
3642
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3643
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3644
|
+
Date: components["parameters"]["Date"];
|
3645
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3646
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3647
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3648
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3649
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3650
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3651
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3652
|
+
};
|
3653
|
+
};
|
3654
|
+
/** @description Details of the FX transfer to be created. */
|
3655
|
+
requestBody: {
|
3656
|
+
content: {
|
3657
|
+
"application/json": components["schemas"]["FxTransfersPostRequest"];
|
3658
|
+
};
|
3659
|
+
};
|
3660
|
+
responses: {
|
3661
|
+
202: components["responses"]["202"];
|
3662
|
+
400: components["responses"]["400"];
|
3663
|
+
401: components["responses"]["401"];
|
3664
|
+
403: components["responses"]["403"];
|
3665
|
+
404: components["responses"]["404"];
|
3666
|
+
405: components["responses"]["405"];
|
3667
|
+
406: components["responses"]["406"];
|
3668
|
+
501: components["responses"]["501"];
|
3669
|
+
503: components["responses"]["503"];
|
3670
|
+
};
|
3671
|
+
};
|
3672
|
+
/**
|
3673
|
+
* Retrieve FX transfer information
|
3674
|
+
* @description The HTTP request `GET /fxTransfers/{ID}` s used to request information regarding a request for confirmation of a currency conversion which the sender has previously issued. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer.
|
3675
|
+
*/
|
3676
|
+
FxTransfersByIDGet: {
|
3677
|
+
parameters: {
|
3678
|
+
header: {
|
3679
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3680
|
+
Date: components["parameters"]["Date"];
|
3681
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3682
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3683
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3684
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3685
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3686
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3687
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3688
|
+
Accept: components["parameters"]["Accept"];
|
3689
|
+
};
|
3690
|
+
path: {
|
3691
|
+
ID: components["parameters"]["ID"];
|
3692
|
+
};
|
3693
|
+
};
|
3694
|
+
responses: {
|
3695
|
+
202: components["responses"]["202"];
|
3696
|
+
400: components["responses"]["400"];
|
3697
|
+
401: components["responses"]["401"];
|
3698
|
+
403: components["responses"]["403"];
|
3699
|
+
404: components["responses"]["404"];
|
3700
|
+
405: components["responses"]["405"];
|
3701
|
+
406: components["responses"]["406"];
|
3702
|
+
501: components["responses"]["501"];
|
3703
|
+
503: components["responses"]["503"];
|
3704
|
+
};
|
3705
|
+
};
|
3706
|
+
/**
|
3707
|
+
* Return FX transfer information
|
3708
|
+
* @description The callback `PUT /fxTransfers/{ID}` is used to inform the requester about the outcome of a request for execution of a currency conversion. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer, or the `{ID}` that was used in the `GET /fxTransfers/{ID}` request.
|
3709
|
+
*/
|
3710
|
+
FxTransfersByIDPut: {
|
3711
|
+
parameters: {
|
3712
|
+
header: {
|
3713
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3714
|
+
Date: components["parameters"]["Date"];
|
3715
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3716
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3717
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3718
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3719
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3720
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3721
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3722
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3723
|
+
};
|
3724
|
+
path: {
|
3725
|
+
ID: components["parameters"]["ID"];
|
3726
|
+
};
|
3727
|
+
};
|
3728
|
+
/** @description Transfer information returned. */
|
3729
|
+
requestBody: {
|
3730
|
+
content: {
|
3731
|
+
"application/json": components["schemas"]["FxTransfersIDPutResponse"];
|
3732
|
+
};
|
3733
|
+
};
|
3734
|
+
responses: {
|
3735
|
+
200: components["responses"]["200"];
|
3736
|
+
400: components["responses"]["400"];
|
3737
|
+
401: components["responses"]["401"];
|
3738
|
+
403: components["responses"]["403"];
|
3739
|
+
404: components["responses"]["404"];
|
3740
|
+
405: components["responses"]["405"];
|
3741
|
+
406: components["responses"]["406"];
|
3742
|
+
501: components["responses"]["501"];
|
3743
|
+
503: components["responses"]["503"];
|
3744
|
+
};
|
3745
|
+
};
|
3746
|
+
/**
|
3747
|
+
* Return FX transfer information
|
3748
|
+
* @description The HTTP request PATCH /fxTransfers/<ID> is used to inform the requester about the final determination by the switch of the transfer a request for execution of a currency conversion. The <ID> in the URI should contain the commitRequestId that was used for the creation of the FX transfer. Please note that this request does not generate a callback.
|
3749
|
+
*/
|
3750
|
+
FxTransfersByIDPatch: {
|
3751
|
+
parameters: {
|
3752
|
+
header: {
|
3753
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3754
|
+
Date: components["parameters"]["Date"];
|
3755
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3756
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3757
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3758
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3759
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3760
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3761
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3762
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3763
|
+
};
|
3764
|
+
path: {
|
3765
|
+
ID: components["parameters"]["ID"];
|
3766
|
+
};
|
3767
|
+
};
|
3768
|
+
/** @description Transfer notification upon completion. */
|
3769
|
+
requestBody: {
|
3770
|
+
content: {
|
3771
|
+
"application/json": components["schemas"]["FxTransfersIDPatchResponse"];
|
3772
|
+
};
|
3773
|
+
};
|
3774
|
+
responses: {
|
3775
|
+
200: components["responses"]["200"];
|
3776
|
+
400: components["responses"]["400"];
|
3777
|
+
401: components["responses"]["401"];
|
3778
|
+
403: components["responses"]["403"];
|
3779
|
+
404: components["responses"]["404"];
|
3780
|
+
405: components["responses"]["405"];
|
3781
|
+
406: components["responses"]["406"];
|
3782
|
+
501: components["responses"]["501"];
|
3783
|
+
503: components["responses"]["503"];
|
3784
|
+
};
|
3785
|
+
};
|
3786
|
+
/**
|
3787
|
+
* Return FX transfer information error
|
3788
|
+
* @description If the switch or FXP is unable to find or create a FX transfer, or another processing error occurs, the error callback `PUT /fxTransfers/{ID}/error` is used. The `{ID}` in the URI should contain the `commitRequestId` that was used for the creation of the FX transfer, or the `{ID}` that was used in the `GET /fxTransfers/{ID}`.
|
3789
|
+
*/
|
3790
|
+
FxTransfersByIDAndErrorPut: {
|
3791
|
+
parameters: {
|
3792
|
+
header: {
|
3793
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3794
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3795
|
+
Date: components["parameters"]["Date"];
|
3796
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3797
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3798
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3799
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3800
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3801
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3802
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3803
|
+
};
|
3804
|
+
path: {
|
3805
|
+
ID: components["parameters"]["ID"];
|
3806
|
+
};
|
3807
|
+
};
|
3808
|
+
/** @description Details of the error returned. */
|
3809
|
+
requestBody: {
|
3810
|
+
content: {
|
3811
|
+
"application/json": components["schemas"]["ErrorInformationObject"];
|
3812
|
+
};
|
3813
|
+
};
|
3814
|
+
responses: {
|
3815
|
+
200: components["responses"]["200"];
|
3816
|
+
400: components["responses"]["400"];
|
3817
|
+
401: components["responses"]["401"];
|
3818
|
+
403: components["responses"]["403"];
|
3819
|
+
404: components["responses"]["404"];
|
3820
|
+
405: components["responses"]["405"];
|
3821
|
+
406: components["responses"]["406"];
|
3822
|
+
501: components["responses"]["501"];
|
3823
|
+
503: components["responses"]["503"];
|
3824
|
+
};
|
3825
|
+
};
|
3826
|
+
/**
|
3827
|
+
* Obtain a list of the DFSPs in the scheme who provide FXP service
|
3828
|
+
* @description The HTTP request `GET /services/FXP` is used to request information about the participants in a scheme who offer currency conversion services.
|
3829
|
+
*/
|
3830
|
+
ServicesFXPGet: {
|
3831
|
+
parameters: {
|
3832
|
+
header: {
|
3833
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3834
|
+
Date: components["parameters"]["Date"];
|
3835
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3836
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3837
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3838
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3839
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3840
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3841
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3842
|
+
Accept: components["parameters"]["Accept"];
|
3843
|
+
};
|
3844
|
+
};
|
3845
|
+
responses: {
|
3846
|
+
202: components["responses"]["202"];
|
3847
|
+
400: components["responses"]["400"];
|
3848
|
+
401: components["responses"]["401"];
|
3849
|
+
403: components["responses"]["403"];
|
3850
|
+
404: components["responses"]["404"];
|
3851
|
+
405: components["responses"]["405"];
|
3852
|
+
406: components["responses"]["406"];
|
3853
|
+
501: components["responses"]["501"];
|
3854
|
+
503: components["responses"]["503"];
|
3855
|
+
};
|
3856
|
+
};
|
3857
|
+
/** @description The callback `PUT /services/FXP` is used to inform the requester about participants in a scheme who offer currency conversion services. If no participants offer these services, the return object will be blank. */
|
3858
|
+
ServicesFXPPut: {
|
3859
|
+
parameters: {
|
3860
|
+
header: {
|
3861
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3862
|
+
Date: components["parameters"]["Date"];
|
3863
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3864
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3865
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3866
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3867
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3868
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3869
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3870
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3871
|
+
};
|
3872
|
+
};
|
3873
|
+
/** @description The list of participant(s) who offer currency conversion services. */
|
3874
|
+
requestBody: {
|
3875
|
+
content: {
|
3876
|
+
"application/json": components["schemas"]["ServicesFXPPutResponse"];
|
3877
|
+
};
|
3878
|
+
};
|
3879
|
+
responses: {
|
3880
|
+
200: components["responses"]["200"];
|
3881
|
+
400: components["responses"]["400"];
|
3882
|
+
401: components["responses"]["401"];
|
3883
|
+
403: components["responses"]["403"];
|
3884
|
+
404: components["responses"]["404"];
|
3885
|
+
405: components["responses"]["405"];
|
3886
|
+
406: components["responses"]["406"];
|
3887
|
+
501: components["responses"]["501"];
|
3888
|
+
503: components["responses"]["503"];
|
3889
|
+
};
|
3890
|
+
};
|
3891
|
+
/**
|
3892
|
+
* Obtain a list of the DFSPs in the scheme who provide FXP service
|
3893
|
+
* @description The HTTP request `GET /services/FXP/{SourceCurrency}/{TargetCurrency}` is used to request information about the participants in a scheme who offer currency conversion services in a particular currency corridor. The required corridor is specified by giving the ISO 4217 currency code for the SourceCurrency and the TargetCurrency.
|
3894
|
+
*/
|
3895
|
+
ServicesFXPSourceCurrencyTargetCurrencyGet: {
|
3896
|
+
parameters: {
|
3897
|
+
header: {
|
3898
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3899
|
+
Date: components["parameters"]["Date"];
|
3900
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3901
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3902
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3903
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3904
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3905
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3906
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3907
|
+
Accept: components["parameters"]["Accept"];
|
3908
|
+
};
|
3909
|
+
path: {
|
3910
|
+
SourceCurrency: components["parameters"]["SourceCurrency"];
|
3911
|
+
TargetCurrency: components["parameters"]["TargetCurrency"];
|
3912
|
+
};
|
3913
|
+
};
|
3914
|
+
responses: {
|
3915
|
+
202: components["responses"]["202"];
|
3916
|
+
400: components["responses"]["400"];
|
3917
|
+
401: components["responses"]["401"];
|
3918
|
+
403: components["responses"]["403"];
|
3919
|
+
404: components["responses"]["404"];
|
3920
|
+
405: components["responses"]["405"];
|
3921
|
+
406: components["responses"]["406"];
|
3922
|
+
501: components["responses"]["501"];
|
3923
|
+
503: components["responses"]["503"];
|
3924
|
+
};
|
3925
|
+
};
|
3926
|
+
/** @description The callback `PUT /services/FXP/{SourceCurrency}/{TargetCurrency}` is used to inform the requester about participants in a scheme who offer currency conversion services. If no participants offer these services, the return object will be blank. The required corridor is specified by giving the ISO 4217 currency code for the SourceCurrency and the TargetCurrency. */
|
3927
|
+
ServicesFXPSourceCurrencyTargetCurrencyPut: {
|
3928
|
+
parameters: {
|
3929
|
+
header: {
|
3930
|
+
"Content-Type": components["parameters"]["Content-Type"];
|
3931
|
+
Date: components["parameters"]["Date"];
|
3932
|
+
"X-Forwarded-For"?: components["parameters"]["X-Forwarded-For"];
|
3933
|
+
"FSPIOP-Source": components["parameters"]["FSPIOP-Source"];
|
3934
|
+
"FSPIOP-Destination"?: components["parameters"]["FSPIOP-Destination"];
|
3935
|
+
"FSPIOP-Encryption"?: components["parameters"]["FSPIOP-Encryption"];
|
3936
|
+
"FSPIOP-Signature"?: components["parameters"]["FSPIOP-Signature"];
|
3937
|
+
"FSPIOP-URI"?: components["parameters"]["FSPIOP-URI"];
|
3938
|
+
"FSPIOP-HTTP-Method"?: components["parameters"]["FSPIOP-HTTP-Method"];
|
3939
|
+
"Content-Length"?: components["parameters"]["Content-Length"];
|
3940
|
+
};
|
3941
|
+
path: {
|
3942
|
+
SourceCurrency: components["parameters"]["SourceCurrency"];
|
3943
|
+
TargetCurrency: components["parameters"]["TargetCurrency"];
|
3944
|
+
};
|
3945
|
+
};
|
3946
|
+
/** @description The list of participant(s) who offer currency conversion services. */
|
3947
|
+
requestBody: {
|
3948
|
+
content: {
|
3949
|
+
"application/json": components["schemas"]["ServicesFXPSourceCurrencyTargetCurrencyPutResponse"];
|
3950
|
+
};
|
3951
|
+
};
|
3952
|
+
responses: {
|
3953
|
+
200: components["responses"]["200"];
|
3954
|
+
400: components["responses"]["400"];
|
3955
|
+
401: components["responses"]["401"];
|
3956
|
+
403: components["responses"]["403"];
|
3957
|
+
404: components["responses"]["404"];
|
3958
|
+
405: components["responses"]["405"];
|
3959
|
+
406: components["responses"]["406"];
|
3960
|
+
501: components["responses"]["501"];
|
3961
|
+
503: components["responses"]["503"];
|
3962
|
+
};
|
3963
|
+
};
|
3964
|
+
}
|