@mojaloop/api-snippets 17.0.2 → 17.0.3-snapshot.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.
@@ -661,32 +661,44 @@ export interface components {
661
661
  */
662
662
  Note: string;
663
663
  /**
664
- * IlpFulfilment
665
- * @description Fulfilment that must be attached to the transfer by the Payee.
666
- * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
664
+ * Money
665
+ * @description Data model for the complex type Money.
667
666
  */
668
- IlpFulfilment: string;
667
+ Money: {
668
+ currency: components["schemas"]["Currency"];
669
+ amount: components["schemas"]["Amount"];
670
+ };
669
671
  /**
670
- * TransferState
671
- * @description Below are the allowed values for the enumeration.
672
- * - RECEIVED - Next ledger has received the transfer.
673
- * - RESERVED - Next ledger has reserved the transfer.
674
- * - COMMITTED - Next ledger has successfully performed the transfer.
675
- * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
676
- * @example RESERVED
677
- * @enum {string}
672
+ * Latitude
673
+ * @description The API data type Latitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
674
+ * @example +45.4215
678
675
  */
679
- TransferState: "RECEIVED" | "RESERVED" | "COMMITTED" | "ABORTED";
676
+ Latitude: string;
680
677
  /**
681
- * TransfersIDPutResponse
682
- * @description The object sent in the PUT /transfers/{ID} callback.
678
+ * Longitude
679
+ * @description The API data type Longitude is a JSON String in a lexical format that is restricted by a regular expression for interoperability reasons.
680
+ * @example +75.6972
683
681
  */
684
- TransfersIDPutResponse: {
685
- fulfilment?: components["schemas"]["IlpFulfilment"];
686
- completedTimestamp?: components["schemas"]["DateTime"];
687
- transferState: components["schemas"]["TransferState"];
688
- extensionList?: components["schemas"]["ExtensionList"];
682
+ Longitude: string;
683
+ /**
684
+ * GeoCode
685
+ * @description Data model for the complex type GeoCode. Indicates the geographic location from where the transaction was initiated.
686
+ */
687
+ GeoCode: {
688
+ latitude: components["schemas"]["Latitude"];
689
+ longitude: components["schemas"]["Longitude"];
689
690
  };
691
+ /**
692
+ * IlpPacket
693
+ * @description Information for recipient (transport layer information).
694
+ * @example AYIBgQAAAAAAAASwNGxldmVsb25lLmRmc3AxLm1lci45T2RTOF81MDdqUUZERmZlakgyOVc4bXFmNEpLMHlGTFGCAUBQU0svMS4wCk5vbmNlOiB1SXlweUYzY3pYSXBFdzVVc05TYWh3CkVuY3J5cHRpb246IG5vbmUKUGF5bWVudC1JZDogMTMyMzZhM2ItOGZhOC00MTYzLTg0NDctNGMzZWQzZGE5OGE3CgpDb250ZW50LUxlbmd0aDogMTM1CkNvbnRlbnQtVHlwZTogYXBwbGljYXRpb24vanNvbgpTZW5kZXItSWRlbnRpZmllcjogOTI4MDYzOTEKCiJ7XCJmZWVcIjowLFwidHJhbnNmZXJDb2RlXCI6XCJpbnZvaWNlXCIsXCJkZWJpdE5hbWVcIjpcImFsaWNlIGNvb3BlclwiLFwiY3JlZGl0TmFtZVwiOlwibWVyIGNoYW50XCIsXCJkZWJpdElkZW50aWZpZXJcIjpcIjkyODA2MzkxXCJ9IgA
695
+ */
696
+ IlpPacket: string;
697
+ /**
698
+ * IlpCondition
699
+ * @description Condition that must be attached to the transfer by the Payer.
700
+ */
701
+ IlpCondition: string;
690
702
  /**
691
703
  * ErrorCode
692
704
  * @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.
@@ -710,6 +722,33 @@ export interface components {
710
722
  mojaloopError: {
711
723
  errorInformation?: components["schemas"]["ErrorInformation"];
712
724
  };
725
+ /** @description This object represents a Mojaloop API error received at any time during the quote process */
726
+ quoteError: {
727
+ /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
728
+ httpStatusCode?: number;
729
+ /** @description If a quote process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object. */
730
+ mojaloopError?: components["schemas"]["mojaloopError"];
731
+ };
732
+ individualQuoteResult: {
733
+ quoteId: components["schemas"]["CorrelationId"];
734
+ transferAmount: components["schemas"]["Money"];
735
+ payeeReceiveAmount?: components["schemas"]["Money"];
736
+ payeeFspFee?: components["schemas"]["Money"];
737
+ payeeFspCommission?: components["schemas"]["Money"];
738
+ geoCode?: components["schemas"]["GeoCode"];
739
+ ilpPacket: components["schemas"]["IlpPacket"];
740
+ condition: components["schemas"]["IlpCondition"];
741
+ /** @description Optional extension, specific to deployment. */
742
+ extensionList?: components["schemas"]["ExtensionList"];
743
+ /** @description Object representing the last error to occur during a quote process. This may be a Mojaloop API error returned from another entity in the scheme or an object representing other types of error e.g. exceptions that may occur inside the scheme adapter. */
744
+ lastError?: components["schemas"]["quoteError"];
745
+ };
746
+ /**
747
+ * IlpFulfilment
748
+ * @description Fulfilment that must be attached to the transfer by the Payee.
749
+ * @example WLctttbu2HvTsa1XWvUoGRcQozHsqeu9Ahl2JW9Bsu8
750
+ */
751
+ IlpFulfilment: string;
713
752
  /** @description This object represents a Mojaloop API error received at any time during the transfer process */
714
753
  transferError: {
715
754
  /** @description The HTTP status code returned to the caller. This is the same as the actual HTTP status code returned with the response. */
@@ -717,6 +756,14 @@ export interface components {
717
756
  /** @description If a transfer process results in an error callback during the asynchronous Mojaloop API exchange, this property will contain the underlying Mojaloop API error object. */
718
757
  mojaloopError?: components["schemas"]["mojaloopError"];
719
758
  };
759
+ individualTransferResult: {
760
+ transferId: components["schemas"]["CorrelationId"];
761
+ /** @description Fulfilment of the condition specified with the transaction. Mandatory if transfer has completed successfully. */
762
+ fulfilment?: components["schemas"]["IlpFulfilment"];
763
+ /** @description Optional extension, specific to deployment. */
764
+ extensionList?: components["schemas"]["ExtensionList"];
765
+ lastError?: components["schemas"]["transferError"];
766
+ };
720
767
  bulkTransactionIndividualTransferResult: {
721
768
  transferId?: components["schemas"]["CorrelationId"];
722
769
  /** @description Transaction ID from the DFSP backend, used to reconcile transactions between the Switch and DFSP backend systems. */
@@ -730,10 +777,8 @@ export interface components {
730
777
  amount?: components["schemas"]["Amount"];
731
778
  note?: components["schemas"]["Note"];
732
779
  quoteId?: components["schemas"]["CorrelationId"];
733
- quoteResponse?: {
734
- [key: string]: unknown;
735
- };
736
- fulfil?: components["schemas"]["TransfersIDPutResponse"];
780
+ quoteResponse?: components["schemas"]["individualQuoteResult"];
781
+ fulfil?: components["schemas"]["individualTransferResult"];
737
782
  quoteExtensions?: components["schemas"]["ExtensionList"];
738
783
  transferExtensions?: components["schemas"]["ExtensionList"];
739
784
  lastError?: components["schemas"]["transferError"];