@mojaloop/api-snippets 17.3.0-snapshot.0 → 17.4.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.
@@ -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
@@ -636,53 +632,139 @@ export interface paths {
636
632
  export type webhooks = Record<string, never>;
637
633
  export interface components {
638
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;
639
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. */
640
698
  BinaryString: string;
641
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. */
642
700
  BinaryString32: string;
643
701
  /**
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”.
646
- */
647
- Date: string;
648
- /**
649
- * Integer
650
- * @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.
702
+ * BulkQuotesIDPutResponse
703
+ * @description The object sent in the PUT /bulkQuotes/{ID} callback.
651
704
  */
652
- Integer: string;
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
+ };
653
711
  /**
654
- * Name
655
- * @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.
656
- *
657
- * 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 ( ).
658
- *
659
- * **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.
712
+ * BulkQuotesPostRequest
713
+ * @description The object sent in the POST /bulkQuotes request.
660
714
  */
661
- Name: string;
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
+ };
662
724
  /**
663
- * PersonalIdentifierType
725
+ * BulkTransactionState
664
726
  * @description Below are the allowed values for the enumeration.
665
- * - PASSPORT - A passport number is used as reference to a Party.
666
- * - NATIONAL_REGISTRATION - A national registration number is used as reference to a Party.
667
- * - DRIVING_LICENSE - A driving license is used as reference to a Party.
668
- * - ALIEN_REGISTRATION - An alien registration number is used as reference to a Party.
669
- * - NATIONAL_ID_CARD - A national ID card number is used as reference to a Party.
670
- * - EMPLOYER_ID - A tax identification number is used as reference to a Party.
671
- * - TAX_ID_NUMBER - A tax identification number is used as reference to a Party.
672
- * - SENIOR_CITIZENS_CARD - A senior citizens card number is used as reference to a Party.
673
- * - MARRIAGE_CERTIFICATE - A marriage certificate number is used as reference to a Party.
674
- * - HEALTH_CARD - A health card number is used as reference to a Party.
675
- * - VOTERS_ID - A voter’s identification number is used as reference to a Party.
676
- * - UNITED_NATIONS - An UN (United Nations) number is used as reference to a Party.
677
- * - OTHER_ID - Any other type of identification type number is used as reference to a Party.
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
678
734
  * @enum {string}
679
735
  */
680
- 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";
736
+ BulkTransferState: "RECEIVED" | "PENDING" | "ACCEPTED" | "PROCESSING" | "COMPLETED" | "REJECTED";
681
737
  /**
682
- * TokenCode
683
- * @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.
738
+ * BulkTransfersIDPutResponse
739
+ * @description The object sent in the PUT /bulkTransfers/{ID} callback.
684
740
  */
685
- TokenCode: string;
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;
686
768
  /**
687
769
  * CorrelationId
688
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 (‘-‘).
@@ -690,45 +772,68 @@ export interface components {
690
772
  */
691
773
  CorrelationId: string;
692
774
  /**
693
- * PartyIdType
694
- * @description Below are the allowed values for the enumeration.
695
- * - 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.
696
- * - 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).
697
- * - 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.
698
- * - 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.
699
- * - 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.
700
- * - 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.
701
- * - 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.
702
- * - 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.
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.
703
777
  * @enum {string}
704
778
  */
705
- PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
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";
706
780
  /**
707
- * PartyIdentifier
708
- * @description Identifier of the Party.
709
- * @example 16135551212
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}
710
784
  */
711
- PartyIdentifier: string;
785
+ CurrencyConverter: "PAYER" | "PAYEE";
712
786
  /**
713
- * PartySubIdOrType
714
- * @description Either a sub-identifier of a PartyIdentifier, or a sub-type of the PartyIdType, normally a PersonalIdentifierType.
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”.
715
789
  */
716
- PartySubIdOrType: string;
790
+ Date: string;
717
791
  /**
718
- * FspId
719
- * @description FSP identifier.
792
+ * DateofBirth (type Date)
793
+ * @description Date of Birth of the Party.
794
+ * @example 1966-06-16
720
795
  */
721
- FspId: string;
796
+ DateOfBirth: string;
722
797
  /**
723
- * ExtensionKey
724
- * @description Extension key.
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
725
801
  */
726
- ExtensionKey: string;
802
+ DateTime: string;
727
803
  /**
728
- * ExtensionValue
729
- * @description Extension value.
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
730
807
  */
731
- ExtensionValue: string;
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
+ };
732
837
  /**
733
838
  * Extension
734
839
  * @description Data model for the complex type Extension.
@@ -737,6 +842,11 @@ export interface components {
737
842
  key: components["schemas"]["ExtensionKey"];
738
843
  value: components["schemas"]["ExtensionValue"];
739
844
  };
845
+ /**
846
+ * ExtensionKey
847
+ * @description Extension key.
848
+ */
849
+ ExtensionKey: string;
740
850
  /**
741
851
  * ExtensionList
742
852
  * @description Data model for the complex type ExtensionList. An optional list of extensions, specific to deployment.
@@ -746,59 +856,195 @@ export interface components {
746
856
  extension: components["schemas"]["Extension"][];
747
857
  };
748
858
  /**
749
- * PartyIdInfo
750
- * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
859
+ * ExtensionValue
860
+ * @description Extension value.
751
861
  */
752
- PartyIdInfo: {
753
- partyIdType: components["schemas"]["PartyIdType"];
754
- partyIdentifier: components["schemas"]["PartyIdentifier"];
755
- partySubIdOrType?: components["schemas"]["PartySubIdOrType"];
756
- fspId?: components["schemas"]["FspId"];
757
- extensionList?: components["schemas"]["ExtensionList"];
758
- };
862
+ ExtensionValue: string;
759
863
  /**
760
- * MerchantClassificationCode
761
- * @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.
864
+ * FirstName
865
+ * @description First name of the Party (Name Type).
866
+ * @example Henrik
762
867
  */
