Variable ledgerAccountApiConst

Type Declaration

• Readonly/v1/ledger-accounts: {
      get: {
          querystring: TObject<
              {
                  addresses: TOptional<TString>;
                  createdAfter: TOptional<TString>;
                  createdBefore: TOptional<TString>;
                  identityIds: TOptional<TString>;
                  orderBy: TOptional<TString>;
                  organizationIds: TOptional<TString>;
                  page: TOptional<TInteger>;
                  pageSize: TOptional<TInteger>;
              },
          >;
          response: {
              "200": TObject<
                  {
                      hasNext: TBoolean;
                      items: TArray<
                          TIntersect<
                              [
                                  TObject<
                                      {
                                          address: ...;
                                          balance: ...;
                                          createdAt: ...;
                                          id: ...;
                                          name: ...;
                                          referenceId: ...;
                                          updatedAt: ...;
                                          visibility: ...;
                                      },
                                  >,
                                  TUnion<[(...), (...)]>,
                              ],
                          >,
                      >;
                  },
              >;
              "400": TObject<{ code: TLiteral<"INVALID_ADDRESSES">; message: TString }>;
          };
          summary: "Search for ledger accounts";
          tags: readonly ["Ledger Account"];
      };
  }

• Readonly/v1/ledger-accounts/{id}: {
      get: {
          params: TObject<{ id: TString }>;
          response: {
              "200": TIntersect<
                  [
                      TObject<
                          {
                              address: TString;
                              balance: TString;
                              createdAt: TString;
                              id: TString;
                              name: TOptional<TString>;
                              referenceId: TOptional<TString>;
                              updatedAt: TString;
                              visibility: TUnsafe<"PRIVATE" | "PUBLIC">;
                          },
                      >,
                      TUnion<
                          [
                              TObject<{ identityId: TString }>,
                              TObject<{ organizationId: TString }>,
                          ],
                      >,
                  ],
              >;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Get a ledger account details";
          tags: readonly ["Ledger Account"];
      };
  }