@mojaloop/api-snippets 17.6.0-snapshot.2 → 17.6.0

package/lib/sdk-scheme-adapter/v2_1_0/backend/openapi.d.ts

@@ -4,90 +4,291 @@
  */
 export interface paths {
     "/": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
         /** Health check endpoint. */
         get: operations["BackendHealthCheck"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/bulkQuotes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
         /** Requests a bulk quote. */
         post: operations["BackendBulkQuotesPost"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/bulkQuotes/{idValue}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
         /** Requests information relating to a bulk quote identified by the specified identifier value. */
         get: operations["BackendBulkQuotesGet"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/bulkTransactions/{bulkTransactionId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
         /**
          * Callbacks for the bulk transaction request.
          * @description The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to amend information regarding a bulk transaction, i.e. when autoAcceptParty or autoAcceptQuote  is false then the payer need to provide confirmation to proceed with further processing of the request. The `{bulkTransactionId}` in the URI should contain the `bulkTransactionId` that was used for the creation of the bulk transfer.
          */
         put: operations["BackendBulkTransactionsPut"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/requestToPay/{transactionRequestId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
         /**
          * Callback for the requestToPay request.
          * @description It is used to notify the DFSP backend about the status of the requestToPayTransfer.
          */
         put: operations["RequestToPayPut"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/bulkTransfers": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
         /** Execute bulk transfer of funds from an external account to internal accounts. */
         post: operations["BackendBulkTransfersPost"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/bulkTransfers/{idValue}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
         /** Requests information relating to a bulk transfer identified by the specified identifier value. */
         get: operations["BackendBulkTransfersGet"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/otp/{transactionRequestId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
         /** Requests OTP. */
         get: operations["BackendOtpGet"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/participants/{idType}/{idValue}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
         /**
          * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value.
          * @description The HTTP request `GET /participants/{idType}/{idValue}` is used to find out in which FSP the requested party, defined by `{idType}` and `{idValue}`, is located.
          */
         get: operations["BackendParticipantsGetByTypeAndID"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/participants/{idType}/{idValue}/{idSubValue}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
         /**
          * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value.
          * @description The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is used to find out in which FSP the requested party, defined by `{idType}`, `{idValue}` and `{idSubValue}` is located.
          */
         get: operations["BackendParticipantsGetByTypeIDAndSubId"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/parties/{idType}/{idValue}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
         /**
          * Requests information relating to a transfer party identified by the specified identifier type and value.
          * @description The HTTP request `GET /parties/{idType}/{idValue}` is used to look up information regarding the requested transfer party, identified by `{idType}` and `{idValue}`.
          */
         get: operations["BackendPartiesGetByTypeAndID"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/parties/{idType}/{idValue}/{idSubValue}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
         /**
          * Requests information relating to a transfer party identified by the specified identifier type, value and subId value.
          * @description The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used to look up information regarding the requested transfer party, identified by `{idType}`, `{idValue}` and `{idSubValue}`.
          */
         get: operations["BackendPartiesGetByTypeIdAndSubId"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/quoterequests": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
         /**
          * Requests a quote for the specified transfer.
          * @description The HTTP request `POST /quoterequests` is used to request the creation of a quote for the provided financial transaction.
          */
         post: operations["BackendQuoteRequest"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/transactionrequests": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
         /** Transaction request that supports pull based transfers. */
         post: operations["BackendTransactionRequest"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/transfers": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
         /**
          * Transfers funds from an external account to an internal account.
          * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the transfer party.
          */
         post: operations["BackendTransfersPost"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/transfers/{transferId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
         /**
          * Retrieves information for a specific transfer.
          * @description The HTTP request `GET /transfers/{transferId}` is used to get information regarding a transfer created or requested earlier. The `{transferId}` in the URI should contain the `transferId` that was used for the creation of the transfer.
@@ -98,27 +299,72 @@ export interface paths {
          * @description The HTTP request `PUT /transfers/{transferId}` is used to receive notification for transfer being fulfiled when the FSP is a Payee.
          */
         put: operations["BackendTransfersPut"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/fxQuotes": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
         /**
          * Calculate FX quote
          * @description The HTTP request `POST /fxQuotes` is used to ask an FXP backend to provide a quotation for a currency conversion.
          */
         post: operations["FxQuotesPost"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/fxTransfers": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
         /**
          * Perform FX transfer
          * @description The HTTP request `POST /fxTransfers` is used to ask an FXP backend to confirm the execution of an agreed currency conversion.
          */
         post: operations["FxTransfersPost"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
     "/fxTransfers/{commitRequestId}": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
         /**
          * FX Commit Notification
          * @description The HTTP request `PUT /fxTransfers/{commitRequestId}` is used to notify an FXP backend about the status of currency conversion.
          */
         put: operations["FxTransfersById"];
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
     };
 }
 export type webhooks = Record<string, never>;
@@ -259,6 +505,7 @@ export interface components {
         /**
          * ErrorCode
          * @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) represents the specific error.
+         *
          */
         errorCode: string;
         /**
@@ -391,8 +638,8 @@ export interface components {
             transactionId: components["schemas"]["transactionId"];
             transactionType: components["schemas"]["transactionType"];
             transactionRequestId?: components["schemas"]["transactionRequestId"];
-            converter?: components["schemas"]["CurrencyConverter"];
-            currencyConversion?: components["schemas"]["FxRate"];
+            converter?: components["schemas"]["CurrencyConverter"] & unknown;
+            currencyConversion?: components["schemas"]["FxRate"] & unknown;
         };
         /** @description A response to a request for a quote. */
         quoteResponse: {
@@ -544,32 +791,32 @@ export interface components {
          * KYCInformation
          * @description KYC information for the party in a form mandated by an individual scheme.
          * @example {
-         *     "metadata": {
-         *         "format": "JSON",
-         *         "version": "1.0",
-         *         "description": "Data containing KYC Information"
-         *     },
-         *     "data": {
-         *         "name": "John Doe",
-         *         "dob": "1980-05-15",
-         *         "gender": "Male",
-         *         "address": "123 Main Street, Anytown, USA",
-         *         "email": "johndoe@example.com",
-         *         "phone": "+1 555-123-4567",
-         *         "nationality": "US",
-         *         "passport_number": "AB1234567",
-         *         "issue_date": "2010-02-20",
-         *         "expiry_date": "2025-02-20",
-         *         "bank_account_number": "1234567890",
-         *         "bank_name": "Example Bank",
-         *         "employer": "ABC Company",
-         *         "occupation": "Software Engineer",
-         *         "income": "$80,000 per year",
-         *         "marital_status": "Single",
-         *         "dependents": 0,
-         *         "risk_level": "Low"
+         *         "metadata": {
+         *             "format": "JSON",
+         *             "version": "1.0",
+         *             "description": "Data containing KYC Information"
+         *         },
+         *         "data": {
+         *             "name": "John Doe",
+         *             "dob": "1980-05-15",
+         *             "gender": "Male",
+         *             "address": "123 Main Street, Anytown, USA",
+         *             "email": "johndoe@example.com",
+         *             "phone": "+1 555-123-4567",
+         *             "nationality": "US",
+         *             "passport_number": "AB1234567",
+         *             "issue_date": "2010-02-20",
+         *             "expiry_date": "2025-02-20",
+         *             "bank_account_number": "1234567890",
+         *             "bank_name": "Example Bank",
+         *             "employer": "ABC Company",
+         *             "occupation": "Software Engineer",
+         *             "income": "$80,000 per year",
+         *             "marital_status": "Single",
+         *             "dependents": 0,
+         *             "risk_level": "Low"
+         *         }
          *     }
-         * }
          */
         KYCInformation: string;
         /**
@@ -579,10 +826,9 @@ export interface components {
          */
         TransactionSubScenario: string;
         errorResponse: {
-            /**
-             * @description Backend error code from FSP. Ideally, statusCode is FSPIOP conforming. SDK will use status code to retrieve an FSPIOP error with the same code.
-             * Otherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message.
-             */
+            /** @description Backend error code from FSP. Ideally, statusCode is FSPIOP conforming. SDK will use status code to retrieve an FSPIOP error with the same code.
+             *     Otherwise, a suitable generic FSPIOP will be used with the errorResponse in the FSPIOP error message.
+             *      */
             statusCode?: string;
             /** @description Error message text. */
             message?: string;
@@ -641,14 +887,14 @@ export interface components {
         /**
          * PartyIdType
          * @description Below are the allowed values for the enumeration.
-         * - 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.
-         * - 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).
-         * - 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.
-         * - 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.
-         * - 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.
-         * - 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.
-         * - 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.
-         * - 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.
+         *     - 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.
+         *     - 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).
+         *     - 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.
+         *     - 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.
+         *     - 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.
+         *     - 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.
+         *     - 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.
+         *     - 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.
          * @enum {string}
          */
         PartyIdType: "MSISDN" | "EMAIL" | "PERSONAL_ID" | "BUSINESS" | "DEVICE" | "ACCOUNT_ID" | "IBAN" | "ALIAS";
@@ -738,8 +984,8 @@ export interface components {
         /**
          * AmountType
          * @description Below are the allowed values for the enumeration AmountType.
-         * - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
-         * - 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.
+         *     - SEND - Amount the Payer would like to send, that is, the amount that should be withdrawn from the Payer account including any fees.
+         *     - 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.
          * @example RECEIVE
          * @enum {string}
          */
@@ -839,10 +1085,10 @@ export interface components {
         /**
          * TransferState
          * @description Below are the allowed values for the enumeration.
-         * - RECEIVED - Next ledger has received the transfer.
-         * - RESERVED - Next ledger has reserved the transfer.
-         * - COMMITTED - Next ledger has successfully performed the transfer.
-         * - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
+         *     - RECEIVED - Next ledger has received the transfer.
+         *     - RESERVED - Next ledger has reserved the transfer.
+         *     - COMMITTED - Next ledger has successfully performed the transfer.
+         *     - ABORTED - Next ledger has aborted the transfer due to a rejection or failure to perform the transfer.
          * @example RESERVED
          * @enum {string}
          */
@@ -901,15 +1147,15 @@ export interface components {
          * @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.
          */
         FxRate: {
-            sourceAmount: components["schemas"]["Money"];
-            targetAmount: components["schemas"]["Money"];
+            sourceAmount: components["schemas"]["Money"] & unknown;
+            targetAmount: components["schemas"]["Money"] & unknown;
         };
         /**
          * AuthenticationType
          * @description Below are the allowed values for the enumeration AuthenticationType.
-         * - OTP - One-time password generated by the Payer FSP.
-         * - QRCODE - QR code used as One Time Password.
-         * - U2F - U2F is a new addition isolated to Thirdparty stream.
+         *     - OTP - One-time password generated by the Payer FSP.
+         *     - QRCODE - QR code used as One Time Password.
+         *     - U2F - U2F is a new addition isolated to Thirdparty stream.
          * @example OTP
          * @enum {string}
          */
@@ -929,33 +1175,33 @@ export interface components {
         FxCharge: {
             /** @description A description of the charge which is being levied. */
             chargeType: string;
-            sourceAmount?: components["schemas"]["Money"];
-            targetAmount?: components["schemas"]["Money"];
+            sourceAmount?: components["schemas"]["Money"] & unknown;
+            targetAmount?: components["schemas"]["Money"] & unknown;
         };
         /**
          * FxConversion
          * @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.
          */
         FxConversion: {
-            conversionId: components["schemas"]["CorrelationId"];
-            determiningTransferId?: components["schemas"]["CorrelationId"];
-            initiatingFsp: components["schemas"]["FspId"];
-            counterPartyFsp: components["schemas"]["FspId"];
-            amountType: components["schemas"]["AmountType"];
-            sourceAmount: components["schemas"]["FxMoney"];
-            targetAmount: components["schemas"]["FxMoney"];
-            expiration: components["schemas"]["DateTime"];
+            conversionId: components["schemas"]["CorrelationId"] & unknown;
+            determiningTransferId?: components["schemas"]["CorrelationId"] & unknown;
+            initiatingFsp: components["schemas"]["FspId"] & unknown;
+            counterPartyFsp: components["schemas"]["FspId"] & unknown;
+            amountType: components["schemas"]["AmountType"] & unknown;
+            sourceAmount: components["schemas"]["FxMoney"] & unknown;
+            targetAmount: components["schemas"]["FxMoney"] & unknown;
+            expiration: components["schemas"]["DateTime"] & unknown;
             /** @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. */
             charges?: components["schemas"]["FxCharge"][];
-            extensionList?: components["schemas"]["ExtensionList"];
+            extensionList?: components["schemas"]["ExtensionList"] & unknown;
         };
         /**
          * FxQuotesPostBackendRequest
          * @description The object sent in the POST /fxQuotes request.
          */
         FxQuotesPostBackendRequest: {
-            conversionRequestId: components["schemas"]["CorrelationId"];
-            conversionTerms: components["schemas"]["FxConversion"];
+            conversionRequestId: components["schemas"]["CorrelationId"] & unknown;
+            conversionTerms: components["schemas"]["FxConversion"] & unknown;
         };
         /**
          * FxQuotesPostBackendResponse
@@ -964,15 +1210,15 @@ export interface components {
         FxQuotesPostBackendResponse: {
             /** @description Transaction ID for the FXP backend, used to reconcile transactions between the Switch and FXP backend systems. */
             homeTransactionId?: string;
-            conversionTerms: components["schemas"]["FxConversion"];
+            conversionTerms: components["schemas"]["FxConversion"] & unknown;
         };
-        commitRequestId: components["schemas"]["CorrelationId"];
-        determiningTransferId: components["schemas"]["CorrelationId"];
-        initiatingFsp: components["schemas"]["FspId"];
-        counterPartyFsp: components["schemas"]["FspId"];
-        sourceAmount: components["schemas"]["Money"];
-        targetAmount: components["schemas"]["Money"];
-        condition: components["schemas"]["IlpCondition"];
+        commitRequestId: components["schemas"]["CorrelationId"] & unknown;
+        determiningTransferId: components["schemas"]["CorrelationId"] & unknown;
+        initiatingFsp: components["schemas"]["FspId"] & unknown;
+        counterPartyFsp: components["schemas"]["FspId"] & unknown;
+        sourceAmount: components["schemas"]["Money"] & unknown;
+        targetAmount: components["schemas"]["Money"] & unknown;
+        condition: components["schemas"]["IlpCondition"] & unknown;
         /**
          * FxTransfersPostBackendRequest
          * @description The object sent in the POST /fxTransfers request.
@@ -988,9 +1234,9 @@ export interface components {
             targetAmount: components["schemas"]["targetAmount"];
             condition?: components["schemas"]["condition"];
         };
-        fulfilment: components["schemas"]["IlpFulfilment"];
-        completedTimestamp: components["schemas"]["DateTime"];
-        conversionState: components["schemas"]["TransferState"];
+        fulfilment: components["schemas"]["IlpFulfilment"] & unknown;
+        completedTimestamp: components["schemas"]["DateTime"] & unknown;
+        conversionState: components["schemas"]["TransferState"] & unknown;
         /**
          * FxTransfersPostBackendResponse
          * @description The object sent as a response for the POST /fxTransfers request.
@@ -1019,22 +1265,34 @@ export interface components {
     responses: {
         /** @description OK */
         200: {
-            content: never;
+            headers: {
+                [name: string]: unknown;
+            };
+            content?: never;
         };
         /** @description Malformed or missing required headers or parameters. */
         400: {
+            headers: {
+                [name: string]: unknown;
+            };
             content: {
                 "application/json": components["schemas"]["errorResponse"];
             };
         };
         /** @description Not Found */
         404: {
+            headers: {
+                [name: string]: unknown;
+            };
             content: {
                 "application/json": components["schemas"]["errorResponse"];
             };
         };
         /** @description An error occurred processing the request. */
         500: {
+            headers: {
+                [name: string]: unknown;
+            };
             content: {
                 "application/json": components["schemas"]["errorResponse"];
             };
@@ -1057,19 +1315,32 @@ export interface components {
     pathItems: never;
 }
 export type $defs = Record<string, never>;
-export type external = Record<string, never>;
 export interface operations {
-    /** Health check endpoint. */
     BackendHealthCheck: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
         responses: {
             /** @description Returns empty body if the service is running. */
             200: {
-                content: never;
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
             };
         };
     };
-    /** Requests a bulk quote. */
     BackendBulkQuotesPost: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
         /** @description Incoming request for a bulk quotation. */
         requestBody?: {
             content: {
@@ -1079,6 +1350,9 @@ export interface operations {
         responses: {
             /** @description A response to the bulk quote request. */
             200: {
+                headers: {
+                    [name: string]: unknown;
+                };
                 content: {
                     "application/json": components["schemas"]["bulkQuoteResponse"];
                 };
@@ -1087,16 +1361,23 @@ export interface operations {
             500: components["responses"]["500"];
         };
     };
-    /** Requests information relating to a bulk quote identified by the specified identifier value. */
     BackendBulkQuotesGet: {
         parameters: {
+            query?: never;
+            header?: never;
             path: {
+                /** @description The identifier value. */
                 idValue: components["parameters"]["idValue"];
             };
+            cookie?: never;
         };
+        requestBody?: never;
         responses: {
             /** @description Response containing details of the requested bulk quote. */
             200: {
+                headers: {
+                    [name: string]: unknown;
+                };
                 content: {
                     "application/json": components["schemas"]["bulkQuoteResponse"];
                 };
@@ -1106,15 +1387,15 @@ export interface operations {
             500: components["responses"]["500"];
         };
     };
-    /**
-     * Callbacks for the bulk transaction request.
-     * @description The HTTP request `PUT /bulkTransactions/{bulkTransactionId}` is used to amend information regarding a bulk transaction, i.e. when autoAcceptParty or autoAcceptQuote  is false then the payer need to provide confirmation to proceed with further processing of the request. The `{bulkTransactionId}` in the URI should contain the `bulkTransactionId` that was used for the creation of the bulk transfer.
-     */
     BackendBulkTransactionsPut: {
         parameters: {
+            query?: never;
+            header?: never;
             path: {
+                /** @description Identifier of the bulk transaction to continue as returned in the response to a `POST /bulkTransaction` request. */
                 bulkTransactionId: components["parameters"]["bulkTransactionId"];
             };
+            cookie?: never;
         };
         requestBody?: {
             content: {
@@ -1124,21 +1405,23 @@ export interface operations {
         responses: {
             /** @description Bulk transaction information successfully amended. */
             202: {
-                content: never;
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
             };
             400: components["responses"]["400"];
             500: components["responses"]["500"];
         };
     };
-    /**
-     * Callback for the requestToPay request.
-     * @description It is used to notify the DFSP backend about the status of the requestToPayTransfer.
-     */
     RequestToPayPut: {
         parameters: {
+            query?: never;
+            header?: never;
             path: {
                 transactionRequestId: components["parameters"]["transactionRequestId"];
             };
+            cookie?: never;
         };
         requestBody?: {
             content: {
@@ -1148,14 +1431,22 @@ export interface operations {
         responses: {
             /** @description OK */
             200: {
-                content: never;
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
             };
             400: components["responses"]["400"];
             500: components["responses"]["500"];
         };
     };
-    /** Execute bulk transfer of funds from an external account to internal accounts. */
     BackendBulkTransfersPost: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
         /** @description An incoming bulk transfer request. */
         requestBody?: {
             content: {
@@ -1165,6 +1456,9 @@ export interface operations {
         responses: {
             /** @description The bulk transfer was accepted. */
             200: {
+                headers: {
+                    [name: string]: unknown;
+                };
                 content: {
                     "application/json": components["schemas"]["bulkTransferResponse"];
                 };
@@ -1173,16 +1467,23 @@ export interface operations {
             500: components["responses"]["500"];
         };
     };
-    /** Requests information relating to a bulk transfer identified by the specified identifier value. */
     BackendBulkTransfersGet: {
         parameters: {
+            query?: never;
+            header?: never;
             path: {
+                /** @description The identifier value. */
                 idValue: components["parameters"]["idValue"];
             };
+            cookie?: never;
         };
+        requestBody?: never;
         responses: {
             /** @description Response containing details of the requested bulk transfer. */
             200: {
+                headers: {
+                    [name: string]: unknown;
+                };
                 content: {
                     "application/json": components["schemas"]["bulkTransferResponse"];
                 };
@@ -1192,16 +1493,22 @@ export interface operations {
             500: components["responses"]["500"];
         };
     };
-    /** Requests OTP. */
     BackendOtpGet: {
         parameters: {
+            query?: never;
+            header?: never;
             path: {
                 transactionRequestId: components["parameters"]["transactionRequestId"];
             };
+            cookie?: never;
         };
+        requestBody?: never;
         responses: {
             /** @description Response containing details of the OTP. */
             200: {
+                headers: {
+                    [name: string]: unknown;
+                };
                 content: {
                     "application/json": components["schemas"]["otpDetails"];
                 };
@@ -1211,20 +1518,25 @@ export interface operations {
             500: components["responses"]["500"];
         };
     };
-    /**
-     * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value.
-     * @description The HTTP request `GET /participants/{idType}/{idValue}` is used to find out in which FSP the requested party, defined by `{idType}` and `{idValue}`, is located.
-     */
     BackendParticipantsGetByTypeAndID: {
         parameters: {
+            query?: never;
+            header?: never;
             path: {
+                /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
                 idType: components["parameters"]["idType"];
+                /** @description The identifier value. */
                 idValue: components["parameters"]["idValue"];
             };
+            cookie?: never;
         };
+        requestBody?: never;
         responses: {
             /** @description Response containing details of the requested party. */
             200: {
+                headers: {
+                    [name: string]: unknown;
+                };
                 content: {
                     "application/json": components["schemas"]["participantsResponse"];
                 };
@@ -1234,21 +1546,27 @@ export interface operations {
             500: components["responses"]["500"];
         };
     };
-    /**
-     * Asks for the identifier (fspId) of the scheme participant (FSP) that can handle transfers for the specified identifier type and value.
-     * @description The HTTP request `GET /participants/{idType}/{idValue}/{idSubValue}` is used to find out in which FSP the requested party, defined by `{idType}`, `{idValue}` and `{idSubValue}` is located.
-     */
     BackendParticipantsGetByTypeIDAndSubId: {
         parameters: {
+            query?: never;
+            header?: never;
             path: {
+                /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
                 idType: components["parameters"]["idType"];
+                /** @description The identifier value. */
                 idValue: components["parameters"]["idValue"];
+                /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
                 idSubValue: components["parameters"]["idSubValue"];
             };
+            cookie?: never;
         };
+        requestBody?: never;
         responses: {
             /** @description Response containing details of the requested party. */
             200: {
+                headers: {
+                    [name: string]: unknown;
+                };
                 content: {
                     "application/json": components["schemas"]["participantsResponse"];
                 };
@@ -1258,20 +1576,25 @@ export interface operations {
             500: components["responses"]["500"];
         };
     };
-    /**
-     * Requests information relating to a transfer party identified by the specified identifier type and value.
-     * @description The HTTP request `GET /parties/{idType}/{idValue}` is used to look up information regarding the requested transfer party, identified by `{idType}` and `{idValue}`.
-     */
     BackendPartiesGetByTypeAndID: {
         parameters: {
+            query?: never;
+            header?: never;
             path: {
+                /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
                 idType: components["parameters"]["idType"];
+                /** @description The identifier value. */
                 idValue: components["parameters"]["idValue"];
             };
+            cookie?: never;
         };
+        requestBody?: never;
         responses: {
             /** @description Response containing details of the requested party. */
             200: {
+                headers: {
+                    [name: string]: unknown;
+                };
                 content: {
                     "application/json": components["schemas"]["transferParty"];
                 };
@@ -1281,21 +1604,27 @@ export interface operations {
             500: components["responses"]["500"];
         };
     };
-    /**
-     * Requests information relating to a transfer party identified by the specified identifier type, value and subId value.
-     * @description The HTTP request `GET /parties/{idType}/{idValue}/{idSubValue}` is used to look up information regarding the requested transfer party, identified by `{idType}`, `{idValue}` and `{idSubValue}`.
-     */
     BackendPartiesGetByTypeIdAndSubId: {
         parameters: {
+            query?: never;
+            header?: never;
             path: {
+                /** @description The type of the party identifier. For example, `MSISDN`, `PERSONAL_ID`. */
                 idType: components["parameters"]["idType"];
+                /** @description The identifier value. */
                 idValue: components["parameters"]["idValue"];
+                /** @description A sub-identifier of the party identifier, or a sub-type of the party identifier's type. For example, `PASSPORT`, `DRIVING_LICENSE`. */
                 idSubValue: components["parameters"]["idSubValue"];
             };
+            cookie?: never;
         };
+        requestBody?: never;
         responses: {
             /** @description Response containing details of the requested party. */
             200: {
+                headers: {
+                    [name: string]: unknown;
+                };
                 content: {
                     "application/json": components["schemas"]["transferParty"];
                 };
@@ -1305,11 +1634,13 @@ export interface operations {
             500: components["responses"]["500"];
         };
     };
-    /**
-     * Requests a quote for the specified transfer.
-     * @description The HTTP request `POST /quoterequests` is used to request the creation of a quote for the provided financial transaction.
-     */
     BackendQuoteRequest: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
         /** @description Request for a transfer quotation. */
         requestBody?: {
             content: {
@@ -1319,6 +1650,9 @@ export interface operations {
         responses: {
             /** @description A response to the transfer quotation request. */
             200: {
+                headers: {
+                    [name: string]: unknown;
+                };
                 content: {
                     "application/json": components["schemas"]["quoteResponse"];
                 };
@@ -1327,8 +1661,13 @@ export interface operations {
             500: components["responses"]["500"];
         };
     };
-    /** Transaction request that supports pull based transfers. */
     BackendTransactionRequest: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
         /** @description Request for Transaction Request. */
         requestBody?: {
             content: {
@@ -1338,6 +1677,9 @@ export interface operations {
         responses: {
             /** @description A response to the transfer transaction request. */
             200: {
+                headers: {
+                    [name: string]: unknown;
+                };
                 content: {
                     "application/json": components["schemas"]["transactionRequestResponse"];
                 };
@@ -1346,11 +1688,13 @@ export interface operations {
             500: components["responses"]["500"];
         };
     };
-    /**
-     * Transfers funds from an external account to an internal account.
-     * @description The HTTP request `POST /transfers` is used to request the creation of a transfer for the transfer party.
-     */
     BackendTransfersPost: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
         /** @description An incoming transfer request. */
         requestBody?: {
             content: {
@@ -1360,6 +1704,9 @@ export interface operations {
         responses: {
             /** @description The transfer was accepted. */
             200: {
+                headers: {
+                    [name: string]: unknown;
+                };
                 content: {
                     "application/json": components["schemas"]["transferResponse"];
                 };
@@ -1368,19 +1715,22 @@ export interface operations {
             500: components["responses"]["500"];
         };
     };
-    /**
-     * Retrieves information for a specific transfer.
-     * @description The HTTP request `GET /transfers/{transferId}` is used to get information regarding a transfer created or requested earlier. The `{transferId}` in the URI should contain the `transferId` that was used for the creation of the transfer.
-     */
     BackendTransfersGet: {
         parameters: {
+            query?: never;
+            header?: never;
             path: {
                 transferId: components["parameters"]["transferId"];
             };
+            cookie?: never;
         };
+        requestBody?: never;
         responses: {
             /** @description The transfer was accepted. */
             200: {
+                headers: {
+                    [name: string]: unknown;
+                };
                 content: {
                     "application/json": components["schemas"]["transferDetailsResponse"];
                 };
@@ -1388,15 +1738,14 @@ export interface operations {
             500: components["responses"]["500"];
         };
     };
-    /**
-     * Receive notification for a specific transfer.
-     * @description The HTTP request `PUT /transfers/{transferId}` is used to receive notification for transfer being fulfiled when the FSP is a Payee.
-     */
     BackendTransfersPut: {
         parameters: {
+            query?: never;
+            header?: never;
             path: {
                 transferId: components["parameters"]["transferId"];
             };
+            cookie?: never;
         };
         /** @description An incoming notification for fulfiled transfer. */
         requestBody?: {
@@ -1407,16 +1756,21 @@ export interface operations {
         responses: {
             /** @description The notification was accepted. */
             200: {
-                content: never;
+                headers: {
+                    [name: string]: unknown;
+                };
+                content?: never;
             };
             500: components["responses"]["500"];
         };
     };
-    /**
-     * Calculate FX quote
-     * @description The HTTP request `POST /fxQuotes` is used to ask an FXP backend to provide a quotation for a currency conversion.
-     */
     FxQuotesPost: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
         /** @description Details of the FX quote request. */
         requestBody: {
             content: {
@@ -1426,6 +1780,9 @@ export interface operations {
         responses: {
             /** @description Successful response. */
             200: {
+                headers: {
+                    [name: string]: unknown;
+                };
                 content: {
                     "application/json": components["schemas"]["FxQuotesPostBackendResponse"];
                 };
@@ -1434,11 +1791,13 @@ export interface operations {
             500: components["responses"]["500"];
         };
     };
-    /**
-     * Perform FX transfer
-     * @description The HTTP request `POST /fxTransfers` is used to ask an FXP backend to confirm the execution of an agreed currency conversion.
-     */
     FxTransfersPost: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
         /** @description Details of the FX transfer request. */
         requestBody: {
             content: {
@@ -1448,6 +1807,9 @@ export interface operations {
         responses: {
             /** @description Successful response. */
             200: {
+                headers: {
+                    [name: string]: unknown;
+                };
                 content: {
                     "application/json": components["schemas"]["FxTransfersPostBackendResponse"];
                 };
@@ -1456,11 +1818,13 @@ export interface operations {
             500: components["responses"]["500"];
         };
     };
-    /**
-     * FX Commit Notification
-     * @description The HTTP request `PUT /fxTransfers/{commitRequestId}` is used to notify an FXP backend about the status of currency conversion.
-     */
     FxTransfersById: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
         /** @description Status of the FX transfer. */
         requestBody: {
             content: {