Variable estimateApiConst

Type Declaration

• Readonly/v1/withdrawal/estimate: {
      get: {
          description: "Get an estimate for a Withdrawal on the CFX network.\n\nSupply either `sourceAmount` (the amount to be debited from wallet) or `targetAmountAfterFees` (the amount to arrive at the destination) to receive an estimate.\n\nNote this endpoint is purely for the estimation of withdrawal amounts and fees.\nThe actual withdrawal is actioned via other withdrawal endpoints which facilitate the creation of a binding withdrawal quote and capturing explicit acceptance.";
          querystring: TIntersect<
              [
                  TObject<
                      {
                          identityId: TOptional<TString>;
                          organizationId: TOptional<TString>;
                      },
                  >,
                  TObject<
                      {
                          country: TUnsafe<string>;
                          sourceAmount: TOptional<TNumber>;
                          sourceCurrency: TUnsafe<"USDC" | "MOVEUSD">;
                          targetAmountAfterFees: TOptional<TNumber>;
                          targetCurrency: TUnsafe<
                              | "USD"
                              | "MXN"
                              | "XOF"
                              | "KES"
                              | "AUD"
                              | "HKD"
                              | "JPY"
                              | "NZD"
                              | "SGD"
                              | "SEK"
                              | "CHF"
                              | "CAD"
                              | "GBP"
                              | "CZK"
                              | "DKK"
                              | "EUR",
                          >;
                      },
                  >,
              ],
          >;
          response: {
              "200": TObject<
                  {
                      country: TUnsafe<string>;
                      methods: TArray<
                          TUnion<
                              [
                                  TIntersect<[(...), (...)]>,
                                  TIntersect<[(...), (...)]>,
                                  TIntersect<[(...), (...)]>,
                              ],
                          >,
                      >;
                      sourceAmount: TNumber;
                      sourceCurrency: TUnsafe<"USDC" | "MOVEUSD">;
                      targetCurrency: TUnsafe<
                          | "USD"
                          | "MXN"
                          | "XOF"
                          | "KES"
                          | "AUD"
                          | "HKD"
                          | "JPY"
                          | "NZD"
                          | "SGD"
                          | "SEK"
                          | "CHF"
                          | "CAD"
                          | "GBP"
                          | "CZK"
                          | "DKK"
                          | "EUR",
                      >;
                  },
              >;
              "400": TObject<
                  {
                      code: TString;
                      details: TOptional<TRecord<"^.*$", TAny>>;
                      message: TString;
                  },
              >;
              "404": TObject<
                  {
                      code: TLiteral<"notFound">;
                      details: TOptional<TRecord<"^.*$", TAny>>;
                      message: TString;
                  },
              >;
              default: TObject<
                  {
                      code: TString;
                      details: TOptional<TRecord<"^.*$", TAny>>;
                      message: TString;
                  },
              >;
          };
          summary: "Get Withdrawal Estimate";
          tags: readonly ["Estimate"];
      };
  }