763
- MerchantClassificationCode: string;
868
+ FirstName: string;
764
869
  /**
765
- * PartyName
766
- * @description Name of the Party. Could be a real name or a nickname.
870
+ * FspId
871
+ * @description FSP identifier.
767
872
  */
768
- PartyName: string;
873
+ FspId: string;
769
874
  /**
770
- * FirstName
771
- * @description First name of the Party (Name Type).
772
- * @example Henrik
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.
773
877
  */
774
- FirstName: string;
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
+ };
775
884
  /**
776
- * MiddleName
777
- * @description Middle name of the Party (Name Type).
778
- * @example Johannes
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.
779
887
  */
780
- MiddleName: string;
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
+ };
781
901
  /**
782
- * LastName
783
- * @description Last name of the Party (Name Type).
784
- * @example Karlsson
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.
785
904
  */
786
- LastName: string;
905
+ FxMoney: {
906
+ currency: components["schemas"]["Currency"];
907
+ amount?: components["schemas"]["Amount"];
908
+ };
787
909
  /**
788
- * PartyComplexName
789
- * @description Data model for the complex type PartyComplexName.
910
+ * FxQuotesIDPutResponse
911
+ * @description The object sent in the PUT /fxQuotes/{ID} callback.
790
912
  */
791
- PartyComplexName: {
792
- firstName?: components["schemas"]["FirstName"];
793
- middleName?: components["schemas"]["MiddleName"];
794
- lastName?: components["schemas"]["LastName"];
913
+ FxQuotesIDPutResponse: {
914
+ condition?: components["schemas"]["IlpCondition"];
915
+ conversionTerms: components["schemas"]["FxConversion"];
795
916
  };
796
917
  /**
797
- * DateofBirth (type Date)
798
- * @description Date of Birth of the Party.
799
- * @example 1966-06-16
918
+ * FxQuotesPostRequest
919
+ * @description The object sent in the POST /fxQuotes request.
800
920
  */
801
- DateOfBirth: string;
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;
802
1048
  /**
803
1049
  * KYCInformation
804
1050
  * @description KYC information for the party in a form mandated by an individual scheme.
@@ -832,38 +1078,34 @@ export interface components {
832
1078
  */
833
1079
  KYCInformation: string;
834
1080
  /**
835
- * PartyPersonalInfo
836
- * @description Data model for the complex type PartyPersonalInfo.
1081
+ * LastName
1082
+ * @description Last name of the Party (Name Type).
1083
+ * @example Karlsson
837
1084
  */
838
- PartyPersonalInfo: {
839
- complexName?: components["schemas"]["PartyComplexName"];
840
- dateOfBirth?: components["schemas"]["DateOfBirth"];
841
- kycInformation?: components["schemas"]["KYCInformation"];
842
- };
1085
+ LastName: string;
843
1086
  /**
844
- * Currency
845
- * @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.
846
- * @enum {string}
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
847
1090
  */
848
- 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";
1091
+ Latitude: string;
849
1092
  /**
850
- * Party
851
- * @description Data model for the complex type Party.
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
852
1096
  */
853
- Party: {
854
- partyIdInfo: components["schemas"]["PartyIdInfo"];
855
- merchantClassificationCode?: components["schemas"]["MerchantClassificationCode"];
856
- name?: components["schemas"]["PartyName"];
857
- personalInfo?: components["schemas"]["PartyPersonalInfo"];
858
- /** @description Currencies in which the party can receive funds. */
859
- supportedCurrencies?: components["schemas"]["Currency"][];
860
- };
1097
+ Longitude: string;
861
1098
  /**
862
- * Amount
863
- * @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.
864
- * @example 123.45
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.
865
1101
  */
866
- Amount: string;
1102
+ MerchantClassificationCode: string;
1103
+ /**
1104
+ * MiddleName
1105
+ * @description Middle name of the Party (Name Type).
1106
+ * @example Johannes
1107
+ */
1108
+ MiddleName: string;
867
1109
  /**
868
1110
  * Money
869
1111
  * @description Data model for the complex type Money.
@@ -873,143 +1115,43 @@ export interface components {
873
1115
  amount: components["schemas"]["Amount"];
874
1116
  };
875
1117
  /**
876
- * CurrencyConverter
877
- * @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.
878
- * @enum {string}
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.
879
1124
  */
880
- CurrencyConverter: "PAYER" | "PAYEE";
1125
+ Name: string;
881
1126
  /**
882
- * FxRate
883
- * @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.
1127
+ * Note
1128
+ * @description Memo assigned to transaction.
1129
+ * @example Note sent to Payee.
884
1130
  */
885
- FxRate: {
886
- sourceAmount: components["schemas"]["Money"];
887
- targetAmount: components["schemas"]["Money"];
888
- };
1131
+ Note: string;
889
1132
  /**
890
- * TransactionScenario
891
- * @description Below are the allowed values for the enumeration.
892
- * - 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.
893
- * - 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.
894
- * - TRANSFER - Used for performing a P2P (Peer to Peer, or Consumer to Consumer) transaction.
895
- * - 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.
896
- * - REFUND - Used for performing a refund of transaction.
897
- * @example DEPOSIT
898
- * @enum {string}
899
- */
900
- TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND";
901
- /**
902
- * TransactionSubScenario
903
- * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).
904
- * @example LOCALLY_DEFINED_SUBSCENARIO
905
- */
906
- TransactionSubScenario: string;
907
- /**
908
- * TransactionInitiator
909
- * @description Below are the allowed values for the enumeration.
910
- * - 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.
911
- * - 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.
912
- * @example PAYEE
913
- * @enum {string}
914
- */
915
- TransactionInitiator: "PAYER" | "PAYEE";
916
- /**
917
- * TransactionInitiatorType
918
- * @description Below are the allowed values for the enumeration.
919
- * - CONSUMER - Consumer is the initiator of the transaction.
920
- * - AGENT - Agent is the initiator of the transaction.
921
- * - BUSINESS - Business is the initiator of the transaction.
922
- * - DEVICE - Device is the initiator of the transaction.
923
- * @example CONSUMER
924
- * @enum {string}
925
- */
926
- TransactionInitiatorType: "CONSUMER" | "AGENT" | "BUSINESS" | "DEVICE";
927
- /**
928
- * RefundReason
929
- * @description Reason for the refund.
930
- * @example Free text indicating reason for the refund.
931
- */
932
- RefundReason: string;
933
- /**
934
- * Refund
935
- * @description Data model for the complex type Refund.
936
- */
937
- Refund: {
938
- originalTransactionId: components["schemas"]["CorrelationId"];
939
- refundReason?: components["schemas"]["RefundReason"];
940
- };
941
- /**
942
- * BalanceOfPayments
943
- * @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.
944
- * @example 123
945
- */
946
- BalanceOfPayments: string;
947
- /**
948
- * TransactionType
949
- * @description Data model for the complex type TransactionType.
950
- */
951
- TransactionType: {
952
- scenario: components["schemas"]["TransactionScenario"];
953
- subScenario?: components["schemas"]["TransactionSubScenario"];
954
- initiator: components["schemas"]["TransactionInitiator"];
955
- initiatorType: components["schemas"]["TransactionInitiatorType"];
956
- refundInfo?: components["schemas"]["Refund"];
957
- balanceOfPayments?: components["schemas"]["BalanceOfPayments"];
958
- };
959
- /**
960
- * Note
961
- * @description Memo assigned to transaction.
962
- * @example Note sent to Payee.
963
- */
964
- Note: string;
965
- /**
966
- * Transaction
967
- * @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.
968
- */
969
- Transaction: {
970
- transactionId: components["schemas"]["CorrelationId"];
971
- quoteId: components["schemas"]["CorrelationId"];
972
- payee: components["schemas"]["Party"];
973
- payer: components["schemas"]["Party"];
974
- amount: components["schemas"]["Money"];
975
- payeeReceiveAmount?: components["schemas"]["Money"];
976
- converter?: components["schemas"]["CurrencyConverter"];
977
- currencyConversion?: components["schemas"]["FxRate"];
978
- transactionType: components["schemas"]["TransactionType"];
979
- note?: components["schemas"]["Note"];
980
- extensionList?: components["schemas"]["ExtensionList"];
981
- };
982
- /**
983
- * UndefinedEnum
984
- * @description The API data type UndefinedEnum is a JSON String consisting of 1 to 32 uppercase characters including an underscore character (_).
985
- */
986
- UndefinedEnum: string;
987
- /**
988
- * ErrorCode
989
- * @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.
990
- * @example 5100
991
- */
992
- ErrorCode: string;
993
- /**
994
- * ErrorDescription
995
- * @description Error description string.
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.
996
1135
  */
997
- ErrorDescription: string;
1136
+ OtpValue: string;
998
1137
  /**
999
- * ErrorInformation
1000
- * @description Data model for the complex type ErrorInformation.
1138
+ * ParticipantsIDPutResponse
1139
+ * @description The object sent in the PUT /participants/{ID} callback.
1001
1140
  */
1002
- ErrorInformation: {
1003
- errorCode: components["schemas"]["ErrorCode"];
1004
- errorDescription: components["schemas"]["ErrorDescription"];
1005
- extensionList?: components["schemas"]["ExtensionList"];
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"];
1006
1145
  };
1007
1146
  /**
1008
- * ErrorInformationResponse
1009
- * @description Data model for the complex type object that contains an optional element ErrorInformation used along with 4xx and 5xx responses.
1147
+ * ParticipantsPostRequest
1148
+ * @description The object sent in the POST /participants request.
1010
1149
  */
1011
- ErrorInformationResponse: {
1012
- errorInformation?: components["schemas"]["ErrorInformation"];
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"];
1013
1155
  };
1014
1156
  /**
1015
1157
  * ParticipantsTypeIDPutResponse
@@ -1027,40 +1169,6 @@ export interface components {
1027
1169
  currency?: components["schemas"]["Currency"];
1028
1170
  extensionList?: components["schemas"]["ExtensionList"];
1029
1171
  };
1030
- /**
1031
- * ErrorInformationObject
1032
- * @description Data model for the complex type object that contains ErrorInformation.
1033
- */
1034
- ErrorInformationObject: {
1035
- errorInformation: components["schemas"]["ErrorInformation"];
1036
- };
1037
- /**
1038
- * ParticipantsPostRequest
1039
- * @description The object sent in the POST /participants request.
1040
- */
1041
- ParticipantsPostRequest: {
1042
- requestId: components["schemas"]["CorrelationId"];
1043
- /** @description List of PartyIdInfo elements that the client would like to update or create FSP information about. */
1044
- partyList: components["schemas"]["PartyIdInfo"][];
1045
- currency?: components["schemas"]["Currency"];
1046
- };
1047
- /**
1048
- * PartyResult
1049
- * @description Data model for the complex type PartyResult.
1050
- */
1051
- PartyResult: {
1052
- partyId: components["schemas"]["PartyIdInfo"];
1053
- errorInformation?: components["schemas"]["ErrorInformation"];
1054
- };
1055
- /**
1056
- * ParticipantsIDPutResponse
1057
- * @description The object sent in the PUT /participants/{ID} callback.
1058
- */
1059
- ParticipantsIDPutResponse: {
1060
- /** @description List of PartyResult elements that were either created or failed to be created. */
1061
- partyList: components["schemas"]["PartyResult"][];
1062
- currency?: components["schemas"]["Currency"];
1063
- };
1064
1172
  /**
1065
1173
  * PartiesTypeIDPutResponse
1066
1174
  * @description The object sent in the PUT /parties/{Type}/{ID} callback.
@@ -1069,479 +1177,367 @@ export interface components {
1069
1177
  party: components["schemas"]["Party"];
1070
1178
  };
1071
1179
  /**
1072
- * Latitude
1073
- * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
1074
- * @example +45.4215
1075
- */
1076
- Latitude: string;
1077
- /**
1078
- * Longitude
1079
- * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
1080
- * @example +75.6972
1081
- */
1082
- Longitude: string;
1083
- /**
1084
- * GeoCode
1085
- * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
1086
- */
1087
- GeoCode: {
1088
- latitude: components["schemas"]["Latitude"];
1089
- longitude: components["schemas"]["Longitude"];
1090
- };
1091
- /**
1092
- * AuthenticationType
1093
- * @description Below are the allowed values for the enumeration AuthenticationType.
1094
- * - OTP - One-time password generated by the Payer FSP.
1095
- * - QRCODE - QR code used as One Time Password.
1096
- * - U2F - U2F is a new addition isolated to Thirdparty stream.
1097
- * @example OTP
1098
- * @enum {string}
1099
- */
1100
- AuthenticationType: "OTP" | "QRCODE" | "U2F";
1101
- /**
1102
- * DateTime
1103
- * @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).
1104
- * @example 2016-05-24T08:38:08.699-04:00
1105
- */
1106
- DateTime: string;
1107
- /**
1108
- * TransactionRequestsPostRequest
1109
- * @description The object sent in the POST /transactionRequests request.
1110
- */
1111
- TransactionRequestsPostRequest: {
1112
- transactionRequestId: components["schemas"]["CorrelationId"];
1113
- payee: components["schemas"]["Party"];
1114
- payer: components["schemas"]["PartyIdInfo"];
1115
- amount: components["schemas"]["Money"];
1116
- transactionType: components["schemas"]["TransactionType"];
1117
- note?: components["schemas"]["Note"];
1118
- geoCode?: components["schemas"]["GeoCode"];
1119
- authenticationType?: components["schemas"]["AuthenticationType"];
1120
- expiration?: components["schemas"]["DateTime"];
1121
- extensionList?: components["schemas"]["ExtensionList"];
1122
- };
1123
- /**
1124
- * TransactionRequestState
1125
- * @description Below are the allowed values for the enumeration.
1126
- * - RECEIVED - Payer FSP has received the transaction from the Payee FSP.
1127
- * - PENDING - Payer FSP has sent the transaction request to the Payer.
1128
- * - ACCEPTED - Payer has approved the transaction.
1129
- * - REJECTED - Payer has rejected the transaction.
1130
- * @example RECEIVED
1131
- * @enum {string}
1132
- */
1133
- TransactionRequestState: "RECEIVED" | "PENDING" | "ACCEPTED" | "REJECTED";
1134
- /**
1135
- * TransactionRequestsIDPutResponse
1136
- * @description The object sent in the PUT /transactionRequests/{ID} callback.
1137
- */
1138
- TransactionRequestsIDPutResponse: {
1139
- transactionId?: components["schemas"]["CorrelationId"];
1140
- transactionRequestState: components["schemas"]["TransactionRequestState"];
1141
- extensionList?: components["schemas"]["ExtensionList"];
1142
- };
1143
- /**
1144
- * AmountType
1145
- * @description Below are the allowed values for the enumeration AmountType.
1146
- * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
1147
- * - 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.
1148
- * @example RECEIVE
1149
- * @enum {string}
1150
- */
1151
- AmountType: "SEND" | "RECEIVE";
1152
- /**
1153
- * QuotesPostRequest
1154
- * @description The object sent in the POST /quotes request.
1155
- */
1156
- QuotesPostRequest: {
1157
- quoteId: components["schemas"]["CorrelationId"];
1158
- transactionId: components["schemas"]["CorrelationId"];
1159
- transactionRequestId?: components["schemas"]["CorrelationId"];
1160
- payee: components["schemas"]["Party"];
1161
- payer: components["schemas"]["Party"];
1162
- amountType: components["schemas"]["AmountType"];
1163
- amount: components["schemas"]["Money"];
1164
- fees?: components["schemas"]["Money"];
1165
- transactionType: components["schemas"]["TransactionType"];
1166
- converter?: components["schemas"]["CurrencyConverter"];
1167
- currencyConversion?: components["schemas"]["FxRate"];
1168
- geoCode?: components["schemas"]["GeoCode"];
1169
- note?: components["schemas"]["Note"];
1170
- expiration?: components["schemas"]["DateTime"];
1171
- extensionList?: components["schemas"]["ExtensionList"];
1172
- };
1173
- /**
1174
- * IlpPacket
1175
- * @description Information for recipient (transport layer information).
1176
- * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
1177
- */
1178
- IlpPacket: string;
1179
- /**
1180
- * IlpCondition
1181
- * @description Condition that must be attached to the transfer by the Payer.
1182
- */
1183
- IlpCondition: string;
1184
- /**
1185
- * QuotesIDPutResponse
1186
- * @description The object sent in the PUT /quotes/{ID} callback.
1187
- */
1188
- QuotesIDPutResponse: {
1189
- transferAmount: components["schemas"]["Money"];
1190
- payeeReceiveAmount?: components["schemas"]["Money"];
1191
- payeeFspFee?: components["schemas"]["Money"];
1192
- payeeFspCommission?: components["schemas"]["Money"];
1193
- expiration: components["schemas"]["DateTime"];
1194
- geoCode?: components["schemas"]["GeoCode"];
1195
- ilpPacket: components["schemas"]["IlpPacket"];
1196
- condition: components["schemas"]["IlpCondition"];
1197
- extensionList?: components["schemas"]["ExtensionList"];
1198
- };
1199
- /**
1200
- * OtpValue
1201
- * @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.
1202
- */
1203
- OtpValue: string;
1204
- /**
1205
- * QRCODE
1206
- * @description QR code used as a One Time Password.
1207
- */
1208
- QRCODE: string;
1209
- /**
1210
- * U2FPIN
1211
- * @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
1212
- */
1213
- U2FPIN: string;
1214
- /**
1215
- * U2FPinValue
1216
- * @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
1217
- */
1218
- U2FPinValue: {
1219
- /** @description U2F challenge-response. */
1220
- pinValue: components["schemas"]["U2FPIN"];
1221
- /** @description Sequential counter used for cloning detection. Present only for U2F authentication. */
1222
- counter: components["schemas"]["Integer"];
1223
- };
1224
- /**
1225
- * AuthenticationValue
1226
- * @description Contains the authentication value. The format depends on the authentication type used in the AuthenticationInfo complex type.
1227
- */
1228
- AuthenticationValue: components["schemas"]["OtpValue"] | components["schemas"]["QRCODE"] | components["schemas"]["U2FPinValue"];
1229
- /**
1230
- * AuthenticationInfo
1231
- * @description Data model for the complex type AuthenticationInfo.
1232
- */
1233
- AuthenticationInfo: {
1234
- authentication: components["schemas"]["AuthenticationType"];
1235
- authenticationValue: components["schemas"]["AuthenticationValue"];
1236
- };
1237
- /**
1238
- * AuthorizationResponse
1239
- * @description Below are the allowed values for the enumeration.
1240
- * - ENTERED - Consumer entered the authentication value.
1241
- * - REJECTED - Consumer rejected the transaction.
1242
- * - RESEND - Consumer requested to resend the authentication value.
1243
- * @example ENTERED
1244
- * @enum {string}
1245
- */
1246
- AuthorizationResponse: "ENTERED" | "REJECTED" | "RESEND";
1247
- /**
1248
- * AuthorizationsIDPutResponse
1249
- * @description The object sent in the PUT /authorizations/{ID} callback.
1180
+ * Party
1181
+ * @description Data model for the complex type Party.
1250
1182
  */
1251
- AuthorizationsIDPutResponse: {
1252
- authenticationInfo?: components["schemas"]["AuthenticationInfo"];
1253
- responseType: components["schemas"]["AuthorizationResponse"];
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"][];
1254
1190
  };
1255
1191
  /**
1256
- * TransfersPostRequest
1257
- * @description The object sent in the POST /transfers request.
1192
+ * PartyComplexName
1193
+ * @description Data model for the complex type PartyComplexName.
1258
1194
  */
1259
- TransfersPostRequest: {
1260
- transferId: components["schemas"]["CorrelationId"];
1261
- payeeFsp: components["schemas"]["FspId"];
1262
- payerFsp: components["schemas"]["FspId"];
1263
- amount: components["schemas"]["Money"];
1264
- ilpPacket: components["schemas"]["IlpPacket"];
1265
- condition: components["schemas"]["IlpCondition"];
1266
- expiration: components["schemas"]["DateTime"];
1267
- extensionList?: components["schemas"]["ExtensionList"];
1195
+ PartyComplexName: {
1196
+ firstName?: components["schemas"]["FirstName"];
1197
+ middleName?: components["schemas"]["MiddleName"];
1198
+ lastName?: components["schemas"]["LastName"];
1268
1199
  };
1269
1200
  /**
1270
- * IlpFulfilment
1271
- * @description Fulfilment that must be attached to the transfer by the Payee.
1272
- * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
1201
+ * PartyIdInfo
1202
+ * @description Data model for the complex type PartyIdInfo. An ExtensionList element has been added to this reqeust in version v1.1
1273
1203
  */
1274
- IlpFulfilment: string;
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
+ };
1275
1211
  /**
1276
- * TransferState
1212
+ * PartyIdType
1277
1213
  * @description Below are the allowed values for the enumeration.
1278
- * - RECEIVED - Next ledger has received the transfer.
1279
- * - RESERVED - Next ledger has reserved the transfer.
1280
- * - COMMITTED - Next ledger has successfully performed the transfer.
1281
- * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
1282
- * @example RESERVED
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.
1283
1222
  * @enum {string}
1284
1223
  */
1285
- TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
1224
+ PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
1286
1225
  /**
1287
- * TransfersIDPutResponse
1288
- * @description The object sent in the PUT /transfers/{ID} callback.
1226
+ * PartyIdentifier
1227
+ * @description Identifier of the Party.
1228
+ * @example 16135551212
1289
1229
  */
1290
- TransfersIDPutResponse: {
1291
- fulfilment?: components["schemas"]["IlpFulfilment"];
1292
- completedTimestamp?: components["schemas"]["DateTime"];
1293
- transferState: components["schemas"]["TransferState"];
1294
- extensionList?: components["schemas"]["ExtensionList"];
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"];
1295
1244
  };
1296
1245
  /**
1297
- * TransfersIDPatchResponse
1298
- * @description PATCH /transfers/{ID} object
1246
+ * PartyResult
1247
+ * @description Data model for the complex type PartyResult.
1299
1248
  */
1300
- TransfersIDPatchResponse: {
1301
- completedTimestamp: components["schemas"]["DateTime"];
1302
- transferState: components["schemas"]["TransferState"];
1303
- extensionList?: components["schemas"]["ExtensionList"];
1249
+ PartyResult: {
1250
+ partyId: components["schemas"]["PartyIdInfo"];
1251
+ errorInformation?: components["schemas"]["ErrorInformation"];
1304
1252
  };
1305
1253
  /**
1306
- * TransactionState
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
1307
1260
  * @description Below are the allowed values for the enumeration.
1308
- * - RECEIVED - Payee FSP has received the transaction from the Payer FSP.
1309
- * - PENDING - Payee FSP has validated the transaction.
1310
- * - COMPLETED - Payee FSP has successfully performed the transaction.
1311
- * - REJECTED - Payee FSP has failed to perform the transaction.
1312
- * @example RECEIVED
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.
1313
1274
  * @enum {string}
1314
1275
  */
1315
- TransactionState: "RECEIVED" | "PENDING" | "COMPLETED" | "REJECTED";
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";
1316
1277
  /**
1317
- * Code
1318
- * @description Any code/token returned by the Payee FSP (TokenCode Type).
1319
- * @example Test-Code
1278
+ * QRCODE
1279
+ * @description QR code used as a One Time Password.
1320
1280
  */
1321
- Code: string;
1281
+ QRCODE: string;
1322
1282
  /**
1323
- * TransactionsIDPutResponse
1324
- * @description The object sent in the PUT /transactions/{ID} callback.
1283
+ * QuotesIDPutResponse
1284
+ * @description The object sent in the PUT /quotes/{ID} callback.
1325
1285
  */
1326
- TransactionsIDPutResponse: {
1327
- completedTimestamp?: components["schemas"]["DateTime"];
1328
- transactionState: components["schemas"]["TransactionState"];
1329
- code?: components["schemas"]["Code"];
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"];
1330
1295
  extensionList?: components["schemas"]["ExtensionList"];
1331
1296
  };
1332
1297
  /**
1333
- * IndividualQuote
1334
- * @description Data model for the complex type IndividualQuote.
1298
+ * QuotesPostRequest
1299
+ * @description The object sent in the POST /quotes request.
1335
1300
  */
1336
- IndividualQuote: {
1301
+ QuotesPostRequest: {
1337
1302
  quoteId: components["schemas"]["CorrelationId"];
1338
1303
  transactionId: components["schemas"]["CorrelationId"];
1304
+ transactionRequestId?: components["schemas"]["CorrelationId"];
1339
1305
  payee: components["schemas"]["Party"];
1306
+ payer: components["schemas"]["Party"];
1340
1307
  amountType: components["schemas"]["AmountType"];
1341
1308
  amount: components["schemas"]["Money"];
1342
1309
  fees?: components["schemas"]["Money"];
1343
1310
  transactionType: components["schemas"]["TransactionType"];
1311
+ converter?: components["schemas"]["CurrencyConverter"];
1312
+ currencyConversion?: components["schemas"]["FxRate"];
1313
+ geoCode?: components["schemas"]["GeoCode"];
1344
1314
  note?: components["schemas"]["Note"];
1315
+ expiration?: components["schemas"]["DateTime"];
1345
1316
  extensionList?: components["schemas"]["ExtensionList"];
1346
1317
  };
1347
1318
  /**
1348
- * BulkQuotesPostRequest
1349
- * @description The object sent in the POST /bulkQuotes request.
1319
+ * Refund
1320
+ * @description Data model for the complex type Refund.
1350
1321
  */
1351
- BulkQuotesPostRequest: {
1352
- bulkQuoteId: components["schemas"]["CorrelationId"];
1353
- payer: components["schemas"]["Party"];
1354
- geoCode?: components["schemas"]["GeoCode"];
1355
- expiration?: components["schemas"]["DateTime"];
1356
- /** @description List of quotes elements. */
1357
- individualQuotes: components["schemas"]["IndividualQuote"][];
1358
- extensionList?: components["schemas"]["ExtensionList"];
1322
+ Refund: {
1323
+ originalTransactionId: components["schemas"]["CorrelationId"];
1324
+ refundReason?: components["schemas"]["RefundReason"];
1359
1325
  };
1360
1326
  /**
1361
- * IndividualQuoteResult
1362
- * @description Data model for the complex type IndividualQuoteResult.
1327
+ * RefundReason
1328
+ * @description Reason for the refund.
1329
+ * @example Free text indicating reason for the refund.
1363
1330
  */
1364
- IndividualQuoteResult: {
1365
- quoteId: components["schemas"]["CorrelationId"];
1366
- payee?: components["schemas"]["Party"];
1367
- transferAmount?: components["schemas"]["Money"];
1368
- payeeReceiveAmount?: components["schemas"]["Money"];
1369
- payeeFspFee?: components["schemas"]["Money"];
1370
- payeeFspCommission?: components["schemas"]["Money"];
1371
- ilpPacket?: components["schemas"]["IlpPacket"];
1372
- condition?: components["schemas"]["IlpCondition"];
1373
- errorInformation?: components["schemas"]["ErrorInformation"];
1374
- extensionList?: components["schemas"]["ExtensionList"];
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"][];
1375
1339
  };
1376
1340
  /**
1377
- * BulkQuotesIDPutResponse
1378
- * @description The object sent in the PUT /bulkQuotes/{ID} callback.
1341
+ * ServicesFXPSourceCurrencyTargetCurrencyPutResponse
1342
+ * @description The object sent in the PUT /services/FXP/{SourceCurrency}/{TargetCurrency} callback.
1379
1343
  */
1380
- BulkQuotesIDPutResponse: {
1381
- /** @description Fees for each individual transaction, if any of them are charged per transaction. */
1382
- individualQuoteResults?: components["schemas"]["IndividualQuoteResult"][];
1383
- expiration: components["schemas"]["DateTime"];
1384
- extensionList?: components["schemas"]["ExtensionList"];
1344
+ ServicesFXPSourceCurrencyTargetCurrencyPutResponse: {
1345
+ /** @description The FSP Id(s) of the participant(s) who offer currency conversion services. */
1346
+ providers: components["schemas"]["FspId"][];
1385
1347
  };
1386
1348
  /**
1387
- * IndividualTransfer
1388
- * @description Data model for the complex type IndividualTransfer.
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.
1389
1351
  */
1390
- IndividualTransfer: {
1391
- transferId: components["schemas"]["CorrelationId"];
1392
- transferAmount: components["schemas"]["Money"];
1393
- ilpPacket: components["schemas"]["IlpPacket"];
1394
- condition: components["schemas"]["IlpCondition"];
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"];
1395
1368
  extensionList?: components["schemas"]["ExtensionList"];
1396
1369
  };
1397
1370
  /**
1398
- * BulkTransfersPostRequest
1399
- * @description The object sent in the POST /bulkTransfers request.
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.
1400
1404
  */
1401
- BulkTransfersPostRequest: {
1402
- bulkTransferId: components["schemas"]["CorrelationId"];
1403
- bulkQuoteId: components["schemas"]["CorrelationId"];
1404
- payerFsp: components["schemas"]["FspId"];
1405
- payeeFsp: components["schemas"]["FspId"];
1406
- /** @description List of IndividualTransfer elements. */
1407
- individualTransfers: components["schemas"]["IndividualTransfer"][];
1408
- expiration: components["schemas"]["DateTime"];
1405
+ TransactionRequestsIDPutResponse: {
1406
+ transactionId?: components["schemas"]["CorrelationId"];
1407
+ transactionRequestState: components["schemas"]["TransactionRequestState"];
1409
1408
  extensionList?: components["schemas"]["ExtensionList"];
1410
1409
  };
1411
1410
  /**
1412
- * IndividualTransferResult
1413
- * @description Data model for the complex type IndividualTransferResult.
1411
+ * TransactionRequestsPostRequest
1412
+ * @description The object sent in the POST /transactionRequests request.
1414
1413
  */
1415
- IndividualTransferResult: {
1416
- transferId: components["schemas"]["CorrelationId"];
1417
- fulfilment?: components["schemas"]["IlpFulfilment"];
1418
- errorInformation?: components["schemas"]["ErrorInformation"];
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"];
1419
1424
  extensionList?: components["schemas"]["ExtensionList"];
1420
1425
  };
1421
1426
  /**
1422
- * BulkTransactionState
1427
+ * TransactionScenario
1423
1428
  * @description Below are the allowed values for the enumeration.
1424
- * - RECEIVED - Payee FSP has received the bulk transfer from the Payer FSP.
1425
- * - PENDING - Payee FSP has validated the bulk transfer.
1426
- * - ACCEPTED - Payee FSP has accepted to process the bulk transfer.
1427
- * - PROCESSING - Payee FSP has started to transfer fund to the Payees.
1428
- * - COMPLETED - Payee FSP has completed transfer of funds to the Payees.
1429
- * - REJECTED - Payee FSP has rejected to process the bulk transfer.
1430
- * @example RECEIVED
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
1431
1435
  * @enum {string}
1432
1436
  */
1433
- BulkTransferState: "RECEIVED" | "PENDING" | "ACCEPTED" | "PROCESSING" | "COMPLETED" | "REJECTED";
1437
+ TransactionScenario: "DEPOSIT" | "WITHDRAWAL" | "TRANSFER" | "PAYMENT" | "REFUND";
1434
1438
  /**
1435
- * BulkTransfersIDPutResponse
1436
- * @description The object sent in the PUT /bulkTransfers/{ID} callback.
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}
1437
1447
  */
1438
- BulkTransfersIDPutResponse: {
1439
- completedTimestamp?: components["schemas"]["DateTime"];
1440
- /** @description List of IndividualTransferResult elements. */
1441
- individualTransferResults?: components["schemas"]["IndividualTransferResult"][];
1442
- bulkTransferState: components["schemas"]["BulkTransferState"];
1443
- extensionList?: components["schemas"]["ExtensionList"];
1444
- };
1448
+ TransactionState: "RECEIVED" | "PENDING" | "COMPLETED" | "REJECTED";
1445
1449
  /**
1446
- * FxMoney
1447
- * @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.
1450
+ * TransactionSubScenario
1451
+ * @description Possible sub-scenario, defined locally within the scheme (UndefinedEnum Type).
1452
+ * @example LOCALLY_DEFINED_SUBSCENARIO
1448
1453
  */
1449
- FxMoney: {
1450
- currency: components["schemas"]["Currency"];
1451
- amount?: components["schemas"]["Amount"];
1452
- };
1454
+ TransactionSubScenario: string;
1453
1455
  /**
1454
- * FxCharge
1455
- * @description An FXP will be able to specify a charge which it proposes to levy on the currency conversion operation using a FxCharge object.
1456
+ * TransactionType
1457
+ * @description Data model for the complex type TransactionType.
1456
1458
  */
1457
- FxCharge: {
1458
- /** @description A description of the charge which is being levied. */
1459
- chargeType: string;
1460
- sourceAmount?: components["schemas"]["Money"];
1461
- targetAmount?: components["schemas"]["Money"];
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"];
1462
1466
  };
1463
1467
  /**
1464
- * FxConversion
1465
- * @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.
1468
+ * TransactionsIDPutResponse
1469
+ * @description The object sent in the PUT /transactions/{ID} callback.
1466
1470
  */
1467
- FxConversion: {
1468
- conversionId: components["schemas"]["CorrelationId"];
1469
- determiningTransferId?: components["schemas"]["CorrelationId"];
1470
- initiatingFsp: components["schemas"]["FspId"];
1471
- counterPartyFsp: components["schemas"]["FspId"];
1472
- amountType: components["schemas"]["AmountType"];
1473
- sourceAmount: components["schemas"]["FxMoney"];
1474
- targetAmount: components["schemas"]["FxMoney"];
1475
- expiration: components["schemas"]["DateTime"];
1476
- /** @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. */
1477
- charges?: components["schemas"]["FxCharge"][];
1471
+ TransactionsIDPutResponse: {
1472
+ completedTimestamp?: components["schemas"]["DateTime"];
1473
+ transactionState: components["schemas"]["TransactionState"];
1474
+ code?: components["schemas"]["Code"];
1478
1475
  extensionList?: components["schemas"]["ExtensionList"];
1479
1476
  };
1480
1477
  /**
1481
- * FxQuotesPostRequest
1482
- * @description The object sent in the POST /fxQuotes request.
1483
- */
1484
- FxQuotesPostRequest: {
1485
- conversionRequestId: components["schemas"]["CorrelationId"];
1486
- conversionTerms: components["schemas"]["FxConversion"];
1487
- };
1488
- /**
1489
- * FxQuotesIDPutResponse
1490
- * @description The object sent in the PUT /fxQuotes/{ID} callback.
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}
1491
1486
  */
1492
- FxQuotesIDPutResponse: {
1493
- condition?: components["schemas"]["IlpCondition"];
1494
- conversionTerms: components["schemas"]["FxConversion"];
1495
- };
1487
+ TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
1496
1488
  /**
1497
- * FxTransfersPostRequest
1498
- * @description The object sent in the POST /fxTransfers request.
1489
+ * TransfersIDPatchResponse
1490
+ * @description PATCH /transfers/{ID} object
1499
1491
  */
1500
- FxTransfersPostRequest: {
1501
- commitRequestId: components["schemas"]["CorrelationId"];
1502
- determiningTransferId?: components["schemas"]["CorrelationId"];
1503
- initiatingFsp: components["schemas"]["FspId"];
1504
- counterPartyFsp: components["schemas"]["FspId"];
1505
- sourceAmount: components["schemas"]["Money"];
1506
- targetAmount: components["schemas"]["Money"];
1507
- condition: components["schemas"]["IlpCondition"];
1508
- expiration?: components["schemas"]["DateTime"];
1492
+ TransfersIDPatchResponse: {
1493
+ completedTimestamp: components["schemas"]["DateTime"];
1494
+ transferState: components["schemas"]["TransferState"];
1495
+ extensionList?: components["schemas"]["ExtensionList"];
1509
1496
  };
1510
1497
  /**
1511
- * FxTransfersIDPutResponse
1512
- * @description The object sent in the PUT /fxTransfers/{ID} callback.
1498
+ * TransfersIDPutResponse
1499
+ * @description The object sent in the PUT /transfers/{ID} callback.
1513
1500
  */
1514
- FxTransfersIDPutResponse: {
1501
+ TransfersIDPutResponse: {
1515
1502
  fulfilment?: components["schemas"]["IlpFulfilment"];
1516
1503
  completedTimestamp?: components["schemas"]["DateTime"];
1517
- conversionState: components["schemas"]["TransferState"];
1504
+ transferState: components["schemas"]["TransferState"];
1518
1505
  extensionList?: components["schemas"]["ExtensionList"];
1519
1506
  };
1520
1507
  /**
1521
- * FxTransfersIDPatchResponse
1522
- * @description PATCH /fxTransfers/{ID} object
1508
+ * TransfersPostRequest
1509
+ * @description The object sent in the POST /transfers request.
1523
1510
  */
1524
- FxTransfersIDPatchResponse: {
1525
- completedTimestamp?: components["schemas"]["DateTime"];
1526
- conversionState: components["schemas"]["TransferState"];
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"];
1527
1519
  extensionList?: components["schemas"]["ExtensionList"];
1528
1520
  };
1529
1521
  /**
1530
- * ServicesFXPPutResponse
1531
- * @description The object sent in the PUT /services/FXP callback.
1522
+ * U2FPIN
1523
+ * @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
1532
1524
  */
1533
- ServicesFXPPutResponse: {
1534
- /** @description The FSP Id(s) of the participant(s) who offer currency conversion services. */
1535
- providers: components["schemas"]["FspId"][];
1536
- };
1525
+ U2FPIN: string;
1537
1526
  /**
1538
- * ServicesFXPSourceCurrencyTargetCurrencyPutResponse
1539
- * @description The object sent in the PUT /services/FXP/{SourceCurrency}/{TargetCurrency} callback.
1527
+ * U2FPinValue
1528
+ * @description U2F challenge-response, where payer FSP verifies if the response provided by end-user device matches the previously registered key.
1540
1529
  */
1541
- ServicesFXPSourceCurrencyTargetCurrencyPutResponse: {
1542
- /** @description The FSP Id(s) of the participant(s) who offer currency conversion services. */
1543
- providers: components["schemas"]["FspId"][];
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"];
1544
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;
1545
1541
  };
1546
1542
  responses: {
1547
1543
  /** @description OK */
@@ -1634,46 +1630,46 @@ export interface components {
1634
1630
  };
1635
1631
  };
1636
1632
  parameters: {
1637
- /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
1638
- Type: string;
1639
- /** @description The identifier value. */
1640
- ID: string;
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
1641
  /** @description The `Content-Type` header indicates the specific version of the API used to send the payload body. */
1642
1642
  "Content-Type": string;
1643
1643
  /** @description The `Date` header field indicates the date when the request was sent. */
1644
1644
  Date: string;
1645
- /**
1646
- * @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.
1647
- *
1648
- * **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`.
1649
- */
1650
- "X-Forwarded-For"?: string;
1651
- /** @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`). */
1652
- "FSPIOP-Source": string;
1653
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. */
1654
1646
  "FSPIOP-Destination"?: string;
1655
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. */
1656
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;
1657
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. */
1658
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;
1659
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). */
1660
1656
  "FSPIOP-URI"?: string;
1661
- /** @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). */
1662
- "FSPIOP-HTTP-Method"?: string;
1663
- /** @description The `Accept` header field indicates the version of the API the client would like the server to use. */
1664
- Accept: string;
1665
- /**
1666
- * @description The `Content-Length` header field indicates the anticipated size of the payload body. Only sent if there is a body.
1667
- *
1668
- * **Note:** The API supports a maximum size of 5242880 bytes (5 Megabytes).
1669
- */
1670
- "Content-Length"?: number;
1671
- /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
1672
- SubId: string;
1657
+ /** @description The identifier value. */
1658
+ ID: string;
1673
1659
  /** @description ISO 4217 currency code for the source currency. */
1674
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;
1675
1663
  /** @description ISO 4217 currency code for the target currency. */
1676
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;
1677
1673
  };
1678
1674
  requestBodies: never;
1679
1675
  headers: {
@@ -1691,20 +1687,6 @@ export interface components {
1691
1687
  export type $defs = Record<string, never>;
1692
1688
  export type external = Record<string, never>;
1693
1689
  export interface operations {
1694
- /** @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. */
1695
- test: {
1696
- requestBody?: {
1697
- content: {
1698
- "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"];
1699
- };
1700
- };
1701
- responses: {
1702
- /** @description Ok */
1703
- 200: {
1704
- content: never;
1705
- };
1706
- };
1707
- };
1708
1690
  /**
1709
1691
  * Look up participant information
1710
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.