Variable identityLedgerAccountApiConst

Type Declaration

• Readonly/v1/identity/{identityId}/ledger-accounts: {
      get: {
          params: TObject<{ identityId: TString }>;
          querystring: TObject<
              {
                  addresses: TOptional<TString>;
                  createdAfter: TOptional<TString>;
                  createdBefore: TOptional<TString>;
                  orderBy: TOptional<TString>;
                  page: TOptional<TInteger>;
                  pageSize: TOptional<TInteger>;
              },
          >;
          response: {
              "200": TObject<
                  {
                      hasNext: TBoolean;
                      items: TArray<
                          TObject<
                              {
                                  address: TString;
                                  balance: TString;
                                  createdAt: TString;
                                  id: TString;
                                  name: TOptional<TString>;
                                  referenceId: TOptional<TString>;
                                  updatedAt: TString;
                                  visibility: TUnsafe<(...) | (...)>;
                              },
                          >,
                      >;
                  },
              >;
              "400": TObject<{ code: TLiteral<"INVALID_ADDRESSES">; message: TString }>;
          };
          summary: "Search for ledger accounts of an identity";
          tags: readonly ["Identity", "Ledger Account"];
      };
      post: {
          body: TIntersect<
              [
                  TObject<
                      { name: TOptional<TString>; referenceId: TOptional<TString> },
                  >,
                  TObject<{ visibility: TOptional<TUnsafe<"PRIVATE" | "PUBLIC">> }>,
              ],
          >;
          description: "Ledger accounts can hold MoveUSD and be used in transactions.";
          params: TObject<{ identityId: TString }>;
          response: {
              "202": TObject<
                  {
                      address: TString;
                      balance: TString;
                      createdAt: TString;
                      id: TString;
                      name: TOptional<TString>;
                      referenceId: TOptional<TString>;
                      updatedAt: TString;
                      visibility: TUnsafe<"PRIVATE" | "PUBLIC">;
                  },
              >;
              "400": TObject<{ code: TLiteral<"INVALID_IDENTITY">; message: TString }>;
          };
          summary: "Create a ledger account of an identity";
          tags: readonly ["Identity", "Ledger Account"];
      };
  }

• Readonly/v1/identity/{identityId}/ledger-accounts/{id}: {
      get: {
          params: TObject<{ id: TString; identityId: TString }>;
          response: {
              "200": TObject<
                  {
                      address: TString;
                      balance: TString;
                      createdAt: TString;
                      id: TString;
                      name: TOptional<TString>;
                      referenceId: TOptional<TString>;
                      updatedAt: TString;
                      visibility: TUnsafe<"PRIVATE" | "PUBLIC">;
                  },
              >;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Get a ledger account details, belonging to an identity";
          tags: readonly ["Identity", "Ledger Account"];
      };
      put: {
          body: TObject<
              { name: TOptional<TString>; referenceId: TOptional<TString> },
          >;
          params: TObject<{ id: TString; identityId: TString }>;
          response: {
              "200": TObject<
                  {
                      address: TString;
                      balance: TString;
                      createdAt: TString;
                      id: TString;
                      name: TOptional<TString>;
                      referenceId: TOptional<TString>;
                      updatedAt: TString;
                      visibility: TUnsafe<"PRIVATE" | "PUBLIC">;
                  },
              >;
              "400": TObject<{ code: TLiteral<"INVALID_IDENTITY">; message: TString }>;
              "404": TObject<{ code: TLiteral<"NOT_FOUND">; message: TString }>;
          };
          summary: "Update a ledger account of an identity";
          tags: readonly ["Identity", "Ledger Account"];
      };
  }