Variable depositApiConst

Type Declaration

• Readonly/v1/deposit: {
      get: {
          description: "Search deposits across all payment instruments for a given identityId or organizationId.\n\nDeposits can be further filtered by populating the `status` and `reference` parameters.\n\nNote that cash deposits will only be returned after they have progressed to at least the `RECEIVED` state.";
          querystring: TIntersect<
              [
                  TObject<
                      {
                          identityId: TOptional<TString>;
                          organizationId: TOptional<TString>;
                      },
                  >,
                  TObject<
                      {
                          id: TOptional<TString>;
                          page: TOptional<TInteger>;
                          pageSize: TOptional<TInteger>;
                          reference: TOptional<TString>;
                          status: TOptional<TString>;
                          type: TOptional<
                              TUnsafe<
                                  | "CASH"
                                  | "US_BANK_ACH"
                                  | "ACH_CREDIT"
                                  | "RTP"
                                  | "US_WIRE"
                                  | "SWIFT_WIRE",
                              >,
                          >;
                      },
                  >,
              ],
          >;
          response: {
              "200": TObject<
                  {
                      results: TArray<
                          TUnion<[TIntersect<[(...), (...)]>, TIntersect<[(...), (...)]>]>,
                      >;
                  },
              >;
              "400": TObject<
                  {
                      code: TString;
                      details: TOptional<TRecord<"^.*$", TAny>>;
                      message: TString;
                  },
              >;
              default: TObject<
                  {
                      code: TString;
                      details: TOptional<TRecord<"^.*$", TAny>>;
                      message: TString;
                  },
              >;
          };
          summary: "Search Deposits";
          tags: readonly ["Deposit"];
      };
  }

• Readonly/v1/deposit/{id}: {
      get: {
          description: "Get deposit details including the financial instrument utilised.";
          params: TObject<{ id: TString }>;
          querystring: TObject<{ withRequest: TOptional<TBoolean> }>;
          response: {
              "200": TUnion<
                  [
                      TIntersect<
                          [
                              TObject<
                                  {
                                      amount: TUnion<(...)>;
                                      createdAt: TString;
                                      history: TOptional<(...)>;
                                      id: TString;
                                      quote: TUnion<(...)>;
                                      receipt: TUnion<(...)>;
                                      reference: TString;
                                      status: TUnion<(...)>;
                                      wallet: TUnion<(...)>;
                                  },
                              >,
                              TObject<{ request: TOptional<(...)>; type: TLiteral<(...)> }>,
                          ],
                      >,
                      TIntersect<
                          [
                              TObject<
                                  {
                                      amount: TUnion<(...)>;
                                      createdAt: TString;
                                      history: TOptional<(...)>;
                                      id: TString;
                                      quote: TUnion<(...)>;
                                      receipt: TUnion<(...)>;
                                      reference: TString;
                                      status: TUnion<(...)>;
                                      wallet: TUnion<(...)>;
                                  },
                              >,
                              TObject<{ request: TOptional<(...)>; type: TLiteral<(...)> }>,
                          ],
                      >,
                      TIntersect<
                          [
                              TObject<
                                  {
                                      amount: TUnion<(...)>;
                                      createdAt: TString;
                                      history: TOptional<(...)>;
                                      id: TString;
                                      quote: TUnion<(...)>;
                                      receipt: TUnion<(...)>;
                                      reference: TString;
                                      status: TUnion<(...)>;
                                      wallet: TUnion<(...)>;
                                  },
                              >,
                              TObject<{ request: TOptional<(...)>; type: TLiteral<(...)> }>,
                          ],
                      >,
                  ],
              >;
              "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 Deposit";
          tags: readonly ["Deposit"];
      };
  }

• Readonly/v1/deposit/products: {
      get: {
          deprecated: true;
          description: "**DEPRECATED:** Use Product API instead.\n\nRetrieve deposit product, their current usages and defined limits for a given identity";
          querystring: TIntersect<
              [
                  TObject<
                      {
                          identityId: TOptional<TString>;
                          organizationId: TOptional<TString>;
                      },
                  >,
                  TObject<{}>,
              ],
          >;
          response: {
              "200": TObject<
                  {
                      aggregated: TObject<
                          {
                              limits: TObject<
                                  {
                                      dailyCountLimit: TOptional<(...)>;
                                      dailyCurrencyLimit: TOptional<(...)>;
                                      lifetimeCountLimit: TOptional<(...)>;
                                      monthlyCountLimit: TOptional<(...)>;
                                      monthlyCurrencyLimit: TOptional<(...)>;
                                      perTransactionMaximum: TOptional<(...)>;
                                      perTransactionMinimum: TOptional<(...)>;
                                      weeklyCountLimit: TOptional<(...)>;
                                      weeklyCurrencyLimit: TOptional<(...)>;
                                  },
                              >;
                              usage: TObject<
                                  {
                                      last30Days: TObject<(...)>;
                                      last7Days: TObject<(...)>;
                                      lifetime: TObject<(...)>;
                                      today: TObject<(...)>;
                                  },
                              >;
                          },
                      >;
                      products: TArray<
                          TObject<
                              {
                                  limits: TObject<
                                      {
                                          dailyCountLimit: ...;
                                          dailyCurrencyLimit: ...;
                                          lifetimeCountLimit: ...;
                                          monthlyCountLimit: ...;
                                          monthlyCurrencyLimit: ...;
                                          perTransactionMaximum: ...;
                                          perTransactionMinimum: ...;
                                          weeklyCountLimit: ...;
                                          weeklyCurrencyLimit: ...;
                                      },
                                  >;
                                  name: TUnion<[(...), (...), (...), (...)]>;
                                  usage: TObject<
                                      { last30Days: ...; last7Days: ...; lifetime: ...; today: ... },
                                  >;
                              },
                          >,
                      >;
                  },
              >;
              "400": TObject<
                  {
                      code: TString;
                      details: TOptional<TRecord<"^.*$", TAny>>;
                      message: TString;
                  },
              >;
              default: TObject<
                  {
                      code: TString;
                      details: TOptional<TRecord<"^.*$", TAny>>;
                      message: TString;
                  },
              >;
          };
          summary: "Get Deposit Products";
          tags: readonly ["Deposit"];
      };
  }

• Readonly/v1/deposit/usage: {
      get: {
          description: "Retrieve deposit product usages for a given identity";
          querystring: TIntersect<
              [
                  TObject<
                      {
                          identityId: TOptional<TString>;
                          organizationId: TOptional<TString>;
                      },
                  >,
                  TObject<{}>,
              ],
          >;
          response: {
              "200": TObject<
                  {
                      aggregated: TObject<
                          {
                              last30Days: TObject<
                                  {
                                      amount: TNumber;
                                      count: TNumber;
                                      since: TString;
                                      updateAt: TString;
                                  },
                              >;
                              last7Days: TObject<
                                  {
                                      amount: TNumber;
                                      count: TNumber;
                                      since: TString;
                                      updateAt: TString;
                                  },
                              >;
                              lifetime: TObject<{ amount: TNumber; count: TNumber }>;
                              today: TObject<
                                  {
                                      amount: TNumber;
                                      count: TNumber;
                                      resetAt: TString;
                                      since: TString;
                                  },
                              >;
                          },
                      >;
                      products: TArray<
                          TIntersect<
                              [
                                  TObject<{ name: ... }>,
                                  TObject<
                                      { last30Days: ...; last7Days: ...; lifetime: ...; today: ... },
                                  >,
                              ],
                          >,
                      >;
                  },
              >;
              "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 Deposit Usage";
          tags: readonly ["Deposit"];
      };
  }