@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
@@ -3,10 +3,6 @@
|
|
3
3
|
* Do not make direct changes to the file.
|
4
4
|
*/
|
5
5
|
export interface paths {
|
6
|
-
"/interface": {
|
7
|
-
/** @description Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */
|
8
|
-
post: operations["test"];
|
9
|
-
};
|
10
6
|
"/participants/{Type}/{ID}": {
|
11
7
|
/**
|
12
8
|
* Look up participant information
|
@@ -499,53 +495,139 @@ export interface paths {
|
|
499
495
|
export type webhooks = Record<string, never>;
|
500
496
|
export interface components {
|
501
497
|
schemas: {
|
498
|
+
/**
|
499
|
+
* Amount
|
500
|
+
* @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.
|
501
|
+
* @example 123.45
|
502
|
+
*/
|
503
|
+
Amount: string;
|
504
|
+
/**
|
505
|
+
* AmountType
|
506
|
+
* @description Below are the allowed values for the enumeration AmountType.
|
507
|
+
* - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
|
508
|
+
* - 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.
|
509
|
+
* @example RECEIVE
|
510
|
+
* @enum {string}
|
511
|
+
*/
|
512
|
+
AmountType: "SEND" | "RECEIVE";
|
513
|
+
/**
|
514
|
+
* AuthenticationInfo
|
515
|
+
* @description Data model for the complex type AuthenticationInfo.
|
516
|
+
*/
|
517
|
+
AuthenticationInfo: {
|
518
|
+
authentication: components["schemas"]["AuthenticationType"];
|
519
|
+
authenticationValue: components["schemas"]["AuthenticationValue"];
|
520
|
+
};
|
521
|
+
/**
|
522
|
+
* AuthenticationType
|
523
|
+
* @description Below are the allowed values for the enumeration AuthenticationType.
|
524
|
+
* - OTP - One-time password generated by the Payer FSP.
|
525
|
+
* - QRCODE - QR code used as One Time Password.
|
526
|
+
* - U2F - U2F is a new addition isolated to Thirdparty stream.
|
527
|
+
* @example OTP
|
528
|
+
* @enum {string}
|
529
|
+
*/
|
530
|
+
AuthenticationType: "OTP" | "QRCODE" | "U2F";
|
531
|
+
/**
|
532
|
+
* AuthenticationValue
|
533
|
+
* @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type.
|
534
|
+
*/
|
535
|
+
AuthenticationValue: components["schemas"]["OtpValue"] | components["schemas"]["QRCODE"] | components["schemas"]["U2FPinValue"];
|
536
|
+
/**
|
537
|
+
* AuthorizationResponse
|
538
|
+
* @description Below are the allowed values for the enumeration.
|
539
|
+
* - ENTERED - Consumer entered the authentication value.
|
540
|
+
* - REJECTED - Consumer rejected the transaction.
|
541
|
+
* - RESEND - Consumer requested to resend the authentication value.
|
542
|
+
* @example ENTERED
|
543
|
+
* @enum {string}
|
544
|
+
*/
|
545
|
+
AuthorizationResponse: "ENTERED" | "REJECTED" | "RESEND";
|
546
|
+
/**
|
547
|
+
* AuthorizationsIDPutResponse
|
548
|
+
* @description The object sent in the PUT /authorizations/{ID} callback.
|
549
|
+
*/
|
550
|
+
AuthorizationsIDPutResponse: {
|
551
|
+
authenticationInfo?: components["schemas"]["AuthenticationInfo"];
|
552
|
+
responseType: components["schemas"]["AuthorizationResponse"];
|
553
|
+
};
|
554
|
+
/**
|
555
|
+
* BalanceOfPayments
|
556
|
+
* @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.
|
557
|
+
* @example 123
|
558
|
+
*/
|
559
|
+
BalanceOfPayments: string;
|
502
560
|
/** @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. */
|
503
561
|
BinaryString: string;
|
504
562
|
/** @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. */
|
505
563
|
BinaryString32: string;
|
506
564
|
/**
|
507
|
-
*
|
508
|
-
* @description The
|
509
|
-
*/
|
510
|
-
Date: string;
|
511
|
-
/**
|
512
|
-
* Integer
|
513
|
-
* @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.
|
565
|
+
* BulkQuotesIDPutResponse
|
566
|
+
* @description The object sent in the PUT /bulkQuotes/{ID} callback.
|
514
567
|
*/
|
515
|
-
|
568
|
+
BulkQuotesIDPutResponse: {
|
569
|
+
/** @description Fees for each individual transaction, if any of them are charged per transaction. */
|
570
|
+
individualQuoteResults?: components["schemas"]["IndividualQuoteResult"][];
|
571
|
+
expiration: components["schemas"]["DateTime"];
|
572
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
573
|
+
};
|
516
574
|
/**
|
517
|
-
*
|
518
|
-
* @description The
|
519
|
-
*
|
520
|
-
* 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 ( ).
|
521
|
-
*
|
522
|
-
* **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.
|
575
|
+
* BulkQuotesPostRequest
|
576
|
+
* @description The object sent in the POST /bulkQuotes request.
|
523
577
|
*/
|
524
|
-
|
578
|
+
BulkQuotesPostRequest: {
|
579
|
+
bulkQuoteId: components["schemas"]["CorrelationId"];
|
580
|
+
payer: components["schemas"]["Party"];
|
581
|
+
geoCode?: components["schemas"]["GeoCode"];
|
582
|
+
expiration?: components["schemas"]["DateTime"];
|
583
|
+
/** @description List of quotes elements. */
|
584
|
+
individualQuotes: components["schemas"]["IndividualQuote"][];
|
585
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
586
|
+
};
|
525
587
|
/**
|
526
|
-
*
|
588
|
+
* BulkTransactionState
|
527
589
|
* @description Below are the allowed values for the enumeration.
|
528
|
-
* -
|
529
|
-
* -
|
530
|
-
* -
|
531
|
-
* -
|
532
|
-
* -
|
533
|
-
* -
|
534
|
-
*
|
535
|
-
* - SENIOR_CITIZENS_CARD - A senior citizens card number is used as reference to a Party.
|
536
|
-
* - MARRIAGE_CERTIFICATE - A marriage certificate number is used as reference to a Party.
|
537
|
-
* - HEALTH_CARD - A health card number is used as reference to a Party.
|
538
|
-
* - VOTERS_ID - A voter’s identification number is used as reference to a Party.
|
539
|
-
* - UNITED_NATIONS - An UN (United Nations) number is used as reference to a Party.
|
540
|
-
* - OTHER_ID - Any other type of identification type number is used as reference to a Party.
|
590
|
+
* - RECEIVED - Payee FSP has received the bulk transfer from the Payer FSP.
|
591
|
+
* - PENDING - Payee FSP has validated the bulk transfer.
|
592
|
+
* - ACCEPTED - Payee FSP has accepted to process the bulk transfer.
|
593
|
+
* - PROCESSING - Payee FSP has started to transfer fund to the Payees.
|
594
|
+
* - COMPLETED - Payee FSP has completed transfer of funds to the Payees.
|
595
|
+
* - REJECTED - Payee FSP has rejected to process the bulk transfer.
|
596
|
+
* @example RECEIVED
|
541
597
|
* @enum {string}
|
542
598
|
*/
|
543
|
-
|
599
|
+
BulkTransferState: "RECEIVED" | "PENDING" | "ACCEPTED" | "PROCESSING" | "COMPLETED" | "REJECTED";
|
544
600
|
/**
|
545
|
-
*
|
546
|
-
* @description The
|
601
|
+
* BulkTransfersIDPutResponse
|
602
|
+
* @description The object sent in the PUT /bulkTransfers/{ID} callback.
|
547
603
|
*/
|
548
|
-
|
604
|
+
BulkTransfersIDPutResponse: {
|
605
|
+
completedTimestamp?: components["schemas"]["DateTime"];
|
606
|
+
/** @description List of IndividualTransferResult elements. */
|
607
|
+
individualTransferResults?: components["schemas"]["IndividualTransferResult"][];
|
608
|
+
bulkTransferState: components["schemas"]["BulkTransferState"];
|
609
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
610
|
+
};
|
611
|
+
/**
|
612
|
+
* BulkTransfersPostRequest
|
613
|
+
* @description The object sent in the POST /bulkTransfers request.
|
614
|
+
*/
|
615
|
+
BulkTransfersPostRequest: {
|
616
|
+
bulkTransferId: components["schemas"]["CorrelationId"];
|
617
|
+
bulkQuoteId: components["schemas"]["CorrelationId"];
|
618
|
+
payerFsp: components["schemas"]["FspId"];
|
619
|
+
payeeFsp: components["schemas"]["FspId"];
|
620
|
+
/** @description List of IndividualTransfer elements. */
|
621
|
+
individualTransfers: components["schemas"]["IndividualTransfer"][];
|
622
|
+
expiration: components["schemas"]["DateTime"];
|
623
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
624
|
+
};
|
625
|
+
/**
|
626
|
+
* Code
|
627
|
+
* @description Any code/token returned by the Payee FSP (TokenCode Type).
|
628
|
+
* @example Test-Code
|
629
|
+
*/
|
630
|
+
Code: string;
|
549
631
|
/**
|
550
632
|
* CorrelationId
|
551
633
|
* @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 (‘-‘).
|
@@ -553,45 +635,62 @@ export interface components {
|
|
553
635
|
*/
|
554
636
|
CorrelationId: string;
|
555
637
|
/**
|
556
|
-
*
|
557
|
-
* @description
|
558
|
-
* - 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.
|
559
|
-
* - 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).
|
560
|
-
* - 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.
|
561
|
-
* - 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.
|
562
|
-
* - 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.
|
563
|
-
* - 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.
|
564
|
-
* - 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.
|
565
|
-
* - 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.
|
638
|
+
* Currency
|
639
|
+
* @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.
|
566
640
|
* @enum {string}
|
567
641
|
*/
|
568
|
-
|
642
|
+
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";
|
569
643
|
/**
|
570
|
-
*
|
571
|
-
* @description
|
572
|
-
* @example 16135551212
|
644
|
+
* Date
|
645
|
+
* @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”.
|
573
646
|
*/
|
574
|
-
|
647
|
+
Date: string;
|
575
648
|
/**
|
576
|
-
*
|
577
|
-
* @description
|
649
|
+
* DateofBirth (type Date)
|
650
|
+
* @description Date of Birth of the Party.
|
651
|
+
* @example 1966-06-16
|
578
652
|
*/
|
579
|
-
|
653
|
+
DateOfBirth: string;
|
580
654
|
/**
|
581
|
-
*
|
582
|
-
* @description
|
655
|
+
* DateTime
|
656
|
+
* @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).
|
657
|
+
* @example 2016-05-24T08:38:08.699-04:00
|
583
658
|
*/
|
584
|
-
|
659
|
+
DateTime: string;
|
585
660
|
/**
|
586
|
-
*
|
587
|
-
* @description
|
661
|
+
* ErrorCode
|
662
|
+
* @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.
|
663
|
+
* @example 5100
|
588
664
|
*/
|
589
|
-
|
665
|
+
ErrorCode: string;
|
590
666
|
/**
|
591
|
-
*
|
592
|
-
* @description
|
667
|
+
* ErrorDescription
|
668
|
+
* @description Error description string.
|
593
669
|
*/
|
594
|
-
|
670
|
+
ErrorDescription: string;
|
671
|
+
/**
|
672
|
+
* ErrorInformation
|
673
|
+
* @description Data model for the complex type ErrorInformation.
|
674
|
+
*/
|
675
|
+
ErrorInformation: {
|
676
|
+
errorCode: components["schemas"]["ErrorCode"];
|
677
|
+
errorDescription: components["schemas"]["ErrorDescription"];
|
678
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
679
|
+
};
|
680
|
+
/**
|
681
|
+
* ErrorInformationObject
|
682
|
+
* @description Data model for the complex type object that contains ErrorInformation.
|
683
|
+
*/
|
684
|
+
ErrorInformationObject: {
|
685
|
+
errorInformation: components["schemas"]["ErrorInformation"];
|
686
|
+
};
|
687
|
+
/**
|
688
|
+
* ErrorInformationResponse
|
689
|
+
* @description Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses.
|
690
|
+
*/
|
691
|
+
ErrorInformationResponse: {
|
692
|
+
errorInformation?: components["schemas"]["ErrorInformation"];
|
693
|
+
};
|
595
694
|
/**
|
596
695
|
* Extension
|
597
696
|
* @description Data model for the complex type Extension.
|
@@ -600,6 +699,11 @@ export interface components {
|
|
600
699
|
key: components["schemas"]["ExtensionKey"];
|
601
700
|
value: components["schemas"]["ExtensionValue"];
|
602
701
|
};
|
702
|
+
/**
|
703
|
+
* ExtensionKey
|
704
|
+
* @description Extension key.
|
705
|
+
*/
|
706
|
+
ExtensionKey: string;
|
603
707
|
/**
|
604
708
|
* ExtensionList
|
605
709
|
* @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
|
@@ -609,26 +713,10 @@ export interface components {
|
|
609
713
|
extension: components["schemas"]["Extension"][];
|
610
714
|
};
|
611
715
|
/**
|
612
|
-
*
|
613
|
-
* @description
|
614
|
-
*/
|
615
|
-
PartyIdInfo: {
|
616
|
-
partyIdType: components["schemas"]["PartyIdType"];
|
617
|
-
partyIdentifier: components["schemas"]["PartyIdentifier"];
|
618
|
-
partySubIdOrType?: components["schemas"]["PartySubIdOrType"];
|
619
|
-
fspId?: components["schemas"]["FspId"];
|
620
|
-
extensionList?: components["schemas"]["ExtensionList"];
|
621
|
-
};
|
622
|
-
/**
|
623
|
-
* MerchantClassificationCode
|
624
|
-
* @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.
|
625
|
-
*/
|
626
|
-
MerchantClassificationCode: string;
|
627
|
-
/**
|
628
|
-
* PartyName
|
629
|
-
* @description Name of the Party. Could be a real name or a nickname.
|
716
|
+
* ExtensionValue
|
717
|
+
* @description Extension value.
|
630
718
|
*/
|
631
|
-
|
719
|
+
ExtensionValue: string;
|
632
720
|
/**
|
633
721
|
* FirstName
|
634
722
|
* @description First name of the Party (Name Type).
|
@@ -636,140 +724,138 @@ export interface components {
|
|
636
724
|
*/
|
637
725
|
FirstName: string;
|
638
726
|
/**
|
639
|
-
*
|
640
|
-
* @description
|
641
|
-
* @example Johannes
|
727
|
+
* FspId
|
728
|
+
* @description FSP identifier.
|
642
729
|
*/
|
643
|
-
|
730
|
+
FspId: string;
|
644
731
|
/**
|
645
|
-
*
|
646
|
-
* @description
|
647
|
-
* @example Karlsson
|
732
|
+
* GeoCode
|
733
|
+
* @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
|
648
734
|
*/
|
649
|
-
|
735
|
+
GeoCode: {
|
736
|
+
latitude: components["schemas"]["Latitude"];
|
737
|
+
longitude: components["schemas"]["Longitude"];
|
738
|
+
};
|
650
739
|
/**
|
651
|
-
*
|
652
|
-
* @description
|
740
|
+
* IlpCondition
|
741
|
+
* @description Condition that must be attached to the transfer by the Payer.
|
653
742
|
*/
|
654
|
-
|
655
|
-
firstName?: components["schemas"]["FirstName"];
|
656
|
-
middleName?: components["schemas"]["MiddleName"];
|
657
|
-
lastName?: components["schemas"]["LastName"];
|
658
|
-
};
|
743
|
+
IlpCondition: string;
|
659
744
|
/**
|
660
|
-
*
|
661
|
-
* @description
|
662
|
-
* @example
|
745
|
+
* IlpFulfilment
|
746
|
+
* @description Fulfilment that must be attached to the transfer by the Payee.
|
747
|
+
* @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
|
663
748
|
*/
|
664
|
-
|
749
|
+
IlpFulfilment: string;
|
665
750
|
/**
|
666
|
-
*
|
667
|
-
* @description
|
751
|
+
* IlpPacket
|
752
|
+
* @description Information for recipient (transport layer information).
|
753
|
+
* @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
|
668
754
|
*/
|
669
|
-
|
670
|
-
complexName?: components["schemas"]["PartyComplexName"];
|
671
|
-
dateOfBirth?: components["schemas"]["DateOfBirth"];
|
672
|
-
};
|
755
|
+
IlpPacket: string;
|
673
756
|
/**
|
674
|
-
*
|
675
|
-
* @description Data model for the complex type
|
757
|
+
* IndividualQuote
|
758
|
+
* @description Data model for the complex type IndividualQuote.
|
676
759
|
*/
|
677
|
-
|
678
|
-
|
679
|
-
|
680
|
-
|
681
|
-
|
760
|
+
IndividualQuote: {
|
761
|
+
quoteId: components["schemas"]["CorrelationId"];
|
762
|
+
transactionId: components["schemas"]["CorrelationId"];
|
763
|
+
payee: components["schemas"]["Party"];
|
764
|
+
amountType: components["schemas"]["AmountType"];
|
765
|
+
amount: components["schemas"]["Money"];
|
766
|
+
fees?: components["schemas"]["Money"];
|
767
|
+
transactionType: components["schemas"]["TransactionType"];
|
768
|
+
note?: components["schemas"]["Note"];
|
769
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
682
770
|
};
|
683
771
|
/**
|
684
|
-
*
|
685
|
-
* @description
|
686
|
-
* @enum {string}
|
772
|
+
* IndividualQuoteResult
|
773
|
+
* @description Data model for the complex type IndividualQuoteResult.
|
687
774
|
*/
|
688
|
-
|
775
|
+
IndividualQuoteResult: {
|
776
|
+
quoteId: components["schemas"]["CorrelationId"];
|
777
|
+
payee?: components["schemas"]["Party"];
|
778
|
+
transferAmount?: components["schemas"]["Money"];
|
779
|
+
payeeReceiveAmount?: components["schemas"]["Money"];
|
780
|
+
payeeFspFee?: components["schemas"]["Money"];
|
781
|
+
payeeFspCommission?: components["schemas"]["Money"];
|
782
|
+
ilpPacket?: components["schemas"]["IlpPacket"];
|
783
|
+
condition?: components["schemas"]["IlpCondition"];
|
784
|
+
errorInformation?: components["schemas"]["ErrorInformation"];
|
785
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
786
|
+
};
|
689
787
|
/**
|
690
|
-
*
|
691
|
-
* @description
|
692
|
-
* @example 123.45
|
788
|
+
* IndividualTransfer
|
789
|
+
* @description Data model for the complex type IndividualTransfer.
|
693
790
|
*/
|
694
|
-
|
791
|
+
IndividualTransfer: {
|
792
|
+
transferId: components["schemas"]["CorrelationId"];
|
793
|
+
transferAmount: components["schemas"]["Money"];
|
794
|
+
ilpPacket: components["schemas"]["IlpPacket"];
|
795
|
+
condition: components["schemas"]["IlpCondition"];
|
796
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
797
|
+
};
|
695
798
|
/**
|
696
|
-
*
|
697
|
-
* @description Data model for the complex type
|
799
|
+
* IndividualTransferResult
|
800
|
+
* @description Data model for the complex type IndividualTransferResult.
|
698
801
|
*/
|
699
|
-
|
700
|
-
|
701
|
-
|
802
|
+
IndividualTransferResult: {
|
803
|
+
transferId: components["schemas"]["CorrelationId"];
|
804
|
+
fulfilment?: components["schemas"]["IlpFulfilment"];
|
805
|
+
errorInformation?: components["schemas"]["ErrorInformation"];
|
806
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
702
807
|
};
|
703
808
|
/**
|
704
|
-
*
|
705
|
-
* @description
|
706
|
-
* - 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.
|
707
|
-
* - 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.
|
708
|
-
* - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.
|
709
|
-
* - 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.
|
710
|
-
* - REFUND - Used for performing a refund of transaction.
|
711
|
-
* @example DEPOSIT
|
712
|
-
* @enum {string}
|
809
|
+
* Integer
|
810
|
+
* @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.
|
713
811
|
*/
|
714
|
-
|
812
|
+
Integer: string;
|
715
813
|
/**
|
716
|
-
*
|
717
|
-
* @description
|
718
|
-
* @example
|
814
|
+
* LastName
|
815
|
+
* @description Last name of the Party (Name Type).
|
816
|
+
* @example Karlsson
|
719
817
|
*/
|
720
|
-
|
818
|
+
LastName: string;
|
721
819
|
/**
|
722
|
-
*
|
723
|
-
* @description
|
724
|
-
*
|
725
|
-
* - 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.
|
726
|
-
* @example PAYEE
|
727
|
-
* @enum {string}
|
820
|
+
* Latitude
|
821
|
+
* @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
|
822
|
+
* @example +45.4215
|
728
823
|
*/
|
729
|
-
|
824
|
+
Latitude: string;
|
730
825
|
/**
|
731
|
-
*
|
732
|
-
* @description
|
733
|
-
*
|
734
|
-
* - AGENT - Agent is the initiator of the transaction.
|
735
|
-
* - BUSINESS - Business is the initiator of the transaction.
|
736
|
-
* - DEVICE - Device is the initiator of the transaction.
|
737
|
-
* @example CONSUMER
|
738
|
-
* @enum {string}
|
826
|
+
* Longitude
|
827
|
+
* @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
|
828
|
+
* @example +75.6972
|
739
829
|
*/
|
740
|
-
|
830
|
+
Longitude: string;
|
741
831
|
/**
|
742
|
-
*
|
743
|
-
* @description
|
744
|
-
* @example Free text indicating reason for the refund.
|
832
|
+
* MerchantClassificationCode
|
833
|
+
* @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.
|
745
834
|
*/
|
746
|
-
|
835
|
+
MerchantClassificationCode: string;
|
747
836
|
/**
|
748
|
-
*
|
749
|
-
* @description
|
837
|
+
* MiddleName
|
838
|
+
* @description Middle name of the Party (Name Type).
|
839
|
+
* @example Johannes
|
750
840
|
*/
|
751
|
-
|
752
|
-
originalTransactionId: components["schemas"]["CorrelationId"];
|
753
|
-
refundReason?: components["schemas"]["RefundReason"];
|
754
|
-
};
|
841
|
+
MiddleName: string;
|
755
842
|
/**
|
756
|
-
*
|
757
|
-
* @description
|
758
|
-
* @example 123
|
843
|
+
* Money
|
844
|
+
* @description Data model for the complex type Money.
|
759
845
|
*/
|
760
|
-
|
846
|
+
Money: {
|
847
|
+
currency: components["schemas"]["Currency"];
|
848
|
+
amount: components["schemas"]["Amount"];
|
849
|
+
};
|
761
850
|
/**
|
762
|
-
*
|
763
|
-
* @description
|
851
|
+
* Name
|
852
|
+
* @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.
|
853
|
+
*
|
854
|
+
* 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 ( ).
|
855
|
+
*
|
856
|
+
* **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.
|
764
857
|
*/
|
765
|
-
|
766
|
-
scenario: components["schemas"]["TransactionScenario"];
|
767
|
-
subScenario?: components["schemas"]["TransactionSubScenario"];
|
768
|
-
initiator: components["schemas"]["TransactionInitiator"];
|
769
|
-
initiatorType: components["schemas"]["TransactionInitiatorType"];
|
770
|
-
refundInfo?: components["schemas"]["Refund"];
|
771
|
-
balanceOfPayments?: components["schemas"]["BalanceOfPayments"];
|
772
|
-
};
|
858
|
+
Name: string;
|
773
859
|
/**
|
774
860
|
* Note
|
775
861
|
* @description Memo assigned to transaction.
|
@@ -777,50 +863,28 @@ export interface components {
|
|
777
863
|
*/
|
778
864
|
Note: string;
|
779
865
|
/**
|
780
|
-
*
|
781
|
-
* @description
|
782
|
-
*/
|
783
|
-
Transaction: {
|
784
|
-
transactionId: components["schemas"]["CorrelationId"];
|
785
|
-
quoteId: components["schemas"]["CorrelationId"];
|
786
|
-
payee: components["schemas"]["Party"];
|
787
|
-
payer: components["schemas"]["Party"];
|
788
|
-
amount: components["schemas"]["Money"];
|
789
|
-
transactionType: components["schemas"]["TransactionType"];
|
790
|
-
note?: components["schemas"]["Note"];
|
791
|
-
extensionList?: components["schemas"]["ExtensionList"];
|
792
|
-
};
|
793
|
-
/**
|
794
|
-
* UndefinedEnum
|
795
|
-
* @description The API data type UndefinedEnum is a JSON String consisting of 1 to 32 uppercase characters including an underscore character (_).
|
796
|
-
*/
|
797
|
-
UndefinedEnum: string;
|
798
|
-
/**
|
799
|
-
* ErrorCode
|
800
|
-
* @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.
|
801
|
-
* @example 5100
|
802
|
-
*/
|
803
|
-
ErrorCode: string;
|
804
|
-
/**
|
805
|
-
* ErrorDescription
|
806
|
-
* @description Error description string.
|
866
|
+
* OtpValue
|
867
|
+
* @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.
|
807
868
|
*/
|
808
|
-
|
869
|
+
OtpValue: string;
|
809
870
|
/**
|
810
|
-
*
|
811
|
-
* @description
|
871
|
+
* ParticipantsIDPutResponse
|
872
|
+
* @description The object sent in the PUT /participants/{ID} callback.
|
812
873
|
*/
|
813
|
-
|
814
|
-
|
815
|
-
|
816
|
-
|
874
|
+
ParticipantsIDPutResponse: {
|
875
|
+
/** @description List of PartyResult elements that were either created or failed to be created. */
|
876
|
+
partyList: components["schemas"]["PartyResult"][];
|
877
|
+
currency?: components["schemas"]["Currency"];
|
817
878
|
};
|
818
879
|
/**
|
819
|
-
*
|
820
|
-
* @description
|
880
|
+
* ParticipantsPostRequest
|
881
|
+
* @description The object sent in the POST /participants request.
|
821
882
|
*/
|
822
|
-
|
823
|
-
|
883
|
+
ParticipantsPostRequest: {
|
884
|
+
requestId: components["schemas"]["CorrelationId"];
|
885
|
+
/** @description List of PartyIdInfo elements that the client would like to update or create FSP information about. */
|
886
|
+
partyList: components["schemas"]["PartyIdInfo"][];
|
887
|
+
currency?: components["schemas"]["Currency"];
|
824
888
|
};
|
825
889
|
/**
|
826
890
|
* ParticipantsTypeIDPutResponse
|
@@ -839,127 +903,127 @@ export interface components {
|
|
839
903
|
extensionList?: components["schemas"]["ExtensionList"];
|
840
904
|
};
|
841
905
|
/**
|
842
|
-
*
|
843
|
-
* @description
|
906
|
+
* PartiesTypeIDPutResponse
|
907
|
+
* @description The object sent in the PUT /parties/{Type}/{ID} callback.
|
844
908
|
*/
|
845
|
-
|
846
|
-
|
909
|
+
PartiesTypeIDPutResponse: {
|
910
|
+
party: components["schemas"]["Party"];
|
847
911
|
};
|
848
912
|
/**
|
849
|
-
*
|
850
|
-
* @description
|
851
|
-
*/
|
852
|
-
ParticipantsPostRequest: {
|
853
|
-
requestId: components["schemas"]["CorrelationId"];
|
854
|
-
/** @description List of PartyIdInfo elements that the client would like to update or create FSP information about. */
|
855
|
-
partyList: components["schemas"]["PartyIdInfo"][];
|
856
|
-
currency?: components["schemas"]["Currency"];
|
857
|
-
};
|
858
|
-
/**
|
859
|
-
* PartyResult
|
860
|
-
* @description Data model for the complex type PartyResult.
|
913
|
+
* Party
|
914
|
+
* @description Data model for the complex type Party.
|
861
915
|
*/
|
862
|
-
|
863
|
-
|
864
|
-
|
916
|
+
Party: {
|
917
|
+
partyIdInfo: components["schemas"]["PartyIdInfo"];
|
918
|
+
merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"];
|
919
|
+
name?: components["schemas"]["PartyName"];
|
920
|
+
personalInfo?: components["schemas"]["PartyPersonalInfo"];
|
865
921
|
};
|
866
922
|
/**
|
867
|
-
*
|
868
|
-
* @description
|
923
|
+
* PartyComplexName
|
924
|
+
* @description Data model for the complex type PartyComplexName.
|
869
925
|
*/
|
870
|
-
|
871
|
-
|
872
|
-
|
873
|
-
|
926
|
+
PartyComplexName: {
|
927
|
+
firstName?: components["schemas"]["FirstName"];
|
928
|
+
middleName?: components["schemas"]["MiddleName"];
|
929
|
+
lastName?: components["schemas"]["LastName"];
|
874
930
|
};
|
875
931
|
/**
|
876
|
-
*
|
877
|
-
* @description
|
932
|
+
* PartyIdInfo
|
933
|
+
* @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
|
878
934
|
*/
|
879
|
-
|
880
|
-
|
935
|
+
PartyIdInfo: {
|
936
|
+
partyIdType: components["schemas"]["PartyIdType"];
|
937
|
+
partyIdentifier: components["schemas"]["PartyIdentifier"];
|
938
|
+
partySubIdOrType?: components["schemas"]["PartySubIdOrType"];
|
939
|
+
fspId?: components["schemas"]["FspId"];
|
940
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
881
941
|
};
|
882
942
|
/**
|
883
|
-
*
|
884
|
-
* @description
|
885
|
-
*
|
943
|
+
* PartyIdType
|
944
|
+
* @description Below are the allowed values for the enumeration.
|
945
|
+
* - 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.
|
946
|
+
* - 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).
|
947
|
+
* - 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.
|
948
|
+
* - 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.
|
949
|
+
* - 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.
|
950
|
+
* - 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.
|
951
|
+
* - 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.
|
952
|
+
* - 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.
|
953
|
+
* @enum {string}
|
886
954
|
*/
|
887
|
-
|
955
|
+
PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
|
888
956
|
/**
|
889
|
-
*
|
890
|
-
* @description
|
891
|
-
* @example
|
957
|
+
* PartyIdentifier
|
958
|
+
* @description Identifier of the Party.
|
959
|
+
* @example 16135551212
|
892
960
|
*/
|
893
|
-
|
961
|
+
PartyIdentifier: string;
|
894
962
|
/**
|
895
|
-
*
|
896
|
-
* @description
|
963
|
+
* PartyName
|
964
|
+
* @description Name of the Party. Could be a real name or a nickname.
|
897
965
|
*/
|
898
|
-
|
899
|
-
latitude: components["schemas"]["Latitude"];
|
900
|
-
longitude: components["schemas"]["Longitude"];
|
901
|
-
};
|
966
|
+
PartyName: string;
|
902
967
|
/**
|
903
|
-
*
|
904
|
-
* @description
|
905
|
-
* - OTP - One-time password generated by the Payer FSP.
|
906
|
-
* - QRCODE - QR code used as One Time Password.
|
907
|
-
* - U2F - U2F is a new addition isolated to Thirdparty stream.
|
908
|
-
* @example OTP
|
909
|
-
* @enum {string}
|
968
|
+
* PartyPersonalInfo
|
969
|
+
* @description Data model for the complex type PartyPersonalInfo.
|
910
970
|
*/
|
911
|
-
|
971
|
+
PartyPersonalInfo: {
|
972
|
+
complexName?: components["schemas"]["PartyComplexName"];
|
973
|
+
dateOfBirth?: components["schemas"]["DateOfBirth"];
|
974
|
+
};
|
912
975
|
/**
|
913
|
-
*
|
914
|
-
* @description
|
915
|
-
* @example 2016-05-24T08:38:08.699-04:00
|
976
|
+
* PartyResult
|
977
|
+
* @description Data model for the complex type PartyResult.
|
916
978
|
*/
|
917
|
-
|
979
|
+
PartyResult: {
|
980
|
+
partyId: components["schemas"]["PartyIdInfo"];
|
981
|
+
errorInformation?: components["schemas"]["ErrorInformation"];
|
982
|
+
};
|
918
983
|
/**
|
919
|
-
*
|
920
|
-
* @description
|
984
|
+
* PartySubIdOrType
|
985
|
+
* @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
|
921
986
|
*/
|
922
|
-
|
923
|
-
transactionRequestId: components["schemas"]["CorrelationId"];
|
924
|
-
payee: components["schemas"]["Party"];
|
925
|
-
payer: components["schemas"]["PartyIdInfo"];
|
926
|
-
amount: components["schemas"]["Money"];
|
927
|
-
transactionType: components["schemas"]["TransactionType"];
|
928
|
-
note?: components["schemas"]["Note"];
|
929
|
-
geoCode?: components["schemas"]["GeoCode"];
|
930
|
-
authenticationType?: components["schemas"]["AuthenticationType"];
|
931
|
-
expiration?: components["schemas"]["DateTime"];
|
932
|
-
extensionList?: components["schemas"]["ExtensionList"];
|
933
|
-
};
|
987
|
+
PartySubIdOrType: string;
|
934
988
|
/**
|
935
|
-
*
|
989
|
+
* PersonalIdentifierType
|
936
990
|
* @description Below are the allowed values for the enumeration.
|
937
|
-
* -
|
938
|
-
* -
|
939
|
-
* -
|
940
|
-
* -
|
941
|
-
*
|
991
|
+
* - PASSPORT - A passport number is used as reference to a Party.
|
992
|
+
* - NATIONAL_REGISTRATION - A national registration number is used as reference to a Party.
|
993
|
+
* - DRIVING_LICENSE - A driving license is used as reference to a Party.
|
994
|
+
* - ALIEN_REGISTRATION - An alien registration number is used as reference to a Party.
|
995
|
+
* - NATIONAL_ID_CARD - A national ID card number is used as reference to a Party.
|
996
|
+
* - EMPLOYER_ID - A tax identification number is used as reference to a Party.
|
997
|
+
* - TAX_ID_NUMBER - A tax identification number is used as reference to a Party.
|
998
|
+
* - SENIOR_CITIZENS_CARD - A senior citizens card number is used as reference to a Party.
|
999
|
+
* - MARRIAGE_CERTIFICATE - A marriage certificate number is used as reference to a Party.
|
1000
|
+
* - HEALTH_CARD - A health card number is used as reference to a Party.
|
1001
|
+
* - VOTERS_ID - A voter’s identification number is used as reference to a Party.
|
1002
|
+
* - UNITED_NATIONS - An UN (United Nations) number is used as reference to a Party.
|
1003
|
+
* - OTHER_ID - Any other type of identification type number is used as reference to a Party.
|
942
1004
|
* @enum {string}
|
943
1005
|
*/
|
944
|
-
|
1006
|
+
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";
|
945
1007
|
/**
|
946
|
-
*
|
947
|
-
* @description
|
1008
|
+
* QRCODE
|
1009
|
+
* @description QR code used as a One Time Password.
|
948
1010
|
*/
|
949
|
-
|
950
|
-
transactionId?: components["schemas"]["CorrelationId"];
|
951
|
-
transactionRequestState: components["schemas"]["TransactionRequestState"];
|
952
|
-
extensionList?: components["schemas"]["ExtensionList"];
|
953
|
-
};
|
1011
|
+
QRCODE: string;
|
954
1012
|
/**
|
955
|
-
*
|
956
|
-
* @description
|
957
|
-
* - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
|
958
|
-
* - 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.
|
959
|
-
* @example RECEIVE
|
960
|
-
* @enum {string}
|
1013
|
+
* QuotesIDPutResponse
|
1014
|
+
* @description The object sent in the PUT /quotes/{ID} callback.
|
961
1015
|
*/
|
962
|
-
|
1016
|
+
QuotesIDPutResponse: {
|
1017
|
+
transferAmount: components["schemas"]["Money"];
|
1018
|
+
payeeReceiveAmount?: components["schemas"]["Money"];
|
1019
|
+
payeeFspFee?: components["schemas"]["Money"];
|
1020
|
+
payeeFspCommission?: components["schemas"]["Money"];
|
1021
|
+
expiration: components["schemas"]["DateTime"];
|
1022
|
+
geoCode?: components["schemas"]["GeoCode"];
|
1023
|
+
ilpPacket: components["schemas"]["IlpPacket"];
|
1024
|
+
condition: components["schemas"]["IlpCondition"];
|
1025
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
1026
|
+
};
|
963
1027
|
/**
|
964
1028
|
* QuotesPostRequest
|
965
1029
|
* @description The object sent in the POST /quotes request.
|
@@ -980,137 +1044,106 @@ export interface components {
|
|
980
1044
|
extensionList?: components["schemas"]["ExtensionList"];
|
981
1045
|
};
|
982
1046
|
/**
|
983
|
-
*
|
984
|
-
* @description
|
985
|
-
* @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
|
986
|
-
*/
|
987
|
-
IlpPacket: string;
|
988
|
-
/**
|
989
|
-
* IlpCondition
|
990
|
-
* @description Condition that must be attached to the transfer by the Payer.
|
991
|
-
*/
|
992
|
-
IlpCondition: string;
|
993
|
-
/**
|
994
|
-
* QuotesIDPutResponse
|
995
|
-
* @description The object sent in the PUT /quotes/{ID} callback.
|
1047
|
+
* Refund
|
1048
|
+
* @description Data model for the complex type Refund.
|
996
1049
|
*/
|
997
|
-
|
998
|
-
|
999
|
-
|
1000
|
-
payeeFspFee?: components["schemas"]["Money"];
|
1001
|
-
payeeFspCommission?: components["schemas"]["Money"];
|
1002
|
-
expiration: components["schemas"]["DateTime"];
|
1003
|
-
geoCode?: components["schemas"]["GeoCode"];
|
1004
|
-
ilpPacket: components["schemas"]["IlpPacket"];
|
1005
|
-
condition: components["schemas"]["IlpCondition"];
|
1006
|
-
extensionList?: components["schemas"]["ExtensionList"];
|
1050
|
+
Refund: {
|
1051
|
+
originalTransactionId: components["schemas"]["CorrelationId"];
|
1052
|
+
refundReason?: components["schemas"]["RefundReason"];
|
1007
1053
|
};
|
1008
1054
|
/**
|
1009
|
-
*
|
1010
|
-
* @description
|
1011
|
-
|
1012
|
-
OtpValue: string;
|
1013
|
-
/**
|
1014
|
-
* QRCODE
|
1015
|
-
* @description QR code used as a One Time Password.
|
1016
|
-
*/
|
1017
|
-
QRCODE: string;
|
1018
|
-
/**
|
1019
|
-
* U2FPIN
|
1020
|
-
* @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
|
1021
|
-
*/
|
1022
|
-
U2FPIN: string;
|
1023
|
-
/**
|
1024
|
-
* U2FPinValue
|
1025
|
-
* @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
|
1055
|
+
* RefundReason
|
1056
|
+
* @description Reason for the refund.
|
1057
|
+
* @example Free text indicating reason for the refund.
|
1026
1058
|
*/
|
1027
|
-
|
1028
|
-
/** @description U2F challenge-response. */
|
1029
|
-
pinValue: components["schemas"]["U2FPIN"];
|
1030
|
-
/** @description Sequential counter used for cloning detection. Present only for U2F authentication. */
|
1031
|
-
counter: components["schemas"]["Integer"];
|
1032
|
-
};
|
1059
|
+
RefundReason: string;
|
1033
1060
|
/**
|
1034
|
-
*
|
1035
|
-
* @description
|
1061
|
+
* TokenCode
|
1062
|
+
* @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.
|
1036
1063
|
*/
|
1037
|
-
|
1064
|
+
TokenCode: string;
|
1038
1065
|
/**
|
1039
|
-
*
|
1040
|
-
* @description Data model for the complex type
|
1066
|
+
* Transaction
|
1067
|
+
* @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.
|
1041
1068
|
*/
|
1042
|
-
|
1043
|
-
|
1044
|
-
|
1069
|
+
Transaction: {
|
1070
|
+
transactionId: components["schemas"]["CorrelationId"];
|
1071
|
+
quoteId: components["schemas"]["CorrelationId"];
|
1072
|
+
payee: components["schemas"]["Party"];
|
1073
|
+
payer: components["schemas"]["Party"];
|
1074
|
+
amount: components["schemas"]["Money"];
|
1075
|
+
transactionType: components["schemas"]["TransactionType"];
|
1076
|
+
note?: components["schemas"]["Note"];
|
1077
|
+
extensionList?: components["schemas"]["ExtensionList"];
|
1045
1078
|
};
|
1046
1079
|
/**
|
1047
|
-
*
|
1080
|
+
* TransactionInitiator
|
1048
1081
|
* @description Below are the allowed values for the enumeration.
|
1049
|
-
* -
|
1050
|
-
* -
|
1051
|
-
*
|
1052
|
-
* @example ENTERED
|
1082
|
+
* - 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.
|
1083
|
+
* - 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.
|
1084
|
+
* @example PAYEE
|
1053
1085
|
* @enum {string}
|
1054
1086
|
*/
|
1055
|
-
|
1056
|
-
/**
|
1057
|
-
* AuthorizationsIDPutResponse
|
1058
|
-
* @description The object sent in the PUT /authorizations/{ID} callback.
|
1059
|
-
*/
|
1060
|
-
AuthorizationsIDPutResponse: {
|
1061
|
-
authenticationInfo?: components["schemas"]["AuthenticationInfo"];
|
1062
|
-
responseType: components["schemas"]["AuthorizationResponse"];
|
1063
|
-
};
|
1064
|
-
/**
|
1065
|
-
* TransfersPostRequest
|
1066
|
-
* @description The object sent in the POST /transfers request.
|
1067
|
-
*/
|
1068
|
-
TransfersPostRequest: {
|
1069
|
-
transferId: components["schemas"]["CorrelationId"];
|
1070
|
-
payeeFsp: components["schemas"]["FspId"];
|
1071
|
-
payerFsp: components["schemas"]["FspId"];
|
1072
|
-
amount: components["schemas"]["Money"];
|
1073
|
-
ilpPacket: components["schemas"]["IlpPacket"];
|
1074
|
-
condition: components["schemas"]["IlpCondition"];
|
1075
|
-
expiration: components["schemas"]["DateTime"];
|
1076
|
-
extensionList?: components["schemas"]["ExtensionList"];
|
1077
|
-
};
|
1087
|
+
TransactionInitiator: "PAYER" | "PAYEE";
|
1078
1088
|
/**
|
1079
|
-
*
|
1080
|
-
* @description
|
1081
|
-
*
|
1089
|
+
* TransactionInitiatorType
|
1090
|
+
* @description Below are the allowed values for the enumeration.
|
1091
|
+
* - CONSUMER - Consumer is the initiator of the transaction.
|
1092
|
+
* - AGENT - Agent is the initiator of the transaction.
|
1093
|
+
* - BUSINESS - Business is the initiator of the transaction.
|
1094
|
+
* - DEVICE - Device is the initiator of the transaction.
|
1095
|
+
* @example CONSUMER
|
1096
|
+
* @enum {string}
|
1082
1097
|
*/
|
1083
|
-
|
1098
|
+
TransactionInitiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
|
1084
1099
|
/**
|
1085
|
-
*
|
1100
|
+
* TransactionRequestState
|
1086
1101
|
* @description Below are the allowed values for the enumeration.
|
1087
|
-
* - RECEIVED -
|
1088
|
-
* -
|
1089
|
-
* -
|
1090
|
-
* -
|
1091
|
-
* @example
|
1102
|
+
* - RECEIVED - Payer FSP has received the transaction from the Payee FSP.
|
1103
|
+
* - PENDING - Payer FSP has sent the transaction request to the Payer.
|
1104
|
+
* - ACCEPTED - Payer has approved the transaction.
|
1105
|
+
* - REJECTED - Payer has rejected the transaction.
|
1106
|
+
* @example RECEIVED
|
1092
1107
|
* @enum {string}
|
1093
1108
|
*/
|
1094
|
-
|
1109
|
+
TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED";
|
1095
1110
|
/**
|
1096
|
-
*
|
1097
|
-
* @description The object sent in the PUT /
|
1111
|
+
* TransactionRequestsIDPutResponse
|
1112
|
+
* @description The object sent in the PUT /transactionRequests/{ID} callback.
|
1098
1113
|
*/
|
1099
|
-
|
1100
|
-
|
1101
|
-
|
1102
|
-
transferState: components["schemas"]["TransferState"];
|
1114
|
+
TransactionRequestsIDPutResponse: {
|
1115
|
+
transactionId?: components["schemas"]["CorrelationId"];
|
1116
|
+
transactionRequestState: components["schemas"]["TransactionRequestState"];
|
1103
1117
|
extensionList?: components["schemas"]["ExtensionList"];
|
1104
1118
|
};
|
1105
1119
|
/**
|
1106
|
-
*
|
1107
|
-
* @description
|
1120
|
+
* TransactionRequestsPostRequest
|
1121
|
+
* @description The object sent in the POST /transactionRequests request.
|
1108
1122
|
*/
|
1109
|
-
|
1110
|
-
|
1111
|
-
|
1123
|
+
TransactionRequestsPostRequest: {
|
1124
|
+
transactionRequestId: components["schemas"]["CorrelationId"];
|
1125
|
+
payee: components["schemas"]["Party"];
|
1126
|
+
payer: components["schemas"]["PartyIdInfo"];
|
1127
|
+
amount: components["schemas"]["Money"];
|
1128
|
+
transactionType: components["schemas"]["TransactionType"];
|
1129
|
+
note?: components["schemas"]["Note"];
|
1130
|
+
geoCode?: components["schemas"]["GeoCode"];
|
1131
|
+
authenticationType?: components["schemas"]["AuthenticationType"];
|
1132
|
+
expiration?: components["schemas"]["DateTime"];
|
1112
1133
|
extensionList?: components["schemas"]["ExtensionList"];
|
1113
1134
|
};
|
1135
|
+
/**
|
1136
|
+
* TransactionScenario
|
1137
|
+
* @description Below are the allowed values for the enumeration.
|
1138
|
+
* - 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.
|
1139
|
+
* - 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.
|
1140
|
+
* - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.
|
1141
|
+
* - 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.
|
1142
|
+
* - REFUND - Used for performing a refund of transaction.
|
1143
|
+
* @example DEPOSIT
|
1144
|
+
* @enum {string}
|
1145
|
+
*/
|
1146
|
+
TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND";
|
1114
1147
|
/**
|
1115
1148
|
* TransactionState
|
1116
1149
|
* @description Below are the allowed values for the enumeration.
|
@@ -1123,11 +1156,23 @@ export interface components {
|
|
1123
1156
|
*/
|
1124
1157
|
TransactionState: "RECEIVED" | "PENDING" | "COMPLETED" | "REJECTED";
|
1125
1158
|
/**
|
1126
|
-
*
|
1127
|
-
* @description
|
1128
|
-
* @example
|
1159
|
+
* TransactionSubScenario
|
1160
|
+
* @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).
|
1161
|
+
* @example LOCALLY_DEFINED_SUBSCENARIO
|
1129
1162
|
*/
|
1130
|
-
|
1163
|
+
TransactionSubScenario: string;
|
1164
|
+
/**
|
1165
|
+
* TransactionType
|
1166
|
+
* @description Data model for the complex type TransactionType.
|
1167
|
+
*/
|
1168
|
+
TransactionType: {
|
1169
|
+
scenario: components["schemas"]["TransactionScenario"];
|
1170
|
+
subScenario?: components["schemas"]["TransactionSubScenario"];
|
1171
|
+
initiator: components["schemas"]["TransactionInitiator"];
|
1172
|
+
initiatorType: components["schemas"]["TransactionInitiatorType"];
|
1173
|
+
refundInfo?: components["schemas"]["Refund"];
|
1174
|
+
balanceOfPayments?: components["schemas"]["BalanceOfPayments"];
|
1175
|
+
};
|
1131
1176
|
/**
|
1132
1177
|
* TransactionsIDPutResponse
|
1133
1178
|
* @description The object sent in the PUT /transactions/{ID} callback.
|
@@ -1139,118 +1184,69 @@ export interface components {
|
|
1139
1184
|
extensionList?: components["schemas"]["ExtensionList"];
|
1140
1185
|
};
|
1141
1186
|
/**
|
1142
|
-
*
|
1143
|
-
* @description
|
1144
|
-
|
1145
|
-
|
1146
|
-
|
1147
|
-
|
1148
|
-
|
1149
|
-
|
1150
|
-
amount: components["schemas"]["Money"];
|
1151
|
-
fees?: components["schemas"]["Money"];
|
1152
|
-
transactionType: components["schemas"]["TransactionType"];
|
1153
|
-
note?: components["schemas"]["Note"];
|
1154
|
-
extensionList?: components["schemas"]["ExtensionList"];
|
1155
|
-
};
|
1156
|
-
/**
|
1157
|
-
* BulkQuotesPostRequest
|
1158
|
-
* @description The object sent in the POST /bulkQuotes request.
|
1187
|
+
* TransferState
|
1188
|
+
* @description Below are the allowed values for the enumeration.
|
1189
|
+
* - RECEIVED - Next ledger has received the transfer.
|
1190
|
+
* - RESERVED - Next ledger has reserved the transfer.
|
1191
|
+
* - COMMITTED - Next ledger has successfully performed the transfer.
|
1192
|
+
* - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
|
1193
|
+
* @example RESERVED
|
1194
|
+
* @enum {string}
|
1159
1195
|
*/
|
1160
|
-
|
1161
|
-
bulkQuoteId: components["schemas"]["CorrelationId"];
|
1162
|
-
payer: components["schemas"]["Party"];
|
1163
|
-
geoCode?: components["schemas"]["GeoCode"];
|
1164
|
-
expiration?: components["schemas"]["DateTime"];
|
1165
|
-
/** @description List of quotes elements. */
|
1166
|
-
individualQuotes: components["schemas"]["IndividualQuote"][];
|
1167
|
-
extensionList?: components["schemas"]["ExtensionList"];
|
1168
|
-
};
|
1196
|
+
TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
|
1169
1197
|
/**
|
1170
|
-
*
|
1171
|
-
* @description
|
1198
|
+
* TransfersIDPatchResponse
|
1199
|
+
* @description PATCH /transfers/{ID} object
|
1172
1200
|
*/
|
1173
|
-
|
1174
|
-
|
1175
|
-
|
1176
|
-
transferAmount?: components["schemas"]["Money"];
|
1177
|
-
payeeReceiveAmount?: components["schemas"]["Money"];
|
1178
|
-
payeeFspFee?: components["schemas"]["Money"];
|
1179
|
-
payeeFspCommission?: components["schemas"]["Money"];
|
1180
|
-
ilpPacket?: components["schemas"]["IlpPacket"];
|
1181
|
-
condition?: components["schemas"]["IlpCondition"];
|
1182
|
-
errorInformation?: components["schemas"]["ErrorInformation"];
|
1201
|
+
TransfersIDPatchResponse: {
|
1202
|
+
completedTimestamp: components["schemas"]["DateTime"];
|
1203
|
+
transferState: components["schemas"]["TransferState"];
|
1183
1204
|
extensionList?: components["schemas"]["ExtensionList"];
|
1184
1205
|
};
|
1185
1206
|
/**
|
1186
|
-
*
|
1187
|
-
* @description The object sent in the PUT /
|
1207
|
+
* TransfersIDPutResponse
|
1208
|
+
* @description The object sent in the PUT /transfers/{ID} callback.
|
1188
1209
|
*/
|
1189
|
-
|
1190
|
-
|
1191
|
-
|
1192
|
-
|
1210
|
+
TransfersIDPutResponse: {
|
1211
|
+
fulfilment?: components["schemas"]["IlpFulfilment"];
|
1212
|
+
completedTimestamp?: components["schemas"]["DateTime"];
|
1213
|
+
transferState: components["schemas"]["TransferState"];
|
1193
1214
|
extensionList?: components["schemas"]["ExtensionList"];
|
1194
1215
|
};
|
1195
1216
|
/**
|
1196
|
-
*
|
1197
|
-
* @description
|
1217
|
+
* TransfersPostRequest
|
1218
|
+
* @description The object sent in the POST /transfers request.
|
1198
1219
|
*/
|
1199
|
-
|
1220
|
+
TransfersPostRequest: {
|
1200
1221
|
transferId: components["schemas"]["CorrelationId"];
|
1201
|
-
|
1222
|
+
payeeFsp: components["schemas"]["FspId"];
|
1223
|
+
payerFsp: components["schemas"]["FspId"];
|
1224
|
+
amount: components["schemas"]["Money"];
|
1202
1225
|
ilpPacket: components["schemas"]["IlpPacket"];
|
1203
1226
|
condition: components["schemas"]["IlpCondition"];
|
1204
|
-
extensionList?: components["schemas"]["ExtensionList"];
|
1205
|
-
};
|
1206
|
-
/**
|
1207
|
-
* BulkTransfersPostRequest
|
1208
|
-
* @description The object sent in the POST /bulkTransfers request.
|
1209
|
-
*/
|
1210
|
-
BulkTransfersPostRequest: {
|
1211
|
-
bulkTransferId: components["schemas"]["CorrelationId"];
|
1212
|
-
bulkQuoteId: components["schemas"]["CorrelationId"];
|
1213
|
-
payerFsp: components["schemas"]["FspId"];
|
1214
|
-
payeeFsp: components["schemas"]["FspId"];
|
1215
|
-
/** @description List of IndividualTransfer elements. */
|
1216
|
-
individualTransfers: components["schemas"]["IndividualTransfer"][];
|
1217
1227
|
expiration: components["schemas"]["DateTime"];
|
1218
1228
|
extensionList?: components["schemas"]["ExtensionList"];
|
1219
1229
|
};
|
1220
1230
|
/**
|
1221
|
-
*
|
1222
|
-
* @description
|
1231
|
+
* U2FPIN
|
1232
|
+
* @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
|
1223
1233
|
*/
|
1224
|
-
|
1225
|
-
transferId: components["schemas"]["CorrelationId"];
|
1226
|
-
fulfilment?: components["schemas"]["IlpFulfilment"];
|
1227
|
-
errorInformation?: components["schemas"]["ErrorInformation"];
|
1228
|
-
extensionList?: components["schemas"]["ExtensionList"];
|
1229
|
-
};
|
1234
|
+
U2FPIN: string;
|
1230
1235
|
/**
|
1231
|
-
*
|
1232
|
-
* @description
|
1233
|
-
* - RECEIVED - Payee FSP has received the bulk transfer from the Payer FSP.
|
1234
|
-
* - PENDING - Payee FSP has validated the bulk transfer.
|
1235
|
-
* - ACCEPTED - Payee FSP has accepted to process the bulk transfer.
|
1236
|
-
* - PROCESSING - Payee FSP has started to transfer fund to the Payees.
|
1237
|
-
* - COMPLETED - Payee FSP has completed transfer of funds to the Payees.
|
1238
|
-
* - REJECTED - Payee FSP has rejected to process the bulk transfer.
|
1239
|
-
* @example RECEIVED
|
1240
|
-
* @enum {string}
|
1236
|
+
* U2FPinValue
|
1237
|
+
* @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
|
1241
1238
|
*/
|
1242
|
-
|
1239
|
+
U2FPinValue: {
|
1240
|
+
/** @description U2F challenge-response. */
|
1241
|
+
pinValue: components["schemas"]["U2FPIN"];
|
1242
|
+
/** @description Sequential counter used for cloning detection. Present only for U2F authentication. */
|
1243
|
+
counter: components["schemas"]["Integer"];
|
1244
|
+
};
|
1243
1245
|
/**
|
1244
|
-
*
|
1245
|
-
* @description The
|
1246
|
+
* UndefinedEnum
|
1247
|
+
* @description The API data type UndefinedEnum is a JSON String consisting of 1 to 32 uppercase characters including an underscore character (_).
|
1246
1248
|
*/
|
1247
|
-
|
1248
|
-
completedTimestamp?: components["schemas"]["DateTime"];
|
1249
|
-
/** @description List of IndividualTransferResult elements. */
|
1250
|
-
individualTransferResults?: components["schemas"]["IndividualTransferResult"][];
|
1251
|
-
bulkTransferState: components["schemas"]["BulkTransferState"];
|
1252
|
-
extensionList?: components["schemas"]["ExtensionList"];
|
1253
|
-
};
|
1249
|
+
UndefinedEnum: string;
|
1254
1250
|
};
|
1255
1251
|
responses: {
|
1256
1252
|
/** @description OK */
|
@@ -1343,42 +1339,42 @@ export interface components {
|
|
1343
1339
|
};
|
1344
1340
|
};
|
1345
1341
|
parameters: {
|
1346
|
-
/** @description The
|
1347
|
-
|
1348
|
-
/**
|
1349
|
-
|
1342
|
+
/** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
|
1343
|
+
Accept: string;
|
1344
|
+
/**
|
1345
|
+
* @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
|
1346
|
+
*
|
1347
|
+
* **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
|
1348
|
+
*/
|
1349
|
+
"Content-Length"?: number;
|
1350
1350
|
/** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
|
1351
1351
|
"Content-Type": string;
|
1352
1352
|
/** @description The `Date` header field indicates the date when the request was sent. */
|
1353
1353
|
Date: string;
|
1354
|
-
/**
|
1355
|
-
* @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.
|
1356
|
-
*
|
1357
|
-
* **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`.
|
1358
|
-
*/
|
1359
|
-
"X-Forwarded-For"?: string;
|
1360
|
-
/** @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`). */
|
1361
|
-
"FSPIOP-Source": string;
|
1362
1354
|
/** @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. */
|
1363
1355
|
"FSPIOP-Destination"?: string;
|
1364
1356
|
/** @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. */
|
1365
1357
|
"FSPIOP-Encryption"?: string;
|
1358
|
+
/** @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). */
|
1359
|
+
"FSPIOP-HTTP-Method"?: string;
|
1366
1360
|
/** @description The `FSPIOP-Signature` header field is a non-HTTP standard field used by the API for applying an end-to-end request signature. */
|
1367
1361
|
"FSPIOP-Signature"?: string;
|
1362
|
+
/** @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`). */
|
1363
|
+
"FSPIOP-Source": string;
|
1368
1364
|
/** @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). */
|
1369
1365
|
"FSPIOP-URI"?: string;
|
1370
|
-
/** @description The
|
1371
|
-
|
1372
|
-
/** @description
|
1373
|
-
|
1366
|
+
/** @description The identifier value. */
|
1367
|
+
ID: string;
|
1368
|
+
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1369
|
+
SubId: string;
|
1370
|
+
/** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
|
1371
|
+
Type: string;
|
1374
1372
|
/**
|
1375
|
-
* @description The `
|
1373
|
+
* @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.
|
1376
1374
|
*
|
1377
|
-
* **Note:**
|
1375
|
+
* **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`.
|
1378
1376
|
*/
|
1379
|
-
"
|
1380
|
-
/** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
|
1381
|
-
SubId: string;
|
1377
|
+
"X-Forwarded-For"?: string;
|
1382
1378
|
};
|
1383
1379
|
requestBodies: never;
|
1384
1380
|
headers: {
|
@@ -1396,20 +1392,6 @@ export interface components {
|
|
1396
1392
|
export type $defs = Record<string, never>;
|
1397
1393
|
export type external = Record<string, never>;
|
1398
1394
|
export interface operations {
|
1399
|
-
/** @description Essential path to include schema definitions that are not used so that these definitions get included into the openapi-cli bundle api definition so that they get converted into typescript definitions. */
|
1400
|
-
test: {
|
1401
|
-
requestBody?: {
|
1402
|
-
content: {
|
1403
|
-
"application/json": components["schemas"]["BinaryString"] | components["schemas"]["BinaryString32"] | components["schemas"]["Date"] | components["schemas"]["Integer"] | components["schemas"]["Name"] | components["schemas"]["PersonalIdentifierType"] | components["schemas"]["TokenCode"] | components["schemas"]["Transaction"] | components["schemas"]["UndefinedEnum"];
|
1404
|
-
};
|
1405
|
-
};
|
1406
|
-
responses: {
|
1407
|
-
/** @description Ok */
|
1408
|
-
200: {
|
1409
|
-
content: never;
|
1410
|
-
};
|
1411
|
-
};
|
1412
|
-
};
|
1413
1395
|
/**
|
1414
1396
|
* Look up participant information
|
1415
1397
|
* @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.
|